a combination of vtkColorTransferFunction and vtkLookupTable. More...
#include <vtkDiscretizableColorTransferFunction.h>
Detailed Description
a combination of vtkColorTransferFunction and vtkLookupTable.
This is a cross between a vtkColorTransferFunction and a vtkLookupTable selectively combiniting the functionality of both. NOTE: One must call Build() after making any changes to the points in the ColorTransferFunction to ensure that the discrete and non-discrete version match up.
This class behaves differently depending on how IndexedLookup is set. When true, vtkLookupTable enters a mode for representing categorical color maps. By setting IndexedLookup to true, you indicate that the annotated values are the only valid values for which entries in the color table should be returned. The colors in the lookup Table are assigned to annotated values by taking the modulus of their index in the list of annotations. IndexedLookup changes the behavior of GetIndex, which in turn changes the way MapScalars behaves; when IndexedLookup is true, MapScalars will search for scalar values in AnnotatedValues and use the resulting index to determine the color. If a scalar value is not present in AnnotatedValues, then NanColor will be used.
Definition at line 53 of file vtkDiscretizableColorTransferFunction.h.
Member Typedef Documentation
Reimplemented from vtkColorTransferFunction.
Definition at line 57 of file vtkDiscretizableColorTransferFunction.h.
Constructor & Destructor Documentation
Member Function Documentation
| static vtkDiscretizableColorTransferFunction* vtkDiscretizableColorTransferFunction::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkColorTransferFunction.
| static int vtkDiscretizableColorTransferFunction::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type 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 vtkColorTransferFunction.
| virtual int vtkDiscretizableColorTransferFunction::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 vtkColorTransferFunction.
| static vtkDiscretizableColorTransferFunction* vtkDiscretizableColorTransferFunction::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkColorTransferFunction.
| virtual vtkObjectBase* vtkDiscretizableColorTransferFunction::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkColorTransferFunction.
Reimplemented from vtkColorTransferFunction.
| void vtkDiscretizableColorTransferFunction::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Print method for vtkColorTransferFunction
Reimplemented from vtkColorTransferFunction.
| int vtkDiscretizableColorTransferFunction::IsOpaque | ( | ) | [virtual] |
Return true if all of the values defining the mapping have an opacity equal to 1. Default implementation return true.
Reimplemented from vtkScalarsToColors.
| virtual void vtkDiscretizableColorTransferFunction::Build | ( | ) | [virtual] |
Generate discretized lookup table, if applicable. This method must be called after changes to the ColorTransferFunction otherwise the discretized version will be inconsistent with the non-discretized one.
Reimplemented from vtkScalarsToColors.
| virtual void vtkDiscretizableColorTransferFunction::SetDiscretize | ( | int | ) | [virtual] |
Set if the values are to mapped after discretization. The number of discrete values is set by using SetNumberOfValues(). Not set by default, i.e. color value is determined by interpolating at the scalar value.
| virtual int vtkDiscretizableColorTransferFunction::GetDiscretize | ( | ) | [virtual] |
Set if the values are to mapped after discretization. The number of discrete values is set by using SetNumberOfValues(). Not set by default, i.e. color value is determined by interpolating at the scalar value.
| virtual void vtkDiscretizableColorTransferFunction::DiscretizeOn | ( | ) | [virtual] |
Set if the values are to mapped after discretization. The number of discrete values is set by using SetNumberOfValues(). Not set by default, i.e. color value is determined by interpolating at the scalar value.
| virtual void vtkDiscretizableColorTransferFunction::DiscretizeOff | ( | ) | [virtual] |
Set if the values are to mapped after discretization. The number of discrete values is set by using SetNumberOfValues(). Not set by default, i.e. color value is determined by interpolating at the scalar value.
| virtual void vtkDiscretizableColorTransferFunction::SetUseLogScale | ( | int | useLogScale | ) | [virtual] |
Get/Set if log scale must be used while mapping scalars to colors. The default is 0.
| virtual int vtkDiscretizableColorTransferFunction::GetUseLogScale | ( | ) | [virtual] |
Get/Set if log scale must be used while mapping scalars to colors. The default is 0.
Set the number of values i.e. colors to be generated in the discrete lookup table. This has no effect if Discretize is off. The default is
| virtual vtkIdType vtkDiscretizableColorTransferFunction::GetNumberOfValues | ( | ) | [virtual] |
Set the number of values i.e. colors to be generated in the discrete lookup table. This has no effect if Discretize is off. The default is
| virtual unsigned char* vtkDiscretizableColorTransferFunction::MapValue | ( | double | v | ) | [virtual] |
Map one value through the lookup table and return a color defined as a RGBA unsigned char tuple (4 bytes).
Reimplemented from vtkColorTransferFunction.
| virtual void vtkDiscretizableColorTransferFunction::GetColor | ( | double | v, |
| double | rgb[3] | ||
| ) | [virtual] |
Map one value through the lookup table and return the color as an RGB array of doubles between 0 and 1.
Reimplemented from vtkColorTransferFunction.
| virtual double vtkDiscretizableColorTransferFunction::GetOpacity | ( | double | v | ) | [virtual] |
Return the opacity of a given scalar.
Reimplemented from vtkScalarsToColors.
| virtual vtkUnsignedCharArray* vtkDiscretizableColorTransferFunction::MapScalars | ( | vtkDataArray * | scalars, |
| int | colorMode, | ||
| int | component | ||
| ) | [virtual] |
An internal method maps a data array into a 4-component, unsigned char RGBA array. The color mode determines the behavior of mapping. If VTK_COLOR_MODE_DEFAULT is set, then unsigned char data arrays are treated as colors (and converted to RGBA if necessary); otherwise, the data is mapped through this instance of ScalarsToColors. The offset is used for data arrays with more than one component; it indicates which component to use to do the blending. When the component argument is -1, then the this object uses its own selected technique to change a vector into a scalar to map. When IndexedLookup (inherited from vtkScalarsToColors) is true, the scalar opacity function is not used regardless of EnableOpacityMapping.
Reimplemented from vtkScalarsToColors.
Returns the (x, r, g, b) values as an array.
| virtual void vtkDiscretizableColorTransferFunction::SetAlpha | ( | double | alpha | ) | [virtual] |
Specify an additional opacity (alpha) value to blend with. Values != 1 modify the resulting color consistent with the requested form of the output. This is typically used by an actor in order to blend its opacity. Overridden to pass the alpha to the internal vtkLookupTable.
Reimplemented from vtkScalarsToColors.
| virtual void vtkDiscretizableColorTransferFunction::SetNanColor | ( | double | r, |
| double | g, | ||
| double | b | ||
| ) | [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]. Overridden to pass the NanColor to the internal vtkLookupTable.
Reimplemented from vtkColorTransferFunction.
| virtual void vtkDiscretizableColorTransferFunction::SetNanColor | ( | double | rgb[3] | ) | [inline, 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]. Overridden to pass the NanColor to the internal vtkLookupTable.
Reimplemented from vtkColorTransferFunction.
Definition at line 135 of file vtkDiscretizableColorTransferFunction.h.
| virtual int vtkDiscretizableColorTransferFunction::UsingLogScale | ( | ) | [inline, virtual] |
This should return 1 is the subclass is using log scale for mapping scalars to colors.
Reimplemented from vtkScalarsToColors.
Definition at line 144 of file vtkDiscretizableColorTransferFunction.h.
| virtual vtkIdType vtkDiscretizableColorTransferFunction::GetNumberOfAvailableColors | ( | ) | [virtual] |
Get the number of available colors for mapping to.
Reimplemented from vtkColorTransferFunction.
| virtual void vtkDiscretizableColorTransferFunction::SetScalarOpacityFunction | ( | vtkPiecewiseFunction * | function | ) | [virtual] |
Set/get the opacity function to use.
| virtual vtkPiecewiseFunction* vtkDiscretizableColorTransferFunction::GetScalarOpacityFunction | ( | ) | const [virtual] |
Set/get the opacity function to use.
| virtual void vtkDiscretizableColorTransferFunction::SetEnableOpacityMapping | ( | bool | ) | [virtual] |
Enable/disable the usage of the scalar opacity function.
| virtual bool vtkDiscretizableColorTransferFunction::GetEnableOpacityMapping | ( | ) | [virtual] |
Enable/disable the usage of the scalar opacity function.
| virtual void vtkDiscretizableColorTransferFunction::EnableOpacityMappingOn | ( | ) | [virtual] |
Enable/disable the usage of the scalar opacity function.
| virtual void vtkDiscretizableColorTransferFunction::EnableOpacityMappingOff | ( | ) | [virtual] |
Enable/disable the usage of the scalar opacity function.
| void vtkDiscretizableColorTransferFunction::ScalarOpacityFunctionModified | ( | ) | [protected] |
Called when ScalarOpacityFunction is modified.
Member Data Documentation
int vtkDiscretizableColorTransferFunction::Discretize [protected] |
Definition at line 171 of file vtkDiscretizableColorTransferFunction.h.
Definition at line 172 of file vtkDiscretizableColorTransferFunction.h.
Definition at line 174 of file vtkDiscretizableColorTransferFunction.h.
Definition at line 175 of file vtkDiscretizableColorTransferFunction.h.
Reimplemented from vtkColorTransferFunction.
Definition at line 177 of file vtkDiscretizableColorTransferFunction.h.
bool vtkDiscretizableColorTransferFunction::EnableOpacityMapping [protected] |
Definition at line 179 of file vtkDiscretizableColorTransferFunction.h.
vtkSmartPointer<vtkPiecewiseFunction> vtkDiscretizableColorTransferFunction::ScalarOpacityFunction [protected] |
Definition at line 180 of file vtkDiscretizableColorTransferFunction.h.
unsigned long vtkDiscretizableColorTransferFunction::ScalarOpacityFunctionObserverId [protected] |
Definition at line 181 of file vtkDiscretizableColorTransferFunction.h.
The documentation for this class was generated from the following file:
- dox/Rendering/Core/vtkDiscretizableColorTransferFunction.h
