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

vtkColorTransferFunction - Defines a transfer function for mapping a property to an RGB color value. More...

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

List of all members.

Public Member Functions

 vtkColorTransferFunction (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkColorTransferFunction ()
 *Undocumented Block
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. See the description of class vtkPiecewiseFunction for an explanation of midpoint and sharpness.
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. See the description of class vtkPiecewiseFunction for an explanation of midpoint and sharpness.
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.
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. See the description of class vtkPiecewiseFunction for an explanation of midpoint and sharpness.
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. See the description of class vtkPiecewiseFunction for an explanation of midpoint and sharpness.
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.
int AdjustRange (IntPtr range)
 Remove all points out of the new range, and make sure there is a point at each end of that range. Return 1 on success, 0 otherwise.
virtual void AllowDuplicateScalarsOff ()
 Toggle whether to allow duplicate scalar values in the color transfer function (off by default).
virtual void AllowDuplicateScalarsOn ()
 Toggle whether to allow duplicate scalar values in the color transfer function (off by default).
void BuildFunctionFromTable (double x1, double x2, int size, IntPtr table)
 Construct a color transfer function from a table. Function range is is set to [x1, x2], each function size is set to size, and function points are regularly spaced between x1 and x2. Parameter "table" is assumed to be a block of memory of size [3*size].
virtual void ClampingOff ()
 Sets and gets the clamping value for this transfer function.
virtual void ClampingOn ()
 Sets and gets the clamping value for this transfer function.
void DeepCopy (vtkColorTransferFunction f)
 *Undocumented Block
void FillFromDataPointer (int arg0, IntPtr arg1)
 Returns a list of all nodes Fills from a pointer to data stored in a similar list of nodes.
virtual int GetAllowDuplicateScalars ()
 Toggle whether to allow duplicate scalar values in the color transfer function (off by default).
double GetBlueValue (double x)
 Get the color components individually.
virtual int GetClamping ()
 Sets and gets the clamping value for this transfer function.
virtual int GetClampingMaxValue ()
 Sets and gets the clamping value for this transfer function.
virtual int GetClampingMinValue ()
 Sets and gets the clamping value for this transfer function.
new double[] GetColor (double x)
 Returns an RGB color for the specified scalar value.
override void GetColor (double x, IntPtr rgb)
 Returns an RGB color for the specified scalar value.
virtual int GetColorSpace ()
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.
virtual int GetColorSpaceMaxValue ()
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.
virtual int GetColorSpaceMinValue ()
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.
IntPtr GetDataPointer ()
 Returns a list of all nodes Fills from a pointer to data stored in a similar list of nodes.
double GetGreenValue (double x)
 Get the color components individually.
virtual int GetHSVWrap ()
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.
virtual double[] GetNanColor ()
 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].
virtual void GetNanColor (ref double _arg1, ref double _arg2, ref double _arg3)
 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].
virtual void GetNanColor (IntPtr _arg)
 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].
int GetNodeValue (int index, IntPtr val)
 For the node specified by index, set/get the location (X), R, G, and B values, midpoint, and sharpness values at the node.
override int GetNumberOfAvailableColors ()
 Get the number of available colors for mapping to.
override double[] GetRange ()
 Returns min and max position of all function points.
virtual void GetRange (ref double _arg1, ref double _arg2)
 Returns min and max position of all function points.
virtual void GetRange (IntPtr _arg)
 Returns min and max position of all function points.
double GetRedValue (double x)
 Get the color components individually.
virtual int GetScale ()
 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.
int GetSize ()
 How many points are there defining this function?
void GetTable (double x1, double x2, int n, IntPtr table)
 Fills in a table of n function values between x1 and x2.
IntPtr GetTable (double x1, double x2, int n)
 Fills in a table of n function values between x1 and x2.
virtual void HSVWrapOff ()
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.
virtual void HSVWrapOn ()
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.
override int IsA (string type)
 *Undocumented Block
override void MapScalarsThroughTable2 (IntPtr input, IntPtr output, int inputDataType, int numberOfValues, int inputIncrement, int outputIncrement)
 map a set of scalars through the lookup table
override IntPtr MapValue (double v)
 Map one value through the lookup table.
new vtkColorTransferFunction NewInstance ()
 *Undocumented Block
void RemoveAllPoints ()
 Remove all points.
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. See the description of class vtkPiecewiseFunction for an explanation of midpoint and sharpness.
virtual void SetAllowDuplicateScalars (int _arg)
 Toggle whether to allow duplicate scalar values in the color transfer function (off by default).
virtual void SetClamping (int _arg)
 Sets and gets the clamping value for this transfer function.
virtual void SetColorSpace (int _arg)
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.
void SetColorSpaceToDiverging ()
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.
void SetColorSpaceToHSV ()
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.
void SetColorSpaceToLab ()
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.
void SetColorSpaceToRGB ()
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.
virtual void SetHSVWrap (int _arg)
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.
virtual void SetNanColor (double _arg1, double _arg2, double _arg3)
 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].
virtual void SetNanColor (IntPtr _arg)
 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].
int SetNodeValue (int index, IntPtr val)
 For the node specified by index, set/get the location (X), R, G, and B values, midpoint, and sharpness values at the node.
virtual void SetScale (int _arg)
 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 SetScaleToLinear ()
 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 SetScaleToLog10 ()
 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 ShallowCopy (vtkColorTransferFunction f)
 *Undocumented Block
- Public Member Functions inherited from Kitware.VTK.vtkScalarsToColors
 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.
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 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 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.
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 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.
- Public Member Functions inherited from Kitware.VTK.vtkObject
 vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObject ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint AddObserver (uint arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
uint AddObserver (string arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void DebugOff ()
 Turn debugging output off.
virtual void DebugOn ()
 Turn debugging output on.
vtkCommand GetCommand (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
byte GetDebug ()
 Get the value of the debug flag.
virtual uint GetMTime ()
 Return this object's modified time.
int HasObserver (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void Modified ()
 Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void RemoveAllObservers ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (vtkCommand arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void SetDebug (byte debugFlag)
 Set the value of the debug flag. A non-zero value turns debugging on.
override string ToString ()
 Returns the result of calling vtkObject::Print as a C# string.
delegate void vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
 Generic signature for all vtkObject events.
void RemoveAllHandlersForAllEvents ()
 Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
- Public Member Functions inherited from Kitware.VTK.vtkObjectBase
 vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObjectBase ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void Register (vtkObjectBase o)
 Increase the reference count (mark as used by another object).
virtual void FastDelete ()
 Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string GetClassName ()
 Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int arg0)
 Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions

static new vtkColorTransferFunction New ()
 *Undocumented Block
static new int IsTypeOf (string type)
 *Undocumented Block
static new vtkColorTransferFunction SafeDownCast (vtkObjectBase o)
 *Undocumented Block

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkColorTransferFunction"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkScalarsToColors
- Public Attributes inherited from Kitware.VTK.vtkObject
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
- Public Attributes inherited from Kitware.VTK.WrappedObject
const string vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
 Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
 Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
 Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
 Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
 Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
 Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
 Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
 Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
 Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
 Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
 Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
 Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
 Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
 Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
 Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes

static new readonly string MRClassNameKey = "24vtkColorTransferFunction"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkScalarsToColors
- Static Public Attributes inherited from Kitware.VTK.vtkObject
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

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.

Static Private Member Functions

static vtkColorTransferFunction ()
 Automatically generated type registration mechanics.

Additional Inherited Members

- Public Types inherited from Kitware.VTK.vtkScalarsToColors
enum  VectorModes { COMPONENT = 1, MAGNITUDE = 0 }
 Change mode that maps vectors by magnitude vs. component. More...

Detailed Description

vtkColorTransferFunction - Defines a transfer function for mapping a property to an RGB color value.


Constructor & Destructor Documentation

static Kitware.VTK.vtkColorTransferFunction.vtkColorTransferFunction ( )
staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkColorTransferFunction.vtkColorTransferFunction ( )

*Undocumented Block


Member Function Documentation

int Kitware.VTK.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 Kitware.VTK.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.

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

int Kitware.VTK.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 Kitware.VTK.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.

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

int Kitware.VTK.vtkColorTransferFunction.AdjustRange ( IntPtr  range)

Remove all points out of the new range, and make sure there is a point at each end of that range. Return 1 on success, 0 otherwise.

virtual void Kitware.VTK.vtkColorTransferFunction.AllowDuplicateScalarsOff ( )
virtual

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

virtual void Kitware.VTK.vtkColorTransferFunction.AllowDuplicateScalarsOn ( )
virtual

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

void Kitware.VTK.vtkColorTransferFunction.BuildFunctionFromTable ( double  x1,
double  x2,
int  size,
IntPtr  table 
)

Construct a color transfer function from a table. Function range is is set to [x1, x2], each function size is set to size, and function points are regularly spaced between x1 and x2. Parameter "table" is assumed to be a block of memory of size [3*size].

virtual void Kitware.VTK.vtkColorTransferFunction.ClampingOff ( )
virtual

Sets and gets the clamping value for this transfer function.

virtual void Kitware.VTK.vtkColorTransferFunction.ClampingOn ( )
virtual

Sets and gets the clamping value for this transfer function.

void Kitware.VTK.vtkColorTransferFunction.DeepCopy ( vtkColorTransferFunction  f)

*Undocumented Block

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

Reimplemented in Kitware.VTK.vtkDiscretizableColorTransferFunction.

void Kitware.VTK.vtkColorTransferFunction.FillFromDataPointer ( int  arg0,
IntPtr  arg1 
)

Returns a list of all nodes Fills from a pointer to data stored in a similar list of nodes.

virtual int Kitware.VTK.vtkColorTransferFunction.GetAllowDuplicateScalars ( )
virtual

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

double Kitware.VTK.vtkColorTransferFunction.GetBlueValue ( double  x)

Get the color components individually.

virtual int Kitware.VTK.vtkColorTransferFunction.GetClamping ( )
virtual

Sets and gets the clamping value for this transfer function.

virtual int Kitware.VTK.vtkColorTransferFunction.GetClampingMaxValue ( )
virtual

Sets and gets the clamping value for this transfer function.

virtual int Kitware.VTK.vtkColorTransferFunction.GetClampingMinValue ( )
virtual

Sets and gets the clamping value for this transfer function.

new double [] Kitware.VTK.vtkColorTransferFunction.GetColor ( double  x)

Returns an RGB color for the specified scalar value.

Reimplemented from Kitware.VTK.vtkScalarsToColors.

override void Kitware.VTK.vtkColorTransferFunction.GetColor ( double  x,
IntPtr  rgb 
)
virtual

Returns an RGB color for the specified scalar value.

Reimplemented from Kitware.VTK.vtkScalarsToColors.

Reimplemented in Kitware.VTK.vtkDiscretizableColorTransferFunction.

virtual int Kitware.VTK.vtkColorTransferFunction.GetColorSpace ( )
virtual

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

virtual int Kitware.VTK.vtkColorTransferFunction.GetColorSpaceMaxValue ( )
virtual

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

virtual int Kitware.VTK.vtkColorTransferFunction.GetColorSpaceMinValue ( )
virtual

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

IntPtr Kitware.VTK.vtkColorTransferFunction.GetDataPointer ( )

Returns a list of all nodes Fills from a pointer to data stored in a similar list of nodes.

double Kitware.VTK.vtkColorTransferFunction.GetGreenValue ( double  x)

Get the color components individually.

virtual int Kitware.VTK.vtkColorTransferFunction.GetHSVWrap ( )
virtual

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

virtual double [] Kitware.VTK.vtkColorTransferFunction.GetNanColor ( )
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].

virtual void Kitware.VTK.vtkColorTransferFunction.GetNanColor ( ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
)
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].

virtual void Kitware.VTK.vtkColorTransferFunction.GetNanColor ( IntPtr  _arg)
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].

int Kitware.VTK.vtkColorTransferFunction.GetNodeValue ( int  index,
IntPtr  val 
)

For the node specified by index, set/get the location (X), R, G, and B values, midpoint, and sharpness values at the node.

override int Kitware.VTK.vtkColorTransferFunction.GetNumberOfAvailableColors ( )
virtual

Get the number of available colors for mapping to.

Reimplemented from Kitware.VTK.vtkScalarsToColors.

Reimplemented in Kitware.VTK.vtkDiscretizableColorTransferFunction.

override double [] Kitware.VTK.vtkColorTransferFunction.GetRange ( )
virtual

Returns min and max position of all function points.

Reimplemented from Kitware.VTK.vtkScalarsToColors.

virtual void Kitware.VTK.vtkColorTransferFunction.GetRange ( ref double  _arg1,
ref double  _arg2 
)
virtual

Returns min and max position of all function points.

virtual void Kitware.VTK.vtkColorTransferFunction.GetRange ( IntPtr  _arg)
virtual

Returns min and max position of all function points.

double Kitware.VTK.vtkColorTransferFunction.GetRedValue ( double  x)

Get the color components individually.

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

int Kitware.VTK.vtkColorTransferFunction.GetSize ( )

How many points are there defining this function?

void Kitware.VTK.vtkColorTransferFunction.GetTable ( double  x1,
double  x2,
int  n,
IntPtr  table 
)

Fills in a table of n function values between x1 and x2.

IntPtr Kitware.VTK.vtkColorTransferFunction.GetTable ( double  x1,
double  x2,
int  n 
)

Fills in a table of n function values between x1 and x2.

virtual void Kitware.VTK.vtkColorTransferFunction.HSVWrapOff ( )
virtual

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

virtual void Kitware.VTK.vtkColorTransferFunction.HSVWrapOn ( )
virtual

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

override int Kitware.VTK.vtkColorTransferFunction.IsA ( string  type)
virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkScalarsToColors.

Reimplemented in Kitware.VTK.vtkDiscretizableColorTransferFunction.

static new int Kitware.VTK.vtkColorTransferFunction.IsTypeOf ( string  type)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkScalarsToColors.

Reimplemented in Kitware.VTK.vtkDiscretizableColorTransferFunction.

override void Kitware.VTK.vtkColorTransferFunction.MapScalarsThroughTable2 ( IntPtr  input,
IntPtr  output,
int  inputDataType,
int  numberOfValues,
int  inputIncrement,
int  outputIncrement 
)
virtual

map a set of scalars through the lookup table

Reimplemented from Kitware.VTK.vtkScalarsToColors.

override IntPtr Kitware.VTK.vtkColorTransferFunction.MapValue ( double  v)
virtual

Map one value through the lookup table.

Reimplemented from Kitware.VTK.vtkScalarsToColors.

Reimplemented in Kitware.VTK.vtkDiscretizableColorTransferFunction.

static new vtkColorTransferFunction Kitware.VTK.vtkColorTransferFunction.New ( )
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkDiscretizableColorTransferFunction.

new vtkColorTransferFunction Kitware.VTK.vtkColorTransferFunction.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkScalarsToColors.

Reimplemented in Kitware.VTK.vtkDiscretizableColorTransferFunction.

void Kitware.VTK.vtkColorTransferFunction.RemoveAllPoints ( )

Remove all points.

int Kitware.VTK.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.

static new vtkColorTransferFunction Kitware.VTK.vtkColorTransferFunction.SafeDownCast ( vtkObjectBase  o)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkScalarsToColors.

Reimplemented in Kitware.VTK.vtkDiscretizableColorTransferFunction.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkColorTransferFunction.SetAllowDuplicateScalars ( int  _arg)
virtual

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

virtual void Kitware.VTK.vtkColorTransferFunction.SetClamping ( int  _arg)
virtual

Sets and gets the clamping value for this transfer function.

virtual void Kitware.VTK.vtkColorTransferFunction.SetColorSpace ( int  _arg)
virtual

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

void Kitware.VTK.vtkColorTransferFunction.SetColorSpaceToDiverging ( )

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

void Kitware.VTK.vtkColorTransferFunction.SetColorSpaceToHSV ( )

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

void Kitware.VTK.vtkColorTransferFunction.SetColorSpaceToLab ( )

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

void Kitware.VTK.vtkColorTransferFunction.SetColorSpaceToRGB ( )

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

virtual void Kitware.VTK.vtkColorTransferFunction.SetHSVWrap ( int  _arg)
virtual

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, or Diverging. 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). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors.

virtual void Kitware.VTK.vtkColorTransferFunction.SetNanColor ( double  _arg1,
double  _arg2,
double  _arg3 
)
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].

Reimplemented in Kitware.VTK.vtkDiscretizableColorTransferFunction.

virtual void Kitware.VTK.vtkColorTransferFunction.SetNanColor ( IntPtr  _arg)
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].

Reimplemented in Kitware.VTK.vtkDiscretizableColorTransferFunction.

int Kitware.VTK.vtkColorTransferFunction.SetNodeValue ( int  index,
IntPtr  val 
)

For the node specified by index, set/get the location (X), R, G, and B values, midpoint, and sharpness values at the node.

virtual void Kitware.VTK.vtkColorTransferFunction.SetScale ( int  _arg)
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 Kitware.VTK.vtkColorTransferFunction.SetScaleToLinear ( )

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 Kitware.VTK.vtkColorTransferFunction.SetScaleToLog10 ( )

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 Kitware.VTK.vtkColorTransferFunction.ShallowCopy ( vtkColorTransferFunction  f)

*Undocumented Block


Member Data Documentation

new readonly string Kitware.VTK.vtkColorTransferFunction.MRClassNameKey = "24vtkColorTransferFunction"
static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkScalarsToColors.

Reimplemented in Kitware.VTK.vtkDiscretizableColorTransferFunction.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkScalarsToColors.

Reimplemented in Kitware.VTK.vtkDiscretizableColorTransferFunction.


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