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

vtkMapper - abstract class specifies interface to map data to graphics primitives More...

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

List of all members.

Public Member Functions

 vtkMapper (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
void ColorByArrayComponent (int arrayNum, int component)
 Legacy: These methods used to be used to specify the array component. It is better to do this in the lookup table.
void ColorByArrayComponent (string arrayName, int component)
 Legacy: These methods used to be used to specify the array component. It is better to do this in the lookup table.
virtual void CreateDefaultLookupTable ()
 Create default lookup table. Generally used to create one when none is available with the scalar data.
int GetArrayAccessMode ()
 Get the array name or number and component to color by.
int GetArrayComponent ()
 Get the array name or number and component to color by.
int GetArrayId ()
 Get the array name or number and component to color by.
string GetArrayName ()
 Get the array name or number and component to color by.
override double[] GetBounds ()
 Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).
override void GetBounds (IntPtr bounds)
 Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).
virtual int GetColorMode ()
 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. (Note that for multi-component scalars, the particular component to use for mapping can be specified using the SelectColorArray() method.)
string GetColorModeAsString ()
 Return the method of coloring scalar data.
virtual int GetForceCompileOnly ()
 Turn on/off flag to control whether data is rendered using immediate mode or note. Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.
virtual int GetImmediateModeRendering ()
 Turn on/off flag to control whether data is rendered using immediate mode or note. Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.
vtkDataSet GetInput ()
 This instance variable is used by vtkLODActor to determine which mapper to use. It is an estimate of the time necessary to render. Setting the render time does not modify the mapper.
vtkDataSet GetInputAsDataSet ()
 Get the input to this mapper as a vtkDataSet, instead of as a more specialized data type that the subclass may return from GetInput(). This method is provided for use in the wrapper languages, C++ programmers should use GetInput() instead.
virtual int GetInterpolateScalarsBeforeMapping ()
 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.
vtkScalarsToColors GetLookupTable ()
 Specify a lookup table for the mapper to use.
override uint GetMTime ()
 Overload standard modified time function. If lookup table is modified, then this object is modified as well.
virtual double GetRenderTime ()
 This instance variable is used by vtkLODActor to determine which mapper to use. It is an estimate of the time necessary to render. Setting the render time does not modify the mapper.
virtual int GetScalarMaterialMode ()
 Set/Get the light-model color mode.
string GetScalarMaterialModeAsString ()
 Return the light-model color mode.
virtual int GetScalarMode ()
 Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors. When ScalarMode is set to use Field Data (ScalarModeToFieldData), you must call SelectColorArray to choose the field data array to be used to color cells. In this mode, if the poly data has triangle strips, the field data is treated as the celldata for each mini-cell formed by a triangle in the strip rather than the entire strip.
string GetScalarModeAsString ()
 Return the method for obtaining scalar data.
virtual double[] GetScalarRange ()
 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.
virtual void GetScalarRange (IntPtr data)
 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.
virtual int GetScalarVisibility ()
 Turn on/off flag to control whether scalar data is used to color objects.
virtual int GetStatic ()
 Turn on/off flag to control whether the mapper's data is static. Static data means that the mapper does not propagate updates down the pipeline, greatly decreasing the time it takes to update many mappers. This should only be used if the data never changes.
virtual bool GetSupportsSelection ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection.
virtual int GetUseLookupTableScalarRange ()
 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.
virtual void ImmediateModeRenderingOff ()
 Turn on/off flag to control whether data is rendered using immediate mode or note. Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.
virtual void ImmediateModeRenderingOn ()
 Turn on/off flag to control whether data is rendered using immediate mode or note. Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.
virtual void InterpolateScalarsBeforeMappingOff ()
 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.
virtual void InterpolateScalarsBeforeMappingOn ()
 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.
override int IsA (string type)
 Undocumented Block.
vtkUnsignedCharArray MapScalars (double alpha)
 Map the scalars (if there are any scalars and ScalarVisibility is on) through the lookup table, returning an unsigned char RGBA array. This is typically done as part of the rendering process. The alpha parameter allows the blending of the scalars with an additional alpha (typically which comes from a vtkActor, etc.)
new vtkMapper NewInstance ()
 Undocumented Block.
override void ReleaseGraphicsResources (vtkWindow arg0)
 Release any graphics resources that are being consumed by this mapper. The parameter window could be used to determine which graphic resources to release.
virtual void Render (vtkRenderer ren, vtkActor a)
 Method initiates the mapping process. Generally sent by the actor as each frame is rendered.
virtual void ScalarVisibilityOff ()
 Turn on/off flag to control whether scalar data is used to color objects.
virtual void ScalarVisibilityOn ()
 Turn on/off flag to control whether scalar data is used to color objects.
void SelectColorArray (int arrayNum)
 When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods. The lookup table will decide how to convert vectors to colors.
void SelectColorArray (string arrayName)
 When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods. The lookup table will decide how to convert vectors to colors.
virtual void SetColorMode (int _arg)
 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. (Note that for multi-component scalars, the particular component to use for mapping can be specified using the SelectColorArray() method.)
void SetColorModeToDefault ()
 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. (Note that for multi-component scalars, the particular component to use for mapping can be specified using the SelectColorArray() method.)
void SetColorModeToMapScalars ()
 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. (Note that for multi-component scalars, the particular component to use for mapping can be specified using the SelectColorArray() method.)
void SetForceCompileOnly (int value)
 Turn on/off flag to control whether data is rendered using immediate mode or note. Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.
virtual void SetImmediateModeRendering (int _arg)
 Turn on/off flag to control whether data is rendered using immediate mode or note. Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.
virtual void SetInterpolateScalarsBeforeMapping (int _arg)
 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.
void SetLookupTable (vtkScalarsToColors lut)
 Specify a lookup table for the mapper to use.
void SetRenderTime (double time)
 This instance variable is used by vtkLODActor to determine which mapper to use. It is an estimate of the time necessary to render. Setting the render time does not modify the mapper.
virtual void SetScalarMaterialMode (int _arg)
 Set/Get the light-model color mode.
void SetScalarMaterialModeToAmbient ()
 Set/Get the light-model color mode.
void SetScalarMaterialModeToAmbientAndDiffuse ()
 Set/Get the light-model color mode.
void SetScalarMaterialModeToDefault ()
 Set/Get the light-model color mode.
void SetScalarMaterialModeToDiffuse ()
 Set/Get the light-model color mode.
virtual void SetScalarMode (int _arg)
 Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors. When ScalarMode is set to use Field Data (ScalarModeToFieldData), you must call SelectColorArray to choose the field data array to be used to color cells. In this mode, if the poly data has triangle strips, the field data is treated as the celldata for each mini-cell formed by a triangle in the strip rather than the entire strip.
void SetScalarModeToDefault ()
 Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors. When ScalarMode is set to use Field Data (ScalarModeToFieldData), you must call SelectColorArray to choose the field data array to be used to color cells. In this mode, if the poly data has triangle strips, the field data is treated as the celldata for each mini-cell formed by a triangle in the strip rather than the entire strip.
void SetScalarModeToUseCellData ()
 Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors. When ScalarMode is set to use Field Data (ScalarModeToFieldData), you must call SelectColorArray to choose the field data array to be used to color cells. In this mode, if the poly data has triangle strips, the field data is treated as the celldata for each mini-cell formed by a triangle in the strip rather than the entire strip.
void SetScalarModeToUseCellFieldData ()
 Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors. When ScalarMode is set to use Field Data (ScalarModeToFieldData), you must call SelectColorArray to choose the field data array to be used to color cells. In this mode, if the poly data has triangle strips, the field data is treated as the celldata for each mini-cell formed by a triangle in the strip rather than the entire strip.
void SetScalarModeToUseFieldData ()
 Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors. When ScalarMode is set to use Field Data (ScalarModeToFieldData), you must call SelectColorArray to choose the field data array to be used to color cells. In this mode, if the poly data has triangle strips, the field data is treated as the celldata for each mini-cell formed by a triangle in the strip rather than the entire strip.
void SetScalarModeToUsePointData ()
 Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors. When ScalarMode is set to use Field Data (ScalarModeToFieldData), you must call SelectColorArray to choose the field data array to be used to color cells. In this mode, if the poly data has triangle strips, the field data is treated as the celldata for each mini-cell formed by a triangle in the strip rather than the entire strip.
void SetScalarModeToUsePointFieldData ()
 Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors. When ScalarMode is set to use Field Data (ScalarModeToFieldData), you must call SelectColorArray to choose the field data array to be used to color cells. In this mode, if the poly data has triangle strips, the field data is treated as the celldata for each mini-cell formed by a triangle in the strip rather than the entire strip.
virtual void SetScalarRange (double _arg1, double _arg2)
 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.
void SetScalarRange (IntPtr _arg)
 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.
virtual void SetScalarVisibility (int _arg)
 Turn on/off flag to control whether scalar data is used to color objects.
virtual void SetStatic (int _arg)
 Turn on/off flag to control whether the mapper's data is static. Static data means that the mapper does not propagate updates down the pipeline, greatly decreasing the time it takes to update many mappers. This should only be used if the data never changes.
virtual void SetUseLookupTableScalarRange (int _arg)
 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.
new void ShallowCopy (vtkAbstractMapper m)
 Make a shallow copy of this mapper.
virtual void StaticOff ()
 Turn on/off flag to control whether the mapper's data is static. Static data means that the mapper does not propagate updates down the pipeline, greatly decreasing the time it takes to update many mappers. This should only be used if the data never changes.
virtual void StaticOn ()
 Turn on/off flag to control whether the mapper's data is static. Static data means that the mapper does not propagate updates down the pipeline, greatly decreasing the time it takes to update many mappers. This should only be used if the data never changes.
virtual void UseLookupTableScalarRangeOff ()
 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.
virtual void UseLookupTableScalarRangeOn ()
 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

static int GetGlobalImmediateModeRendering ()
 Turn on/off flag to control whether data is rendered using immediate mode or note. Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.
static int GetResolveCoincidentTopology ()
 Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems). If not off, there are two methods to choose from. PolygonOffset uses graphics systems calls to shift polygons, but does not distinguish vertices and lines from one another. ShiftZBuffer remaps the z-buffer to distinguish vertices, lines, and polygons, but does not always produce acceptable results. If you use the ShiftZBuffer approach, you may also want to set the ResolveCoincidentTopologyZShift value. (Note: not all mappers/graphics systems implement this functionality.)
static int GetResolveCoincidentTopologyPolygonOffsetFaces ()
 Used when ResolveCoincidentTopology is set to PolygonOffset. The polygon offset can be applied either to the solid polygonal faces or the lines/vertices. When set (default), the offset is applied to the faces otherwise it is applied to lines and vertices. This is a global variable.
static void GetResolveCoincidentTopologyPolygonOffsetParameters (ref double factor, ref double units)
 Used to set the polygon offset scale factor and units. Used when ResolveCoincidentTopology is set to PolygonOffset. These are global variables.
static double GetResolveCoincidentTopologyZShift ()
 Used to set the z-shift if ResolveCoincidentTopology is set to ShiftZBuffer. This is a global variable.
static void GlobalImmediateModeRenderingOff ()
 Turn on/off flag to control whether data is rendered using immediate mode or note. Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.
static void GlobalImmediateModeRenderingOn ()
 Turn on/off flag to control whether data is rendered using immediate mode or note. Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkMapper SafeDownCast (vtkObjectBase o)
 Undocumented Block.
static void SetGlobalImmediateModeRendering (int val)
 Turn on/off flag to control whether data is rendered using immediate mode or note. Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.
static void SetResolveCoincidentTopology (int val)
 Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems). If not off, there are two methods to choose from. PolygonOffset uses graphics systems calls to shift polygons, but does not distinguish vertices and lines from one another. ShiftZBuffer remaps the z-buffer to distinguish vertices, lines, and polygons, but does not always produce acceptable results. If you use the ShiftZBuffer approach, you may also want to set the ResolveCoincidentTopologyZShift value. (Note: not all mappers/graphics systems implement this functionality.)
static void SetResolveCoincidentTopologyPolygonOffsetFaces (int faces)
 Used when ResolveCoincidentTopology is set to PolygonOffset. The polygon offset can be applied either to the solid polygonal faces or the lines/vertices. When set (default), the offset is applied to the faces otherwise it is applied to lines and vertices. This is a global variable.
static void SetResolveCoincidentTopologyPolygonOffsetParameters (double factor, double units)
 Used to set the polygon offset scale factor and units. Used when ResolveCoincidentTopology is set to PolygonOffset. These are global variables.
static void SetResolveCoincidentTopologyToDefault ()
 Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems). If not off, there are two methods to choose from. PolygonOffset uses graphics systems calls to shift polygons, but does not distinguish vertices and lines from one another. ShiftZBuffer remaps the z-buffer to distinguish vertices, lines, and polygons, but does not always produce acceptable results. If you use the ShiftZBuffer approach, you may also want to set the ResolveCoincidentTopologyZShift value. (Note: not all mappers/graphics systems implement this functionality.)
static void SetResolveCoincidentTopologyToOff ()
 Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems). If not off, there are two methods to choose from. PolygonOffset uses graphics systems calls to shift polygons, but does not distinguish vertices and lines from one another. ShiftZBuffer remaps the z-buffer to distinguish vertices, lines, and polygons, but does not always produce acceptable results. If you use the ShiftZBuffer approach, you may also want to set the ResolveCoincidentTopologyZShift value. (Note: not all mappers/graphics systems implement this functionality.)
static void SetResolveCoincidentTopologyToPolygonOffset ()
 Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems). If not off, there are two methods to choose from. PolygonOffset uses graphics systems calls to shift polygons, but does not distinguish vertices and lines from one another. ShiftZBuffer remaps the z-buffer to distinguish vertices, lines, and polygons, but does not always produce acceptable results. If you use the ShiftZBuffer approach, you may also want to set the ResolveCoincidentTopologyZShift value. (Note: not all mappers/graphics systems implement this functionality.)
static void SetResolveCoincidentTopologyToShiftZBuffer ()
 Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems). If not off, there are two methods to choose from. PolygonOffset uses graphics systems calls to shift polygons, but does not distinguish vertices and lines from one another. ShiftZBuffer remaps the z-buffer to distinguish vertices, lines, and polygons, but does not always produce acceptable results. If you use the ShiftZBuffer approach, you may also want to set the ResolveCoincidentTopologyZShift value. (Note: not all mappers/graphics systems implement this functionality.)
static void SetResolveCoincidentTopologyZShift (double val)
 Used to set the z-shift if ResolveCoincidentTopology is set to ShiftZBuffer. This is a global variable.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "9vtkMapper"
 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 vtkMapper_ColorByArrayComponent_01 (HandleRef pThis, int arrayNum, int component)
static internal void vtkMapper_ColorByArrayComponent_02 (HandleRef pThis, string arrayName, int component)
static internal void vtkMapper_CreateDefaultLookupTable_03 (HandleRef pThis)
static internal int vtkMapper_GetArrayAccessMode_04 (HandleRef pThis)
static internal int vtkMapper_GetArrayComponent_05 (HandleRef pThis)
static internal int vtkMapper_GetArrayId_06 (HandleRef pThis)
static internal IntPtr vtkMapper_GetArrayName_07 (HandleRef pThis)
static internal IntPtr vtkMapper_GetBounds_08 (HandleRef pThis)
static internal void vtkMapper_GetBounds_09 (HandleRef pThis, IntPtr bounds)
static internal int vtkMapper_GetColorMode_10 (HandleRef pThis)
static internal IntPtr vtkMapper_GetColorModeAsString_11 (HandleRef pThis)
static internal int vtkMapper_GetForceCompileOnly_12 (HandleRef pThis)
static internal int vtkMapper_GetGlobalImmediateModeRendering_13 ()
static internal int vtkMapper_GetImmediateModeRendering_14 (HandleRef pThis)
static internal IntPtr vtkMapper_GetInput_15 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkMapper_GetInputAsDataSet_16 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkMapper_GetInterpolateScalarsBeforeMapping_17 (HandleRef pThis)
static internal IntPtr vtkMapper_GetLookupTable_18 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal uint vtkMapper_GetMTime_19 (HandleRef pThis)
static internal double vtkMapper_GetRenderTime_20 (HandleRef pThis)
static internal int vtkMapper_GetResolveCoincidentTopology_21 ()
static internal int vtkMapper_GetResolveCoincidentTopologyPolygonOffsetFaces_22 ()
static internal void vtkMapper_GetResolveCoincidentTopologyPolygonOffsetParameters_23 (ref double factor, ref double units)
static internal double vtkMapper_GetResolveCoincidentTopologyZShift_24 ()
static internal int vtkMapper_GetScalarMaterialMode_25 (HandleRef pThis)
static internal IntPtr vtkMapper_GetScalarMaterialModeAsString_26 (HandleRef pThis)
static internal int vtkMapper_GetScalarMode_27 (HandleRef pThis)
static internal IntPtr vtkMapper_GetScalarModeAsString_28 (HandleRef pThis)
static internal IntPtr vtkMapper_GetScalarRange_29 (HandleRef pThis)
static internal void vtkMapper_GetScalarRange_30 (HandleRef pThis, IntPtr data)
static internal int vtkMapper_GetScalarVisibility_31 (HandleRef pThis)
static internal int vtkMapper_GetStatic_32 (HandleRef pThis)
static internal byte vtkMapper_GetSupportsSelection_33 (HandleRef pThis)
static internal int vtkMapper_GetUseLookupTableScalarRange_34 (HandleRef pThis)
static internal void vtkMapper_GlobalImmediateModeRenderingOff_35 ()
static internal void vtkMapper_GlobalImmediateModeRenderingOn_36 ()
static internal void vtkMapper_ImmediateModeRenderingOff_37 (HandleRef pThis)
static internal void vtkMapper_ImmediateModeRenderingOn_38 (HandleRef pThis)
static internal void vtkMapper_InterpolateScalarsBeforeMappingOff_39 (HandleRef pThis)
static internal void vtkMapper_InterpolateScalarsBeforeMappingOn_40 (HandleRef pThis)
static internal int vtkMapper_IsA_41 (HandleRef pThis, string type)
static internal int vtkMapper_IsTypeOf_42 (string type)
static internal IntPtr vtkMapper_MapScalars_43 (HandleRef pThis, double alpha, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkMapper_NewInstance_44 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkMapper_ReleaseGraphicsResources_45 (HandleRef pThis, HandleRef arg0)
static internal void vtkMapper_Render_46 (HandleRef pThis, HandleRef ren, HandleRef a)
static internal IntPtr vtkMapper_SafeDownCast_47 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkMapper_ScalarVisibilityOff_48 (HandleRef pThis)
static internal void vtkMapper_ScalarVisibilityOn_49 (HandleRef pThis)
static internal void vtkMapper_SelectColorArray_50 (HandleRef pThis, int arrayNum)
static internal void vtkMapper_SelectColorArray_51 (HandleRef pThis, string arrayName)
static internal void vtkMapper_SetColorMode_52 (HandleRef pThis, int _arg)
static internal void vtkMapper_SetColorModeToDefault_53 (HandleRef pThis)
static internal void vtkMapper_SetColorModeToMapScalars_54 (HandleRef pThis)
static internal void vtkMapper_SetForceCompileOnly_55 (HandleRef pThis, int value)
static internal void vtkMapper_SetGlobalImmediateModeRendering_56 (int val)
static internal void vtkMapper_SetImmediateModeRendering_57 (HandleRef pThis, int _arg)
static internal void vtkMapper_SetInterpolateScalarsBeforeMapping_58 (HandleRef pThis, int _arg)
static internal void vtkMapper_SetLookupTable_59 (HandleRef pThis, HandleRef lut)
static internal void vtkMapper_SetRenderTime_60 (HandleRef pThis, double time)
static internal void vtkMapper_SetResolveCoincidentTopology_61 (int val)
static internal void vtkMapper_SetResolveCoincidentTopologyPolygonOffsetFaces_62 (int faces)
static internal void vtkMapper_SetResolveCoincidentTopologyPolygonOffsetParameters_63 (double factor, double units)
static internal void vtkMapper_SetResolveCoincidentTopologyToDefault_64 ()
static internal void vtkMapper_SetResolveCoincidentTopologyToOff_65 ()
static internal void vtkMapper_SetResolveCoincidentTopologyToPolygonOffset_66 ()
static internal void vtkMapper_SetResolveCoincidentTopologyToShiftZBuffer_67 ()
static internal void vtkMapper_SetResolveCoincidentTopologyZShift_68 (double val)
static internal void vtkMapper_SetScalarMaterialMode_69 (HandleRef pThis, int _arg)
static internal void vtkMapper_SetScalarMaterialModeToAmbient_70 (HandleRef pThis)
static internal void vtkMapper_SetScalarMaterialModeToAmbientAndDiffuse_71 (HandleRef pThis)
static internal void vtkMapper_SetScalarMaterialModeToDefault_72 (HandleRef pThis)
static internal void vtkMapper_SetScalarMaterialModeToDiffuse_73 (HandleRef pThis)
static internal void vtkMapper_SetScalarMode_74 (HandleRef pThis, int _arg)
static internal void vtkMapper_SetScalarModeToDefault_75 (HandleRef pThis)
static internal void vtkMapper_SetScalarModeToUseCellData_76 (HandleRef pThis)
static internal void vtkMapper_SetScalarModeToUseCellFieldData_77 (HandleRef pThis)
static internal void vtkMapper_SetScalarModeToUseFieldData_78 (HandleRef pThis)
static internal void vtkMapper_SetScalarModeToUsePointData_79 (HandleRef pThis)
static internal void vtkMapper_SetScalarModeToUsePointFieldData_80 (HandleRef pThis)
static internal void vtkMapper_SetScalarRange_81 (HandleRef pThis, double _arg1, double _arg2)
static internal void vtkMapper_SetScalarRange_82 (HandleRef pThis, IntPtr _arg)
static internal void vtkMapper_SetScalarVisibility_83 (HandleRef pThis, int _arg)
static internal void vtkMapper_SetStatic_84 (HandleRef pThis, int _arg)
static internal void vtkMapper_SetUseLookupTableScalarRange_85 (HandleRef pThis, int _arg)
static internal void vtkMapper_ShallowCopy_86 (HandleRef pThis, HandleRef m)
static internal void vtkMapper_StaticOff_87 (HandleRef pThis)
static internal void vtkMapper_StaticOn_88 (HandleRef pThis)
static internal void vtkMapper_UseLookupTableScalarRangeOff_89 (HandleRef pThis)
static internal void vtkMapper_UseLookupTableScalarRangeOn_90 (HandleRef pThis)

Static Private Member Functions

static vtkMapper ()
 Automatically generated type registration mechanics.

Detailed Description

vtkMapper - abstract class specifies interface to map data to graphics primitives

Description vtkMapper is an abstract class to specify interface between data and graphics primitives. Subclasses of vtkMapper map data through a lookuptable and control the creation of rendering primitives that interface to the graphics library. The mapping can be controlled by supplying a lookup table and specifying a scalar range to map data through.

There are several important control mechanisms affecting the behavior of this object. The ScalarVisibility flag controls whether scalar data (if any) controls the color of the associated actor(s) that refer to the mapper. The ScalarMode ivar is used to determine whether scalar point data or cell data is used to color the object. By default, point data scalars are used unless there are none, in which cell scalars are used. Or you can explicitly control whether to use point or cell scalar data. Finally, the mapping of scalars through the lookup table varies depending on the setting of the ColorMode flag. See the documentation for the appropriate methods for an explanation.

Another important feature of this class is whether to use immediate mode rendering (ImmediateModeRenderingOn) or display list rendering (ImmediateModeRenderingOff). If display lists are used, a data structure is constructed (generally in the rendering library) which can then be rapidly traversed and rendered by the rendering library. The disadvantage of display lists is that they require additionally memory which may affect the performance of the system.

Another important feature of the mapper is the ability to shift the z-buffer to resolve coincident topology. For example, if you'd like to draw a mesh with some edges a different color, and the edges lie on the mesh, this feature can be useful to get nice looking lines. (See the ResolveCoincidentTopology-related methods.)


Constructor & Destructor Documentation

static Kitware.VTK.vtkMapper.vtkMapper ( ) [static, private]

Automatically generated type registration mechanics.

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

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


Member Function Documentation

void Kitware.VTK.vtkMapper.ColorByArrayComponent ( int  arrayNum,
int  component 
)

Legacy: These methods used to be used to specify the array component. It is better to do this in the lookup table.

void Kitware.VTK.vtkMapper.ColorByArrayComponent ( string  arrayName,
int  component 
)

Legacy: These methods used to be used to specify the array component. It is better to do this in the lookup table.

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

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

Get the array name or number and component to color by.

Get the array name or number and component to color by.

Get the array name or number and component to color by.

Get the array name or number and component to color by.

override double [] Kitware.VTK.vtkMapper.GetBounds ( ) [virtual]

Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).

Reimplemented from Kitware.VTK.vtkAbstractMapper3D.

Reimplemented in Kitware.VTK.vtkGraphMapper, Kitware.VTK.vtkGlyph3DMapper, Kitware.VTK.vtkCompositePolyDataMapper, and Kitware.VTK.vtkPolyDataMapper.

override void Kitware.VTK.vtkMapper.GetBounds ( IntPtr  bounds) [virtual]

Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).

Reimplemented from Kitware.VTK.vtkAbstractMapper3D.

Reimplemented in Kitware.VTK.vtkGraphMapper, Kitware.VTK.vtkGlyph3DMapper, Kitware.VTK.vtkCompositePolyDataMapper, and Kitware.VTK.vtkPolyDataMapper.

virtual int Kitware.VTK.vtkMapper.GetColorMode ( ) [virtual]

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. (Note that for multi-component scalars, the particular component to use for mapping can be specified using the SelectColorArray() method.)

Return the method of coloring scalar data.

virtual int Kitware.VTK.vtkMapper.GetForceCompileOnly ( ) [virtual]

Turn on/off flag to control whether data is rendered using immediate mode or note. Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.

Turn on/off flag to control whether data is rendered using immediate mode or note. Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.

Turn on/off flag to control whether data is rendered using immediate mode or note. Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.

This instance variable is used by vtkLODActor to determine which mapper to use. It is an estimate of the time necessary to render. Setting the render time does not modify the mapper.

Reimplemented in Kitware.VTK.vtkGraphMapper, Kitware.VTK.vtkPolyDataMapper, and Kitware.VTK.vtkDataSetMapper.

Here is the call graph for this function:

Get the input to this mapper as a vtkDataSet, instead of as a more specialized data type that the subclass may return from GetInput(). This method is provided for use in the wrapper languages, C++ programmers should use GetInput() instead.

Here is the call graph for this function:

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.

Specify a lookup table for the mapper to use.

Here is the call graph for this function:

override uint Kitware.VTK.vtkMapper.GetMTime ( ) [virtual]

Overload standard modified time function. If lookup table is modified, then this object is modified as well.

Reimplemented from Kitware.VTK.vtkAbstractMapper.

Reimplemented in Kitware.VTK.vtkGraphMapper, and Kitware.VTK.vtkDataSetMapper.

virtual double Kitware.VTK.vtkMapper.GetRenderTime ( ) [virtual]

This instance variable is used by vtkLODActor to determine which mapper to use. It is an estimate of the time necessary to render. Setting the render time does not modify the mapper.

Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems). If not off, there are two methods to choose from. PolygonOffset uses graphics systems calls to shift polygons, but does not distinguish vertices and lines from one another. ShiftZBuffer remaps the z-buffer to distinguish vertices, lines, and polygons, but does not always produce acceptable results. If you use the ShiftZBuffer approach, you may also want to set the ResolveCoincidentTopologyZShift value. (Note: not all mappers/graphics systems implement this functionality.)

Used when ResolveCoincidentTopology is set to PolygonOffset. The polygon offset can be applied either to the solid polygonal faces or the lines/vertices. When set (default), the offset is applied to the faces otherwise it is applied to lines and vertices. This is a global variable.

static void Kitware.VTK.vtkMapper.GetResolveCoincidentTopologyPolygonOffsetParameters ( ref double  factor,
ref double  units 
) [static]

Used to set the polygon offset scale factor and units. Used when ResolveCoincidentTopology is set to PolygonOffset. These are global variables.

Used to set the z-shift if ResolveCoincidentTopology is set to ShiftZBuffer. This is a global variable.

Set/Get the light-model color mode.

Return the light-model color mode.

virtual int Kitware.VTK.vtkMapper.GetScalarMode ( ) [virtual]

Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors. When ScalarMode is set to use Field Data (ScalarModeToFieldData), you must call SelectColorArray to choose the field data array to be used to color cells. In this mode, if the poly data has triangle strips, the field data is treated as the celldata for each mini-cell formed by a triangle in the strip rather than the entire strip.

Return the method for obtaining scalar data.

virtual double [] Kitware.VTK.vtkMapper.GetScalarRange ( ) [virtual]

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.

virtual void Kitware.VTK.vtkMapper.GetScalarRange ( IntPtr  data) [virtual]

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.

virtual int Kitware.VTK.vtkMapper.GetScalarVisibility ( ) [virtual]

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

virtual int Kitware.VTK.vtkMapper.GetStatic ( ) [virtual]

Turn on/off flag to control whether the mapper's data is static. Static data means that the mapper does not propagate updates down the pipeline, greatly decreasing the time it takes to update many mappers. This should only be used if the data never changes.

virtual bool Kitware.VTK.vtkMapper.GetSupportsSelection ( ) [virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection.

Reimplemented in Kitware.VTK.vtkGlyph3DMapper, and Kitware.VTK.vtkPainterPolyDataMapper.

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.

Turn on/off flag to control whether data is rendered using immediate mode or note. Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.

Turn on/off flag to control whether data is rendered using immediate mode or note. Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.

Turn on/off flag to control whether data is rendered using immediate mode or note. Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.

Turn on/off flag to control whether data is rendered using immediate mode or note. Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.

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.

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.

override int Kitware.VTK.vtkMapper.IsA ( string  type) [virtual]
static new int Kitware.VTK.vtkMapper.IsTypeOf ( string  type) [static]

Map the scalars (if there are any scalars and ScalarVisibility is on) through the lookup table, returning an unsigned char RGBA array. This is typically done as part of the rendering process. The alpha parameter allows the blending of the scalars with an additional alpha (typically which comes from a vtkActor, etc.)

Here is the call graph for this function:

override void Kitware.VTK.vtkMapper.ReleaseGraphicsResources ( vtkWindow  arg0) [virtual]

Release any graphics resources that are being consumed by this mapper. The parameter window could be used to determine which graphic resources to release.

Reimplemented from Kitware.VTK.vtkAbstractMapper.

Reimplemented in Kitware.VTK.vtkGraphMapper, Kitware.VTK.vtkPainterPolyDataMapper, Kitware.VTK.vtkDataSetMapper, Kitware.VTK.vtkCompositePolyDataMapper, Kitware.VTK.vtkOpenGLPolyDataMapper, and Kitware.VTK.vtkOpenGLGlyph3DMapper.

virtual void Kitware.VTK.vtkMapper.Render ( vtkRenderer  ren,
vtkActor  a 
) [virtual]

Method initiates the mapping process. Generally sent by the actor as each frame is rendered.

Reimplemented in Kitware.VTK.vtkGraphMapper, Kitware.VTK.vtkGlyph3DMapper, Kitware.VTK.vtkPolyDataMapper, Kitware.VTK.vtkDataSetMapper, Kitware.VTK.vtkCompositePolyDataMapper, and Kitware.VTK.vtkOpenGLGlyph3DMapper.

virtual void Kitware.VTK.vtkMapper.ScalarVisibilityOff ( ) [virtual]

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

virtual void Kitware.VTK.vtkMapper.ScalarVisibilityOn ( ) [virtual]

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

When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods. The lookup table will decide how to convert vectors to colors.

void Kitware.VTK.vtkMapper.SelectColorArray ( string  arrayName)

When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods. The lookup table will decide how to convert vectors to colors.

virtual void Kitware.VTK.vtkMapper.SetColorMode ( int  _arg) [virtual]

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. (Note that for multi-component scalars, the particular component to use for mapping can be specified using the SelectColorArray() method.)

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. (Note that for multi-component scalars, the particular component to use for mapping can be specified using the SelectColorArray() method.)

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. (Note that for multi-component scalars, the particular component to use for mapping can be specified using the SelectColorArray() method.)

Turn on/off flag to control whether data is rendered using immediate mode or note. Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.

static void Kitware.VTK.vtkMapper.SetGlobalImmediateModeRendering ( int  val) [static]

Turn on/off flag to control whether data is rendered using immediate mode or note. Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.

virtual void Kitware.VTK.vtkMapper.SetImmediateModeRendering ( int  _arg) [virtual]

Turn on/off flag to control whether data is rendered using immediate mode or note. Immediate mode rendering tends to be slower but it can handle larger datasets. The default value is immediate mode off. If you are having problems rendering a large dataset you might want to consider using immediate more rendering.

virtual void Kitware.VTK.vtkMapper.SetInterpolateScalarsBeforeMapping ( int  _arg) [virtual]

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.

Specify a lookup table for the mapper to use.

void Kitware.VTK.vtkMapper.SetRenderTime ( double  time)

This instance variable is used by vtkLODActor to determine which mapper to use. It is an estimate of the time necessary to render. Setting the render time does not modify the mapper.

static void Kitware.VTK.vtkMapper.SetResolveCoincidentTopology ( int  val) [static]

Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems). If not off, there are two methods to choose from. PolygonOffset uses graphics systems calls to shift polygons, but does not distinguish vertices and lines from one another. ShiftZBuffer remaps the z-buffer to distinguish vertices, lines, and polygons, but does not always produce acceptable results. If you use the ShiftZBuffer approach, you may also want to set the ResolveCoincidentTopologyZShift value. (Note: not all mappers/graphics systems implement this functionality.)

Used when ResolveCoincidentTopology is set to PolygonOffset. The polygon offset can be applied either to the solid polygonal faces or the lines/vertices. When set (default), the offset is applied to the faces otherwise it is applied to lines and vertices. This is a global variable.

static void Kitware.VTK.vtkMapper.SetResolveCoincidentTopologyPolygonOffsetParameters ( double  factor,
double  units 
) [static]

Used to set the polygon offset scale factor and units. Used when ResolveCoincidentTopology is set to PolygonOffset. These are global variables.

Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems). If not off, there are two methods to choose from. PolygonOffset uses graphics systems calls to shift polygons, but does not distinguish vertices and lines from one another. ShiftZBuffer remaps the z-buffer to distinguish vertices, lines, and polygons, but does not always produce acceptable results. If you use the ShiftZBuffer approach, you may also want to set the ResolveCoincidentTopologyZShift value. (Note: not all mappers/graphics systems implement this functionality.)

Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems). If not off, there are two methods to choose from. PolygonOffset uses graphics systems calls to shift polygons, but does not distinguish vertices and lines from one another. ShiftZBuffer remaps the z-buffer to distinguish vertices, lines, and polygons, but does not always produce acceptable results. If you use the ShiftZBuffer approach, you may also want to set the ResolveCoincidentTopologyZShift value. (Note: not all mappers/graphics systems implement this functionality.)

Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems). If not off, there are two methods to choose from. PolygonOffset uses graphics systems calls to shift polygons, but does not distinguish vertices and lines from one another. ShiftZBuffer remaps the z-buffer to distinguish vertices, lines, and polygons, but does not always produce acceptable results. If you use the ShiftZBuffer approach, you may also want to set the ResolveCoincidentTopologyZShift value. (Note: not all mappers/graphics systems implement this functionality.)

Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems). If not off, there are two methods to choose from. PolygonOffset uses graphics systems calls to shift polygons, but does not distinguish vertices and lines from one another. ShiftZBuffer remaps the z-buffer to distinguish vertices, lines, and polygons, but does not always produce acceptable results. If you use the ShiftZBuffer approach, you may also want to set the ResolveCoincidentTopologyZShift value. (Note: not all mappers/graphics systems implement this functionality.)

static void Kitware.VTK.vtkMapper.SetResolveCoincidentTopologyZShift ( double  val) [static]

Used to set the z-shift if ResolveCoincidentTopology is set to ShiftZBuffer. This is a global variable.

virtual void Kitware.VTK.vtkMapper.SetScalarMaterialMode ( int  _arg) [virtual]

Set/Get the light-model color mode.

Set/Get the light-model color mode.

Set/Get the light-model color mode.

Set/Get the light-model color mode.

Set/Get the light-model color mode.

virtual void Kitware.VTK.vtkMapper.SetScalarMode ( int  _arg) [virtual]

Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors. When ScalarMode is set to use Field Data (ScalarModeToFieldData), you must call SelectColorArray to choose the field data array to be used to color cells. In this mode, if the poly data has triangle strips, the field data is treated as the celldata for each mini-cell formed by a triangle in the strip rather than the entire strip.

Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors. When ScalarMode is set to use Field Data (ScalarModeToFieldData), you must call SelectColorArray to choose the field data array to be used to color cells. In this mode, if the poly data has triangle strips, the field data is treated as the celldata for each mini-cell formed by a triangle in the strip rather than the entire strip.

Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors. When ScalarMode is set to use Field Data (ScalarModeToFieldData), you must call SelectColorArray to choose the field data array to be used to color cells. In this mode, if the poly data has triangle strips, the field data is treated as the celldata for each mini-cell formed by a triangle in the strip rather than the entire strip.

Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors. When ScalarMode is set to use Field Data (ScalarModeToFieldData), you must call SelectColorArray to choose the field data array to be used to color cells. In this mode, if the poly data has triangle strips, the field data is treated as the celldata for each mini-cell formed by a triangle in the strip rather than the entire strip.

Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors. When ScalarMode is set to use Field Data (ScalarModeToFieldData), you must call SelectColorArray to choose the field data array to be used to color cells. In this mode, if the poly data has triangle strips, the field data is treated as the celldata for each mini-cell formed by a triangle in the strip rather than the entire strip.

Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors. When ScalarMode is set to use Field Data (ScalarModeToFieldData), you must call SelectColorArray to choose the field data array to be used to color cells. In this mode, if the poly data has triangle strips, the field data is treated as the celldata for each mini-cell formed by a triangle in the strip rather than the entire strip.

Control how the filter works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectColorArray before you call GetColors. When ScalarMode is set to use Field Data (ScalarModeToFieldData), you must call SelectColorArray to choose the field data array to be used to color cells. In this mode, if the poly data has triangle strips, the field data is treated as the celldata for each mini-cell formed by a triangle in the strip rather than the entire strip.

virtual void Kitware.VTK.vtkMapper.SetScalarRange ( double  _arg1,
double  _arg2 
) [virtual]

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.

void Kitware.VTK.vtkMapper.SetScalarRange ( IntPtr  _arg)

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.

virtual void Kitware.VTK.vtkMapper.SetScalarVisibility ( int  _arg) [virtual]

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

virtual void Kitware.VTK.vtkMapper.SetStatic ( int  _arg) [virtual]

Turn on/off flag to control whether the mapper's data is static. Static data means that the mapper does not propagate updates down the pipeline, greatly decreasing the time it takes to update many mappers. This should only be used if the data never changes.

virtual void Kitware.VTK.vtkMapper.SetUseLookupTableScalarRange ( int  _arg) [virtual]

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.

Make a shallow copy of this mapper.

Reimplemented from Kitware.VTK.vtkAbstractMapper.

Reimplemented in Kitware.VTK.vtkPolyDataMapper.

virtual void Kitware.VTK.vtkMapper.StaticOff ( ) [virtual]

Turn on/off flag to control whether the mapper's data is static. Static data means that the mapper does not propagate updates down the pipeline, greatly decreasing the time it takes to update many mappers. This should only be used if the data never changes.

virtual void Kitware.VTK.vtkMapper.StaticOn ( ) [virtual]

Turn on/off flag to control whether the mapper's data is static. Static data means that the mapper does not propagate updates down the pipeline, greatly decreasing the time it takes to update many mappers. This should only be used if the data never changes.

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.

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 internal void Kitware.VTK.vtkMapper.vtkMapper_ColorByArrayComponent_01 ( HandleRef  pThis,
int  arrayNum,
int  component 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_ColorByArrayComponent_02 ( HandleRef  pThis,
string  arrayName,
int  component 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_CreateDefaultLookupTable_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkMapper.vtkMapper_GetArrayAccessMode_04 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkMapper.vtkMapper_GetArrayComponent_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkMapper.vtkMapper_GetArrayId_06 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkMapper.vtkMapper_GetArrayName_07 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkMapper.vtkMapper_GetBounds_08 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_GetBounds_09 ( HandleRef  pThis,
IntPtr  bounds 
) [private]
static internal int Kitware.VTK.vtkMapper.vtkMapper_GetColorMode_10 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkMapper.vtkMapper_GetColorModeAsString_11 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkMapper.vtkMapper_GetForceCompileOnly_12 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkMapper.vtkMapper_GetImmediateModeRendering_14 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkMapper.vtkMapper_GetInput_15 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkMapper.vtkMapper_GetInputAsDataSet_16 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkMapper.vtkMapper_GetInterpolateScalarsBeforeMapping_17 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkMapper.vtkMapper_GetLookupTable_18 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal uint Kitware.VTK.vtkMapper.vtkMapper_GetMTime_19 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkMapper.vtkMapper_GetRenderTime_20 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_GetResolveCoincidentTopologyPolygonOffsetParameters_23 ( ref double  factor,
ref double  units 
) [private]
static internal int Kitware.VTK.vtkMapper.vtkMapper_GetScalarMaterialMode_25 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkMapper.vtkMapper_GetScalarMaterialModeAsString_26 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkMapper.vtkMapper_GetScalarMode_27 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkMapper.vtkMapper_GetScalarModeAsString_28 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkMapper.vtkMapper_GetScalarRange_29 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_GetScalarRange_30 ( HandleRef  pThis,
IntPtr  data 
) [private]
static internal int Kitware.VTK.vtkMapper.vtkMapper_GetScalarVisibility_31 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkMapper.vtkMapper_GetStatic_32 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkMapper.vtkMapper_GetSupportsSelection_33 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkMapper.vtkMapper_GetUseLookupTableScalarRange_34 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_ImmediateModeRenderingOff_37 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_ImmediateModeRenderingOn_38 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_InterpolateScalarsBeforeMappingOff_39 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_InterpolateScalarsBeforeMappingOn_40 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkMapper.vtkMapper_IsA_41 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkMapper.vtkMapper_IsTypeOf_42 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkMapper.vtkMapper_MapScalars_43 ( HandleRef  pThis,
double  alpha,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkMapper.vtkMapper_NewInstance_44 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_ReleaseGraphicsResources_45 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_Render_46 ( HandleRef  pThis,
HandleRef  ren,
HandleRef  a 
) [private]
static internal IntPtr Kitware.VTK.vtkMapper.vtkMapper_SafeDownCast_47 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_ScalarVisibilityOff_48 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_ScalarVisibilityOn_49 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SelectColorArray_50 ( HandleRef  pThis,
int  arrayNum 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SelectColorArray_51 ( HandleRef  pThis,
string  arrayName 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetColorMode_52 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetColorModeToDefault_53 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetColorModeToMapScalars_54 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetForceCompileOnly_55 ( HandleRef  pThis,
int  value 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetGlobalImmediateModeRendering_56 ( int  val) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetImmediateModeRendering_57 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetInterpolateScalarsBeforeMapping_58 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetLookupTable_59 ( HandleRef  pThis,
HandleRef  lut 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetRenderTime_60 ( HandleRef  pThis,
double  time 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetResolveCoincidentTopology_61 ( int  val) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetResolveCoincidentTopologyPolygonOffsetParameters_63 ( double  factor,
double  units 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetResolveCoincidentTopologyZShift_68 ( double  val) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetScalarMaterialMode_69 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetScalarMaterialModeToAmbient_70 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetScalarMaterialModeToAmbientAndDiffuse_71 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetScalarMaterialModeToDefault_72 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetScalarMaterialModeToDiffuse_73 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetScalarMode_74 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetScalarModeToDefault_75 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetScalarModeToUseCellData_76 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetScalarModeToUseCellFieldData_77 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetScalarModeToUseFieldData_78 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetScalarModeToUsePointData_79 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetScalarModeToUsePointFieldData_80 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetScalarRange_81 ( HandleRef  pThis,
double  _arg1,
double  _arg2 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetScalarRange_82 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetScalarVisibility_83 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetStatic_84 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_SetUseLookupTableScalarRange_85 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_ShallowCopy_86 ( HandleRef  pThis,
HandleRef  m 
) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_StaticOff_87 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_StaticOn_88 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_UseLookupTableScalarRangeOff_89 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkMapper.vtkMapper_UseLookupTableScalarRangeOn_90 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkMapper.MRClassNameKey = "9vtkMapper" [static]
new const string Kitware.VTK.vtkMapper.MRFullTypeName = "Kitware.VTK.vtkMapper"

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