Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkColorTransferFunction Class Reference

#include <vtkColorTransferFunction.h>

Inheritance diagram for vtkColorTransferFunction:

Inheritance graph
[legend]
Collaboration diagram for vtkColorTransferFunction:

Collaboration graph
[legend]
List of all members.

Detailed Description

Defines a transfer function for mapping a property to an RGB color value.

vtkColorTransferFunction encapsulates three vtkPiecewiseFunction instances to provide a full RGB transfer function.

See also:
vtkPiecewiseFunction
Examples:
vtkColorTransferFunction (Examples)
Tests:
vtkColorTransferFunction (Tests)

Definition at line 42 of file vtkColorTransferFunction.h.

Public Types

typedef vtkScalarsToColors Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void DeepCopy (vtkColorTransferFunction *f)
void PrintSelf (ostream &os, vtkIndent indent)
int GetSize ()
int AddRGBPoint (double x, double r, double g, double b)
int AddHSVPoint (double x, double h, double s, double v)
int RemovePoint (double x)
void AddRGBSegment (double x1, double r1, double g1, double b1, double x2, double r2, double g2, double b2)
void AddHSVSegment (double x1, double h1, double s1, double v1, double x2, double h2, double s2, double v2)
void RemoveAllPoints ()
double * GetColor (double x)
void GetColor (double x, double rgb[3])
double GetRedValue (double x)
double GetGreenValue (double x)
double GetBlueValue (double x)
virtual unsigned char * MapValue (double v)
virtual double * GetRange ()
virtual void GetRange (double &, double &)
virtual void GetRange (double[2])
int AdjustRange (double range[2])
void GetTable (double x1, double x2, int n, double *table)
void GetTable (double x1, double x2, int n, float *table)
const unsigned char * GetTable (double x1, double x2, int n)
void BuildFunctionFromTable (double x1, double x2, int size, double *table)
virtual void SetClamping (int)
virtual int GetClamping ()
virtual void ClampingOn ()
virtual void ClampingOff ()
virtual void SetColorSpace (int)
void SetColorSpaceToRGB ()
void SetColorSpaceToHSV ()
virtual int GetColorSpace ()
virtual void SetHSVWrap (int)
virtual int GetHSVWrap ()
virtual void HSVWrapOn ()
virtual void HSVWrapOff ()
void SetColorSpaceToHSVNoWrap ()
double * GetDataPointer ()
void FillFromDataPointer (int, double *)
virtual void MapScalarsThroughTable2 (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputIncrement)

Static Public Member Functions

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

Protected Member Functions

 vtkColorTransferFunction ()
 ~vtkColorTransferFunction ()
virtual void SetRange (double, double)
void SetRange (double rng[2])

Protected Attributes

int Clamping
int ColorSpace
int HSVWrap
double * Function
int FunctionSize
int NumberOfPoints
unsigned char UnsignedCharRGBAValue [4]
double Range [2]
vtkPiecewiseFunction * Red
vtkPiecewiseFunction * Green
vtkPiecewiseFunction * Blue
vtkTimeStamp BuildTime
unsigned char * Table
int TableSize

Member Typedef Documentation

typedef vtkScalarsToColors vtkColorTransferFunction::Superclass
 

Reimplemented from vtkScalarsToColors.

Definition at line 46 of file vtkColorTransferFunction.h.

Constructor & Destructor Documentation

vtkColorTransferFunction::vtkColorTransferFunction (   )  [protected]
 

vtkColorTransferFunction::~vtkColorTransferFunction (   )  [protected]
 

Member Function Documentation

static vtkColorTransferFunction* vtkColorTransferFunction::New (   )  [static]
 

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkColorTransferFunction::GetClassName (   )  [virtual]
 

Reimplemented from vtkScalarsToColors.

static int vtkColorTransferFunction::IsTypeOf (  const char *  type  )  [static]
 

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkScalarsToColors.

virtual int vtkColorTransferFunction::IsA (  const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkScalarsToColors.

static vtkColorTransferFunction* vtkColorTransferFunction::SafeDownCast (  vtkObject *  o  )  [static]
 

Reimplemented from vtkScalarsToColors.

void vtkColorTransferFunction::DeepCopy (  vtkColorTransferFunction *  f  ) 
 

void vtkColorTransferFunction::PrintSelf (  ostream &  os,
vtkIndent  indent
)  [virtual]
 

Print method for vtkColorTransferFunction

Reimplemented from vtkScalarsToColors.

int vtkColorTransferFunction::GetSize (   )  [inline]
 

How many points are there defining this function?

Definition at line 53 of file vtkColorTransferFunction.h.

int vtkColorTransferFunction::AddRGBPoint (  double  x,
double  r,
double  g,
double  b
) 
 

Add/Remove a point to/from the function defined in RGB or HSV Return the index of the point (0 based), or -1 on error.

int vtkColorTransferFunction::AddHSVPoint (  double  x,
double  h,
double  s,
double  v
) 
 

How many points are there defining this function?

int vtkColorTransferFunction::RemovePoint (  double  x  ) 
 

How many points are there defining this function?

void vtkColorTransferFunction::AddRGBSegment (  double  x1,
double  r1,
double  g1,
double  b1,
double  x2,
double  r2,
double  g2,
double  b2
) 
 

Add two points to the function and remove all the points between them

void vtkColorTransferFunction::AddHSVSegment (  double  x1,
double  h1,
double  s1,
double  v1,
double  x2,
double  h2,
double  s2,
double  v2
) 
 

Add two points to the function and remove all the points between them

void vtkColorTransferFunction::RemoveAllPoints (   ) 
 

Remove all points

double* vtkColorTransferFunction::GetColor (  double  x  )  [inline]
 

Returns an RGB color for the specified scalar value

Reimplemented from vtkScalarsToColors.

Definition at line 76 of file vtkColorTransferFunction.h.

References vtkScalarsToColors::GetColor().

void vtkColorTransferFunction::GetColor (  double  x,
double  rgb[3]
)  [virtual]
 

Remove all points

Implements vtkScalarsToColors.

double vtkColorTransferFunction::GetRedValue (  double  x  ) 
 

Get the color components individually.

double vtkColorTransferFunction::GetGreenValue (  double  x  ) 
 

Get the color components individually.

double vtkColorTransferFunction::GetBlueValue (  double  x  ) 
 

Get the color components individually.

virtual unsigned char* vtkColorTransferFunction::MapValue (  double  v  )  [virtual]
 

Map one value through the lookup table.

Implements vtkScalarsToColors.

virtual double* vtkColorTransferFunction::GetRange (   )  [virtual]
 

Returns min and max position of all function points.

Implements vtkScalarsToColors.

virtual void vtkColorTransferFunction::GetRange (  double &  ,
double & 
)  [virtual]
 

Map one value through the lookup table.

virtual void vtkColorTransferFunction::GetRange (  double  [2]  )  [virtual]
 

Map one value through the lookup table.

int vtkColorTransferFunction::AdjustRange (  double  range[2]  ) 
 

Remove all points out of the new range, and make sure there is a point at each end of that range. Return 1 on success, 0 otherwise.

void vtkColorTransferFunction::GetTable (  double  x1,
double  x2,
int  n,
double *  table
) 
 

Fills in a table of n function values between x1 and x2

void vtkColorTransferFunction::GetTable (  double  x1,
double  x2,
int  n,
float *  table
) 
 

Remove all points out of the new range, and make sure there is a point at each end of that range. Return 1 on success, 0 otherwise.

const unsigned char* vtkColorTransferFunction::GetTable (  double  x1,
double  x2,
int  n
) 
 

Remove all points out of the new range, and make sure there is a point at each end of that range. Return 1 on success, 0 otherwise.

void vtkColorTransferFunction::BuildFunctionFromTable (  double  x1,
double  x2,
int  size,
double *  table
) 
 

Construct a color transfer function from a table. Function range is is set to [x1, x2], each function size is set to size, and function points are regularly spaced between x1 and x2. Parameter "table" is assumed to be a block of memory of size [3*size]

virtual void vtkColorTransferFunction::SetClamping (  int   )  [virtual]
 

Sets and gets the clamping value for this transfer function.

virtual int vtkColorTransferFunction::GetClamping (   )  [virtual]
 

Construct a color transfer function from a table. Function range is is set to [x1, x2], each function size is set to size, and function points are regularly spaced between x1 and x2. Parameter "table" is assumed to be a block of memory of size [3*size]

virtual void vtkColorTransferFunction::ClampingOn (   )  [virtual]
 

Construct a color transfer function from a table. Function range is is set to [x1, x2], each function size is set to size, and function points are regularly spaced between x1 and x2. Parameter "table" is assumed to be a block of memory of size [3*size]

virtual void vtkColorTransferFunction::ClampingOff (   )  [virtual]
 

Construct a color transfer function from a table. Function range is is set to [x1, x2], each function size is set to size, and function points are regularly spaced between x1 and x2. Parameter "table" is assumed to be a block of memory of size [3*size]

virtual void vtkColorTransferFunction::SetColorSpace (  int   )  [virtual]
 

Set/Get the color space used for interpolation: RGB, or HSV. In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back through 0 if that is the shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0 (in order the match the current functionality of vtkLookupTable)

void vtkColorTransferFunction::SetColorSpaceToRGB (   )  [inline]
 

Set/Get the color space used for interpolation: RGB, or HSV. In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back through 0 if that is the shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0 (in order the match the current functionality of vtkLookupTable)

Definition at line 127 of file vtkColorTransferFunction.h.

References VTK_CTF_RGB.

void vtkColorTransferFunction::SetColorSpaceToHSV (   )  [inline]
 

Set/Get the color space used for interpolation: RGB, or HSV. In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back through 0 if that is the shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0 (in order the match the current functionality of vtkLookupTable)

Definition at line 128 of file vtkColorTransferFunction.h.

References VTK_CTF_HSV.

virtual int vtkColorTransferFunction::GetColorSpace (   )  [virtual]
 

Set/Get the color space used for interpolation: RGB, or HSV. In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back through 0 if that is the shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0 (in order the match the current functionality of vtkLookupTable)

virtual void vtkColorTransferFunction::SetHSVWrap (  int   )  [virtual]
 

Set/Get the color space used for interpolation: RGB, or HSV. In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back through 0 if that is the shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0 (in order the match the current functionality of vtkLookupTable)

virtual int vtkColorTransferFunction::GetHSVWrap (   )  [virtual]
 

Set/Get the color space used for interpolation: RGB, or HSV. In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back through 0 if that is the shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0 (in order the match the current functionality of vtkLookupTable)

virtual void vtkColorTransferFunction::HSVWrapOn (   )  [virtual]
 

Set/Get the color space used for interpolation: RGB, or HSV. In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back through 0 if that is the shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0 (in order the match the current functionality of vtkLookupTable)

virtual void vtkColorTransferFunction::HSVWrapOff (   )  [virtual]
 

Set/Get the color space used for interpolation: RGB, or HSV. In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back through 0 if that is the shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0 (in order the match the current functionality of vtkLookupTable)

void vtkColorTransferFunction::SetColorSpaceToHSVNoWrap (   ) 
 

Set/Get the color space used for interpolation: RGB, or HSV. In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back through 0 if that is the shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0 (in order the match the current functionality of vtkLookupTable)

double* vtkColorTransferFunction::GetDataPointer (   )  [inline]
 

Returns a list of all nodes Fills from a pointer to data stored in a similar list of nodes.

Definition at line 139 of file vtkColorTransferFunction.h.

void vtkColorTransferFunction::FillFromDataPointer (  int  ,
double * 
) 
 

Returns a list of all nodes Fills from a pointer to data stored in a similar list of nodes.

virtual void vtkColorTransferFunction::MapScalarsThroughTable2 (  void *  input,
unsigned char *  output,
int  inputDataType,
int  numberOfValues,
int  inputIncrement,
int  outputIncrement
)  [virtual]
 

map a set of scalars through the lookup table

Implements vtkScalarsToColors.

virtual void vtkColorTransferFunction::SetRange (  double  ,
double 
)  [inline, protected, virtual]
 

Set the range of scalars being mapped. The set has no functionality in this subclass of vtkScalarsToColors.

Implements vtkScalarsToColors.

Definition at line 189 of file vtkColorTransferFunction.h.

void vtkColorTransferFunction::SetRange (  double  rng[2]  )  [inline, protected]
 

Perform any processing required (if any) before processing scalars.

Reimplemented from vtkScalarsToColors.

Definition at line 190 of file vtkColorTransferFunction.h.

References vtkScalarsToColors::SetRange().

Member Data Documentation

int vtkColorTransferFunction::Clamping [protected]
 

Definition at line 158 of file vtkColorTransferFunction.h.

int vtkColorTransferFunction::ColorSpace [protected]
 

Definition at line 161 of file vtkColorTransferFunction.h.

int vtkColorTransferFunction::HSVWrap [protected]
 

Definition at line 164 of file vtkColorTransferFunction.h.

double* vtkColorTransferFunction::Function [protected]
 

Definition at line 167 of file vtkColorTransferFunction.h.

int vtkColorTransferFunction::FunctionSize [protected]
 

Definition at line 168 of file vtkColorTransferFunction.h.

int vtkColorTransferFunction::NumberOfPoints [protected]
 

Definition at line 169 of file vtkColorTransferFunction.h.

unsigned char vtkColorTransferFunction::UnsignedCharRGBAValue[4] [protected]
 

Definition at line 172 of file vtkColorTransferFunction.h.

double vtkColorTransferFunction::Range[2] [protected]
 

Definition at line 175 of file vtkColorTransferFunction.h.

vtkPiecewiseFunction* vtkColorTransferFunction::Red [protected]
 

Definition at line 179 of file vtkColorTransferFunction.h.

vtkPiecewiseFunction* vtkColorTransferFunction::Green [protected]
 

Definition at line 180 of file vtkColorTransferFunction.h.

vtkPiecewiseFunction* vtkColorTransferFunction::Blue [protected]
 

Definition at line 181 of file vtkColorTransferFunction.h.

vtkTimeStamp vtkColorTransferFunction::BuildTime [protected]
 

Definition at line 182 of file vtkColorTransferFunction.h.

unsigned char* vtkColorTransferFunction::Table [protected]
 

Definition at line 183 of file vtkColorTransferFunction.h.

int vtkColorTransferFunction::TableSize [protected]
 

Definition at line 184 of file vtkColorTransferFunction.h.

The documentation for this class was generated from the following file:
Generated on Mon Jan 21 23:38:04 2008 for VTK by  doxygen 1.4.3-20050530