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.vtkScalarsToColorsPainter Class Reference

vtkScalarsToColorsPainter - painter that converts scalars to colors. It enable/disables coloring state depending on the ScalarMode. More...

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

List of all members.

Public Member Functions

 vtkScalarsToColorsPainter (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkScalarsToColorsPainter ()
 *Undocumented Block
virtual void CreateDefaultLookupTable ()
 Create default lookup table. Generally used to create one when none is available with the scalar data.
vtkScalarsToColors GetLookupTable ()
 Specify a lookup table for the mapper to use.
override vtkDataObject GetOutput ()
 Subclasses need to override this to return the output of the pipeline.
virtual int GetPremultiplyColorsWithAlpha (vtkActor actor)
 For alpha blending, we sometime premultiply the colors with alpha and change the alpha blending function. This call returns whether we are premultiplying or using the default blending function. Currently this checks if the actor has a texture, if not it returns true. TODO: It is possible to make this decision dependent on key passed down from a painter upstream that makes a more informed decision for alpha blending depending on extensions available, for example.
virtual int GetTextureSizeLimit ()
 Return the texture size limit. Subclasses need to override this to return the actual correct texture size limit. Here it is hardcoded to 1024.
override int IsA (string type)
 *Undocumented Block
new vtkScalarsToColorsPainter NewInstance ()
 *Undocumented Block
void SetLookupTable (vtkScalarsToColors lut)
 Specify a lookup table for the mapper to use.
- Public Member Functions inherited from Kitware.VTK.vtkPainter
 vtkPainter (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
override void Register (vtkObjectBase o)
 Take part in garbage collection.
virtual vtkPainter GetDelegatePainter ()
 Set/Get the painter to which this painter should propagare its draw calls.
virtual vtkInformation GetInformation ()
 Get/Set the information object associated with this painter.
virtual vtkDataObject GetInput ()
 Set the data object to paint. Currently we only support one data object per painter chain.
virtual double GetProgress ()
 Set/Get the execution progress of a process object.
virtual double GetProgressMaxValue ()
 Set/Get the execution progress of a process object.
virtual double GetProgressMinValue ()
 Set/Get the execution progress of a process object.
virtual double GetTimeToDraw ()
 Get the time required to draw the geometry last time it was rendered. Default implementation adds the current TimeToDraw with that of the delegate painter.
virtual void ReleaseGraphicsResources (vtkWindow arg0)
 Release any graphics resources that are being consumed by this painter. The parameter window could be used to determine which graphic resources to release. The call is propagated to the delegate painter, if any.
virtual void Render (vtkRenderer renderer, vtkActor actor, uint typeflags, bool forceCompileOnly)
 Generates rendering primitives of appropriate type(s). Multiple types of primitives can be requested by or-ring the primitive flags. Default implementation calls UpdateDelegatePainter() to update the deletagate painter and then calls RenderInternal(). forceCompileOnly is passed to the display list painters.
virtual void SetDelegatePainter (vtkPainter arg0)
 Set/Get the painter to which this painter should propagare its draw calls.
virtual void SetInformation (vtkInformation arg0)
 Get/Set the information object associated with this painter.
void SetInput (vtkDataObject arg0)
 Set the data object to paint. Currently we only support one data object per painter chain.
virtual void SetProgress (double _arg)
 Set/Get the execution progress of a process object.
virtual void UpdateBounds (IntPtr bounds)
 Expand or shrink the estimated bounds of the object based on the geometric transformations performed in the painter. If the painter does not modify the geometry, the bounds are passed through.
- 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 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
vtkScalarsToColorsPainter 
New ()
 *Undocumented Block
static vtkInformationIntegerKey ARRAY_ACCESS_MODE ()
 Controls what data array is used to generate colors.
static vtkInformationIntegerKey ARRAY_COMPONENT ()
 Controls what data array is used to generate colors.
static vtkInformationIntegerKey ARRAY_ID ()
 Controls what data array is used to generate colors.
static vtkInformationStringKey ARRAY_NAME ()
 Controls what data array is used to generate colors.
static vtkInformationIntegerKey COLOR_MODE ()
 Control how the scalar data is mapped to colors. By default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is. Setting ColorModeToMapScalars means that all scalar data will be mapped through the lookup table.
static vtkInformationIntegerKey INTERPOLATE_SCALARS_BEFORE_MAPPING ()
 By default, vertex color is used to map colors to a surface. Colors are interpolated after being mapped. This option avoids color interpolation by using a one dimensional texture map for the colors.
static new int IsTypeOf (string type)
 *Undocumented Block
static vtkInformationObjectBaseKey LOOKUP_TABLE ()
 Specify a lookup table for the mapper to use.
static vtkInformationIntegerKey SCALAR_MATERIAL_MODE ()
 Set the light-model color mode.
static vtkInformationIntegerKey SCALAR_MODE ()
 Control how the painter works with scalar point data and cell attribute data. See vtkMapper::ScalarMode for more details.
static
vtkInformationDoubleVectorKey 
SCALAR_RANGE ()
 Specify range in terms of scalar minimum and maximum (smin,smax). These values are used to map scalars into lookup table. Has no effect when UseLookupTableScalarRange is true.
static vtkInformationIntegerKey SCALAR_VISIBILITY ()
 Turn on/off flag to control whether scalar data is used to color objects.
static new
vtkScalarsToColorsPainter 
SafeDownCast (vtkObjectBase o)
 *Undocumented Block
static vtkInformationIntegerKey USE_LOOKUP_TABLE_SCALAR_RANGE ()
 Control whether the mapper sets the lookuptable range based on its own ScalarRange, or whether it will use the LookupTable ScalarRange regardless of it's own setting. By default the Mapper is allowed to set the LookupTable range, but users who are sharing LookupTables between mappers/actors will probably wish to force the mapper to use the LookupTable unchanged.
- Static Public Member Functions inherited from Kitware.VTK.vtkPainter
static vtkInformationIntegerKey CONSERVE_MEMORY ()
 Keys used to specify control the behaviour of the painter. When on, the painter avoids using more memory than it has to. Thus, auxiliary data structures for faster rendering may not be built. Is off by default.
static vtkInformationIntegerKey HIGH_QUALITY ()
 Keys used to specify control the behaviour of the painter. When off, the painter may make approximations that will make the rendering go faster but may degrade image quality. Is on by default.
static vtkInformationIntegerKey STATIC_DATA ()
 Keys used to specify control the behaviour of the painter. When on, the painter assumes that the poly data changes infrequently. It is thus more likely to take time and memory to build auxiliary data structures for faster frame rates. Is off by default.
- Static Public Member Functions inherited from Kitware.VTK.vtkObject
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. It allows the debugger to break on error.
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkScalarsToColorsPainter"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkPainter
- 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 = "25vtkScalarsToColorsPainter"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkPainter
- 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 vtkScalarsToColorsPainter ()
 Automatically generated type registration mechanics.

Additional Inherited Members

- Public Types inherited from Kitware.VTK.vtkPainter
enum  LINES_WrapperEnum { LINES = 2, POLYS = 4, STRIPS = 8, VERTS = 1 }
 Take part in garbage collection. More...

Detailed Description

vtkScalarsToColorsPainter - painter that converts scalars to colors. It enable/disables coloring state depending on the ScalarMode.

Description This is a painter that converts scalars to colors. It enable/disables coloring state depending on the ScalarMode. This painter is composite dataset enabled.


Constructor & Destructor Documentation

static Kitware.VTK.vtkScalarsToColorsPainter.vtkScalarsToColorsPainter ( )
staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkScalarsToColorsPainter.vtkScalarsToColorsPainter ( )

*Undocumented Block


Member Function Documentation

static vtkInformationIntegerKey Kitware.VTK.vtkScalarsToColorsPainter.ARRAY_ACCESS_MODE ( )
static

Controls what data array is used to generate colors.

Here is the call graph for this function:

static vtkInformationIntegerKey Kitware.VTK.vtkScalarsToColorsPainter.ARRAY_COMPONENT ( )
static

Controls what data array is used to generate colors.

Here is the call graph for this function:

static vtkInformationIntegerKey Kitware.VTK.vtkScalarsToColorsPainter.ARRAY_ID ( )
static

Controls what data array is used to generate colors.

Here is the call graph for this function:

static vtkInformationStringKey Kitware.VTK.vtkScalarsToColorsPainter.ARRAY_NAME ( )
static

Controls what data array is used to generate colors.

Here is the call graph for this function:

static vtkInformationIntegerKey Kitware.VTK.vtkScalarsToColorsPainter.COLOR_MODE ( )
static

Control how the scalar data is mapped to colors. By default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is. Setting ColorModeToMapScalars means that all scalar data will be mapped through the lookup table.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkScalarsToColorsPainter.CreateDefaultLookupTable ( )
virtual

Create default lookup table. Generally used to create one when none is available with the scalar data.

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

Reimplemented in Kitware.VTK.vtkOpenGLScalarsToColorsPainter.

vtkScalarsToColors Kitware.VTK.vtkScalarsToColorsPainter.GetLookupTable ( )

Specify a lookup table for the mapper to use.

Here is the call graph for this function:

override vtkDataObject Kitware.VTK.vtkScalarsToColorsPainter.GetOutput ( )
virtual

Subclasses need to override this to return the output of the pipeline.

Reimplemented from Kitware.VTK.vtkPainter.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkScalarsToColorsPainter.GetPremultiplyColorsWithAlpha ( vtkActor  actor)
virtual

For alpha blending, we sometime premultiply the colors with alpha and change the alpha blending function. This call returns whether we are premultiplying or using the default blending function. Currently this checks if the actor has a texture, if not it returns true. TODO: It is possible to make this decision dependent on key passed down from a painter upstream that makes a more informed decision for alpha blending depending on extensions available, for example.

Reimplemented in Kitware.VTK.vtkOpenGLScalarsToColorsPainter.

virtual int Kitware.VTK.vtkScalarsToColorsPainter.GetTextureSizeLimit ( )
virtual

Return the texture size limit. Subclasses need to override this to return the actual correct texture size limit. Here it is hardcoded to 1024.

Reimplemented in Kitware.VTK.vtkOpenGLScalarsToColorsPainter.

static vtkInformationIntegerKey Kitware.VTK.vtkScalarsToColorsPainter.INTERPOLATE_SCALARS_BEFORE_MAPPING ( )
static

By default, vertex color is used to map colors to a surface. Colors are interpolated after being mapped. This option avoids color interpolation by using a one dimensional texture map for the colors.

Here is the call graph for this function:

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

*Undocumented Block

Reimplemented from Kitware.VTK.vtkPainter.

Reimplemented in Kitware.VTK.vtkOpenGLScalarsToColorsPainter.

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

*Undocumented Block

Reimplemented from Kitware.VTK.vtkPainter.

Reimplemented in Kitware.VTK.vtkOpenGLScalarsToColorsPainter.

static vtkInformationObjectBaseKey Kitware.VTK.vtkScalarsToColorsPainter.LOOKUP_TABLE ( )
static

Specify a lookup table for the mapper to use.

Here is the call graph for this function:

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

*Undocumented Block

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkOpenGLScalarsToColorsPainter.

new vtkScalarsToColorsPainter Kitware.VTK.vtkScalarsToColorsPainter.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkPainter.

Reimplemented in Kitware.VTK.vtkOpenGLScalarsToColorsPainter.

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

*Undocumented Block

Reimplemented from Kitware.VTK.vtkPainter.

Reimplemented in Kitware.VTK.vtkOpenGLScalarsToColorsPainter.

Here is the call graph for this function:

static vtkInformationIntegerKey Kitware.VTK.vtkScalarsToColorsPainter.SCALAR_MATERIAL_MODE ( )
static

Set the light-model color mode.

Here is the call graph for this function:

static vtkInformationIntegerKey Kitware.VTK.vtkScalarsToColorsPainter.SCALAR_MODE ( )
static

Control how the painter works with scalar point data and cell attribute data. See vtkMapper::ScalarMode for more details.

Here is the call graph for this function:

static vtkInformationDoubleVectorKey Kitware.VTK.vtkScalarsToColorsPainter.SCALAR_RANGE ( )
static

Specify range in terms of scalar minimum and maximum (smin,smax). These values are used to map scalars into lookup table. Has no effect when UseLookupTableScalarRange is true.

Here is the call graph for this function:

static vtkInformationIntegerKey Kitware.VTK.vtkScalarsToColorsPainter.SCALAR_VISIBILITY ( )
static

Turn on/off flag to control whether scalar data is used to color objects.

Here is the call graph for this function:

void Kitware.VTK.vtkScalarsToColorsPainter.SetLookupTable ( vtkScalarsToColors  lut)

Specify a lookup table for the mapper to use.

static vtkInformationIntegerKey Kitware.VTK.vtkScalarsToColorsPainter.USE_LOOKUP_TABLE_SCALAR_RANGE ( )
static

Control whether the mapper sets the lookuptable range based on its own ScalarRange, or whether it will use the LookupTable ScalarRange regardless of it's own setting. By default the Mapper is allowed to set the LookupTable range, but users who are sharing LookupTables between mappers/actors will probably wish to force the mapper to use the LookupTable unchanged.

Here is the call graph for this function:


Member Data Documentation

new readonly string Kitware.VTK.vtkScalarsToColorsPainter.MRClassNameKey = "25vtkScalarsToColorsPainter"
static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPainter.

Reimplemented in Kitware.VTK.vtkOpenGLScalarsToColorsPainter.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPainter.

Reimplemented in Kitware.VTK.vtkOpenGLScalarsToColorsPainter.


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