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

#include <vtkColorTransferFunction.h>

Inheritance diagram for vtkColorTransferFunction:

Collaboration diagram for vtkColorTransferFunction:

Public Types
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)

vtkColorTransferFunction *	NewInstance () const

void	DeepCopy (vtkScalarsToColors *f)

void	ShallowCopy (vtkColorTransferFunction *f)

void	PrintSelf (ostream &os, vtkIndent indent)

int	GetSize ()

void	RemoveAllPoints ()

virtual unsigned char *	MapValue (double v)

int	AdjustRange (double range[2])

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

double *	GetDataPointer ()

void	FillFromDataPointer (int n, double *ptr)

virtual vtkIdType	GetNumberOfAvailableColors ()

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


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

int	AddRGBPoint (double x, double r, double g, double b, double midpoint, double sharpness)

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

int	AddHSVPoint (double x, double h, double s, double v, double midpoint, double sharpness)

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)


double *	GetColor (double x)

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


double	GetRedValue (double x)

double	GetGreenValue (double x)

double	GetBlueValue (double x)


int	GetNodeValue (int index, double val[6])

int	SetNodeValue (int index, double val[6])


virtual double *	GetRange ()

virtual void	GetRange (double &, double &)

virtual void	GetRange (double[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)


virtual void	SetClamping (int)

virtual int	GetClamping ()

virtual void	ClampingOn ()

virtual void	ClampingOff ()


virtual void	SetColorSpace (int)

void	SetColorSpaceToRGB ()

void	SetColorSpaceToHSV ()

void	SetColorSpaceToLab ()

void	SetColorSpaceToDiverging ()

virtual int	GetColorSpace ()

virtual void	SetHSVWrap (int)

virtual int	GetHSVWrap ()

virtual void	HSVWrapOn ()

virtual void	HSVWrapOff ()


virtual void	SetScale (int)

void	SetScaleToLinear ()

void	SetScaleToLog10 ()

virtual int	GetScale ()


virtual void	SetNanColor (double, double, double)

virtual void	SetNanColor (double[3])

virtual double *	GetNanColor ()

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

virtual void	GetNanColor (double[3])


virtual void	SetBelowRangeColor (double, double, double)

virtual void	SetBelowRangeColor (double[3])

virtual double *	GetBelowRangeColor ()

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

virtual void	GetBelowRangeColor (double[3])


virtual void	SetUseBelowRangeColor (int)

virtual int	GetUseBelowRangeColor ()

virtual void	UseBelowRangeColorOn ()

virtual void	UseBelowRangeColorOff ()


virtual void	SetAboveRangeColor (double, double, double)

virtual void	SetAboveRangeColor (double[3])

virtual double *	GetAboveRangeColor ()

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

virtual void	GetAboveRangeColor (double[3])


virtual void	SetUseAboveRangeColor (int)

virtual int	GetUseAboveRangeColor ()

virtual void	UseAboveRangeColorOn ()

virtual void	UseAboveRangeColorOff ()


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


virtual void	SetAllowDuplicateScalars (int)

virtual int	GetAllowDuplicateScalars ()

virtual void	AllowDuplicateScalarsOn ()

virtual void	AllowDuplicateScalarsOff ()

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

virtual int	IsOpaque ()

virtual void	Build ()

virtual double	GetOpacity (double v)

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 int	UsingLogScale ()

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 vtkColorTransferFunction *	New ()

static int	IsTypeOf (const char *type)

static vtkColorTransferFunction *	SafeDownCast (vtkObjectBase *o)

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

	vtkColorTransferFunction ()

	~vtkColorTransferFunction ()

void	SortAndUpdateRange ()

bool	UpdateRange ()

void	MovePoint (double oldX, double newX)


virtual void	SetRange (double, double)

void	SetRange (double rng[2])

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
vtkColorTransferFunctionInternals *	Internal

int	Clamping

int	ColorSpace

int	HSVWrap

int	Scale

double	NanColor [3]

double	BelowRangeColor [3]

int	UseBelowRangeColor

double	AboveRangeColor [3]

int	UseAboveRangeColor

double *	Function

double	Range [2]

unsigned char	UnsignedCharRGBAValue [4]

int	AllowDuplicateScalars

vtkTimeStamp	BuildTime

unsigned char *	Table

int	TableSize

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

Detailed Description

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

vtkColorTransferFunction is a color mapping in RGB or HSV space that uses piecewise hermite functions to allow interpolation that can be piecewise constant, piecewise linear, or somewhere in-between (a modified piecewise hermite function that squishes the function according to a sharpness parameter). The function also allows for the specification of the midpoint (the place where the function reaches the average of the two bounding nodes) as a normalize distance between nodes. See the description of class vtkPiecewiseFunction for an explanation of midpoint and sharpness.

See also: vtkPiecewiseFunction

Examples:: vtkColorTransferFunction (Examples)

Tests:: vtkColorTransferFunction (Tests)

Definition at line 57 of file vtkColorTransferFunction.h.

Member Typedef Documentation

typedef vtkScalarsToColors vtkColorTransferFunction::Superclass

Definition at line 61 of file vtkColorTransferFunction.h.

Constructor & Destructor Documentation

vtkColorTransferFunction::vtkColorTransferFunction ( )

protected

vtkColorTransferFunction::~vtkColorTransferFunction ( )

protected

Member Function Documentation

static vtkColorTransferFunction* vtkColorTransferFunction::New ( )

static

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

static

virtual int vtkColorTransferFunction::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 vtkScalarsToColors.

Reimplemented in vtkDiscretizableColorTransferFunction.

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

static

virtual vtkObjectBase* vtkColorTransferFunction::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkScalarsToColors.

Reimplemented in vtkDiscretizableColorTransferFunction.

vtkColorTransferFunction* vtkColorTransferFunction::NewInstance ( ) const

void vtkColorTransferFunction::DeepCopy ( vtkScalarsToColors * o )

virtual

Copy the contents from another object.

Reimplemented from vtkScalarsToColors.

void vtkColorTransferFunction::ShallowCopy ( vtkColorTransferFunction * f )

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

virtual

Print method for vtkColorTransferFunction

Reimplemented from vtkScalarsToColors.

Reimplemented in vtkDiscretizableColorTransferFunction.

int vtkColorTransferFunction::GetSize ( )

How many nodes define this function?

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. See the description of class vtkPiecewiseFunction for an explanation of midpoint and sharpness.

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

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. See the description of class vtkPiecewiseFunction for an explanation of midpoint and sharpness.

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

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. See the description of class vtkPiecewiseFunction for an explanation of midpoint and sharpness.

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

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. See the description of class vtkPiecewiseFunction for an explanation of midpoint and sharpness.

int vtkColorTransferFunction::RemovePoint ( double x )

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. See the description of class vtkPiecewiseFunction for an explanation of midpoint and sharpness.

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

Definition at line 98 of file vtkColorTransferFunction.h.

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

virtual

Returns an RGB color for the specified scalar value

Reimplemented from vtkScalarsToColors.

Reimplemented in vtkDiscretizableColorTransferFunction.

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.

int vtkColorTransferFunction::GetNodeValue	(	int	index,
		double	val[6]
	)

For the node specified by index, set/get the location (X), R, G, and B values, midpoint, and sharpness values at the node.

int vtkColorTransferFunction::SetNodeValue	(	int	index,
		double	val[6]
	)

For the node specified by index, set/get the location (X), R, G, and B values, midpoint, and sharpness values at the node.

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

virtual

Map one value through the lookup table.

Reimplemented from vtkScalarsToColors.

Reimplemented in vtkDiscretizableColorTransferFunction.

virtual double* vtkColorTransferFunction::GetRange ( )

virtual

Returns min and max position of all function points.

Reimplemented from vtkScalarsToColors.

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

virtual

Returns min and max position of all function points.

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

virtual

Returns min and max position of all function points.

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. Returns 1 on success, 0 otherwise.

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

Fills in a table of n colors mapped from values mapped with even spacing between x1 and x2, inclusive. Note that GetTable ignores IndexedLookup

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

Fills in a table of n colors mapped from values mapped with even spacing between x1 and x2, inclusive. Note that GetTable ignores IndexedLookup

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

Fills in a table of n colors mapped from values mapped with even spacing between x1 and x2, inclusive. Note that GetTable ignores IndexedLookup

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

Construct a color transfer function from a table. Unlike FillFromDataPointer(), the table parameter's layout is assumed to be [R1, G1, B1, R2, G2, B2, ..., Rn, Gn, Bn], and it is assumed to be a block of memory of size [3*size]. After calling this method, the function range will be [x1, x2], the function will have size nodes, and function values will be regularly spaced between x1 and x2.

virtual void vtkColorTransferFunction::SetClamping ( int )

virtual

Sets/gets whether clamping is used. If on, scalar values below the lower range value set for the transfer function will be mapped to the first node color, and scalar values above the upper range value set for the transfer function will be mapped to the last node color. If off, values outside the range are mapped to black.

virtual int vtkColorTransferFunction::GetClamping ( )

virtual

Sets/gets whether clamping is used. If on, scalar values below the lower range value set for the transfer function will be mapped to the first node color, and scalar values above the upper range value set for the transfer function will be mapped to the last node color. If off, values outside the range are mapped to black.

virtual void vtkColorTransferFunction::ClampingOn ( )

virtual

Sets/gets whether clamping is used. If on, scalar values below the lower range value set for the transfer function will be mapped to the first node color, and scalar values above the upper range value set for the transfer function will be mapped to the last node color. If off, values outside the range are mapped to black.

virtual void vtkColorTransferFunction::ClampingOff ( )

virtual

Sets/gets whether clamping is used. If on, scalar values below the lower range value set for the transfer function will be mapped to the first node color, and scalar values above the upper range value set for the transfer function will be mapped to the last node color. If off, values outside the range are mapped to black.

virtual void vtkColorTransferFunction::SetColorSpace ( int )

virtual

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

void vtkColorTransferFunction::SetColorSpaceToRGB ( )

inline

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

Definition at line 167 of file vtkColorTransferFunction.h.

void vtkColorTransferFunction::SetColorSpaceToHSV ( )

inline

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

Definition at line 168 of file vtkColorTransferFunction.h.

void vtkColorTransferFunction::SetColorSpaceToLab ( )

inline

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

Definition at line 169 of file vtkColorTransferFunction.h.

void vtkColorTransferFunction::SetColorSpaceToDiverging ( )

inline

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

Definition at line 170 of file vtkColorTransferFunction.h.

virtual int vtkColorTransferFunction::GetColorSpace ( )

virtual

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

virtual void vtkColorTransferFunction::SetHSVWrap ( int )

virtual

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

virtual int vtkColorTransferFunction::GetHSVWrap ( )

virtual

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

virtual void vtkColorTransferFunction::HSVWrapOn ( )

virtual

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

virtual void vtkColorTransferFunction::HSVWrapOff ( )

virtual

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

virtual void vtkColorTransferFunction::SetScale ( int )

virtual

Set the type of scale to use, linear or logarithmic. The default is linear. If the scale is logarithmic, and the range contains zero, the color mapping will be linear.

void vtkColorTransferFunction::SetScaleToLinear ( )

inline

Set the type of scale to use, linear or logarithmic. The default is linear. If the scale is logarithmic, and the range contains zero, the color mapping will be linear.

Definition at line 182 of file vtkColorTransferFunction.h.

void vtkColorTransferFunction::SetScaleToLog10 ( )

inline

Set the type of scale to use, linear or logarithmic. The default is linear. If the scale is logarithmic, and the range contains zero, the color mapping will be linear.

Definition at line 183 of file vtkColorTransferFunction.h.

virtual int vtkColorTransferFunction::GetScale ( )

virtual

Set the type of scale to use, linear or logarithmic. The default is linear. If the scale is logarithmic, and the range contains zero, the color mapping will be linear.

virtual void vtkColorTransferFunction::SetNanColor	(	double	,
		double	,
		double
	)

virtual

Set the RGB 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].

Reimplemented in vtkDiscretizableColorTransferFunction.

virtual void vtkColorTransferFunction::SetNanColor ( double [3] )

virtual

Set the RGB 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].

Reimplemented in vtkDiscretizableColorTransferFunction.

virtual double* vtkColorTransferFunction::GetNanColor ( )

virtual

Set the RGB 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].

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

virtual

Set the RGB 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].

virtual void vtkColorTransferFunction::GetNanColor ( double [3] )

virtual

Set the RGB 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].

virtual void vtkColorTransferFunction::SetBelowRangeColor	(	double	,
		double	,
		double
	)

virtual

Set the color to use when a value below the range is encountered. This is an RGB 3-tuple of doubles in the range [0, 1].

virtual void vtkColorTransferFunction::SetBelowRangeColor ( double [3] )

virtual

Set the color to use when a value below the range is encountered. This is an RGB 3-tuple of doubles in the range [0, 1].

virtual double* vtkColorTransferFunction::GetBelowRangeColor ( )

virtual

Set the color to use when a value below the range is encountered. This is an RGB 3-tuple of doubles in the range [0, 1].

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

virtual

Set the color to use when a value below the range is encountered. This is an RGB 3-tuple of doubles in the range [0, 1].

virtual void vtkColorTransferFunction::GetBelowRangeColor ( double [3] )

virtual

Set the color to use when a value below the range is encountered. This is an RGB 3-tuple of doubles in the range [0, 1].

virtual void vtkColorTransferFunction::SetUseBelowRangeColor ( int )

virtual

Set whether the below range color should be used.

virtual int vtkColorTransferFunction::GetUseBelowRangeColor ( )

virtual

Set whether the below range color should be used.

virtual void vtkColorTransferFunction::UseBelowRangeColorOn ( )

virtual

Set whether the below range color should be used.

virtual void vtkColorTransferFunction::UseBelowRangeColorOff ( )

virtual

Set whether the below range color should be used.

virtual void vtkColorTransferFunction::SetAboveRangeColor	(	double	,
		double	,
		double
	)

virtual

Set the color to use when a value above the range is encountered. This is an RGB 3-tuple of doubles in the range [0, 1].

virtual void vtkColorTransferFunction::SetAboveRangeColor ( double [3] )

virtual

Set the color to use when a value above the range is encountered. This is an RGB 3-tuple of doubles in the range [0, 1].

virtual double* vtkColorTransferFunction::GetAboveRangeColor ( )

virtual

Set the color to use when a value above the range is encountered. This is an RGB 3-tuple of doubles in the range [0, 1].

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

virtual

Set the color to use when a value above the range is encountered. This is an RGB 3-tuple of doubles in the range [0, 1].

virtual void vtkColorTransferFunction::GetAboveRangeColor ( double [3] )

virtual

Set the color to use when a value above the range is encountered. This is an RGB 3-tuple of doubles in the range [0, 1].

virtual void vtkColorTransferFunction::SetUseAboveRangeColor ( int )

virtual

Set whether the below range color should be used.

virtual int vtkColorTransferFunction::GetUseAboveRangeColor ( )

virtual

Set whether the below range color should be used.

virtual void vtkColorTransferFunction::UseAboveRangeColorOn ( )

virtual

Set whether the below range color should be used.

virtual void vtkColorTransferFunction::UseAboveRangeColorOff ( )

virtual

Set whether the below range color should be used.

double* vtkColorTransferFunction::GetDataPointer ( )

Returns a pointer to an array of all node values in an interleaved array with the layout [X1, R1, G1, B1, X2, R2, G2, B2, ..., Xn, Rn, Gn, Bn] where n is the number of nodes defining the transfer function. The returned pointer points to an array that is managed by this class, so callers should not free it.

void vtkColorTransferFunction::FillFromDataPointer	(	int	n,
		double *	ptr
	)

Defines the nodes from an array ptr with the layout [X1, R1, G1, B1, X2, R2, G2, B2, ..., Xn, Rn, Gn, Bn] where n is the number 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.

Reimplemented from vtkScalarsToColors.

virtual void vtkColorTransferFunction::SetAllowDuplicateScalars ( int )

virtual

Toggle whether to allow duplicate scalar values in the color transfer function (off by default).

virtual int vtkColorTransferFunction::GetAllowDuplicateScalars ( )

virtual

Toggle whether to allow duplicate scalar values in the color transfer function (off by default).

virtual void vtkColorTransferFunction::AllowDuplicateScalarsOn ( )

virtual

Toggle whether to allow duplicate scalar values in the color transfer function (off by default).

virtual void vtkColorTransferFunction::AllowDuplicateScalarsOff ( )

virtual

Toggle whether to allow duplicate scalar values in the color transfer function (off by default).

virtual vtkIdType vtkColorTransferFunction::GetNumberOfAvailableColors ( )

virtual

Get the number of available colors for mapping to.

Reimplemented from vtkScalarsToColors.

Reimplemented in vtkDiscretizableColorTransferFunction.

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

virtual

Return a color given an integer index. This is used to assign colors to annotations (given an offset into the list of annotations). If there are no control points or idx < 0, then NanColor is returned.

Reimplemented from vtkScalarsToColors.

Reimplemented in vtkDiscretizableColorTransferFunction.

virtual void vtkColorTransferFunction::SetRange	(	double	,
		double
	)

inlineprotectedvirtual

Set the range of scalars being mapped. This method has no functionality in this subclass of vtkScalarsToColors.

Reimplemented from vtkScalarsToColors.

Definition at line 315 of file vtkColorTransferFunction.h.

void vtkColorTransferFunction::SetRange ( double rng[2] )

inlineprotected

Set the range of scalars being mapped. This method has no functionality in this subclass of vtkScalarsToColors.

Definition at line 316 of file vtkColorTransferFunction.h.

void vtkColorTransferFunction::SortAndUpdateRange ( )

protected

Internal method to sort the vector and update the Range whenever a node is added, edited or removed It always calls Modified().

bool vtkColorTransferFunction::UpdateRange ( )

protected

Returns true if the range has been changed. If the ranged has been modified, calls Modified().

void vtkColorTransferFunction::MovePoint	(	double	oldX,
		double	newX
	)

protected

Moves point from oldX to newX. It removed the point from oldX. If any point existed at newX, it will also be removed.

Member Data Documentation

vtkColorTransferFunctionInternals* vtkColorTransferFunction::Internal

protected

Definition at line 261 of file vtkColorTransferFunction.h.

int vtkColorTransferFunction::Clamping

protected

Determines the function value outside of defined points Zero = always return 0.0 outside of defined points One = clamp to the lowest value below defined points and highest value above defined points

Definition at line 266 of file vtkColorTransferFunction.h.

int vtkColorTransferFunction::ColorSpace

protected

The color space in which interpolation is performed.

Definition at line 269 of file vtkColorTransferFunction.h.

int vtkColorTransferFunction::HSVWrap

protected

Specify if HSV is wrap or not

Definition at line 272 of file vtkColorTransferFunction.h.

int vtkColorTransferFunction::Scale

protected

The color interpolation scale (linear or logarithmic).