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:

[legend]

Collaboration diagram for vtkLookupTableWithEnabling:

[legend]

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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkLookupTableWithEnabling *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)


virtual vtkDataArray *	GetEnabledArray ()

virtual void	SetEnabledArray (vtkDataArray *enabledArray)


void	MapScalarsThroughTable2 (void input, unsigned char output, int inputDataType, int numberOfValues, int inputIncrement, int outputIncrement)


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

Public Member Functions inherited from vtkLookupTable
vtkLookupTable *	NewInstance () const

virtual int	IsOpaque ()

int	Allocate (int sz=256, int ext=256)

virtual void	Build ()

virtual void	ForceBuild ()

unsigned char *	GetNanColorAsUnsignedChars ()

unsigned char *	MapValue (double v)

void	GetColor (double x, double rgb[3])

double	GetOpacity (double v)

virtual vtkIdType	GetIndex (double v)

virtual void	SetTableValue (vtkIdType indx, double rgba[4])

double *	GetTableValue (vtkIdType id)

void	GetTableValue (vtkIdType id, double rgba[4])

unsigned char *	WritePointer (const vtkIdType id, const int number)

void	DeepCopy (vtkScalarsToColors *lut)

virtual vtkIdType	GetNumberOfAvailableColors ()

virtual void	GetIndexedColor (vtkIdType idx, double rgba[4])

virtual void	SetRamp (int)

void	SetRampToLinear ()

void	SetRampToSCurve ()

void	SetRampToSQRT ()

virtual int	GetRamp ()

void	SetScale (int scale)

void	SetScaleToLinear ()

void	SetScaleToLog10 ()

virtual int	GetScale ()

void	SetTableRange (double r[2])

virtual void	SetTableRange (double min, double max)

virtual double *	GetTableRange ()

virtual void	GetTableRange (double data[2])

virtual void	SetHueRange (double, double)

void	SetHueRange (double[2])

virtual double *	GetHueRange ()

virtual void	GetHueRange (double &, double &)

virtual void	GetHueRange (double[2])

virtual void	SetSaturationRange (double, double)

void	SetSaturationRange (double[2])

virtual double *	GetSaturationRange ()

virtual void	GetSaturationRange (double &, double &)

virtual void	GetSaturationRange (double[2])

virtual void	SetValueRange (double, double)

void	SetValueRange (double[2])

virtual double *	GetValueRange ()

virtual void	GetValueRange (double &, double &)

virtual void	GetValueRange (double[2])

virtual void	SetAlphaRange (double, double)

void	SetAlphaRange (double[2])

virtual double *	GetAlphaRange ()

virtual void	GetAlphaRange (double &, double &)

virtual void	GetAlphaRange (double[2])

virtual void	SetNanColor (double, double, double, double)

virtual void	SetNanColor (double[4])

virtual double *	GetNanColor ()

virtual void	GetNanColor (double &, double &, double &, double &)

virtual void	GetNanColor (double[4])

virtual void	SetBelowRangeColor (double, double, double, double)

virtual void	SetBelowRangeColor (double[4])

virtual double *	GetBelowRangeColor ()

virtual void	GetBelowRangeColor (double &, double &, double &, double &)

virtual void	GetBelowRangeColor (double[4])

virtual void	SetUseBelowRangeColor (int)

virtual int	GetUseBelowRangeColor ()

virtual void	UseBelowRangeColorOn ()

virtual void	UseBelowRangeColorOff ()

virtual void	SetAboveRangeColor (double, double, double, double)

virtual void	SetAboveRangeColor (double[4])

virtual double *	GetAboveRangeColor ()

virtual void	GetAboveRangeColor (double &, double &, double &, double &)

virtual void	GetAboveRangeColor (double[4])

virtual void	SetUseAboveRangeColor (int)

virtual int	GetUseAboveRangeColor ()

virtual void	UseAboveRangeColorOn ()

virtual void	UseAboveRangeColorOff ()

void	SetNumberOfTableValues (vtkIdType number)

vtkIdType	GetNumberOfTableValues ()

virtual void	SetTableValue (vtkIdType indx, double r, double g, double b, double a=1.0)

unsigned char *	GetPointer (const vtkIdType id)

double *	GetRange ()

void	SetRange (double min, double max)

void	SetRange (double rng[2])

virtual void	SetNumberOfColors (vtkIdType)

virtual vtkIdType	GetNumberOfColors ()

void	SetTable (vtkUnsignedCharArray *)

virtual vtkUnsignedCharArray *	GetTable ()

virtual int	UsingLogScale ()

Public Member Functions inherited from vtkScalarsToColors
vtkScalarsToColors *	NewInstance () const

virtual vtkIdType	SetAnnotation (vtkVariant value, vtkStdString annotation)

virtual vtkIdType	SetAnnotation (vtkStdString value, vtkStdString annotation)

vtkIdType	GetNumberOfAnnotatedValues ()

vtkVariant	GetAnnotatedValue (vtkIdType idx)

vtkStdString	GetAnnotation (vtkIdType idx)

virtual void	GetAnnotationColor (const vtkVariant &val, double rgba[4])

vtkIdType	GetAnnotatedValueIndex (vtkVariant val)

vtkIdType	GetAnnotatedValueIndexInternal (vtkVariant &val)

virtual bool	RemoveAnnotation (vtkVariant value)

virtual void	ResetAnnotations ()

void	SetRange (double rng[2])

double *	GetColor (double v)

double	GetLuminance (double x)

virtual void	SetAlpha (double alpha)

virtual double	GetAlpha ()

virtual vtkUnsignedCharArray *	MapScalars (vtkDataArray *scalars, int colorMode, int component)

virtual vtkUnsignedCharArray *	MapScalars (vtkAbstractArray *scalars, int colorMode, int component)

virtual void	SetVectorMode (int)

virtual int	GetVectorMode ()

void	SetVectorModeToMagnitude ()

void	SetVectorModeToComponent ()

void	SetVectorModeToRGBColors ()

virtual void	SetVectorComponent (int)

virtual int	GetVectorComponent ()

virtual void	SetVectorSize (int)

virtual int	GetVectorSize ()

void	MapVectorsThroughTable (void input, unsigned char output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat, int vectorComponent, int vectorSize)

void	MapVectorsThroughTable (void input, unsigned char output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat)

void	MapScalarsThroughTable (vtkDataArray scalars, unsigned char output, int outputFormat)

void	MapScalarsThroughTable (vtkDataArray scalars, unsigned char output)

void	MapScalarsThroughTable (void input, unsigned char output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat)

virtual void	SetAnnotations (vtkAbstractArray values, vtkStringArray annotations)

virtual vtkAbstractArray *	GetAnnotatedValues ()

virtual vtkStringArray *	GetAnnotations ()

virtual void	SetIndexedLookup (int)

virtual int	GetIndexedLookup ()

virtual void	IndexedLookupOn ()

virtual void	IndexedLookupOff ()

template<>
unsigned char	ColorToUChar (double t)

template<>
unsigned char	ColorToUChar (float t)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkLookupTableWithEnabling *	New ()

static int	IsTypeOf (const char *type)

static vtkLookupTableWithEnabling *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkLookupTable
static vtkLookupTable *	New ()

static int	IsTypeOf (const char *type)

static vtkLookupTable *	SafeDownCast (vtkObjectBase *o)

static void	GetLogRange (const double range[2], double log_range[2])

static void	GetColorAsUnsignedChars (const double colorIn[4], unsigned char colorOut[4])

static double	ApplyLogScale (double v, const double range[2], const double log_range[2])

Static Public Member Functions inherited from vtkScalarsToColors
static int	IsTypeOf (const char *type)

static vtkScalarsToColors *	SafeDownCast (vtkObjectBase *o)

static vtkScalarsToColors *	New ()

template<typename T >
static unsigned char	ColorToUChar (T t)

template<typename T >
static void	ColorToUChar (T t, unsigned char *dest)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

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

	~vtkLookupTableWithEnabling ()

Protected Member Functions inherited from vtkLookupTable
	vtkLookupTable (int sze=256, int ext=256)

	~vtkLookupTable ()

void	ResizeTableForSpecialColors ()

Protected Member Functions inherited from vtkScalarsToColors
	vtkScalarsToColors ()

	~vtkScalarsToColors ()

virtual vtkIdType	CheckForAnnotatedValue (vtkVariant value)

virtual void	UpdateAnnotatedValueMap ()

void	MapColorsToColors (void input, unsigned char output, int inputDataType, int numberOfValues, int numberOfComponents, int vectorSize, int outputFormat)

vtkUnsignedCharArray *	ConvertToRGBA (vtkDataArray *colors, int numComp, int numTuples)

void	MapVectorsToMagnitude (void input, double output, int inputDataType, int numberOfValues, int numberOfComponents, int vectorSize)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
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]

int	UseBelowRangeColor

double	AboveRangeColor [4]

int	UseAboveRangeColor

int	Scale

int	Ramp

vtkTimeStamp	InsertTime

vtkTimeStamp	BuildTime

double	RGBA [4]

unsigned char	NanColorChar [4]

int	OpaqueFlag

vtkTimeStamp	OpaqueFlagBuildTime

Protected Attributes inherited from vtkScalarsToColors
vtkAbstractArray *	AnnotatedValues

vtkStringArray *	Annotations

vtkInternalAnnotatedValueMap *	AnnotatedValueMap

int	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
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Public Attributes inherited from vtkLookupTable
static const vtkIdType	BELOW_RANGE_COLOR_INDEX

static const vtkIdType	ABOVE_RANGE_COLOR_INDEX

static const vtkIdType	NAN_COLOR_INDEX

static const vtkIdType	NUMBER_OF_SPECIAL_COLORS

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

Tests:: vtkLookupTableWithEnabling (Tests)

Definition at line 43 of file vtkLookupTableWithEnabling.h.

Member Typedef Documentation

typedef vtkLookupTable vtkLookupTableWithEnabling::Superclass

Definition at line 48 of file vtkLookupTableWithEnabling.h.

Constructor & Destructor Documentation

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

protected

vtkLookupTableWithEnabling::~vtkLookupTableWithEnabling ( )

protected

Member Function Documentation

static vtkLookupTableWithEnabling* vtkLookupTableWithEnabling::New ( )

static

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

static

virtual int 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.

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

static

virtual vtkObjectBase* vtkLookupTableWithEnabling::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkLookupTable.

vtkLookupTableWithEnabling* vtkLookupTableWithEnabling::NewInstance ( ) const

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

virtual

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.

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.

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.

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

virtual

Map a set of scalars through the lookup table.

Reimplemented from vtkLookupTable.

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

vtkDataArray* vtkLookupTableWithEnabling::EnabledArray

protected

Definition at line 77 of file vtkLookupTableWithEnabling.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/Core/vtkLookupTableWithEnabling.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation