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

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

#include <vtkColorTransferFunction.h>

Inheritance diagram for vtkColorTransferFunction:
[legend]
Collaboration diagram for vtkColorTransferFunction:
[legend]

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)
 
vtkColorTransferFunctionNewInstance () 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)
 
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)
 
doubleGetColor (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 doubleGetRange ()
 
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 doubleGetNanColor ()
 
virtual void GetNanColor (double &, double &, double &)
 
virtual void GetNanColor (double[3])
 
doubleGetDataPointer ()
 
void FillFromDataPointer (int, double *)
 
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
vtkScalarsToColorsNewInstance () const
 
virtual int IsOpaque ()
 
virtual void Build ()
 
virtual double GetOpacity (double v)
 
virtual vtkIdType SetAnnotation (vtkVariant value, vtkStdString annotation)
 Add a new entry (or change an existing entry) to the list of annotated values. More...
 
virtual vtkIdType SetAnnotation (vtkStdString value, vtkStdString annotation)
 This variant of SetAnnotation accepts the value as a string so ParaView can treat annotations as string vector arrays. More...
 
vtkIdType GetNumberOfAnnotatedValues ()
 Return the annotated value at a particular index in the list of annotations. More...
 
vtkVariant GetAnnotatedValue (vtkIdType idx)
 Return the annotated value at a particular index in the list of annotations. More...
 
vtkStdString GetAnnotation (vtkIdType idx)
 Return the annotation at a particular index in the list of annotations. More...
 
virtual void GetAnnotationColor (const vtkVariant &val, double rgba[4])
 Obtain the color associated with a particular annotated value (or NanColor if unmatched). More...
 
vtkIdType GetAnnotatedValueIndex (vtkVariant val)
 Return the index of the given value in the list of annotated values (or -1 if not present). More...
 
vtkIdType GetAnnotatedValueIndexInternal (vtkVariant &val)
 Look up an index into the array of annotations given a value. Does no pointer checks. Returns -1 when val not present. More...
 
virtual bool RemoveAnnotation (vtkVariant value)
 Remove an existing entry from the list of annotated values. More...
 
virtual void ResetAnnotations ()
 Remove all existing values and their annotations. More...
 
void SetRange (double rng[2])
 
doubleGetColor (double 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 ()
 
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 vtkUnsignedCharArrayConvertUnsignedCharToRGBA (vtkUnsignedCharArray *colors, int numComp, int numTuples)
 
virtual int UsingLogScale ()
 
virtual void SetAnnotations (vtkAbstractArray *values, vtkStringArray *annotations)
 
virtual vtkAbstractArrayGetAnnotatedValues ()
 
virtual vtkStringArrayGetAnnotations ()
 
virtual void SetIndexedLookup (int)
 
virtual int GetIndexedLookup ()
 
virtual void IndexedLookupOn ()
 
virtual void IndexedLookupOff ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
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)
 
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 vtkColorTransferFunctionNew ()
 
static int IsTypeOf (const char *type)
 
static vtkColorTransferFunctionSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkScalarsToColors
static int IsTypeOf (const char *type)
 
static vtkScalarsToColorsSafeDownCast (vtkObjectBase *o)
 
static vtkScalarsToColorsNew ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *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

virtual vtkObjectBaseNewInstanceInternal () 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)
 Allocate annotation arrays if needed, then return the index of the given value or -1 if not present. More...
 
virtual void UpdateAnnotatedValueMap ()
 Update the map from annotated values to indices in the array of annotations. More...
 
void MapColorsToColors (void *input, unsigned char *output, int inputDataType, int numberOfValues, int numberOfComponents, int vectorSize, int outputFormat)
 
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]
 
doubleFunction
 
double Range [2]
 
unsigned char UnsignedCharRGBAValue [4]
 
int AllowDuplicateScalars
 
vtkTimeStamp BuildTime
 
unsigned char * Table
 
int TableSize
 
- Protected Attributes inherited from vtkScalarsToColors
vtkAbstractArrayAnnotatedValues
 
vtkStringArrayAnnotations
 
vtkInternalAnnotatedValueMap * AnnotatedValueMap
 
int IndexedLookup
 
double Alpha
 
int VectorMode
 
int VectorComponent
 
int VectorSize
 
int UseMagnitude
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt< vtkTypeInt32 > 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 56 of file vtkColorTransferFunction.h.

Member Typedef Documentation

Definition at line 60 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 points are there defining 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 97 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. 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. Note that GetTable ignores IndexedLookup

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

Fills in a table of n function values between x1 and x2. Note that GetTable ignores IndexedLookup

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

Fills in a table of n function values between x1 and x2. Note that GetTable ignores IndexedLookup

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

Sets and gets the clamping value for this transfer function.

virtual void vtkColorTransferFunction::ClampingOn ( )
virtual

Sets and gets the clamping value for this transfer function.

virtual void vtkColorTransferFunction::ClampingOff ( )
virtual

Sets and gets the clamping value for this transfer function.

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 158 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 159 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 160 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 161 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 173 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 174 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 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 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 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 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 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].

double* vtkColorTransferFunction::GetDataPointer ( )

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

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

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. The set has no functionality in this subclass of vtkScalarsToColors.

Reimplemented from vtkScalarsToColors.

Definition at line 256 of file vtkColorTransferFunction.h.

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

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

Definition at line 257 of file vtkColorTransferFunction.h.

void vtkColorTransferFunction::SortAndUpdateRange ( )
protected
bool vtkColorTransferFunction::UpdateRange ( )
protected
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 219 of file vtkColorTransferFunction.h.

int vtkColorTransferFunction::Clamping
protected

Definition at line 225 of file vtkColorTransferFunction.h.

int vtkColorTransferFunction::ColorSpace
protected

Definition at line 228 of file vtkColorTransferFunction.h.

int vtkColorTransferFunction::HSVWrap
protected

Definition at line 231 of file vtkColorTransferFunction.h.

int vtkColorTransferFunction::Scale
protected

Definition at line 234 of file vtkColorTransferFunction.h.

double vtkColorTransferFunction::NanColor[3]
protected

Definition at line 237 of file vtkColorTransferFunction.h.

double* vtkColorTransferFunction::Function
protected

Definition at line 239 of file vtkColorTransferFunction.h.

double vtkColorTransferFunction::Range[2]
protected

Definition at line 242 of file vtkColorTransferFunction.h.

unsigned char vtkColorTransferFunction::UnsignedCharRGBAValue[4]
protected

Definition at line 245 of file vtkColorTransferFunction.h.

int vtkColorTransferFunction::AllowDuplicateScalars
protected

Definition at line 247 of file vtkColorTransferFunction.h.

vtkTimeStamp vtkColorTransferFunction::BuildTime
protected

Definition at line 249 of file vtkColorTransferFunction.h.

unsigned char* vtkColorTransferFunction::Table
protected

Definition at line 250 of file vtkColorTransferFunction.h.

int vtkColorTransferFunction::TableSize
protected

Definition at line 251 of file vtkColorTransferFunction.h.


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