stores a list of colors. More...
#include <vtkColorSeries.h>
Public Member Functions | |
| virtual int | IsA (const char *type) |
| vtkColorSeries * | NewInstance () 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, int lutIndexing=CATEGORICAL) |
| vtkLookupTable * | CreateLookupTable (int lutIndexing=CATEGORICAL) |
| virtual void | SetColorScheme (int scheme) |
| virtual int | SetColorSchemeByName (const vtkStdString &schemeName) |
| virtual void | InsertColor (int index, const vtkColor3ub &color) |
 Public Member Functions inherited from vtkObject | |
| vtkObject * | NewInstance () const |
| virtual void | DebugOn () |
| virtual void | DebugOff () |
| bool | GetDebug () |
| void | SetDebug (bool 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) |
| vtkCommand * | GetCommand (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) |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, bool(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 &) |
| 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 vtkColorSeries * | SafeDownCast (vtkObjectBase *o) |
| static vtkColorSeries * | New () |
| Static Public Member Functions inherited from vtkObject | |
| static int | IsTypeOf (const char *type) |
| static vtkObject * | SafeDownCast (vtkObjectBase *o) |
| static vtkObject * | New () |
| 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 vtkObjectBase * | New () |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkColorSeries () | |
| virtual | ~vtkColorSeries () |
| virtual void | CopyOnWrite () |
| 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 &) |
| virtual void | ReportReferences (vtkGarbageCollector *) |
| vtkObjectBase (const vtkObjectBase &) | |
| void | operator= (const vtkObjectBase &) |
Protected Attributes | |
| int | ColorScheme |
| vtkStdString | ColorSchemeName |
| The color scheme being used. More... | |
| Private * | Storage |
| Protected Attributes inherited from vtkObject | |
| bool | Debug |
| vtkTimeStamp | MTime |
| vtkSubjectHelper * | SubjectHelper |
| Protected Attributes inherited from vtkObjectBase | |
| vtkAtomicInt32 | ReferenceCount |
| vtkWeakPointerBase ** | WeakPointers |
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
Enum of the available color schemes
Definition at line 65 of file vtkColorSeries.h.
An enum defining how lookup tables should be used: either as a list of discrete colors to choose from (categorical), or as an ordered list of color set - points to interpolate among (ordinal).
| Enumerator | |
|---|---|
| ORDINAL |
indexed lookup is off |
| CATEGORICAL |
indexed lookup is on |
Definition at line 201 of file vtkColorSeries.h.
Constructor & Destructor Documentation
|
protected |
|
protectedvirtual |
Member Function Documentation
|
static |
|
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 |
|
protectedvirtual |
Reimplemented from vtkObject.
| vtkColorSeries* vtkColorSeries::NewInstance | ( | ) | const |
|
virtual |
|
static |
Create a new vtkColorSeries with the SPECTRUM color 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 |
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 |
Get the color scheme that is currently being used.
|
virtual |
Set the name of the current color scheme
|
virtual |
Return the ID of the color scheme currently in use.
|
virtual |
Get the number of colors available in the current color scheme.
|
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 |
Set the color at the specified index. Does nothing if the index is out of range.
|
virtual |
Adds the color to the end of the list.
|
virtual |
Inserts the color at the specified index in the list.
|
virtual |
Removes the color at the specified index in the list.
|
virtual |
Clears the list of colors.
|
virtual |
Make a deep copy of the supplied object.
| void vtkColorSeries::BuildLookupTable | ( | vtkLookupTable * | lkup, |
| int | lutIndexing = CATEGORICAL |
||
| ) |
Populate a lookup table with all the colors in the current scheme. The default behavior is to return categorical data. Set lutIndexing to ORDINAL to return ordinal data. Any other value for lutIndexing is treated as CATEGORICAL.
| vtkLookupTable* vtkColorSeries::CreateLookupTable | ( | int | lutIndexing = CATEGORICAL | ) |
Create a new lookup table with all the colors in the current scheme. The caller is responsible for deleting the table after use. The default behavior is to return categorical data. Set lutIndexing to ORDINAL to return ordinal data. Any other value for lutIndexing is treated as CATEGORICAL.
|
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
|
protected |
Definition at line 295 of file vtkColorSeries.h.
|
protected |
The color scheme being used.
Definition at line 300 of file vtkColorSeries.h.
|
protected |
The color scheme being used.
Definition at line 303 of file vtkColorSeries.h.
The documentation for this class was generated from the following file:
- /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/Color/vtkColorSeries.h
