VTK
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>

Inheritance diagram for vtkColorSeries:
[legend]
Collaboration diagram for vtkColorSeries:
[legend]

Public Types

typedef vtkObject Superclass
 
enum  {
  SPECTRUM = 0, WARM, COOL, BLUES,
  WILD_FLOWER, CITRUS, CUSTOM
}
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

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)
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkColorSeriesSafeDownCast (vtkObject *o)
 
static vtkColorSeriesNew ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkColorSeries ()
 
 ~vtkColorSeries ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &os)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int ColorScheme
 
Private * Storage
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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.

Member Typedef Documentation

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 *  type)
static
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
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.

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: