VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkColorSeries Class Reference

stores a list of colors. More...

#include <vtkColorSeries.h>

Inherits vtkObject.

Public Types

typedef vtkObject Superclass
 
enum  {
  SPECTRUM = 0, WARM, COOL, BLUES,
  WILD_FLOWER, CITRUS, BREWER_DIVERGING_PURPLE_ORANGE_11, BREWER_DIVERGING_PURPLE_ORANGE_10,
  BREWER_DIVERGING_PURPLE_ORANGE_9, BREWER_DIVERGING_PURPLE_ORANGE_8, BREWER_DIVERGING_PURPLE_ORANGE_7, BREWER_DIVERGING_PURPLE_ORANGE_6,
  BREWER_DIVERGING_PURPLE_ORANGE_5, BREWER_DIVERGING_PURPLE_ORANGE_4, BREWER_DIVERGING_PURPLE_ORANGE_3, BREWER_DIVERGING_SPECTRAL_11,
  BREWER_DIVERGING_SPECTRAL_10, BREWER_DIVERGING_SPECTRAL_9, BREWER_DIVERGING_SPECTRAL_8, BREWER_DIVERGING_SPECTRAL_7,
  BREWER_DIVERGING_SPECTRAL_6, BREWER_DIVERGING_SPECTRAL_5, BREWER_DIVERGING_SPECTRAL_4, BREWER_DIVERGING_SPECTRAL_3,
  BREWER_DIVERGING_BROWN_BLUE_GREEN_11, BREWER_DIVERGING_BROWN_BLUE_GREEN_10, BREWER_DIVERGING_BROWN_BLUE_GREEN_9, BREWER_DIVERGING_BROWN_BLUE_GREEN_8,
  BREWER_DIVERGING_BROWN_BLUE_GREEN_7, BREWER_DIVERGING_BROWN_BLUE_GREEN_6, BREWER_DIVERGING_BROWN_BLUE_GREEN_5, BREWER_DIVERGING_BROWN_BLUE_GREEN_4,
  BREWER_DIVERGING_BROWN_BLUE_GREEN_3, BREWER_SEQUENTIAL_BLUE_GREEN_9, BREWER_SEQUENTIAL_BLUE_GREEN_8, BREWER_SEQUENTIAL_BLUE_GREEN_7,
  BREWER_SEQUENTIAL_BLUE_GREEN_6, BREWER_SEQUENTIAL_BLUE_GREEN_5, BREWER_SEQUENTIAL_BLUE_GREEN_4, BREWER_SEQUENTIAL_BLUE_GREEN_3,
  BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_9, BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_8, BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_7, BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_6,
  BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_5, BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_4, BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_3, BREWER_SEQUENTIAL_BLUE_PURPLE_9,
  BREWER_SEQUENTIAL_BLUE_PURPLE_8, BREWER_SEQUENTIAL_BLUE_PURPLE_7, BREWER_SEQUENTIAL_BLUE_PURPLE_6, BREWER_SEQUENTIAL_BLUE_PURPLE_5,
  BREWER_SEQUENTIAL_BLUE_PURPLE_4, BREWER_SEQUENTIAL_BLUE_PURPLE_3, BREWER_QUALITATIVE_ACCENT, BREWER_QUALITATIVE_DARK2,
  BREWER_QUALITATIVE_SET2, BREWER_QUALITATIVE_PASTEL2, BREWER_QUALITATIVE_PASTEL1, BREWER_QUALITATIVE_SET1,
  BREWER_QUALITATIVE_PAIRED, BREWER_QUALITATIVE_SET3, CUSTOM
}
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkColorSeriesNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
int GetNumberOfColorSchemes () const
 
virtual vtkStdString GetColorSchemeName () const
 
virtual void SetColorSchemeName (const vtkStdString &scheme)
 
virtual int GetColorScheme () const
 
virtual int GetNumberOfColors () const
 
virtual void SetNumberOfColors (int numColors)
 
vtkColor3ub GetColor (int index) const
 
vtkColor3ub GetColorRepeating (int index) const
 
virtual void SetColor (int index, const vtkColor3ub &color)
 
virtual void AddColor (const vtkColor3ub &color)
 
virtual void RemoveColor (int index)
 
virtual void ClearColors ()
 
virtual void DeepCopy (vtkColorSeries *chartColors)
 
void BuildLookupTable (vtkLookupTable *lkup)
 
vtkLookupTable * CreateLookupTable ()
 
virtual void SetColorScheme (int scheme)
 
virtual int SetColorSchemeByName (const vtkStdString &schemeName)
 
virtual void InsertColor (int index, const vtkColor3ub &color)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkColorSeriesSafeDownCast (vtkObjectBase *o)
 
static vtkColorSeriesNew ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkColorSeries ()
 
virtual ~vtkColorSeries ()
 
virtual void CopyOnWrite ()
 

Protected Attributes

int ColorScheme
 
vtkStdString ColorSchemeName
 The color scheme being used. More...
 
Private * Storage
 

Detailed Description

stores a list of colors.

The vtkColorSeries stores palettes of colors. There are several default palettes (or schemes) available and functions to control several aspects of what colors are returned. In essence a color scheme is set and then the number of colors and individual color values may be requested.

It is also possible to add schemes beyond the default palettes. Whenever SetColorScheme is called with a string for which no palette already exists, a new, empty palette is created. You may then use SetNumberOfColors and SetColor to populate the palette. You may not extend default palettes by calling functions that alter a scheme; if called while a predefined palette is in use, they will create a new non-default scheme and populate it with the current palette before continuing.

The "Brewer" palettes are courtesy of Cynthia A. Brewer (Dept. of Geography, Pennsylvania State University) and present under the Apache License. See the source code for details.

Tests:
vtkColorSeries (Tests)

Definition at line 53 of file vtkColorSeries.h.

Member Typedef Documentation

typedef vtkObject vtkColorSeries::Superclass

Definition at line 56 of file vtkColorSeries.h.

Member Enumeration Documentation

anonymous enum

Enum of the available color schemes

Enumerator
SPECTRUM 

7 different hues.

WARM 

6 warm colors (red to yellow).

COOL 

7 cool colors (green to purple).

BLUES 

7 different blues.

WILD_FLOWER 

7 colors from blue to magenta.

CITRUS 

6 colors from green to orange.

BREWER_DIVERGING_PURPLE_ORANGE_11 

purple-grey-orange diverging ColorBrewer scheme (11 colors)

BREWER_DIVERGING_PURPLE_ORANGE_10 

purple-grey-orange diverging ColorBrewer scheme (10 colors)

BREWER_DIVERGING_PURPLE_ORANGE_9 

purple-grey-orange diverging ColorBrewer scheme (9 colors)

BREWER_DIVERGING_PURPLE_ORANGE_8 

purple-grey-orange diverging ColorBrewer scheme (8 colors)

BREWER_DIVERGING_PURPLE_ORANGE_7 

purple-grey-orange diverging ColorBrewer scheme (7 colors)

BREWER_DIVERGING_PURPLE_ORANGE_6 

purple-grey-orange diverging ColorBrewer scheme (6 colors)

BREWER_DIVERGING_PURPLE_ORANGE_5 

purple-grey-orange diverging ColorBrewer scheme (5 colors)

BREWER_DIVERGING_PURPLE_ORANGE_4 

purple-grey-orange diverging ColorBrewer scheme (4 colors)

BREWER_DIVERGING_PURPLE_ORANGE_3 

purple-grey-orange diverging ColorBrewer scheme (3 colors)

BREWER_DIVERGING_SPECTRAL_11 

diverging spectral ColorBrewer scheme (11 colors)

BREWER_DIVERGING_SPECTRAL_10 

diverging spectral ColorBrewer scheme (10 colors)

BREWER_DIVERGING_SPECTRAL_9 

diverging spectral ColorBrewer scheme (9 colors)

BREWER_DIVERGING_SPECTRAL_8 

diverging spectral ColorBrewer scheme (8 colors)

BREWER_DIVERGING_SPECTRAL_7 

diverging spectral ColorBrewer scheme (7 colors)

BREWER_DIVERGING_SPECTRAL_6 

diverging spectral ColorBrewer scheme (6 colors)

BREWER_DIVERGING_SPECTRAL_5 

diverging spectral ColorBrewer scheme (5 colors)

BREWER_DIVERGING_SPECTRAL_4 

diverging spectral ColorBrewer scheme (4 colors)

BREWER_DIVERGING_SPECTRAL_3 

diverging spectral ColorBrewer scheme (3 colors)

BREWER_DIVERGING_BROWN_BLUE_GREEN_11 

brown-blue-green diverging ColorBrewer scheme (11 colors)

BREWER_DIVERGING_BROWN_BLUE_GREEN_10 

brown-blue-green diverging ColorBrewer scheme (10 colors)

BREWER_DIVERGING_BROWN_BLUE_GREEN_9 

brown-blue-green diverging ColorBrewer scheme (9 colors)

BREWER_DIVERGING_BROWN_BLUE_GREEN_8 

brown-blue-green diverging ColorBrewer scheme (8 colors)

BREWER_DIVERGING_BROWN_BLUE_GREEN_7 

brown-blue-green diverging ColorBrewer scheme (7 colors)

BREWER_DIVERGING_BROWN_BLUE_GREEN_6 

brown-blue-green diverging ColorBrewer scheme (6 colors)

BREWER_DIVERGING_BROWN_BLUE_GREEN_5 

brown-blue-green diverging ColorBrewer scheme (5 colors)

BREWER_DIVERGING_BROWN_BLUE_GREEN_4 

brown-blue-green diverging ColorBrewer scheme (4 colors)

BREWER_DIVERGING_BROWN_BLUE_GREEN_3 

brown-blue-green diverging ColorBrewer scheme (3 colors)

BREWER_SEQUENTIAL_BLUE_GREEN_9 

blue to green sequential ColorBrewer scheme (9 colors)

BREWER_SEQUENTIAL_BLUE_GREEN_8 

blue to green sequential ColorBrewer scheme (8 colors)

BREWER_SEQUENTIAL_BLUE_GREEN_7 

blue to green sequential ColorBrewer scheme (7 colors)

BREWER_SEQUENTIAL_BLUE_GREEN_6 

blue to green sequential ColorBrewer scheme (6 colors)

BREWER_SEQUENTIAL_BLUE_GREEN_5 

blue to green sequential ColorBrewer scheme (5 colors)

BREWER_SEQUENTIAL_BLUE_GREEN_4 

blue to green sequential ColorBrewer scheme (4 colors)

BREWER_SEQUENTIAL_BLUE_GREEN_3 

blue to green sequential ColorBrewer scheme (3 colors)

BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_9 

yellow-orange-brown sequential ColorBrewer scheme (9 colors)

BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_8 

yellow-orange-brown sequential ColorBrewer scheme (8 colors)

BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_7 

yellow-orange-brown sequential ColorBrewer scheme (7 colors)

BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_6 

yellow-orange-brown sequential ColorBrewer scheme (6 colors)

BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_5 

yellow-orange-brown sequential ColorBrewer scheme (5 colors)

BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_4 

yellow-orange-brown sequential ColorBrewer scheme (4 colors)

BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_3 

yellow-orange-brown sequential ColorBrewer scheme (3 colors)

BREWER_SEQUENTIAL_BLUE_PURPLE_9 

blue to purple sequential ColorBrewer scheme (9 colors)

BREWER_SEQUENTIAL_BLUE_PURPLE_8 

blue to purple sequential ColorBrewer scheme (8 colors)

BREWER_SEQUENTIAL_BLUE_PURPLE_7 

blue to purple sequential ColorBrewer scheme (7 colors)

BREWER_SEQUENTIAL_BLUE_PURPLE_6 

blue to purple sequential ColorBrewer scheme (6 colors)

BREWER_SEQUENTIAL_BLUE_PURPLE_5 

blue to purple sequential ColorBrewer scheme (5 colors)

BREWER_SEQUENTIAL_BLUE_PURPLE_4 

blue to purple sequential ColorBrewer scheme (4 colors)

BREWER_SEQUENTIAL_BLUE_PURPLE_3 

blue to purple sequential ColorBrewer scheme (3 colors)

BREWER_QUALITATIVE_ACCENT 

qualitative ColorBrewer scheme good for accenting

BREWER_QUALITATIVE_DARK2 

a dark set of qualitative colors from ColorBrewer

BREWER_QUALITATIVE_SET2 

a qualitative ColorBrewer scheme useful for color set members

BREWER_QUALITATIVE_PASTEL2 

a qualitative ColorBrewer scheme composed of pastel colors

BREWER_QUALITATIVE_PASTEL1 

a qualitative ColorBrewer scheme composed of pastel colors

BREWER_QUALITATIVE_SET1 

a qualitative ColorBrewer scheme useful for color set members

BREWER_QUALITATIVE_PAIRED 

a qualitative ColorBrewer scheme with pairs of matching colors

BREWER_QUALITATIVE_SET3 

a qualitative ColorBrewer scheme useful for color set members

CUSTOM 

User specified color scheme.

Definition at line 65 of file vtkColorSeries.h.

Constructor & Destructor Documentation

vtkColorSeries::vtkColorSeries ( )
protected
virtual vtkColorSeries::~vtkColorSeries ( )
protectedvirtual

Member Function Documentation

static int vtkColorSeries::IsTypeOf ( const char *  type)
static
virtual int vtkColorSeries::IsA ( const char *  type)
virtual
static vtkColorSeries* vtkColorSeries::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkColorSeries::NewInstanceInternal ( ) const
protectedvirtual
vtkColorSeries* vtkColorSeries::NewInstance ( ) const
virtual void vtkColorSeries::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual
static vtkColorSeries* vtkColorSeries::New ( )
static

Create a new vtkColorSeries with the SPECTRUM color scheme.

virtual void vtkColorSeries::SetColorScheme ( int  scheme)
virtual

Set the color scheme that should be used. The variant of this function that takes an integer should pass a number from those in the enum, or a value returned by the string variant. The variant that accepts a string returns the integer index of the resulting palette (whether it already existed or is newly-created).

virtual int vtkColorSeries::SetColorSchemeByName ( const vtkStdString &  schemeName)
virtual

Set the color scheme that should be used. The variant of this function that takes an integer should pass a number from those in the enum, or a value returned by the string variant. The variant that accepts a string returns the integer index of the resulting palette (whether it already existed or is newly-created).

int vtkColorSeries::GetNumberOfColorSchemes ( ) const

Return the number of schemes currently defined.

virtual vtkStdString vtkColorSeries::GetColorSchemeName ( ) const
virtual

Get the color scheme that is currently being used.

virtual void vtkColorSeries::SetColorSchemeName ( const vtkStdString &  scheme)
virtual

Set the name of the current color scheme

virtual int vtkColorSeries::GetColorScheme ( ) const
virtual

Return the ID of the color scheme currently in use.

virtual int vtkColorSeries::GetNumberOfColors ( ) const
virtual

Get the number of colors available in the current color scheme.

virtual void vtkColorSeries::SetNumberOfColors ( int  numColors)
virtual

Set the number of colors to be stored in a non-default color scheme. Calling this function on a predefined color scheme will cause the scheme to be duplicated to a new custom scheme.

vtkColor3ub vtkColorSeries::GetColor ( int  index) const

Get the color at the specified index. If the index is out of range then black will be returned.

vtkColor3ub vtkColorSeries::GetColorRepeating ( int  index) const

Get the color at the specified index. If the index is out of range then the call wraps around, i.e. uses the mod operator.

virtual void vtkColorSeries::SetColor ( int  index,
const vtkColor3ub color 
)
virtual

Set the color at the specified index. Does nothing if the index is out of range.

virtual void vtkColorSeries::AddColor ( const vtkColor3ub color)
virtual

Adds the color to the end of the list.

virtual void vtkColorSeries::InsertColor ( int  index,
const vtkColor3ub color 
)
virtual

Inserts the color at the specified index in the list.

virtual void vtkColorSeries::RemoveColor ( int  index)
virtual

Removes the color at the specified index in the list.

virtual void vtkColorSeries::ClearColors ( )
virtual

Clears the list of colors.

virtual void vtkColorSeries::DeepCopy ( vtkColorSeries chartColors)
virtual

Make a deep copy of the supplied object.

void vtkColorSeries::BuildLookupTable ( vtkLookupTable *  lkup)

Populate a lookup table with all the colors in the current scheme.

vtkLookupTable* vtkColorSeries::CreateLookupTable ( )

Create a new lookup table with all the colors in the current scheme. The caller is responsible for deleting the table after use.

virtual void vtkColorSeries::CopyOnWrite ( )
protectedvirtual

If the current scheme is a predefined (read-only) scheme, copy the current colors to a new scheme and modify the new scheme instead.

Member Data Documentation

Private* vtkColorSeries::Storage
protected

Definition at line 275 of file vtkColorSeries.h.

int vtkColorSeries::ColorScheme
protected

The color scheme being used.

Definition at line 280 of file vtkColorSeries.h.

vtkStdString vtkColorSeries::ColorSchemeName
protected

The color scheme being used.

Definition at line 283 of file vtkColorSeries.h.


The documentation for this class was generated from the following file: