stores a list of colors. More...
#include <vtkColorSeries.h>
Public Member Functions | |
| virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
| vtkColorSeries * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More... | |
| int | GetNumberOfColorSchemes () const |
| Return the number of schemes currently defined. More... | |
| virtual vtkStdString | GetColorSchemeName () const |
| Get the color scheme that is currently being used. More... | |
| virtual void | SetColorSchemeName (const vtkStdString &scheme) |
| Set the name of the current color scheme. More... | |
| virtual int | GetColorScheme () const |
| Return the ID of the color scheme currently in use. More... | |
| virtual int | GetNumberOfColors () const |
| Get the number of colors available in the current color scheme. More... | |
| virtual void | SetNumberOfColors (int numColors) |
| Set the number of colors to be stored in a non-default color scheme. More... | |
| vtkColor3ub | GetColor (int index) const |
| Get the color at the specified index. More... | |
| vtkColor3ub | GetColorRepeating (int index) const |
| Get the color at the specified index. More... | |
| virtual void | SetColor (int index, const vtkColor3ub &color) |
| Set the color at the specified index. More... | |
| virtual void | AddColor (const vtkColor3ub &color) |
| Adds the color to the end of the list. More... | |
| virtual void | InsertColor (int index, const vtkColor3ub &color) |
| Inserts the color at the specified index in the list. More... | |
| virtual void | RemoveColor (int index) |
| Removes the color at the specified index in the list. More... | |
| virtual void | ClearColors () |
| Clears the list of colors. More... | |
| virtual void | DeepCopy (vtkColorSeries *chartColors) |
| Make a deep copy of the supplied object. More... | |
| void | BuildLookupTable (vtkLookupTable *lkup, int lutIndexing=CATEGORICAL) |
| Populate a lookup table with all the colors in the current scheme. More... | |
| vtkLookupTable * | CreateLookupTable (int lutIndexing=CATEGORICAL) |
| Create a new lookup table with all the colors in the current scheme. More... | |
| virtual void | SetColorScheme (int scheme) |
| Set the color scheme that should be used. More... | |
| virtual int | SetColorSchemeByName (const vtkStdString &schemeName) |
| Set the color scheme that should be used. More... | |
 Public Member Functions inherited from vtkObject | |
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
| virtual void | DebugOn () |
| Turn debugging output on. More... | |
| virtual void | DebugOff () |
| Turn debugging output off. More... | |
| bool | GetDebug () |
| Get the value of the debug flag. More... | |
| void | SetDebug (bool debugFlag) |
| Set the value of the debug flag. More... | |
| virtual void | Modified () |
| Update the modification time for this object. More... | |
| virtual vtkMTimeType | GetMTime () |
| Return this object's modified time. More... | |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More... | |
| void | RemoveObserver (unsigned long tag) |
| void | RemoveObservers (unsigned long event) |
| void | RemoveObservers (const char *event) |
| void | RemoveAllObservers () |
| vtkTypeBool | HasObserver (unsigned long event) |
| vtkTypeBool | HasObserver (const char *event) |
| int | InvokeEvent (unsigned long event) |
| int | InvokeEvent (const char *event) |
| unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkCommand * | GetCommand (unsigned long tag) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObserver (vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Allow user to set the AbortFlagOn() with the return value of the callback method. More... | |
| int | InvokeEvent (unsigned long event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| int | InvokeEvent (const char *event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| Public Member Functions inherited from vtkObjectBase | |
| const char * | GetClassName () const |
| Return the class name as a string. More... | |
| virtual void | Delete () |
| Delete a VTK object. More... | |
| virtual void | FastDelete () |
| Delete a reference to this object. More... | |
| void | InitializeObjectBase () |
| void | Print (ostream &os) |
| Print an object to an ostream. More... | |
| virtual void | Register (vtkObjectBase *o) |
| Increase the reference count (mark as used by another object). More... | |
| virtual void | UnRegister (vtkObjectBase *o) |
| Decrease the reference count (release by another object). More... | |
| int | GetReferenceCount () |
| Return the current reference count of this object. More... | |
| void | SetReferenceCount (int) |
| Sets the reference count. More... | |
| void | PrintRevisions (ostream &) |
| Legacy. More... | |
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
Static Public Member Functions | |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkColorSeries * | SafeDownCast (vtkObjectBase *o) |
| static vtkColorSeries * | New () |
| Create a new vtkColorSeries with the SPECTRUM color scheme. More... | |
| Static Public Member Functions inherited from vtkObject | |
| static vtkObject * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
| static void | BreakOnError () |
| This method is called when vtkErrorMacro executes. More... | |
| static void | SetGlobalWarningDisplay (int val) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOn () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOff () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static int | GetGlobalWarningDisplay () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| Static Public Member Functions inherited from vtkObjectBase | |
| static vtkTypeBool | IsTypeOf (const char *name) |
| Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
| static vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkColorSeries () | |
| ~vtkColorSeries () override | |
| virtual void | CopyOnWrite () |
| If the current scheme is a predefined (read-only) scheme, copy the current colors to a new scheme and modify the new scheme instead. More... | |
| Protected Member Functions inherited from vtkObject | |
| vtkObject () | |
| ~vtkObject () override | |
| void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
| These methods allow a command to exclusively grab all events. More... | |
| void | InternalReleaseFocus () |
| These methods allow a command to exclusively grab all events. More... | |
| 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 |
| The color scheme being used. More... | |
| 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 54 of file vtkColorSeries.h.
Member Typedef Documentation
| typedef vtkObject vtkColorSeries::Superclass |
Definition at line 57 of file vtkColorSeries.h.
Member Enumeration Documentation
Enum of the available color schemes.
Definition at line 68 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 202 of file vtkColorSeries.h.
Constructor & Destructor Documentation
|
protected |
|
overrideprotected |
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 vtkObjectBase.
|
static |
|
protectedvirtual |
| vtkColorSeries* vtkColorSeries::NewInstance | ( | ) | const |
|
overridevirtual |
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 vtkObjectBase.
|
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 331 of file vtkColorSeries.h.
|
protected |
The color scheme being used.
Definition at line 338 of file vtkColorSeries.h.
|
protected |
The color scheme being used.
Definition at line 341 of file vtkColorSeries.h.
The documentation for this class was generated from the following file:
- /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Common/Color/vtkColorSeries.h
