ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkDiscretizableColorTransferFunction Class Reference

vtkDiscretizableColorTransferFunction - a combination of vtkColorTransferFunction and vtkLookupTable. More...

Inheritance diagram for Kitware.VTK.vtkDiscretizableColorTransferFunction:
[legend]
Collaboration diagram for Kitware.VTK.vtkDiscretizableColorTransferFunction:
[legend]

List of all members.

Public Member Functions

 vtkDiscretizableColorTransferFunction (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkDiscretizableColorTransferFunction ()
 Undocumented Block.
override void Build ()
 Generate discretized lookup table, if applicable. This method must be called after changes to the ColorTransferFunction otherwise the discretized version will be inconsitent with the non-discretized one.
virtual void DiscretizeOff ()
 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 DiscretizeOn ()
 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.
override void GetColor (double v, IntPtr rgb)
 Map one value through the lookup table and return the color as an RGB array of doubles between 0 and 1.
virtual int GetDiscretize ()
 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.
override int GetNumberOfAvailableColors ()
 Get the number of available colors for mapping to.
virtual int GetNumberOfValues ()
 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 256.
IntPtr GetRGBPoints ()
 Returns the (x, r, g, b) values as an array.
virtual int GetUseLogScale ()
 Get/Set if log scale must be used while mapping scalars to colors. The default is 0.
override int IsA (string type)
 Undocumented Block.
override vtkUnsignedCharArray MapScalars (vtkDataArray scalars, int colorMode, int component)
 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.
override IntPtr MapValue (double v)
 Map one value through the lookup table and return a color defined as a RGBA unsigned char tuple (4 bytes).
new
vtkDiscretizableColorTransferFunction 
NewInstance ()
 Undocumented Block.
override void SetAlpha (double alpha)
 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.
virtual void SetDiscretize (int _arg)
 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.
override void SetNanColor (double r, double g, double b)
 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.
override void SetNanColor (IntPtr rgb)
 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.
void SetNumberOfValues (int number)
 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 256.
virtual void SetUseLogScale (int useLogScale)
 Get/Set if log scale must be used while mapping scalars to colors. The default is 0.
override int UsingLogScale ()
 This should return 1 is the subclass is using log scale for mapping scalars to colors.

Static Public Member Functions

static new
vtkDiscretizableColorTransferFunction 
New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new
vtkDiscretizableColorTransferFunction 
SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkDiscretizableColorTransferFunction"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "37vtkDiscretizableColorTransferFunction"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkDiscretizableColorTransferFunction_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkDiscretizableColorTransferFunction_Build_01 (HandleRef pThis)
static internal void vtkDiscretizableColorTransferFunction_DiscretizeOff_02 (HandleRef pThis)
static internal void vtkDiscretizableColorTransferFunction_DiscretizeOn_03 (HandleRef pThis)
static internal void vtkDiscretizableColorTransferFunction_GetColor_04 (HandleRef pThis, double v, IntPtr rgb)
static internal int vtkDiscretizableColorTransferFunction_GetDiscretize_05 (HandleRef pThis)
static internal int vtkDiscretizableColorTransferFunction_GetNumberOfAvailableColors_06 (HandleRef pThis)
static internal int vtkDiscretizableColorTransferFunction_GetNumberOfValues_07 (HandleRef pThis)
static internal IntPtr vtkDiscretizableColorTransferFunction_GetRGBPoints_08 (HandleRef pThis)
static internal int vtkDiscretizableColorTransferFunction_GetUseLogScale_09 (HandleRef pThis)
static internal int vtkDiscretizableColorTransferFunction_IsA_10 (HandleRef pThis, string type)
static internal int vtkDiscretizableColorTransferFunction_IsTypeOf_11 (string type)
static internal IntPtr vtkDiscretizableColorTransferFunction_MapScalars_12 (HandleRef pThis, HandleRef scalars, int colorMode, int component, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkDiscretizableColorTransferFunction_MapValue_13 (HandleRef pThis, double v)
static internal IntPtr vtkDiscretizableColorTransferFunction_NewInstance_15 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkDiscretizableColorTransferFunction_SafeDownCast_16 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkDiscretizableColorTransferFunction_SetAlpha_17 (HandleRef pThis, double alpha)
static internal void vtkDiscretizableColorTransferFunction_SetDiscretize_18 (HandleRef pThis, int _arg)
static internal void vtkDiscretizableColorTransferFunction_SetNanColor_19 (HandleRef pThis, double r, double g, double b)
static internal void vtkDiscretizableColorTransferFunction_SetNanColor_20 (HandleRef pThis, IntPtr rgb)
static internal void vtkDiscretizableColorTransferFunction_SetNumberOfValues_21 (HandleRef pThis, int number)
static internal void vtkDiscretizableColorTransferFunction_SetUseLogScale_22 (HandleRef pThis, int useLogScale)
static internal int vtkDiscretizableColorTransferFunction_UsingLogScale_23 (HandleRef pThis)

Static Private Member Functions

static vtkDiscretizableColorTransferFunction ()
 Automatically generated type registration mechanics.

Detailed Description

vtkDiscretizableColorTransferFunction - a combination of vtkColorTransferFunction and vtkLookupTable.

Description 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.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkDiscretizableColorTransferFunction.vtkDiscretizableColorTransferFunction ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

Generate discretized lookup table, if applicable. This method must be called after changes to the ColorTransferFunction otherwise the discretized version will be inconsitent with the non-discretized one.

Reimplemented from Kitware.VTK.vtkScalarsToColors.

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.

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.

override void Kitware.VTK.vtkDiscretizableColorTransferFunction.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkColorTransferFunction.

override void Kitware.VTK.vtkDiscretizableColorTransferFunction.GetColor ( double  v,
IntPtr  rgb 
) [virtual]

Map one value through the lookup table and return the color as an RGB array of doubles between 0 and 1.

Reimplemented from Kitware.VTK.vtkColorTransferFunction.

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.

Get the number of available colors for mapping to.

Reimplemented from Kitware.VTK.vtkColorTransferFunction.

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 256.

Returns the (x, r, g, b) values as an array.

Get/Set if log scale must be used while mapping scalars to colors. The default is 0.

override int Kitware.VTK.vtkDiscretizableColorTransferFunction.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkColorTransferFunction.

static new int Kitware.VTK.vtkDiscretizableColorTransferFunction.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkColorTransferFunction.

override vtkUnsignedCharArray Kitware.VTK.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.

Reimplemented from Kitware.VTK.vtkScalarsToColors.

Here is the call graph for this function:

override IntPtr Kitware.VTK.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 Kitware.VTK.vtkColorTransferFunction.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkColorTransferFunction.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkColorTransferFunction.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkColorTransferFunction.

Here is the call graph for this function:

override void Kitware.VTK.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 Kitware.VTK.vtkScalarsToColors.

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.

override void Kitware.VTK.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 Kitware.VTK.vtkColorTransferFunction.

override void Kitware.VTK.vtkDiscretizableColorTransferFunction.SetNanColor ( IntPtr  rgb) [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 Kitware.VTK.vtkColorTransferFunction.

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 256.

virtual void Kitware.VTK.vtkDiscretizableColorTransferFunction.SetUseLogScale ( int  useLogScale) [virtual]

Get/Set if log scale must be used while mapping scalars to colors. The default is 0.

This should return 1 is the subclass is using log scale for mapping scalars to colors.

Reimplemented from Kitware.VTK.vtkScalarsToColors.

static internal void Kitware.VTK.vtkDiscretizableColorTransferFunction.vtkDiscretizableColorTransferFunction_GetColor_04 ( HandleRef  pThis,
double  v,
IntPtr  rgb 
) [private]
static internal int Kitware.VTK.vtkDiscretizableColorTransferFunction.vtkDiscretizableColorTransferFunction_IsA_10 ( HandleRef  pThis,
string  type 
) [private]
static internal IntPtr Kitware.VTK.vtkDiscretizableColorTransferFunction.vtkDiscretizableColorTransferFunction_MapScalars_12 ( HandleRef  pThis,
HandleRef  scalars,
int  colorMode,
int  component,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkDiscretizableColorTransferFunction.vtkDiscretizableColorTransferFunction_MapValue_13 ( HandleRef  pThis,
double  v 
) [private]
static internal IntPtr Kitware.VTK.vtkDiscretizableColorTransferFunction.vtkDiscretizableColorTransferFunction_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkDiscretizableColorTransferFunction.vtkDiscretizableColorTransferFunction_NewInstance_15 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkDiscretizableColorTransferFunction.vtkDiscretizableColorTransferFunction_SafeDownCast_16 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkDiscretizableColorTransferFunction.vtkDiscretizableColorTransferFunction_SetAlpha_17 ( HandleRef  pThis,
double  alpha 
) [private]
static internal void Kitware.VTK.vtkDiscretizableColorTransferFunction.vtkDiscretizableColorTransferFunction_SetNanColor_19 ( HandleRef  pThis,
double  r,
double  g,
double  b 
) [private]
static internal void Kitware.VTK.vtkDiscretizableColorTransferFunction.vtkDiscretizableColorTransferFunction_SetNanColor_20 ( HandleRef  pThis,
IntPtr  rgb 
) [private]
static internal void Kitware.VTK.vtkDiscretizableColorTransferFunction.vtkDiscretizableColorTransferFunction_SetUseLogScale_22 ( HandleRef  pThis,
int  useLogScale 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkDiscretizableColorTransferFunction.MRClassNameKey = "37vtkDiscretizableColorTransferFunction" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkColorTransferFunction.

new const string Kitware.VTK.vtkDiscretizableColorTransferFunction.MRFullTypeName = "Kitware.VTK.vtkDiscretizableColorTransferFunction"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkColorTransferFunction.


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