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

vtkScalarsToColors - Superclass for mapping scalar values into colors More...

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

List of all members.

Public Types

enum  VectorModes { COMPONENT = 1, MAGNITUDE = 0 }
 Change mode that maps vectors by magnitude vs. component. More...

Public Member Functions

 vtkScalarsToColors (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
virtual void Build ()
 Perform any processing required (if any) before processing scalars.
virtual vtkUnsignedCharArray ConvertUnsignedCharToRGBA (vtkUnsignedCharArray colors, int numComp, int numTuples)
 An internal method used to convert a color array to RGBA. The method instantiates a vtkUnsignedCharArray and returns it. The user is responsible for managing the memory.
virtual double GetAlpha ()
 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.
virtual 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.
double[] GetColor (double v)
 Map one value through the lookup table and return the color as an RGB array of doubles between 0 and 1.
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. Returns the luminance value for the specified scalar value.
virtual int GetNumberOfAvailableColors ()
 Get the number of available colors for mapping to.
virtual double GetOpacity (double arg0)
 Map one value through the lookup table and return the alpha value (the opacity) as a double between 0 and 1.
virtual double[] GetRange ()
 Sets/Gets the range of scalars which will be mapped.
virtual int GetVectorComponent ()
 If the mapper does not select which component of a vector to map to colors, you can specify it here.
virtual int GetVectorMode ()
 Change mode that maps vectors by magnitude vs. component.
override int IsA (string type)
 Undocumented Block.
virtual int IsOpaque ()
 Return true if all of the values defining the mapping have an opacity equal to 1. Default implementation return true.
virtual 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.
void MapScalarsThroughTable (vtkDataArray scalars, IntPtr output, int outputFormat)
 Map a set of scalars through the lookup table in a single operation. The output format can be set to VTK_RGBA (4 components), VTK_RGB (3 components), VTK_LUMINANCE (1 component, greyscale), or VTK_LUMINANCE_ALPHA (2 components) If not supplied, the output format defaults to RGBA.
void MapScalarsThroughTable (vtkDataArray scalars, IntPtr output)
 Map a set of scalars through the lookup table in a single operation. The output format can be set to VTK_RGBA (4 components), VTK_RGB (3 components), VTK_LUMINANCE (1 component, greyscale), or VTK_LUMINANCE_ALPHA (2 components) If not supplied, the output format defaults to RGBA.
virtual void MapScalarsThroughTable2 (IntPtr input, IntPtr output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat)
 An internal method typically not used in applications.
virtual 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 vtkScalarsToColors NewInstance ()
 Undocumented Block.
virtual 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.
virtual void SetRange (double min, double max)
 Sets/Gets the range of scalars which will be mapped.
void SetRange (IntPtr rng)
 Sets/Gets the range of scalars which will be mapped.
virtual void SetVectorComponent (int _arg)
 If the mapper does not select which component of a vector to map to colors, you can specify it here.
virtual void SetVectorMode (int _arg)
 Change mode that maps vectors by magnitude vs. component.
void SetVectorModeToComponent ()
 Change mode that maps vectors by magnitude vs. component.
void SetVectorModeToMagnitude ()
 Change mode that maps vectors by magnitude vs. component.
virtual int UsingLogScale ()
 This should return 1 is the subclass is using log scale for mapping scalars to colors. Default implementation returns 0.

Static Public Member Functions

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

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "18vtkScalarsToColors"
 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 void vtkScalarsToColors_Build_01 (HandleRef pThis)
static internal IntPtr vtkScalarsToColors_ConvertUnsignedCharToRGBA_02 (HandleRef pThis, HandleRef colors, int numComp, int numTuples, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal double vtkScalarsToColors_GetAlpha_03 (HandleRef pThis)
static internal void vtkScalarsToColors_GetColor_04 (HandleRef pThis, double v, IntPtr rgb)
static internal IntPtr vtkScalarsToColors_GetColor_05 (HandleRef pThis, double v)
static internal double vtkScalarsToColors_GetLuminance_06 (HandleRef pThis, double x)
static internal int vtkScalarsToColors_GetNumberOfAvailableColors_07 (HandleRef pThis)
static internal double vtkScalarsToColors_GetOpacity_08 (HandleRef pThis, double arg0)
static internal IntPtr vtkScalarsToColors_GetRange_09 (HandleRef pThis)
static internal int vtkScalarsToColors_GetVectorComponent_10 (HandleRef pThis)
static internal int vtkScalarsToColors_GetVectorMode_11 (HandleRef pThis)
static internal int vtkScalarsToColors_IsA_12 (HandleRef pThis, string type)
static internal int vtkScalarsToColors_IsOpaque_13 (HandleRef pThis)
static internal int vtkScalarsToColors_IsTypeOf_14 (string type)
static internal IntPtr vtkScalarsToColors_MapScalars_15 (HandleRef pThis, HandleRef scalars, int colorMode, int component, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkScalarsToColors_MapScalarsThroughTable_16 (HandleRef pThis, HandleRef scalars, IntPtr output, int outputFormat)
static internal void vtkScalarsToColors_MapScalarsThroughTable_17 (HandleRef pThis, HandleRef scalars, IntPtr output)
static internal void vtkScalarsToColors_MapScalarsThroughTable2_18 (HandleRef pThis, IntPtr input, IntPtr output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat)
static internal IntPtr vtkScalarsToColors_MapValue_19 (HandleRef pThis, double v)
static internal IntPtr vtkScalarsToColors_NewInstance_20 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkScalarsToColors_SafeDownCast_21 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkScalarsToColors_SetAlpha_22 (HandleRef pThis, double alpha)
static internal void vtkScalarsToColors_SetRange_23 (HandleRef pThis, double min, double max)
static internal void vtkScalarsToColors_SetRange_24 (HandleRef pThis, IntPtr rng)
static internal void vtkScalarsToColors_SetVectorComponent_25 (HandleRef pThis, int _arg)
static internal void vtkScalarsToColors_SetVectorMode_26 (HandleRef pThis, int _arg)
static internal void vtkScalarsToColors_SetVectorModeToComponent_27 (HandleRef pThis)
static internal void vtkScalarsToColors_SetVectorModeToMagnitude_28 (HandleRef pThis)
static internal int vtkScalarsToColors_UsingLogScale_29 (HandleRef pThis)

Static Private Member Functions

static vtkScalarsToColors ()
 Automatically generated type registration mechanics.

Detailed Description

vtkScalarsToColors - Superclass for mapping scalar values into colors

Description vtkScalarsToColors is a general purpose superclass for objects that convert scalars to colors. This include vtkLookupTable classes and color transfer functions.

The scalars to color mapping can be augmented with an additional uniform alpha blend. This is used, for example, to blend a vtkActor's opacity with the lookup table values.

vtkLookupTable vtkColorTransferFunction


Member Enumeration Documentation

Change mode that maps vectors by magnitude vs. component.

Enumerator:
COMPONENT 

enum member

MAGNITUDE 

enum member


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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


Member Function Documentation

virtual void Kitware.VTK.vtkScalarsToColors.Build ( ) [virtual]

Perform any processing required (if any) before processing scalars.

Reimplemented in Kitware.VTK.vtkLookupTable, Kitware.VTK.vtkDiscretizableColorTransferFunction, and Kitware.VTK.vtkWindowLevelLookupTable.

virtual vtkUnsignedCharArray Kitware.VTK.vtkScalarsToColors.ConvertUnsignedCharToRGBA ( vtkUnsignedCharArray  colors,
int  numComp,
int  numTuples 
) [virtual]

An internal method used to convert a color array to RGBA. The method instantiates a vtkUnsignedCharArray and returns it. The user is responsible for managing the memory.

Here is the call graph for this function:

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

Reimplemented in Kitware.VTK.vtkLookupTable, Kitware.VTK.vtkLookupTableWithEnabling, Kitware.VTK.vtkLogLookupTable, Kitware.VTK.vtkWindowLevelLookupTable, Kitware.VTK.vtkDiscretizableColorTransferFunction, and Kitware.VTK.vtkColorTransferFunction.

virtual double Kitware.VTK.vtkScalarsToColors.GetAlpha ( ) [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.

virtual void Kitware.VTK.vtkScalarsToColors.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 in Kitware.VTK.vtkColorTransferFunction, Kitware.VTK.vtkLookupTable, and Kitware.VTK.vtkDiscretizableColorTransferFunction.

double [] Kitware.VTK.vtkScalarsToColors.GetColor ( double  v)

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

Reimplemented in Kitware.VTK.vtkColorTransferFunction.

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. Returns the luminance value for the specified scalar value.

Get the number of available colors for mapping to.

Reimplemented in Kitware.VTK.vtkColorTransferFunction, Kitware.VTK.vtkLookupTable, and Kitware.VTK.vtkDiscretizableColorTransferFunction.

virtual double Kitware.VTK.vtkScalarsToColors.GetOpacity ( double  arg0) [virtual]

Map one value through the lookup table and return the alpha value (the opacity) as a double between 0 and 1.

Reimplemented in Kitware.VTK.vtkLookupTable.

virtual double [] Kitware.VTK.vtkScalarsToColors.GetRange ( ) [virtual]

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

Reimplemented in Kitware.VTK.vtkColorTransferFunction, and Kitware.VTK.vtkLookupTable.

If the mapper does not select which component of a vector to map to colors, you can specify it here.

Change mode that maps vectors by magnitude vs. component.

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

Return true if all of the values defining the mapping have an opacity equal to 1. Default implementation return true.

Reimplemented in Kitware.VTK.vtkLookupTable.

static new int Kitware.VTK.vtkScalarsToColors.IsTypeOf ( string  type) [static]
virtual vtkUnsignedCharArray Kitware.VTK.vtkScalarsToColors.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 in Kitware.VTK.vtkDiscretizableColorTransferFunction.

Here is the call graph for this function:

void Kitware.VTK.vtkScalarsToColors.MapScalarsThroughTable ( vtkDataArray  scalars,
IntPtr  output,
int  outputFormat 
)

Map a set of scalars through the lookup table in a single operation. The output format can be set to VTK_RGBA (4 components), VTK_RGB (3 components), VTK_LUMINANCE (1 component, greyscale), or VTK_LUMINANCE_ALPHA (2 components) If not supplied, the output format defaults to RGBA.

Map a set of scalars through the lookup table in a single operation. The output format can be set to VTK_RGBA (4 components), VTK_RGB (3 components), VTK_LUMINANCE (1 component, greyscale), or VTK_LUMINANCE_ALPHA (2 components) If not supplied, the output format defaults to RGBA.

virtual void Kitware.VTK.vtkScalarsToColors.MapScalarsThroughTable2 ( IntPtr  input,
IntPtr  output,
int  inputDataType,
int  numberOfValues,
int  inputIncrement,
int  outputFormat 
) [virtual]

An internal method typically not used in applications.

Reimplemented in Kitware.VTK.vtkLookupTable, Kitware.VTK.vtkColorTransferFunction, and Kitware.VTK.vtkLookupTableWithEnabling.

virtual IntPtr Kitware.VTK.vtkScalarsToColors.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 in Kitware.VTK.vtkLookupTable, Kitware.VTK.vtkColorTransferFunction, and Kitware.VTK.vtkDiscretizableColorTransferFunction.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkColorTransferFunction, Kitware.VTK.vtkLookupTable, Kitware.VTK.vtkDiscretizableColorTransferFunction, Kitware.VTK.vtkWindowLevelLookupTable, Kitware.VTK.vtkLookupTableWithEnabling, and Kitware.VTK.vtkLogLookupTable.

Here is the call graph for this function:

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

Reimplemented in Kitware.VTK.vtkDiscretizableColorTransferFunction.

virtual void Kitware.VTK.vtkScalarsToColors.SetRange ( double  min,
double  max 
) [virtual]

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

Reimplemented in Kitware.VTK.vtkLookupTable.

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

Reimplemented in Kitware.VTK.vtkLookupTable.

virtual void Kitware.VTK.vtkScalarsToColors.SetVectorComponent ( int  _arg) [virtual]

If the mapper does not select which component of a vector to map to colors, you can specify it here.

virtual void Kitware.VTK.vtkScalarsToColors.SetVectorMode ( int  _arg) [virtual]

Change mode that maps vectors by magnitude vs. component.

Change mode that maps vectors by magnitude vs. component.

Change mode that maps vectors by magnitude vs. component.

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

Reimplemented in Kitware.VTK.vtkLookupTable, and Kitware.VTK.vtkDiscretizableColorTransferFunction.

static internal void Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_Build_01 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_ConvertUnsignedCharToRGBA_02 ( HandleRef  pThis,
HandleRef  colors,
int  numComp,
int  numTuples,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal double Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_GetAlpha_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_GetColor_04 ( HandleRef  pThis,
double  v,
IntPtr  rgb 
) [private]
static internal IntPtr Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_GetColor_05 ( HandleRef  pThis,
double  v 
) [private]
static internal double Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_GetLuminance_06 ( HandleRef  pThis,
double  x 
) [private]
static internal int Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_GetNumberOfAvailableColors_07 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_GetOpacity_08 ( HandleRef  pThis,
double  arg0 
) [private]
static internal IntPtr Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_GetRange_09 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_GetVectorComponent_10 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_GetVectorMode_11 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_IsA_12 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_IsOpaque_13 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_IsTypeOf_14 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_MapScalars_15 ( HandleRef  pThis,
HandleRef  scalars,
int  colorMode,
int  component,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_MapScalarsThroughTable2_18 ( HandleRef  pThis,
IntPtr  input,
IntPtr  output,
int  inputDataType,
int  numberOfValues,
int  inputIncrement,
int  outputFormat 
) [private]
static internal void Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_MapScalarsThroughTable_16 ( HandleRef  pThis,
HandleRef  scalars,
IntPtr  output,
int  outputFormat 
) [private]
static internal void Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_MapScalarsThroughTable_17 ( HandleRef  pThis,
HandleRef  scalars,
IntPtr  output 
) [private]
static internal IntPtr Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_MapValue_19 ( HandleRef  pThis,
double  v 
) [private]
static internal IntPtr Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_NewInstance_20 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_SafeDownCast_21 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_SetAlpha_22 ( HandleRef  pThis,
double  alpha 
) [private]
static internal void Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_SetRange_23 ( HandleRef  pThis,
double  min,
double  max 
) [private]
static internal void Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_SetRange_24 ( HandleRef  pThis,
IntPtr  rng 
) [private]
static internal void Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_SetVectorComponent_25 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_SetVectorMode_26 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_SetVectorModeToComponent_27 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_SetVectorModeToMagnitude_28 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkScalarsToColors.vtkScalarsToColors_UsingLogScale_29 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkScalarsToColors.MRClassNameKey = "18vtkScalarsToColors" [static]
new const string Kitware.VTK.vtkScalarsToColors.MRFullTypeName = "Kitware.VTK.vtkScalarsToColors"

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