Go to the documentation of this file.
36 #ifndef vtkColorTransferFunction_h
37 #define vtkColorTransferFunction_h
39 #include "vtkRenderingCoreModule.h"
42 class vtkColorTransferFunctionInternals;
47 #define VTK_CTF_DIVERGING 3
48 #define VTK_CTF_LAB_CIEDE2000 4
49 #define VTK_CTF_STEP 5
51 #define VTK_CTF_LINEAR 0
52 #define VTK_CTF_LOG10 1
80 int AddRGBPoint(
double x,
double r,
double g,
double b,
double midpoint,
double sharpness);
82 int AddHSVPoint(
double x,
double h,
double s,
double v,
double midpoint,
double sharpness);
151 arg1 = this->Range[0];
152 arg2 = this->Range[1];
171 void GetTable(
double x1,
double x2,
int n,
double* table);
172 void GetTable(
double x1,
double x2,
int n,
float* table);
173 const unsigned char*
GetTable(
double x1,
double x2,
int n);
221 vtkGetMacro(ColorSpace,
int);
233 vtkSetMacro(Scale,
int);
236 vtkGetMacro(Scale,
int);
245 vtkSetVector3Macro(NanColor,
double);
246 vtkGetVector3Macro(NanColor,
double);
254 vtkSetMacro(NanOpacity,
double);
255 vtkGetMacro(NanOpacity,
double);
266 this->SetNanColor(r, g, b);
267 this->SetNanOpacity(a);
272 this->SetNanColorRGBA(rgba[0], rgba[1], rgba[2], rgba[3]);
281 vtkSetVector3Macro(BelowRangeColor,
double);
282 vtkGetVector3Macro(BelowRangeColor,
double);
299 vtkSetVector3Macro(AboveRangeColor,
double);
300 vtkGetVector3Macro(AboveRangeColor,
double);
332 unsigned char* output,
336 int outputIncrement)
override;
409 double BelowRangeColor[3];
419 double AboveRangeColor[3];
439 unsigned char UnsignedCharRGBAValue[4];
~vtkColorTransferFunction() override
void SetColorSpaceToStep()
virtual void GetRange(double _arg[2])
double * GetColor(double x)
Returns an RGB color for the specified scalar value.
void SetNanColorRGBA(double rgba[4])
double * GetDataPointer()
Returns a pointer to an array of all node values in an interleaved array with the layout [X1,...
vtkTypeBool UseBelowRangeColor
Flag indicating whether below-range color should be used.
void SetRange(double, double) override
Set the range of scalars being mapped.
int AddHSVPoint(double x, double h, double s, double v)
vtkTypeBool AllowDuplicateScalars
If on, the same scalar value may have more than one node assigned to it.
void SetRange(const double rng[2]) override
static vtkColorTransferFunction * New()
void GetTable(double x1, double x2, int n, float *table)
vtkColorTransferFunction()
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.
record modification and/or execution time
const unsigned char * GetTable(double x1, double x2, int n)
void SetColorSpaceToDiverging()
void MovePoint(double oldX, double newX)
Moves point from oldX to newX.
vtkColorTransferFunctionInternals * Internal
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,...
void FillFromDataPointer(int n, double *ptr)
Defines the nodes from an array ptr with the layout [X1, R1, G1, B1, X2, R2, G2, B2,...
bool UpdateRange()
Returns true if the range has been changed.
int Scale
The color interpolation scale (linear or logarithmic).
int GetSize()
How many nodes define this function?
void BuildFunctionFromTable(double x1, double x2, int size, double *table)
Construct a color transfer function from a table.
double NanOpacity
The opacity to use for not-a-number.
Defines a transfer function for mapping a property to an RGB color value.
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)...
void SetColorSpaceToLab()
int AddRGBPoint(double x, double r, double g, double b, double midpoint, double sharpness)
double GetRedValue(double x)
Get the color components individually.
void GetIndexedColor(vtkIdType idx, double rgba[4]) override
Return a color given an integer index.
double GetBlueValue(double x)
#define VTK_CTF_LAB_CIEDE2000
vtkIdType GetNumberOfAvailableColors() override
Get the number of available colors for mapping to.
#define VTK_SIZEHINT(...)
void SetColorSpaceToRGB()
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.
a simple class to control print indentation
int AddHSVPoint(double x, double h, double s, double v, double midpoint, double sharpness)
int TableSize
Temporary storage for the size of the table.
vtkTypeBool UseAboveRangeColor
Flag indicating whether below-range color should be used.
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.
Superclass for mapping scalar values to colors.
virtual void GetColor(double v, double rgb[3])
Map one value through the lookup table and store the color as an RGB array of doubles between 0 and 1...
void RemoveAllPoints()
Remove all points.
double GetGreenValue(double x)
void DeepCopy(vtkScalarsToColors *f) override
Copy the contents from another object.
int ColorSpace
The color space in which interpolation is performed.
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...
double * GetRange() override
Returns min and max position of all function points.
vtkTypeBool Clamping
Determines the function value outside of defined points Zero = always return 0.0 outside of defined p...
const unsigned char * MapValue(double v) override
Map one value through the lookup table.
int RemovePoint(double x)
void SetColorSpaceToHSV()
int SetNodeValue(int index, double val[6])
int GetNodeValue(int index, double val[6])
For the node specified by index, set/get the location (X), R, G, and B values, midpoint,...
void SortAndUpdateRange()
Internal method to sort the vector and update the Range whenever a node is added, edited or removed I...
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.
int EstimateMinNumberOfSamples(double const &x1, double const &x2)
Estimates the minimum size of a table such that it would correctly sample this function.
void SetColorSpaceToLabCIEDE2000()
virtual void GetRange(double &arg1, double &arg2)
double * Function
Temporary array to store data from the nodes.
#define VTK_CTF_DIVERGING
void ShallowCopy(vtkColorTransferFunction *f)
void AddHSVSegment(double x1, double h1, double s1, double v1, double x2, double h2, double s2, double v2)
void PrintSelf(ostream &os, vtkIndent indent) override
Print method for vtkColorTransferFunction.
vtkTypeBool HSVWrap
Specify if HSV is wrap or not.
double FindMinimumXDistance()
Traverses the nodes to find the minimum distance.