VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkDiscretizableColorTransferFunction Class Reference

a combination of vtkColorTransferFunction and vtkLookupTable. More...

#include <vtkDiscretizableColorTransferFunction.h>

Inherits vtkColorTransferFunction.

Collaboration diagram for vtkDiscretizableColorTransferFunction:
[legend]

Public Types

typedef vtkColorTransferFunction Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Build ()
 
virtual unsigned char * MapValue (double v)
 
virtual void GetColor (double v, double rgb[3])
 
double * GetRGBPoints ()
 
virtual void SetAlpha (double alpha)
 
virtual vtkIdType GetNumberOfAvailableColors ()
 
virtual void SetDiscretize (int)
 
virtual int GetDiscretize ()
 
virtual void DiscretizeOn ()
 
virtual void DiscretizeOff ()
 
virtual void SetUseLogScale (int useLogScale)
 
virtual int GetUseLogScale ()
 
void SetNumberOfValues (vtkIdType number)
 
virtual vtkIdType GetNumberOfValues ()
 
virtual vtkUnsignedCharArrayMapScalars (vtkDataArray *scalars, int colorMode, int component)
 
virtual void SetNanColor (double r, double g, double b)
 
virtual void SetNanColor (double rgb[3])
 
virtual int UsingLogScale ()
 

Static Public Member Functions

static
vtkDiscretizableColorTransferFunction
New ()
 
static int IsTypeOf (const char *type)
 
static
vtkDiscretizableColorTransferFunction
SafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkDiscretizableColorTransferFunction ()
 
 ~vtkDiscretizableColorTransferFunction ()
 

Protected Attributes

int Discretize
 
int UseLogScale
 
vtkIdType NumberOfValues
 
vtkLookupTableLookupTable
 
vtkTimeStamp BuildTime
 

Detailed Description

a combination of vtkColorTransferFunction and vtkLookupTable.

This is a cross between a vtkColorTransferFunction and a vtkLookupTable selectively combiniting the functionality of both. NOTE: One must call Build() after making any changes to the points in the ColorTransferFunction to ensure that the discrete and non-discrete version match up.

Tests:
vtkDiscretizableColorTransferFunction (Tests)

Definition at line 37 of file vtkDiscretizableColorTransferFunction.h.

Member Typedef Documentation

typedef vtkColorTransferFunction vtkDiscretizableColorTransferFunction::Superclass

Definition at line 41 of file vtkDiscretizableColorTransferFunction.h.

Constructor & Destructor Documentation

vtkDiscretizableColorTransferFunction::vtkDiscretizableColorTransferFunction ( )
protected
vtkDiscretizableColorTransferFunction::~vtkDiscretizableColorTransferFunction ( )
protected

Member Function Documentation

static vtkDiscretizableColorTransferFunction* vtkDiscretizableColorTransferFunction::New ( )
static
virtual const char* vtkDiscretizableColorTransferFunction::GetClassName ( )
virtual
static int vtkDiscretizableColorTransferFunction::IsTypeOf ( const char *  type)
static
virtual int vtkDiscretizableColorTransferFunction::IsA ( const char *  type)
virtual
static vtkDiscretizableColorTransferFunction* vtkDiscretizableColorTransferFunction::SafeDownCast ( vtkObject o)
static
void vtkDiscretizableColorTransferFunction::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtkDiscretizableColorTransferFunction::Build ( )
virtual

Generate discretized lookup table, if applicable. This method must be called after changes to the ColorTransferFunction otherwise the discretized version will be inconsitent with the non-discretized one.

virtual void vtkDiscretizableColorTransferFunction::SetDiscretize ( int  )
virtual

Set if the values are to mapped after discretization. The number of discrete values is set by using SetNumberOfValues(). Not set by default, i.e. color value is determined by interpolating at the scalar value.

virtual int vtkDiscretizableColorTransferFunction::GetDiscretize ( )
virtual

Set if the values are to mapped after discretization. The number of discrete values is set by using SetNumberOfValues(). Not set by default, i.e. color value is determined by interpolating at the scalar value.

virtual void vtkDiscretizableColorTransferFunction::DiscretizeOn ( )
virtual

Set if the values are to mapped after discretization. The number of discrete values is set by using SetNumberOfValues(). Not set by default, i.e. color value is determined by interpolating at the scalar value.

virtual void vtkDiscretizableColorTransferFunction::DiscretizeOff ( )
virtual

Set if the values are to mapped after discretization. The number of discrete values is set by using SetNumberOfValues(). Not set by default, i.e. color value is determined by interpolating at the scalar value.

virtual void vtkDiscretizableColorTransferFunction::SetUseLogScale ( int  useLogScale)
virtual

Get/Set if log scale must be used while mapping scalars to colors. The default is 0.

virtual int vtkDiscretizableColorTransferFunction::GetUseLogScale ( )
virtual

Get/Set if log scale must be used while mapping scalars to colors. The default is 0.

void vtkDiscretizableColorTransferFunction::SetNumberOfValues ( vtkIdType  number)

Set the number of values i.e. colors to be generated in the discrete lookup table. This has no effect if Discretize is off. The default is

virtual vtkIdType vtkDiscretizableColorTransferFunction::GetNumberOfValues ( )
virtual

Set the number of values i.e. colors to be generated in the discrete lookup table. This has no effect if Discretize is off. The default is

virtual unsigned char* vtkDiscretizableColorTransferFunction::MapValue ( double  v)
virtual

Map one value through the lookup table and return a color defined as a RGBA unsigned char tuple (4 bytes).

virtual void vtkDiscretizableColorTransferFunction::GetColor ( double  v,
double  rgb[3] 
)
virtual

Map one value through the lookup table and return the color as an RGB array of doubles between 0 and 1.

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

An internal method maps a data array into a 4-component, unsigned char RGBA array. The color mode determines the behavior of mapping. If VTK_COLOR_MODE_DEFAULT is set, then unsigned char data arrays are treated as colors (and converted to RGBA if necessary); otherwise, the data is mapped through this instance of ScalarsToColors. The offset is used for data arrays with more than one component; it indicates which component to use to do the blending. When the component argument is -1, then the this object uses its own selected technique to change a vector into a scalar to map.

double* vtkDiscretizableColorTransferFunction::GetRGBPoints ( )

Returns the (x, r, g, b) values as an array.

virtual void vtkDiscretizableColorTransferFunction::SetAlpha ( double  alpha)
virtual

Specify an additional opacity (alpha) value to blend with. Values != 1 modify the resulting color consistent with the requested form of the output. This is typically used by an actor in order to blend its opacity. Overridden to pass the alpha to the internal vtkLookupTable.

virtual void vtkDiscretizableColorTransferFunction::SetNanColor ( double  r,
double  g,
double  b 
)
virtual

Set the color to use when a NaN (not a number) is encountered. This is an RGB 3-tuple color of doubles in the range [0,1]. Overridden to pass the NanColor to the internal vtkLookupTable.

virtual void vtkDiscretizableColorTransferFunction::SetNanColor ( double  rgb[3])
inlinevirtual

Set the color to use when a NaN (not a number) is encountered. This is an RGB 3-tuple color of doubles in the range [0,1]. Overridden to pass the NanColor to the internal vtkLookupTable.

Definition at line 111 of file vtkDiscretizableColorTransferFunction.h.

virtual int vtkDiscretizableColorTransferFunction::UsingLogScale ( )
inlinevirtual

This should return 1 is the subclass is using log scale for mapping scalars to colors.

Definition at line 120 of file vtkDiscretizableColorTransferFunction.h.

virtual vtkIdType vtkDiscretizableColorTransferFunction::GetNumberOfAvailableColors ( )
virtual

Get the number of available colors for mapping to.

Member Data Documentation

int vtkDiscretizableColorTransferFunction::Discretize
protected

Definition at line 131 of file vtkDiscretizableColorTransferFunction.h.

int vtkDiscretizableColorTransferFunction::UseLogScale
protected

Definition at line 132 of file vtkDiscretizableColorTransferFunction.h.

vtkIdType vtkDiscretizableColorTransferFunction::NumberOfValues
protected

Definition at line 134 of file vtkDiscretizableColorTransferFunction.h.

vtkLookupTable* vtkDiscretizableColorTransferFunction::LookupTable
protected

Definition at line 135 of file vtkDiscretizableColorTransferFunction.h.

vtkTimeStamp vtkDiscretizableColorTransferFunction::BuildTime
protected

Definition at line 137 of file vtkDiscretizableColorTransferFunction.h.


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