stores a list of colors. More...

#include <vtkColorSeries.h>

Inheritance diagram for vtkColorSeries:

Collaboration diagram for vtkColorSeries:

Public Types
enum	ColorSchemes { 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 }
	Enum of the available color schemes. More...

enum	LUTMode { ORDINAL = 0 , CATEGORICAL }
	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). More...

typedef vtkObject	Superclass

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.

vtkColorSeries *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

int	GetNumberOfColorSchemes () const
	Return the number of schemes currently defined.

virtual vtkStdString	GetColorSchemeName () const
	Get the color scheme that is currently being used.

virtual void	SetColorSchemeName (const vtkStdString &name)
	Set the name of the current color scheme.

virtual int	GetColorScheme () const
	Return the ID of the color scheme currently in use.

virtual int	GetNumberOfColors () const
	Get the number of colors available in the current color scheme.

virtual void	SetNumberOfColors (int numColors)
	Set the number of colors to be stored in a non-default color scheme.

vtkColor3ub	GetColor (int index) const
	Get the color at the specified index.

vtkColor3ub	GetColorRepeating (int index) const
	Get the color at the specified index.

virtual void	SetColor (int index, const vtkColor3ub &color)
	Set the color at the specified index.

virtual void	AddColor (const vtkColor3ub &color)
	Adds the color to the end of the list.

virtual void	InsertColor (int index, const vtkColor3ub &color)
	Inserts the color at the specified index in the list.

virtual void	RemoveColor (int index)
	Removes the color at the specified index in the list.

virtual void	ClearColors ()
	Clears the list of colors.

virtual void	DeepCopy (vtkColorSeries *chartColors)
	Make a deep copy of the supplied object.

void	BuildLookupTable (vtkLookupTable *lkup, int lutIndexing=CATEGORICAL)
	Populate a lookup table with all the colors in the current scheme.

vtkLookupTable *	CreateLookupTable (int lutIndexing=CATEGORICAL)
	Create a new lookup table with all the colors in the current scheme.


virtual void	SetColorScheme (int scheme)
	Set the color scheme that should be used.

virtual int	SetColorSchemeByName (const vtkStdString &schemeName)
	Set the color scheme that should be used.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

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.

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.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

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.

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.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

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.

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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	ColorScheme
	The color scheme being used.

vtkStdString	ColorSchemeName
	The color scheme being used.


Private *	Storage

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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.

For a web page showcasing the default palettes, see: VTKColorSeriesPatches; ColorSeriesPatches was used to generate this table.

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 under the Apache License. See the source code for details.

Online Examples:

CurvatureBandsWithGlyphs

ScalarBarActorColorSeries

Definition at line 167 of file vtkColorSeries.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkColorSeries::Superclass

Definition at line 170 of file vtkColorSeries.h.

Member Enumeration Documentation

◆ ColorSchemes

enum vtkColorSeries::ColorSchemes

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 181 of file vtkColorSeries.h.

◆ LUTMode

enum vtkColorSeries::LUTMode

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 316 of file vtkColorSeries.h.

Constructor & Destructor Documentation

◆ vtkColorSeries()

vtkColorSeries::vtkColorSeries ( )

protected

◆ ~vtkColorSeries()

vtkColorSeries::~vtkColorSeries ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkColorSeries::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool 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 vtkObjectBase.

◆ SafeDownCast()

static vtkColorSeries * vtkColorSeries::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkColorSeries::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkColorSeries * vtkColorSeries::NewInstance ( ) const

◆ PrintSelf()

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

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.

◆ New()

static vtkColorSeries * vtkColorSeries::New ( )

static

Create a new vtkColorSeries with the SPECTRUM color scheme.

◆ SetColorScheme()

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).

◆ SetColorSchemeByName()

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).

◆ GetNumberOfColorSchemes()

int vtkColorSeries::GetNumberOfColorSchemes ( ) const

Return the number of schemes currently defined.

◆ GetColorSchemeName()

virtual vtkStdString vtkColorSeries::GetColorSchemeName ( ) const

virtual

Get the color scheme that is currently being used.

◆ SetColorSchemeName()

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

virtual

Set the name of the current color scheme.

◆ GetColorScheme()

virtual int vtkColorSeries::GetColorScheme ( ) const

virtual

Return the ID of the color scheme currently in use.

◆ GetNumberOfColors()

virtual int vtkColorSeries::GetNumberOfColors ( ) const

virtual

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

◆ SetNumberOfColors()

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.

◆ GetColor()

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.

◆ GetColorRepeating()

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.

◆ SetColor()

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.

◆ AddColor()

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

virtual

Adds the color to the end of the list.

◆ InsertColor()

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

virtual

Inserts the color at the specified index in the list.

◆ RemoveColor()

virtual void vtkColorSeries::RemoveColor ( int index )

virtual

Removes the color at the specified index in the list.

◆ ClearColors()

virtual void vtkColorSeries::ClearColors ( )

virtual

Clears the list of colors.

◆ DeepCopy()

virtual void vtkColorSeries::DeepCopy ( vtkColorSeries * chartColors )

virtual

Make a deep copy of the supplied object.

◆ BuildLookupTable()

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.

◆ CreateLookupTable()

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.

◆ CopyOnWrite()

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

◆ Storage

Private* vtkColorSeries::Storage

protected

Definition at line 447 of file vtkColorSeries.h.

◆ ColorScheme

int vtkColorSeries::ColorScheme

protected

The color scheme being used.

Definition at line 453 of file vtkColorSeries.h.

◆ ColorSchemeName

vtkStdString vtkColorSeries::ColorSchemeName

protected

The color scheme being used.

Definition at line 456 of file vtkColorSeries.h.

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

Common/Color/vtkColorSeries.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ ColorSchemes

◆ LUTMode

Constructor & Destructor Documentation

◆ vtkColorSeries()

◆ ~vtkColorSeries()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ SetColorScheme()

◆ SetColorSchemeByName()

◆ GetNumberOfColorSchemes()

◆ GetColorSchemeName()

◆ SetColorSchemeName()

◆ GetColorScheme()

◆ GetNumberOfColors()

◆ SetNumberOfColors()

◆ GetColor()

◆ GetColorRepeating()

◆ SetColor()

◆ AddColor()

◆ InsertColor()

◆ RemoveColor()

◆ ClearColors()

◆ DeepCopy()

◆ BuildLookupTable()

◆ CreateLookupTable()

◆ CopyOnWrite()

Member Data Documentation

◆ Storage

◆ ColorScheme

◆ ColorSchemeName