vtkColorSeries Class Reference

#include <vtkColorSeries.h>

Inheritance diagram for vtkColorSeries:

Inheritance graph
[legend]
Collaboration diagram for vtkColorSeries:

Collaboration graph
[legend]

List of all members.


Detailed Description

stores a list of colors.

The vtkColorSeries stores a list of colors. There are several schemes available and functions to control several aspects of what colors are returned. In essence a color scheme is set and colors are returned based on the index requested.

Tests:
vtkColorSeries (Tests)

Definition at line 35 of file vtkColorSeries.h.


Public Types

typedef vtkObject Superclass
enum  {
  SPECTRUM = 0, WARM, COOL, BLUES,
  WILD_FLOWER, CITRUS, CUSTOM
}

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
void SetColorScheme (int scheme)
int GetNumberOfColors ()
vtkColor3ub GetColor (int index) const
vtkColor3ub GetColorRepeating (int index) const
void SetColor (int index, const vtkColor3ub &color)
void AddColor (const vtkColor3ub &color)
void RemoveColor (int index)
void ClearColors ()
void DeepCopy (vtkColorSeries *chartColors)
virtual int GetColorScheme ()
void InsertColor (int index, const vtkColor3ub &color)

Static Public Member Functions

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

Protected Member Functions

 vtkColorSeries ()
 ~vtkColorSeries ()

Protected Attributes

int ColorScheme
Private * Storage

Member Typedef Documentation

Reimplemented from vtkObject.

Definition at line 38 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.
CUSTOM  User specified color scheme.

Definition at line 47 of file vtkColorSeries.h.


Constructor & Destructor Documentation

vtkColorSeries::vtkColorSeries (  )  [protected]

vtkColorSeries::~vtkColorSeries (  )  [protected]


Member Function Documentation

virtual const char* vtkColorSeries::GetClassName (  )  [virtual]

Reimplemented from vtkObject.

static int vtkColorSeries::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

virtual int vtkColorSeries::IsA ( const char *  name  )  [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkColorSeries* vtkColorSeries::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkObject.

virtual void vtkColorSeries::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

static vtkColorSeries* vtkColorSeries::New (  )  [static]

Create a new vtkColorSeries with the SPECTRUM color scheme.

Reimplemented from vtkObject.

void vtkColorSeries::SetColorScheme ( int  scheme  ) 

Set the color scheme that should be used from those in the enum.

virtual int vtkColorSeries::GetColorScheme (  )  [virtual]

Get the color scheme that is currently being used.

int vtkColorSeries::GetNumberOfColors (  ) 

Get the number of colors available in the current color 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.

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

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

void vtkColorSeries::AddColor ( const vtkColor3ub color  ) 

Adds the color to the end of the list.

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

Inserts the color at the specified index in the list.

void vtkColorSeries::RemoveColor ( int  index  ) 

Removes the color at the specified index in the list.

void vtkColorSeries::ClearColors (  ) 

Clears the list of colors.

void vtkColorSeries::DeepCopy ( vtkColorSeries chartColors  ) 

Make a deep copy of the supplied object.


Member Data Documentation

Private* vtkColorSeries::Storage [protected]

Definition at line 108 of file vtkColorSeries.h.

int vtkColorSeries::ColorScheme [protected]

The color scheme being used.

Definition at line 113 of file vtkColorSeries.h.


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

Generated on Wed Aug 24 11:31:32 2011 for VTK by  doxygen 1.5.6