vtkLookupTableWithEnabling Class Reference

A lookup table that allows for an optional array to be provided that specifies which scalars to "enable" and which to "disable". More...

#include <vtkLookupTableWithEnabling.h>

Inheritance diagram for vtkLookupTableWithEnabling:

Collaboration diagram for vtkLookupTableWithEnabling:

Public Types
typedef vtkLookupTable	Superclass
Public Types inherited from vtkLookupTable
typedef vtkScalarsToColors	Superclass
Public Types inherited from vtkScalarsToColors
enum	VectorModes { MAGNITUDE = 0 , COMPONENT = 1 , RGBCOLORS = 2 }
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.
vtkLookupTableWithEnabling *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	MapScalarsThroughTable2 (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat) override
	Map a set of scalars through the lookup table.
virtual void	DisableColor (unsigned char r, unsigned char g, unsigned char b, unsigned char *rd, unsigned char *gd, unsigned char *bd)
	A convenience method for taking a color and desaturating it.
virtual vtkDataArray *	GetEnabledArray ()
	This must be set before MapScalars() is called.
virtual void	SetEnabledArray (vtkDataArray *enabledArray)
	This must be set before MapScalars() is called.
Public Member Functions inherited from vtkLookupTable
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkLookupTable *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
int	Allocate (int sz=256, int ext=256)
	Allocate a color table of specified size.
void	Build () override
	Generate lookup table from hue, saturation, value, alpha min/max values.
virtual void	ForceBuild ()
	Force the lookup table to regenerate from hue, saturation, value, and alpha min/max values.
void	BuildSpecialColors ()
	Copies the "special" colors into the given table.
unsigned char *	GetNanColorAsUnsignedChars ()
	Return the NanColor as a pointer to 4 unsigned chars.
const unsigned char *	MapValue (double v) override
	Map one value through the lookup table, returning an RBGA[4] color.
void	GetColor (double v, double rgb[3]) override
	Map one value through the lookup table and return the color as an RGB[3] array of doubles between 0 and 1.
double	GetOpacity (double v) override
	Map one value through the lookup table and return the alpha value (the opacity) as a double between 0 and 1.
virtual vtkIdType	GetIndex (double v)
	Return the table index associated with a particular value.
virtual void	SetTableValue (vtkIdType indx, const double rgba[4])
	Directly load color into lookup table.
virtual void	SetTableValue (vtkIdType indx, double r, double g, double b, double a=1.0)
	Directly load color into lookup table.
double *	GetTableValue (vtkIdType indx)
	Return an RGBA color value for the given index into the lookup table.
void	GetTableValue (vtkIdType indx, double rgba[4])
	Return an RGBA color value for the given index into the lookup table.
unsigned char *	GetPointer (vtkIdType id)
	Get pointer to color table data.
unsigned char *	WritePointer (vtkIdType id, int number)
	Get pointer to data.
void	MapScalarsThroughTable2 (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat) override
	Map a set of scalars through the lookup table.
void	DeepCopy (vtkScalarsToColors *obj) override
	Copy the contents from another LookupTable.
int	UsingLogScale () override
	This should return 1 if the subclass is using log scale for mapping scalars to colors.
vtkIdType	GetNumberOfAvailableColors () override
	Get the number of available colors for mapping to.
void	GetIndexedColor (vtkIdType idx, double rgba[4]) override
	Return a color given an integer index.
int	IsOpaque () override
	Return true if all of the values defining the mapping have an opacity equal to 1.
int	IsOpaque (vtkAbstractArray *scalars, int colorMode, int component) override
	Return true if all of the values defining the mapping have an opacity equal to 1.
virtual void	SetRamp (int)
	Set the shape of the table ramp to either S-curve, linear, or sqrt.
void	SetRampToLinear ()
	Set the shape of the table ramp to either S-curve, linear, or sqrt.
void	SetRampToSCurve ()
	Set the shape of the table ramp to either S-curve, linear, or sqrt.
void	SetRampToSQRT ()
	Set the shape of the table ramp to either S-curve, linear, or sqrt.
virtual int	GetRamp ()
	Set the shape of the table ramp to either S-curve, linear, or sqrt.
void	SetScale (int scale)
	Set the type of scale to use, linear or logarithmic.
void	SetScaleToLinear ()
	Set the type of scale to use, linear or logarithmic.
void	SetScaleToLog10 ()
	Set the type of scale to use, linear or logarithmic.
virtual int	GetScale ()
	Set the type of scale to use, linear or logarithmic.
virtual void	SetTableRange (const double r[2])
	Set/Get the minimum/maximum scalar values for scalar mapping.
virtual void	SetTableRange (double min, double max)
	Set/Get the minimum/maximum scalar values for scalar mapping.
virtual double *	GetTableRange ()
	Set/Get the minimum/maximum scalar values for scalar mapping.
virtual void	GetTableRange (double data[2])
	Set/Get the minimum/maximum scalar values for scalar mapping.
virtual void	SetHueRange (double, double)
	Set the range in hue (using automatic generation).
void	SetHueRange (double[2])
	Set the range in hue (using automatic generation).
virtual double *	GetHueRange ()
	Set the range in hue (using automatic generation).
virtual void	GetHueRange (double &, double &)
	Set the range in hue (using automatic generation).
virtual void	GetHueRange (double[2])
	Set the range in hue (using automatic generation).
virtual void	SetSaturationRange (double, double)
	Set the range in saturation (using automatic generation).
void	SetSaturationRange (double[2])
	Set the range in saturation (using automatic generation).
virtual double *	GetSaturationRange ()
	Set the range in saturation (using automatic generation).
virtual void	GetSaturationRange (double &, double &)
	Set the range in saturation (using automatic generation).
virtual void	GetSaturationRange (double[2])
	Set the range in saturation (using automatic generation).
virtual void	SetValueRange (double, double)
	Set the range in value (using automatic generation).
void	SetValueRange (double[2])
	Set the range in value (using automatic generation).
virtual double *	GetValueRange ()
	Set the range in value (using automatic generation).
virtual void	GetValueRange (double &, double &)
	Set the range in value (using automatic generation).
virtual void	GetValueRange (double[2])
	Set the range in value (using automatic generation).
virtual void	SetAlphaRange (double, double)
	Set the range in alpha (using automatic generation).
void	SetAlphaRange (double[2])
	Set the range in alpha (using automatic generation).
virtual double *	GetAlphaRange ()
	Set the range in alpha (using automatic generation).
virtual void	GetAlphaRange (double &, double &)
	Set the range in alpha (using automatic generation).
virtual void	GetAlphaRange (double[2])
	Set the range in alpha (using automatic generation).
virtual void	SetNanColor (double, double, double, double)
	Set the color to use when a NaN (not a number) is encountered.
virtual void	SetNanColor (double[4])
	Set the color to use when a NaN (not a number) is encountered.
virtual double *	GetNanColor ()
	Set the color to use when a NaN (not a number) is encountered.
virtual void	GetNanColor (double &, double &, double &, double &)
	Set the color to use when a NaN (not a number) is encountered.
virtual void	GetNanColor (double[4])
	Set the color to use when a NaN (not a number) is encountered.
virtual void	SetBelowRangeColor (double, double, double, double)
	Set the color to use when a value below the range is encountered.
virtual void	SetBelowRangeColor (double[4])
	Set the color to use when a value below the range is encountered.
virtual double *	GetBelowRangeColor ()
	Set the color to use when a value below the range is encountered.
virtual void	GetBelowRangeColor (double &, double &, double &, double &)
	Set the color to use when a value below the range is encountered.
virtual void	GetBelowRangeColor (double[4])
	Set the color to use when a value below the range is encountered.
virtual void	SetUseBelowRangeColor (vtkTypeBool)
	Set whether the below range color should be used.
virtual vtkTypeBool	GetUseBelowRangeColor ()
	Set whether the below range color should be used.
virtual void	UseBelowRangeColorOn ()
	Set whether the below range color should be used.
virtual void	UseBelowRangeColorOff ()
	Set whether the below range color should be used.
virtual void	SetAboveRangeColor (double, double, double, double)
	Set the color to use when a value above the range is encountered.
virtual void	SetAboveRangeColor (double[4])
	Set the color to use when a value above the range is encountered.
virtual double *	GetAboveRangeColor ()
	Set the color to use when a value above the range is encountered.
virtual void	GetAboveRangeColor (double &, double &, double &, double &)
	Set the color to use when a value above the range is encountered.
virtual void	GetAboveRangeColor (double[4])
	Set the color to use when a value above the range is encountered.
virtual void	SetUseAboveRangeColor (vtkTypeBool)
	Set whether the above range color should be used.
virtual vtkTypeBool	GetUseAboveRangeColor ()
	Set whether the above range color should be used.
virtual void	UseAboveRangeColorOn ()
	Set whether the above range color should be used.
virtual void	UseAboveRangeColorOff ()
	Set whether the above range color should be used.
void	SetNumberOfTableValues (vtkIdType number)
	Specify the number of values (i.e., colors) in the lookup table.
vtkIdType	GetNumberOfTableValues ()
	Specify the number of values (i.e., colors) in the lookup table.
double *	GetRange () override
	Sets/Gets the range of scalars which will be mapped.
void	SetRange (double min, double max) override
	Sets/Gets the range of scalars which will be mapped.
void	SetRange (const double rng[2]) override
	Sets/Gets the range of scalars which will be mapped.
virtual void	SetNumberOfColors (vtkIdType)
	Set the number of colors in the lookup table.
virtual vtkIdType	GetNumberOfColors ()
	Set the number of colors in the lookup table.
void	SetTable (vtkUnsignedCharArray *)
	Set/Get the internal table array that is used to map the scalars to colors.
virtual vtkUnsignedCharArray *	GetTable ()
	Set/Get the internal table array that is used to map the scalars to colors.
Public Member Functions inherited from vtkScalarsToColors
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkScalarsToColors *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	Build ()
	Perform any processing required (if any) before processing scalars.
virtual const unsigned char *	MapValue (double v)
	Map one value through the lookup table and return a color defined as an RGBA unsigned char tuple (4 bytes).
virtual void	GetColor (double v, double rgb[3])
	Map one value through the lookup table and store the color as an RGB array of doubles between 0 and 1 in the rgb argument.
double *	GetColor (double v)
	Map one value through the lookup table and return the color as an RGB array of doubles between 0 and 1.
virtual double	GetOpacity (double v)
	Map one value through the lookup table and return the alpha value (the opacity) as a double between 0 and 1.
double	GetLuminance (double x)
	Map one value through the lookup table and return the luminance 0.3*red + 0.59*green + 0.11*blue as a double between 0 and 1.
void	MapVectorsThroughTable (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat, int vectorComponent, int vectorSize)
	Map vectors through the lookup table.
void	MapVectorsThroughTable (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat)
void	MapScalarsThroughTable (vtkDataArray *scalars, unsigned char *output, int outputFormat)
	Map a set of scalars through the lookup table in a single operation.
void	MapScalarsThroughTable (vtkDataArray *scalars, unsigned char *output)
void	MapScalarsThroughTable (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat)
virtual void	MapScalarsThroughTable2 (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat)
	An internal method typically not used in applications.
virtual void	DeepCopy (vtkScalarsToColors *o)
	Copy the contents from another object.
virtual int	UsingLogScale ()
	This should return 1 is the subclass is using log scale for mapping scalars to colors.
virtual vtkIdType	GetNumberOfAvailableColors ()
	Get the number of available colors for mapping to.
virtual vtkIdType	SetAnnotation (vtkVariant value, vtkStdString annotation)
	Add a new entry (or change an existing entry) to the list of annotated values.
virtual vtkIdType	SetAnnotation (vtkStdString value, vtkStdString annotation)
	This variant of SetAnnotation accepts the value as a string so ParaView can treat annotations as string vector arrays.
vtkIdType	GetNumberOfAnnotatedValues ()
	Return the annotated value at a particular index in the list of annotations.
vtkVariant	GetAnnotatedValue (vtkIdType idx)
	Return the annotated value at a particular index in the list of annotations.
vtkStdString	GetAnnotation (vtkIdType idx)
	Return the annotation at a particular index in the list of annotations.
virtual void	GetAnnotationColor (const vtkVariant &val, double rgba[4])
	Obtain the color associated with a particular annotated value (or NanColor if unmatched).
vtkIdType	GetAnnotatedValueIndex (vtkVariant val)
	Return the index of the given value in the list of annotated values (or -1 if not present).
vtkIdType	GetAnnotatedValueIndexInternal (const vtkVariant &val)
	Look up an index into the array of annotations given a value.
virtual void	GetIndexedColor (vtkIdType i, double rgba[4])
	Get the "indexed color" assigned to an index.
virtual bool	RemoveAnnotation (vtkVariant value)
	Remove an existing entry from the list of annotated values.
virtual void	ResetAnnotations ()
	Remove all existing values and their annotations.
virtual void	SetAlpha (double alpha)
	Specify an additional opacity (alpha) value to blend with.
virtual double	GetAlpha ()
	Specify an additional opacity (alpha) value to blend with.
virtual vtkUnsignedCharArray *	MapScalars (vtkDataArray *scalars, int colorMode, int component, int outputFormat=VTK_RGBA)
	Internal methods that map a data array into an unsigned char array.
virtual vtkUnsignedCharArray *	MapScalars (vtkAbstractArray *scalars, int colorMode, int component, int outputFormat=VTK_RGBA)
	Internal methods that map a data array into an unsigned char array.
virtual void	SetVectorMode (int)
	Change mode that maps vectors by magnitude vs.
virtual int	GetVectorMode ()
	Change mode that maps vectors by magnitude vs.
void	SetVectorModeToMagnitude ()
	Change mode that maps vectors by magnitude vs.
void	SetVectorModeToComponent ()
	Change mode that maps vectors by magnitude vs.
void	SetVectorModeToRGBColors ()
	Change mode that maps vectors by magnitude vs.
virtual void	SetVectorComponent (int)
	If the mapper does not select which component of a vector to map to colors, you can specify it here.
virtual int	GetVectorComponent ()
	If the mapper does not select which component of a vector to map to colors, you can specify it here.
virtual void	SetVectorSize (int)
	When mapping vectors, consider only the number of components selected by VectorSize to be part of the vector, and ignore any other components.
virtual int	GetVectorSize ()
	When mapping vectors, consider only the number of components selected by VectorSize to be part of the vector, and ignore any other components.
virtual void	SetAnnotations (vtkAbstractArray *values, vtkStringArray *annotations)
	Set a list of discrete values, either as a categorical set of values (when IndexedLookup is true) or as a set of annotations to add to a scalar array (when IndexedLookup is false).
virtual vtkAbstractArray *	GetAnnotatedValues ()
	Set a list of discrete values, either as a categorical set of values (when IndexedLookup is true) or as a set of annotations to add to a scalar array (when IndexedLookup is false).
virtual vtkStringArray *	GetAnnotations ()
	Set a list of discrete values, either as a categorical set of values (when IndexedLookup is true) or as a set of annotations to add to a scalar array (when IndexedLookup is false).
virtual void	SetIndexedLookup (vtkTypeBool)
	Set/get whether the lookup table is for categorical or ordinal data.
virtual vtkTypeBool	GetIndexedLookup ()
	Set/get whether the lookup table is for categorical or ordinal data.
virtual void	IndexedLookupOn ()
	Set/get whether the lookup table is for categorical or ordinal data.
virtual void	IndexedLookupOff ()
	Set/get whether the lookup table is for categorical or ordinal data.
template<>
unsigned char	ColorToUChar (double t)
	Specializations of vtkScalarsToColors::ColorToUChar Converts from a color in a floating point type in range 0.0-1.0 to a uchar in range 0-255.
template<>
unsigned char	ColorToUChar (float t)
	Specializations of vtkScalarsToColors::ColorToUChar Converts from a color in a floating point type in range 0.0-1.0 to a uchar in range 0-255.
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 vtkLookupTableWithEnabling *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkLookupTableWithEnabling *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkLookupTable
static vtkLookupTable *	New ()
	Construct with range=[0,1]; and hsv ranges set up for rainbow color table (from red to blue).
static vtkTypeBool	IsTypeOf (const char *type)
static vtkLookupTable *	SafeDownCast (vtkObjectBase *o)
static void	GetColorAsUnsignedChars (const double colorIn[4], unsigned char colorOut[4])
	Given an RGBA[4] color in the [0,1] range, convert it to RGBA[4] in the [0,255] range.
static void	GetLogRange (const double range[2], double log_range[2])
	Returns the log of range in log_range.
static double	ApplyLogScale (double v, const double range[2], const double log_range[2])
	Apply log to value, with appropriate constraints.
Static Public Member Functions inherited from vtkScalarsToColors
static vtkTypeBool	IsTypeOf (const char *type)
static vtkScalarsToColors *	SafeDownCast (vtkObjectBase *o)
static vtkScalarsToColors *	New ()
template<typename T >
static unsigned char	ColorToUChar (T t)
	Converts a color from numeric type T to uchar.
template<typename T >
static void	ColorToUChar (T t, unsigned char *dest)
	Converts a color from numeric type T to uchar.
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
	vtkLookupTableWithEnabling (int sze=256, int ext=256)
	~vtkLookupTableWithEnabling () override
Protected Member Functions inherited from vtkLookupTable
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkLookupTable (int sze=256, int ext=256)
	~vtkLookupTable () override
void	ResizeTableForSpecialColors ()
	Resize the LookupTable to have enough room for the out-of-range colors.
Protected Member Functions inherited from vtkScalarsToColors
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkScalarsToColors ()
	~vtkScalarsToColors () override
void	MapColorsToColors (void *input, unsigned char *output, int inputDataType, int numberOfValues, int numberOfComponents, int vectorSize, int outputFormat)
	An internal method that assumes that the input already has the right colors, and only remaps the range to [0,255] and pads to the desired output format.
vtkUnsignedCharArray *	ConvertToRGBA (vtkDataArray *colors, int numComp, int numTuples)
	An internal method used to convert a color array to RGBA.
void	MapVectorsToMagnitude (void *input, double *output, int inputDataType, int numberOfValues, int numberOfComponents, int vectorSize)
	An internal method for converting vectors to magnitudes, used as a preliminary step before doing magnitude mapping.
virtual vtkIdType	CheckForAnnotatedValue (vtkVariant value)
	Allocate annotation arrays if needed, then return the index of the given value or -1 if not present.
virtual void	UpdateAnnotatedValueMap ()
	Update the map from annotated values to indices in the array of annotations.
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
vtkDataArray *	EnabledArray
Protected Attributes inherited from vtkLookupTable
vtkIdType	NumberOfColors
vtkUnsignedCharArray *	Table
double	TableRange [2]
double	HueRange [2]
double	SaturationRange [2]
double	ValueRange [2]
double	AlphaRange [2]
double	NanColor [4]
double	BelowRangeColor [4]
vtkTypeBool	UseBelowRangeColor
double	AboveRangeColor [4]
vtkTypeBool	UseAboveRangeColor
int	Scale
int	Ramp
vtkTimeStamp	InsertTime
vtkTimeStamp	BuildTime
double	RGBA [4]
unsigned char	NanColorChar [4]
int	OpaqueFlag
vtkTimeStamp	OpaqueFlagBuildTime
vtkTimeStamp	SpecialColorsBuildTime
Protected Attributes inherited from vtkScalarsToColors
vtkAbstractArray *	AnnotatedValues
vtkStringArray *	Annotations
vtkInternalAnnotatedValueList *	AnnotatedValueList
vtkTypeBool	IndexedLookup
double	Alpha
int	VectorMode
int	VectorComponent
int	VectorSize
int	UseMagnitude
unsigned char	RGBABytes [4]
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 Public Attributes inherited from vtkLookupTable
static const vtkIdType	REPEATED_LAST_COLOR_INDEX
	Constants for offsets of special colors (e.g., NanColor, BelowRangeColor, AboveRangeColor) from the maximum index in the lookup table.
static const vtkIdType	BELOW_RANGE_COLOR_INDEX
	Constants for offsets of special colors (e.g., NanColor, BelowRangeColor, AboveRangeColor) from the maximum index in the lookup table.
static const vtkIdType	ABOVE_RANGE_COLOR_INDEX
	Constants for offsets of special colors (e.g., NanColor, BelowRangeColor, AboveRangeColor) from the maximum index in the lookup table.
static const vtkIdType	NAN_COLOR_INDEX
	Constants for offsets of special colors (e.g., NanColor, BelowRangeColor, AboveRangeColor) from the maximum index in the lookup table.
static const vtkIdType	NUMBER_OF_SPECIAL_COLORS
	Constants for offsets of special colors (e.g., NanColor, BelowRangeColor, AboveRangeColor) from the maximum index in the lookup table.
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

A lookup table that allows for an optional array to be provided that specifies which scalars to "enable" and which to "disable".

vtkLookupTableWithEnabling "disables" or "grays out" output colors based on whether the given value in EnabledArray is "0" or not.

Warning

You must set the EnabledArray before MapScalars() is called. Indices of EnabledArray must map directly to those of the array passed to MapScalars().

Definition at line 41 of file vtkLookupTableWithEnabling.h.

Member Typedef Documentation

Superclass

typedef vtkLookupTable vtkLookupTableWithEnabling::Superclass

Definition at line 46 of file vtkLookupTableWithEnabling.h.

Constructor & Destructor Documentation

vtkLookupTableWithEnabling()

vtkLookupTableWithEnabling::vtkLookupTableWithEnabling ( int  sze = 256, int  ext = 256  )

protected

~vtkLookupTableWithEnabling()

vtkLookupTableWithEnabling::~vtkLookupTableWithEnabling ( )

overrideprotected

Member Function Documentation

New()

static vtkLookupTableWithEnabling * vtkLookupTableWithEnabling::New ( )

static

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool vtkLookupTableWithEnabling::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 vtkLookupTable.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkLookupTableWithEnabling::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkLookupTable.

NewInstance()

vtkLookupTableWithEnabling * vtkLookupTableWithEnabling::NewInstance

(

)

const

PrintSelf()

void vtkLookupTableWithEnabling::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 vtkLookupTable.

GetEnabledArray()

virtual vtkDataArray * vtkLookupTableWithEnabling::GetEnabledArray ( )

virtual

This must be set before MapScalars() is called.

Indices of this array must map directly to those in the scalars array passed to MapScalars(). Values of 0 in the array indicate the color should be desaturatated.

SetEnabledArray()

virtual void vtkLookupTableWithEnabling::SetEnabledArray ( vtkDataArray *  enabledArray )

virtual

This must be set before MapScalars() is called.

Indices of this array must map directly to those in the scalars array passed to MapScalars(). Values of 0 in the array indicate the color should be desaturatated.

MapScalarsThroughTable2()

void vtkLookupTableWithEnabling::MapScalarsThroughTable2 ( void *  input, unsigned char *  output, int  inputDataType, int  numberOfValues, int  inputIncrement, int  outputFormat  )

overridevirtual

Map a set of scalars through the lookup table.

Reimplemented from vtkLookupTable.

DisableColor()

virtual void vtkLookupTableWithEnabling::DisableColor ( unsigned char  r, unsigned char  g, unsigned char  b, unsigned char *  rd, unsigned char *  gd, unsigned char *  bd  )

virtual

A convenience method for taking a color and desaturating it.

Member Data Documentation

EnabledArray

vtkDataArray* vtkLookupTableWithEnabling::EnabledArray

protected

Definition at line 76 of file vtkLookupTableWithEnabling.h.

---

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

• Rendering/Core/vtkLookupTableWithEnabling.h