Man Page for vtkColorTransferFunction
Table of Contents

NAME

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

SYNOPSIS


#include "/opt/vtk-c++/graphics/vtkColorTransferFunction.h"

class VTK_EXPORT vtkColorTransferFunction : public vtkObject

vtkColorTransferFunction();
~vtkColorTransferFunction();
static vtkColorTransferFunction *New() {return new vtkColorTransferFunction;};
const char *GetClassName() {return "vtkColorTransferFunction";};
void PrintSelf(ostream& os, vtkIndent indent);
int GetTotalSize();
int GetRedSize() { return this->Red.GetSize(); }
int GetGreenSize() { return this->Green.GetSize(); };
int GetBlueSize() { return this->Blue.GetSize(); };
void AddRedPoint( float x, float r );
void AddGreenPoint( float x, float g );
void AddBluePoint( float x, float b );
void RemoveRedPoint( float x );
void RemoveGreenPoint( float x );
void RemoveBluePoint( float x );
void AddRedSegment( float x1, float r1, float x2, float r2 );
void AddGreenSegment( float x1, float g1, float x2, float g2 );
void AddBlueSegment( float x1, float b1, float x2, float b2 );
void AddRGBPoint( float x, float r, float g, float b );
void AddRGBSegment( float x1, float r1, float g1, float b1,
float x2, float r2, float g2, float b2 );
void RemoveRGBPoint( float x );
void RemoveAllPoints();
float *GetValue( float x );
float GetRedValue( float x ) { return this->Red.GetValue( x ); };
float GetGreenValue( float x ) { return this->Green.GetValue( x ); };
float GetBlueValue( float x ) { return this->Blue.GetValue( x ); };
float *GetRange();
void GetTable( float x1, float x2, int n, float* table );
void SetClamping(int val);
int GetClamping();

DESCRIPTION

vtkPiecewiseFunction

SEE ALSO

vtkPiecewiseFunction

SUMMARY

vtkColorTransferFunction()
Construct a new vtkColorTransferFunction with default values

~vtkColorTransferFunction()
Destruct a vtkColorTransferFunction

int GetTotalSize()
Returns the sum of the number of function points used to specify the three independent functions (R,G,B)

void AddRedPoint( float x, float r )
Add a point to the red function

void AddGreenPoint( float x, float g )
Add a point to the green function

void AddBluePoint( float x, float b )
Add a point to the blue function

void AddRGBPoint( float x, float r,
float g, float b )
Add a point to all three functions (RGB)

void RemoveRedPoint( float x )
Remove a point from the red function

void RemoveGreenPoint( float x )
Remove a point from the green function

void RemoveBluePoint( float x )
Remove a point from the blue function

void RemoveRGBPoint( float x )
Remove a point from all three functions (RGB)

void RemoveAllPoints()
Remove all points from all three functions (RGB)

void AddRedSegment( float x1, float r1,
float x2, float r2 )
Add a line to the red function

void AddGreenSegment( float x1, float g1,
float x2, float g2 )
Add a line to the green function

void AddBlueSegment( float x1, float b1,
float x2, float b2 )
Add a line to the blue function

void AddRGBSegment( float x1, float r1,
float g1, float b1, float x2, float r2, float g2, float b2 )

Add a line to all three functions (RGB)

float *GetValue( float x )
Returns the RGB color evaluated at the specified location

void UpdateRange()
Updates the min/max range for all three functions (RGB)

float *GetRange()
Returns the min/max range for all three functions

void GetTable( float x1, float x2, int size, float* table ) Returns a table of RGB colors at regular intervals along the function

void PrintSelf(ostream& os, vtkIndent indent)
Print method for vtkColorTransferFunction


Table of Contents