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 Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkColorTransferFunctionNewInstance () const
 
void DeepCopy (vtkScalarsToColors *f) override
 Copy the contents from another object. More...
 
void ShallowCopy (vtkColorTransferFunction *f)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Print method for vtkColorTransferFunction. More...
 
int GetSize ()
 How many nodes define this function? More...
 
void RemoveAllPoints ()
 Remove all points. More...
 
doubleGetColor (double x)
 Returns an RGB color for the specified scalar value. More...
 
void GetColor (double x, double rgb[3]) override
 Map one value through the lookup table and store the color as an RGB array of doubles between 0 and 1 in the rgb argument. More...
 
const unsigned char * MapValue (double v) override
 Map one value through the lookup table. More...
 
int 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. More...
 
void BuildFunctionFromTable (double x1, double x2, int size, double *table)
 Construct a color transfer function from a table. More...
 
doubleGetDataPointer ()
 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. More...
 
void 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. More...
 
void MapScalarsThroughTable2 (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputIncrement) override
 Map a set of scalars through the lookup table. More...
 
vtkIdType GetNumberOfAvailableColors () override
 Get the number of available colors for mapping to. More...
 
void GetIndexedColor (vtkIdType idx, double rgba[4]) override
 Return a color given an integer index. More...
 
int EstimateMinNumberOfSamples (double const &x1, double const &x2)
 Estimates the minimum size of a table such that it would correctly sample this function. More...
 
int 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. More...
 
int 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. More...
 
int 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. More...
 
int 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. More...
 
int 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. More...
 
void 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. More...
 
void 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. More...
 
double GetRedValue (double x)
 Get the color components individually. More...
 
double GetGreenValue (double x)
 Get the color components individually. More...
 
double GetBlueValue (double x)
 Get the color components individually. More...
 
int 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. More...
 
int 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. More...
 
doubleGetRange () override
 Returns min and max position of all function points. More...
 
virtual void GetRange (double &arg1, double &arg2)
 Returns min and max position of all function points. More...
 
virtual void GetRange (double _arg[2])
 Returns min and max position of all function points. More...
 
void 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. More...
 
void 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. More...
 
const unsigned char * 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. More...
 
virtual void SetClamping (vtkTypeBool)
 Sets/gets whether clamping is used. More...
 
virtual vtkTypeBool GetClamping ()
 Sets/gets whether clamping is used. More...
 
virtual void ClampingOn ()
 Sets/gets whether clamping is used. More...
 
virtual void ClampingOff ()
 Sets/gets whether clamping is used. More...
 
virtual void SetColorSpace (int)
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step. More...
 
void SetColorSpaceToRGB ()
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step. More...
 
void SetColorSpaceToHSV ()
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step. More...
 
void SetColorSpaceToLab ()
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step. More...
 
void SetColorSpaceToLabCIEDE2000 ()
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step. More...
 
void SetColorSpaceToDiverging ()
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step. More...
 
void SetColorSpaceToStep ()
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step. More...
 
virtual int GetColorSpace ()
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step. More...
 
virtual void SetHSVWrap (vtkTypeBool)
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step. More...
 
virtual vtkTypeBool GetHSVWrap ()
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step. More...
 
virtual void HSVWrapOn ()
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step. More...
 
virtual void HSVWrapOff ()
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step. More...
 
virtual void SetScale (int)
 Set the type of scale to use, linear or logarithmic. More...
 
void SetScaleToLinear ()
 Set the type of scale to use, linear or logarithmic. More...
 
void SetScaleToLog10 ()
 Set the type of scale to use, linear or logarithmic. More...
 
virtual int GetScale ()
 Set the type of scale to use, linear or logarithmic. More...
 
virtual void SetNanColor (double, double, double)
 Set the RGB color to use when a NaN (not a number) is encountered. More...
 
virtual void SetNanColor (double[3])
 Set the RGB color to use when a NaN (not a number) is encountered. More...
 
virtual doubleGetNanColor ()
 Set the RGB color to use when a NaN (not a number) is encountered. More...
 
virtual void GetNanColor (double &, double &, double &)
 Set the RGB color to use when a NaN (not a number) is encountered. More...
 
virtual void GetNanColor (double[3])
 Set the RGB color to use when a NaN (not a number) is encountered. More...
 
virtual void SetNanOpacity (double)
 Get/Set the opacity to use when a NaN (not a number) is encountered. More...
 
virtual double GetNanOpacity ()
 Get/Set the opacity to use when a NaN (not a number) is encountered. More...
 
virtual void SetNanColorRGBA (double r, double g, double b, double a)
 Set the RGBA color to use when a NaN (not a number) is encountered. More...
 
void SetNanColorRGBA (double rgba[4])
 Set the RGBA color to use when a NaN (not a number) is encountered. More...
 
virtual void SetBelowRangeColor (double, double, double)
 Set the color to use when a value below the range is encountered. More...
 
virtual void SetBelowRangeColor (double[3])
 Set the color to use when a value below the range is encountered. More...
 
virtual doubleGetBelowRangeColor ()
 Set the color to use when a value below the range is encountered. More...
 
virtual void GetBelowRangeColor (double &, double &, double &)
 Set the color to use when a value below the range is encountered. More...
 
virtual void GetBelowRangeColor (double[3])
 Set the color to use when a value below the range is encountered. More...
 
virtual void SetUseBelowRangeColor (vtkTypeBool)
 Set whether the below range color should be used. More...
 
virtual vtkTypeBool GetUseBelowRangeColor ()
 Set whether the below range color should be used. More...
 
virtual void UseBelowRangeColorOn ()
 Set whether the below range color should be used. More...
 
virtual void UseBelowRangeColorOff ()
 Set whether the below range color should be used. More...
 
virtual void SetAboveRangeColor (double, double, double)
 Set the color to use when a value above the range is encountered. More...
 
virtual void SetAboveRangeColor (double[3])
 Set the color to use when a value above the range is encountered. More...
 
virtual doubleGetAboveRangeColor ()
 Set the color to use when a value above the range is encountered. More...
 
virtual void GetAboveRangeColor (double &, double &, double &)
 Set the color to use when a value above the range is encountered. More...
 
virtual void GetAboveRangeColor (double[3])
 Set the color to use when a value above the range is encountered. More...
 
virtual void SetUseAboveRangeColor (vtkTypeBool)
 Set whether the below range color should be used. More...
 
virtual vtkTypeBool GetUseAboveRangeColor ()
 Set whether the below range color should be used. More...
 
virtual void UseAboveRangeColorOn ()
 Set whether the below range color should be used. More...
 
virtual void UseAboveRangeColorOff ()
 Set whether the below range color should be used. More...
 
virtual void SetAllowDuplicateScalars (vtkTypeBool)
 Toggle whether to allow duplicate scalar values in the color transfer function (off by default). More...
 
virtual vtkTypeBool GetAllowDuplicateScalars ()
 Toggle whether to allow duplicate scalar values in the color transfer function (off by default). More...
 
virtual void AllowDuplicateScalarsOn ()
 Toggle whether to allow duplicate scalar values in the color transfer function (off by default). More...
 
virtual void AllowDuplicateScalarsOff ()
 Toggle whether to allow duplicate scalar values in the color transfer function (off by default). More...
 
- Public Member Functions inherited from vtkScalarsToColors
vtkScalarsToColorsNewInstance () const
 
virtual void Build ()
 Perform any processing required (if any) before processing scalars. More...
 
doubleGetColor (double v)
 Map one value through the lookup table and return the color as an RGB array of doubles between 0 and 1. More...
 
virtual double GetOpacity (double v)
 Map one value through the lookup table and return the alpha value (the opacity) as a double between 0 and 1. More...
 
double GetLuminance (double x)
 Map one value through the lookup table and return the luminance 0.3*red + 0.59*green + 0.11*blue as a double between 0 and 1. More...
 
void MapVectorsThroughTable (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat, int vectorComponent, int vectorSize)
 Map vectors through the lookup table. More...
 
void MapVectorsThroughTable (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat)
 
void MapScalarsThroughTable (vtkDataArray *scalars, unsigned char *output, int outputFormat)
 Map a set of scalars through the lookup table in a single operation. More...
 
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 ()
 This should return 1 is the subclass is using log scale for mapping scalars to colors. More...
 
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 (const vtkVariant &val)
 Look up an index into the array of annotations given a value. 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...
 
virtual int IsOpaque ()
 Return true if all of the values defining the mapping have an opacity equal to 1. More...
 
virtual int IsOpaque (vtkAbstractArray *scalars, int colorMode, int component)
 Return true if all of the values defining the mapping have an opacity equal to 1. More...
 
virtual void SetAlpha (double alpha)
 Specify an additional opacity (alpha) value to blend with. More...
 
virtual double GetAlpha ()
 Specify an additional opacity (alpha) value to blend with. More...
 
virtual vtkUnsignedCharArrayMapScalars (vtkDataArray *scalars, int colorMode, int component)
 Internal methods that map a data array into a 4-component, unsigned char RGBA array. More...
 
virtual vtkUnsignedCharArrayMapScalars (vtkAbstractArray *scalars, int colorMode, int component)
 Internal methods that map a data array into a 4-component, unsigned char RGBA array. More...
 
virtual void SetVectorMode (int)
 Change mode that maps vectors by magnitude vs. More...
 
virtual int GetVectorMode ()
 Change mode that maps vectors by magnitude vs. More...
 
void SetVectorModeToMagnitude ()
 Change mode that maps vectors by magnitude vs. More...
 
void SetVectorModeToComponent ()
 Change mode that maps vectors by magnitude vs. More...
 
void SetVectorModeToRGBColors ()
 Change mode that maps vectors by magnitude vs. More...
 
virtual void SetVectorComponent (int)
 If the mapper does not select which component of a vector to map to colors, you can specify it here. More...
 
virtual int GetVectorComponent ()
 If the mapper does not select which component of a vector to map to colors, you can specify it here. More...
 
virtual void SetVectorSize (int)
 When mapping vectors, consider only the number of components selected by VectorSize to be part of the vector, and ignore any other components. More...
 
virtual int GetVectorSize ()
 When mapping vectors, consider only the number of components selected by VectorSize to be part of the vector, and ignore any other components. More...
 
virtual void SetAnnotations (vtkAbstractArray *values, vtkStringArray *annotations)
 Set a list of discrete values, either as a categorical set of values (when IndexedLookup is true) or as a set of annotations to add to a scalar array (when IndexedLookup is false). More...
 
virtual vtkAbstractArrayGetAnnotatedValues ()
 Set a list of discrete values, either as a categorical set of values (when IndexedLookup is true) or as a set of annotations to add to a scalar array (when IndexedLookup is false). More...
 
virtual vtkStringArrayGetAnnotations ()
 Set a list of discrete values, either as a categorical set of values (when IndexedLookup is true) or as a set of annotations to add to a scalar array (when IndexedLookup is false). More...
 
virtual void SetIndexedLookup (vtkTypeBool)
 Set/get whether the lookup table is for categorical or ordinal data. More...
 
virtual vtkTypeBool GetIndexedLookup ()
 Set/get whether the lookup table is for categorical or ordinal data. More...
 
virtual void IndexedLookupOn ()
 Set/get whether the lookup table is for categorical or ordinal data. More...
 
virtual void IndexedLookupOff ()
 Set/get whether the lookup table is for categorical or ordinal data. More...
 
template<>
unsigned char ColorToUChar (double t)
 Specializations of vtkScalarsToColors::ColorToUChar Converts from a color in a floating point type in range 0.0-1.0 to a uchar in range 0-255. More...
 
template<>
unsigned char ColorToUChar (float t)
 Specializations of vtkScalarsToColors::ColorToUChar Converts from a color in a floating point type in range 0.0-1.0 to a uchar in range 0-255. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkColorTransferFunctionNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkColorTransferFunctionSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkScalarsToColors
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkScalarsToColorsSafeDownCast (vtkObjectBase *o)
 
static vtkScalarsToColorsNew ()
 
template<typename T >
static unsigned char ColorToUChar (T t)
 Converts a color from numeric type T to uchar. More...
 
template<typename T >
static void ColorToUChar (T t, unsigned char *dest)
 Converts a color from numeric type T to uchar. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkColorTransferFunction ()
 
 ~vtkColorTransferFunction () override
 
void SetRange (double, double) override
 Set the range of scalars being mapped. More...
 
void SetRange (const double rng[2]) override
 Sets/Gets the range of scalars that will be mapped. More...
 
void SortAndUpdateRange ()
 Internal method to sort the vector and update the Range whenever a node is added, edited or removed It always calls Modified(). More...
 
bool UpdateRange ()
 Returns true if the range has been changed. More...
 
void MovePoint (double oldX, double newX)
 Moves point from oldX to newX. More...
 
double FindMinimumXDistance ()
 Traverses the nodes to find the minimum distance. More...
 
- Protected Member Functions inherited from vtkScalarsToColors
 vtkScalarsToColors ()
 
 ~vtkScalarsToColors () override
 
void MapColorsToColors (void *input, unsigned char *output, int inputDataType, int numberOfValues, int numberOfComponents, int vectorSize, int outputFormat)
 An internal method that assumes that the input already has the right colors, and only remaps the range to [0,255] and pads to the desired output format. More...
 
vtkUnsignedCharArrayConvertToRGBA (vtkDataArray *colors, int numComp, int numTuples)
 An internal method used to convert a color array to RGBA. More...
 
void MapVectorsToMagnitude (void *input, double *output, int inputDataType, int numberOfValues, int numberOfComponents, int vectorSize)
 An internal method for converting vectors to magnitudes, used as a preliminary step before doing magnitude mapping. More...
 
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...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- 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
 
vtkTypeBool Clamping
 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. More...
 
int ColorSpace
 The color space in which interpolation is performed. More...
 
vtkTypeBool HSVWrap
 Specify if HSV is wrap or not. More...
 
int Scale
 The color interpolation scale (linear or logarithmic). More...
 
double NanColor [3]
 The color to use for not-a-number. More...
 
double NanOpacity
 The opacity to use for not-a-number. More...
 
double BelowRangeColor [3]
 The below-range color. More...
 
vtkTypeBool UseBelowRangeColor
 Flag indicating whether below-range color should be used. More...
 
double AboveRangeColor [3]
 The above-range color. More...
 
vtkTypeBool UseAboveRangeColor
 Flag indicating whether below-range color should be used. More...
 
doubleFunction
 Temporary array to store data from the nodes. More...
 
double Range [2]
 The min and max node locations. More...
 
unsigned char UnsignedCharRGBAValue [4]
 Temporary storage for an evaluated color (0 to 255 RGBA A=255) More...
 
vtkTypeBool AllowDuplicateScalars
 If on, the same scalar value may have more than one node assigned to it. More...
 
vtkTimeStamp BuildTime
 
unsigned char * Table
 
int TableSize
 Temporary storage for the size of the table. More...
 
- Protected Attributes inherited from vtkScalarsToColors
vtkAbstractArrayAnnotatedValues
 
vtkStringArrayAnnotations
 
vtkInternalAnnotatedValueMap * AnnotatedValueMap
 
vtkTypeBool 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

Definition at line 54 of file vtkColorTransferFunction.h.

Member Typedef Documentation

Definition at line 58 of file vtkColorTransferFunction.h.

Constructor & Destructor Documentation

vtkColorTransferFunction::vtkColorTransferFunction ( )
protected
vtkColorTransferFunction::~vtkColorTransferFunction ( )
overrideprotected

Member Function Documentation

static vtkColorTransferFunction* vtkColorTransferFunction::New ( )
static
static vtkTypeBool vtkColorTransferFunction::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool 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)
overridevirtual

Copy the contents from another object.

Reimplemented from vtkScalarsToColors.

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

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 117 of file vtkColorTransferFunction.h.

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

Map one value through the lookup table and store the color as an RGB array of doubles between 0 and 1 in the rgb argument.

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.

const unsigned char* vtkColorTransferFunction::MapValue ( double  v)
overridevirtual

Map one value through the lookup table.

Reimplemented from vtkScalarsToColors.

Reimplemented in vtkDiscretizableColorTransferFunction.

double* vtkColorTransferFunction::GetRange ( )
inlineoverridevirtual

Returns min and max position of all function points.

Reimplemented from vtkScalarsToColors.

Definition at line 148 of file vtkColorTransferFunction.h.

virtual void vtkColorTransferFunction::GetRange ( double arg1,
double arg2 
)
inlinevirtual

Returns min and max position of all function points.

Definition at line 149 of file vtkColorTransferFunction.h.

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

Returns min and max position of all function points.

Definition at line 154 of file vtkColorTransferFunction.h.

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 ( vtkTypeBool  )
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 vtkTypeBool 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, Diverging or Step.

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). In Lab/CIEDE2000 mode, it will take the shortest path in the Lab color space with respect to the CIE Delta E 2000 color distance measure. Diverging is a special mode where colors will pass through white when interpolating between two saturated colors. Step is a mode where the color of an interval is the color of the second color of the interval.

void vtkColorTransferFunction::SetColorSpaceToRGB ( )
inline

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step.

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). In Lab/CIEDE2000 mode, it will take the shortest path in the Lab color space with respect to the CIE Delta E 2000 color distance measure. Diverging is a special mode where colors will pass through white when interpolating between two saturated colors. Step is a mode where the color of an interval is the color of the second color of the interval.

Definition at line 215 of file vtkColorTransferFunction.h.

void vtkColorTransferFunction::SetColorSpaceToHSV ( )
inline

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step.

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). In Lab/CIEDE2000 mode, it will take the shortest path in the Lab color space with respect to the CIE Delta E 2000 color distance measure. Diverging is a special mode where colors will pass through white when interpolating between two saturated colors. Step is a mode where the color of an interval is the color of the second color of the interval.

Definition at line 216 of file vtkColorTransferFunction.h.

void vtkColorTransferFunction::SetColorSpaceToLab ( )
inline

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step.

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). In Lab/CIEDE2000 mode, it will take the shortest path in the Lab color space with respect to the CIE Delta E 2000 color distance measure. Diverging is a special mode where colors will pass through white when interpolating between two saturated colors. Step is a mode where the color of an interval is the color of the second color of the interval.

Definition at line 217 of file vtkColorTransferFunction.h.

void vtkColorTransferFunction::SetColorSpaceToLabCIEDE2000 ( )
inline

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step.

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). In Lab/CIEDE2000 mode, it will take the shortest path in the Lab color space with respect to the CIE Delta E 2000 color distance measure. Diverging is a special mode where colors will pass through white when interpolating between two saturated colors. Step is a mode where the color of an interval is the color of the second color of the interval.

Definition at line 218 of file vtkColorTransferFunction.h.

void vtkColorTransferFunction::SetColorSpaceToDiverging ( )
inline

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step.

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). In Lab/CIEDE2000 mode, it will take the shortest path in the Lab color space with respect to the CIE Delta E 2000 color distance measure. Diverging is a special mode where colors will pass through white when interpolating between two saturated colors. Step is a mode where the color of an interval is the color of the second color of the interval.

Definition at line 219 of file vtkColorTransferFunction.h.

void vtkColorTransferFunction::SetColorSpaceToStep ( )
inline

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step.

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). In Lab/CIEDE2000 mode, it will take the shortest path in the Lab color space with respect to the CIE Delta E 2000 color distance measure. Diverging is a special mode where colors will pass through white when interpolating between two saturated colors. Step is a mode where the color of an interval is the color of the second color of the interval.

Definition at line 220 of file vtkColorTransferFunction.h.

virtual int vtkColorTransferFunction::GetColorSpace ( )
virtual

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step.

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). In Lab/CIEDE2000 mode, it will take the shortest path in the Lab color space with respect to the CIE Delta E 2000 color distance measure. Diverging is a special mode where colors will pass through white when interpolating between two saturated colors. Step is a mode where the color of an interval is the color of the second color of the interval.

virtual void vtkColorTransferFunction::SetHSVWrap ( vtkTypeBool  )
virtual

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step.

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). In Lab/CIEDE2000 mode, it will take the shortest path in the Lab color space with respect to the CIE Delta E 2000 color distance measure. Diverging is a special mode where colors will pass through white when interpolating between two saturated colors. Step is a mode where the color of an interval is the color of the second color of the interval.

virtual vtkTypeBool vtkColorTransferFunction::GetHSVWrap ( )
virtual

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step.

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). In Lab/CIEDE2000 mode, it will take the shortest path in the Lab color space with respect to the CIE Delta E 2000 color distance measure. Diverging is a special mode where colors will pass through white when interpolating between two saturated colors. Step is a mode where the color of an interval is the color of the second color of the interval.

virtual void vtkColorTransferFunction::HSVWrapOn ( )
virtual

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step.

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). In Lab/CIEDE2000 mode, it will take the shortest path in the Lab color space with respect to the CIE Delta E 2000 color distance measure. Diverging is a special mode where colors will pass through white when interpolating between two saturated colors. Step is a mode where the color of an interval is the color of the second color of the interval.

virtual void vtkColorTransferFunction::HSVWrapOff ( )
virtual

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step.

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). In Lab/CIEDE2000 mode, it will take the shortest path in the Lab color space with respect to the CIE Delta E 2000 color distance measure. Diverging is a special mode where colors will pass through white when interpolating between two saturated colors. Step is a mode where the color of an interval is the color of the second color of the interval.

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 234 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 235 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::SetNanOpacity ( double  )
virtual

Get/Set the opacity to use when a NaN (not a number) is encountered.

This a double in the range [0,1].

Reimplemented in vtkDiscretizableColorTransferFunction.

virtual double vtkColorTransferFunction::GetNanOpacity ( )
virtual

Get/Set the opacity to use when a NaN (not a number) is encountered.

This a double in the range [0,1].

virtual void vtkColorTransferFunction::SetNanColorRGBA ( double  r,
double  g,
double  b,
double  a 
)
inlinevirtual

Set the RGBA color to use when a NaN (not a number) is encountered.

This is an RGBA 4-tuple color of doubles in the range [0,1].

Definition at line 264 of file vtkColorTransferFunction.h.

void vtkColorTransferFunction::SetNanColorRGBA ( double  rgba[4])
inline

Set the RGBA color to use when a NaN (not a number) is encountered.

This is an RGBA 4-tuple color of doubles in the range [0,1].

Definition at line 270 of file vtkColorTransferFunction.h.

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 ( vtkTypeBool  )
virtual

Set whether the below range color should be used.

virtual vtkTypeBool 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 ( vtkTypeBool  )
virtual

Set whether the below range color should be used.

virtual vtkTypeBool 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.

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

Map a set of scalars through the lookup table.

Reimplemented from vtkScalarsToColors.

Reimplemented in vtkDiscretizableColorTransferFunction.

virtual void vtkColorTransferFunction::SetAllowDuplicateScalars ( vtkTypeBool  )
virtual

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

virtual vtkTypeBool 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).

vtkIdType vtkColorTransferFunction::GetNumberOfAvailableColors ( )
overridevirtual

Get the number of available colors for mapping to.

Reimplemented from vtkScalarsToColors.

Reimplemented in vtkDiscretizableColorTransferFunction.

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

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.

int vtkColorTransferFunction::EstimateMinNumberOfSamples ( double const &  x1,
double const &  x2 
)

Estimates the minimum size of a table such that it would correctly sample this function.

The returned value should be passed as parameter 'n' when calling GetTable().

void vtkColorTransferFunction::SetRange ( double  ,
double   
)
inlineoverrideprotectedvirtual

Set the range of scalars being mapped.

This method has no functionality in this subclass of vtkScalarsToColors.

Reimplemented from vtkScalarsToColors.

Definition at line 459 of file vtkColorTransferFunction.h.

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

Sets/Gets the range of scalars that will be mapped.

Reimplemented from vtkScalarsToColors.

Definition at line 460 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.

double vtkColorTransferFunction::FindMinimumXDistance ( )
protected

Traverses the nodes to find the minimum distance.

Assumes nodes are sorted.

Member Data Documentation

vtkColorTransferFunctionInternals* vtkColorTransferFunction::Internal
protected

Definition at line 371 of file vtkColorTransferFunction.h.

vtkTypeBool 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 379 of file vtkColorTransferFunction.h.

int vtkColorTransferFunction::ColorSpace
protected

The color space in which interpolation is performed.

Definition at line 384 of file vtkColorTransferFunction.h.

vtkTypeBool vtkColorTransferFunction::HSVWrap
protected

Specify if HSV is wrap or not.

Definition at line 389 of file vtkColorTransferFunction.h.

int vtkColorTransferFunction::Scale
protected

The color interpolation scale (linear or logarithmic).

Definition at line 394 of file vtkColorTransferFunction.h.

double vtkColorTransferFunction::NanColor[3]
protected

The color to use for not-a-number.

Definition at line 399 of file vtkColorTransferFunction.h.

double vtkColorTransferFunction::NanOpacity
protected

The opacity to use for not-a-number.

Definition at line 404 of file vtkColorTransferFunction.h.

double vtkColorTransferFunction::BelowRangeColor[3]
protected

The below-range color.

Definition at line 409 of file vtkColorTransferFunction.h.

vtkTypeBool vtkColorTransferFunction::UseBelowRangeColor
protected

Flag indicating whether below-range color should be used.

Definition at line 414 of file vtkColorTransferFunction.h.

double vtkColorTransferFunction::AboveRangeColor[3]
protected

The above-range color.

Definition at line 419 of file vtkColorTransferFunction.h.

vtkTypeBool vtkColorTransferFunction::UseAboveRangeColor
protected

Flag indicating whether below-range color should be used.

Definition at line 424 of file vtkColorTransferFunction.h.

double* vtkColorTransferFunction::Function
protected

Temporary array to store data from the nodes.

Definition at line 429 of file vtkColorTransferFunction.h.

double vtkColorTransferFunction::Range[2]
protected

The min and max node locations.

Definition at line 434 of file vtkColorTransferFunction.h.

unsigned char vtkColorTransferFunction::UnsignedCharRGBAValue[4]
protected

Temporary storage for an evaluated color (0 to 255 RGBA A=255)

Definition at line 439 of file vtkColorTransferFunction.h.

vtkTypeBool vtkColorTransferFunction::AllowDuplicateScalars
protected

If on, the same scalar value may have more than one node assigned to it.

Definition at line 444 of file vtkColorTransferFunction.h.

vtkTimeStamp vtkColorTransferFunction::BuildTime
protected

Definition at line 446 of file vtkColorTransferFunction.h.

unsigned char* vtkColorTransferFunction::Table
protected

Definition at line 447 of file vtkColorTransferFunction.h.

int vtkColorTransferFunction::TableSize
protected

Temporary storage for the size of the table.

Set in the method GetTable() and queried in GetNumberOfAvailableColors().

Definition at line 453 of file vtkColorTransferFunction.h.


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