VTK  9.7.20260915
vtkLookupTableManager Class Reference

#include <vtkLookupTableManager.h>

Detailed Description

Keeps one lookup table per array name.

vtkLookupTableManager is a registry of vtkScalarsToColors objects keyed by array name. Asking for the table of an array that has none creates one from a vtkColorSeries color scheme, so every representation coloring by "Temperature" ends up sharing a single table, and with it a single range and a single set of colors.

A manager can be shared: set the same one on several views to keep their color maps in sync. A view that is not given one creates its own on first use, which keeps views independent by default.

The manager does not own the range of any table. Ranges belong to the tables themselves and are set by whoever knows the data.

See also
vtkScivisView vtkColorSeries vtkLookupTable
Tests:
vtkLookupTableManager (Tests)

Definition at line 37 of file vtkLookupTableManager.h.

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

Public Types

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.
vtkLookupTableManagerNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
vtkMTimeType GetMTime () override
 The tables handed out here stay reachable and mutable by their users, so the modified time reported is the latest of this object's own and those of the tables it holds.
vtkScalarsToColorsGetLookupTable (const char *arrayName)
 Get the lookup table for arrayName, creating one from DefaultColorScheme if this is the first time the array is asked for.
bool HasLookupTable (const char *arrayName)
 Whether arrayName already has a lookup table.
void SetLookupTable (const char *arrayName, vtkScalarsToColors *lut)
 Use lut for arrayName in place of whatever table the array had.
void RemoveLookupTable (const char *arrayName)
 Forget the lookup table of arrayName.
void RemoveAllLookupTables ()
 Forget every lookup table.
int GetNumberOfLookupTables ()
 The tables currently held, in name order.
const char * GetLookupTableName (int index)
 The tables currently held, in name order.
virtual void SetDefaultColorScheme (int)
 The vtkColorSeries::ColorSchemes scheme used to build new lookup tables.
virtual int GetDefaultColorScheme ()
 The vtkColorSeries::ColorSchemes scheme used to build new lookup tables.
virtual void SetNumberOfTableValues (int)
 How many entries new lookup tables are given.
virtual int GetNumberOfTableValues ()
 How many entries new lookup tables are given.
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.
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)
vtkTypeBool InvokeEvent (unsigned long event)
vtkTypeBool InvokeEvent (const char *event)
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
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.
vtkCommandGetCommand (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.
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
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.
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.
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions

static vtkLookupTableManagerNew ()
static vtkTypeBool IsTypeOf (const char *type)
static vtkLookupTableManagerSafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 (vtkTypeBool 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 vtkTypeBool 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 vtkLookupTableManager ()
 ~vtkLookupTableManager () override
void BuildDefaultLookupTable (vtkLookupTable *lut)
 Fill lut with NumberOfTableValues entries interpolated across the colors of DefaultColorScheme.
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 ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Additional Inherited Members

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
static vtkReallocingFunction GetCurrentReallocFunction ()
static vtkFreeingFunction GetCurrentFreeFunction ()
static vtkFreeingFunction GetAlternateFreeFunction ()
Protected Attributes inherited from vtkObject
bool Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
std::string ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
vtkWeakPointerBase ** WeakPointers

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkLookupTableManager()

vtkLookupTableManager::vtkLookupTableManager ( )
protected

◆ ~vtkLookupTableManager()

vtkLookupTableManager::~vtkLookupTableManager ( )
overrideprotected

Member Function Documentation

◆ New()

vtkLookupTableManager * vtkLookupTableManager::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkLookupTableManager::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()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkLookupTableManager::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkLookupTableManager * vtkLookupTableManager::NewInstance ( ) const

◆ PrintSelf()

void vtkLookupTableManager::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.

◆ GetMTime()

vtkMTimeType vtkLookupTableManager::GetMTime ( )
overridevirtual

The tables handed out here stay reachable and mutable by their users, so the modified time reported is the latest of this object's own and those of the tables it holds.

Reimplemented from vtkObject.

◆ GetLookupTable()

vtkScalarsToColors * vtkLookupTableManager::GetLookupTable ( const char * arrayName)

Get the lookup table for arrayName, creating one from DefaultColorScheme if this is the first time the array is asked for.

Returns the same table on every subsequent call, and null for a null or empty name.

◆ HasLookupTable()

bool vtkLookupTableManager::HasLookupTable ( const char * arrayName)

Whether arrayName already has a lookup table.

Unlike GetLookupTable(), this does not create one.

◆ SetLookupTable()

void vtkLookupTableManager::SetLookupTable ( const char * arrayName,
vtkScalarsToColors * lut )

Use lut for arrayName in place of whatever table the array had.

Passing null removes the entry, the same as RemoveLookupTable().

◆ RemoveLookupTable()

void vtkLookupTableManager::RemoveLookupTable ( const char * arrayName)

Forget the lookup table of arrayName.

The next request for that array builds a fresh table.

◆ RemoveAllLookupTables()

void vtkLookupTableManager::RemoveAllLookupTables ( )

Forget every lookup table.

◆ GetNumberOfLookupTables()

int vtkLookupTableManager::GetNumberOfLookupTables ( )

The tables currently held, in name order.

GetLookupTableName() returns null for an index outside [0, GetNumberOfLookupTables()).

◆ GetLookupTableName()

const char * vtkLookupTableManager::GetLookupTableName ( int index)

The tables currently held, in name order.

GetLookupTableName() returns null for an index outside [0, GetNumberOfLookupTables()).

◆ SetDefaultColorScheme()

virtual void vtkLookupTableManager::SetDefaultColorScheme ( int )
virtual

The vtkColorSeries::ColorSchemes scheme used to build new lookup tables.

The scheme's colors are spread evenly over the table and interpolated, so a scheme of a dozen swatches still yields a smooth ramp. Defaults to vtkColorSeries::BREWER_DIVERGING_SPECTRAL_11.

Changing this affects tables built afterwards; tables already handed out keep the colors they were built with.

◆ GetDefaultColorScheme()

virtual int vtkLookupTableManager::GetDefaultColorScheme ( )
virtual

The vtkColorSeries::ColorSchemes scheme used to build new lookup tables.

The scheme's colors are spread evenly over the table and interpolated, so a scheme of a dozen swatches still yields a smooth ramp. Defaults to vtkColorSeries::BREWER_DIVERGING_SPECTRAL_11.

Changing this affects tables built afterwards; tables already handed out keep the colors they were built with.

◆ SetNumberOfTableValues()

virtual void vtkLookupTableManager::SetNumberOfTableValues ( int )
virtual

How many entries new lookup tables are given.

Default is 256. Like DefaultColorScheme, this applies to tables built afterwards.

◆ GetNumberOfTableValues()

virtual int vtkLookupTableManager::GetNumberOfTableValues ( )
virtual

How many entries new lookup tables are given.

Default is 256. Like DefaultColorScheme, this applies to tables built afterwards.

◆ BuildDefaultLookupTable()

void vtkLookupTableManager::BuildDefaultLookupTable ( vtkLookupTable * lut)
protected

Fill lut with NumberOfTableValues entries interpolated across the colors of DefaultColorScheme.


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