VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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:
[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 }
 
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkDataArrayGetEnabledArray ()
 
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
virtual int IsOpaque ()
 
int Allocate (int sz=256, int ext=256)
 
virtual void Build ()
 
virtual void ForceBuild ()
 
unsigned char * MapValue (double v)
 
void GetColor (double x, double rgb[3])
 
double GetOpacity (double v)
 
virtual vtkIdType GetIndex (double v)
 
void SetTableValue (vtkIdType indx, double rgba[4])
 
void SetTableValue (vtkIdType indx, double r, double g, double b, double a=1.0)
 
double * GetTableValue (vtkIdType id)
 
void GetTableValue (vtkIdType id, double rgba[4])
 
unsigned char * WritePointer (const vtkIdType id, const int number)
 
void DeepCopy (vtkLookupTable *lut)
 
virtual vtkIdType GetNumberOfAvailableColors ()
 
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])
 
void SetNumberOfTableValues (vtkIdType number)
 
vtkIdType GetNumberOfTableValues ()
 
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 vtkUnsignedCharArrayGetTable ()
 
virtual int UsingLogScale ()
 
- Public Member Functions inherited from vtkScalarsToColors
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetRange (double rng[2])
 
double * GetColor (double v)
 
virtual double GetOpacity (double vtkNotUsed(v))
 
double GetLuminance (double x)
 
virtual void SetAlpha (double alpha)
 
virtual double GetAlpha ()
 
virtual vtkUnsignedCharArrayMapScalars (vtkDataArray *scalars, int colorMode, int component)
 
virtual void SetVectorMode (int)
 
virtual int GetVectorMode ()
 
void SetVectorModeToMagnitude ()
 
void SetVectorModeToComponent ()
 
virtual void SetVectorComponent (int)
 
virtual int GetVectorComponent ()
 
void MapScalarsThroughTable (vtkDataArray *scalars, unsigned char *output, int outputFormat)
 
void MapScalarsThroughTable (vtkDataArray *scalars, unsigned char *output)
 
virtual vtkUnsignedCharArrayConvertUnsignedCharToRGBA (vtkUnsignedCharArray *colors, int numComp, int numTuples)
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char 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)
 
vtkCommandGetCommand (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)
 
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 &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkLookupTableWithEnablingNew ()
 
static int IsTypeOf (const char *type)
 
static vtkLookupTableWithEnablingSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkLookupTable
static vtkLookupTableNew ()
 
static int IsTypeOf (const char *type)
 
static vtkLookupTableSafeDownCast (vtkObject *o)
 
static void GetLogRange (const double range[2], double log_range[2])
 
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 vtkScalarsToColorsSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 

Protected Member Functions

 vtkLookupTableWithEnabling (int sze=256, int ext=256)
 
 ~vtkLookupTableWithEnabling ()
 
- Protected Member Functions inherited from vtkLookupTable
 vtkLookupTable (int sze=256, int ext=256)
 
 ~vtkLookupTable ()
 
- Protected Member Functions inherited from vtkScalarsToColors
 vtkScalarsToColors ()
 
 ~vtkScalarsToColors ()
 
- 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 &os)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkDataArrayEnabledArray
 
- Protected Attributes inherited from vtkLookupTable
vtkIdType NumberOfColors
 
vtkUnsignedCharArrayTable
 
double TableRange [2]
 
double HueRange [2]
 
double SaturationRange [2]
 
double ValueRange [2]
 
double AlphaRange [2]
 
double NanColor [4]
 
int Scale
 
int Ramp
 
vtkTimeStamp InsertTime
 
vtkTimeStamp BuildTime
 
double RGBA [4]
 
int OpaqueFlag
 
vtkTimeStamp OpaqueFlagBuildTime
 
- Protected Attributes inherited from vtkScalarsToColors
double Alpha
 
int VectorMode
 
int UseMagnitude
 
int VectorComponent
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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 42 of file vtkLookupTableWithEnabling.h.

Member Typedef Documentation

Definition at line 47 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
virtual const char* vtkLookupTableWithEnabling::GetClassName ( )
virtual

Reimplemented from vtkLookupTable.

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 ( vtkObject o)
static
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 76 of file vtkLookupTableWithEnabling.h.


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