abstract class specifies interface to map data to graphics primitives More...
#include <vtkMapper.h>
Detailed Description
abstract class specifies interface to map data to graphics primitives
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.)
- See also:
- vtkDataSetMapper vtkPolyDataMapper
- Examples:
- vtkMapper (Examples)
- Tests:
- vtkMapper (Tests)
Definition at line 86 of file vtkMapper.h.
Member Typedef Documentation
Reimplemented from vtkAbstractMapper3D.
Reimplemented in vtkGraphMapper, vtkMoleculeMapper, vtkOpenGLPolyDataMapper, vtkCompositePolyDataMapper, vtkDataSetMapper, vtkPolyDataMapper, vtkPistonMapper, vtkOpenGLGlyph3DMapper, vtkGlyph3DMapper, vtkHierarchicalPolyDataMapper, vtkCompositePolyDataMapper2, and vtkPainterPolyDataMapper.
Definition at line 89 of file vtkMapper.h.
Constructor & Destructor Documentation
| vtkMapper::vtkMapper | ( | ) | [protected] |
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.
| vtkMapper::~vtkMapper | ( | ) | [protected] |
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.
Member Function Documentation
| static int vtkMapper::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkAbstractMapper3D.
Reimplemented in vtkGraphMapper, vtkMoleculeMapper, vtkOpenGLPolyDataMapper, vtkCompositePolyDataMapper, vtkDataSetMapper, vtkPolyDataMapper, vtkPistonMapper, vtkOpenGLGlyph3DMapper, vtkGlyph3DMapper, vtkHierarchicalPolyDataMapper, vtkCompositePolyDataMapper2, and vtkPainterPolyDataMapper.
| virtual int vtkMapper::IsA | ( | const char * | name | ) | [virtual] |
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkAbstractMapper3D.
Reimplemented in vtkGraphMapper, vtkMoleculeMapper, vtkOpenGLPolyDataMapper, vtkCompositePolyDataMapper, vtkDataSetMapper, vtkPolyDataMapper, vtkPistonMapper, vtkOpenGLGlyph3DMapper, vtkGlyph3DMapper, vtkHierarchicalPolyDataMapper, vtkCompositePolyDataMapper2, and vtkPainterPolyDataMapper.
| static vtkMapper* vtkMapper::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkAbstractMapper3D.
Reimplemented in vtkGraphMapper, vtkMoleculeMapper, vtkOpenGLPolyDataMapper, vtkCompositePolyDataMapper, vtkDataSetMapper, vtkPolyDataMapper, vtkPistonMapper, vtkOpenGLGlyph3DMapper, vtkGlyph3DMapper, vtkHierarchicalPolyDataMapper, vtkCompositePolyDataMapper2, and vtkPainterPolyDataMapper.
| virtual vtkObjectBase* vtkMapper::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkAbstractMapper3D.
Reimplemented in vtkGraphMapper, vtkMoleculeMapper, vtkOpenGLPolyDataMapper, vtkCompositePolyDataMapper, vtkDataSetMapper, vtkPolyDataMapper, vtkPistonMapper, vtkOpenGLGlyph3DMapper, vtkGlyph3DMapper, vtkHierarchicalPolyDataMapper, vtkCompositePolyDataMapper2, and vtkPainterPolyDataMapper.
| vtkMapper* vtkMapper::NewInstance | ( | ) | const |
Reimplemented from vtkAbstractMapper3D.
Reimplemented in vtkGraphMapper, vtkMoleculeMapper, vtkOpenGLPolyDataMapper, vtkCompositePolyDataMapper, vtkDataSetMapper, vtkPolyDataMapper, vtkPistonMapper, vtkOpenGLGlyph3DMapper, vtkGlyph3DMapper, vtkHierarchicalPolyDataMapper, vtkCompositePolyDataMapper2, and vtkPainterPolyDataMapper.
| void vtkMapper::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkAbstractMapper3D.
Reimplemented in vtkGraphMapper, vtkMoleculeMapper, vtkOpenGLPolyDataMapper, vtkCompositePolyDataMapper, vtkDataSetMapper, vtkPolyDataMapper, vtkPistonMapper, vtkOpenGLGlyph3DMapper, vtkGlyph3DMapper, vtkHierarchicalPolyDataMapper, vtkCompositePolyDataMapper2, and vtkPainterPolyDataMapper.
| void vtkMapper::ShallowCopy | ( | vtkAbstractMapper * | m | ) |
Make a shallow copy of this mapper.
Reimplemented from vtkAbstractMapper.
Reimplemented in vtkPolyDataMapper, and vtkPistonMapper.
| unsigned long vtkMapper::GetMTime | ( | ) | [virtual] |
Overload standard modified time function. If lookup table is modified, then this object is modified as well.
Reimplemented from vtkAbstractMapper.
Reimplemented in vtkGraphMapper, and vtkDataSetMapper.
| virtual void vtkMapper::Render | ( | vtkRenderer * | ren, |
| vtkActor * | a | ||
| ) | [pure virtual] |
Method initiates the mapping process. Generally sent by the actor as each frame is rendered.
Implemented in vtkMoleculeMapper, vtkGlyph3DMapper, vtkPistonMapper, vtkGraphMapper, vtkCompositePolyDataMapper, vtkPolyDataMapper, vtkOpenGLGlyph3DMapper, and vtkDataSetMapper.
| virtual void vtkMapper::ReleaseGraphicsResources | ( | vtkWindow * | ) | [inline, 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 vtkAbstractMapper.
Reimplemented in vtkMoleculeMapper, vtkGraphMapper, vtkPistonMapper, vtkCompositePolyDataMapper, vtkDataSetMapper, vtkPainterPolyDataMapper, vtkOpenGLPolyDataMapper, and vtkOpenGLGlyph3DMapper.
Definition at line 106 of file vtkMapper.h.
| void vtkMapper::SetLookupTable | ( | vtkScalarsToColors * | lut | ) |
Specify a lookup table for the mapper to use.
Specify a lookup table for the mapper to use.
| virtual void vtkMapper::CreateDefaultLookupTable | ( | ) | [virtual] |
Create default lookup table. Generally used to create one when none is available with the scalar data.
| virtual void vtkMapper::SetScalarVisibility | ( | int | ) | [virtual] |
Turn on/off flag to control whether scalar data is used to color objects.
| virtual int vtkMapper::GetScalarVisibility | ( | ) | [virtual] |
Turn on/off flag to control whether scalar data is used to color objects.
| virtual void vtkMapper::ScalarVisibilityOn | ( | ) | [virtual] |
Turn on/off flag to control whether scalar data is used to color objects.
| virtual void vtkMapper::ScalarVisibilityOff | ( | ) | [virtual] |
Turn on/off flag to control whether scalar data is used to color objects.
| virtual void vtkMapper::SetStatic | ( | int | ) | [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 int 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 void 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.
| virtual void 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 vtkMapper::SetColorMode | ( | int | ) | [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.)
| virtual int 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.)
| void vtkMapper::SetColorModeToDefault | ( | ) | [inline] |
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.)
Definition at line 146 of file vtkMapper.h.
| void vtkMapper::SetColorModeToMapScalars | ( | ) | [inline] |
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.)
Definition at line 148 of file vtkMapper.h.
| const char* vtkMapper::GetColorModeAsString | ( | ) |
Return the method of coloring scalar data.
| virtual void vtkMapper::SetInterpolateScalarsBeforeMapping | ( | int | ) | [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.
| virtual int vtkMapper::GetInterpolateScalarsBeforeMapping | ( | ) | [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.
| virtual void vtkMapper::InterpolateScalarsBeforeMappingOn | ( | ) | [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.
| virtual void vtkMapper::InterpolateScalarsBeforeMappingOff | ( | ) | [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.
| virtual void vtkMapper::SetUseLookupTableScalarRange | ( | int | ) | [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.
| virtual int vtkMapper::GetUseLookupTableScalarRange | ( | ) | [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.
| virtual void vtkMapper::UseLookupTableScalarRangeOn | ( | ) | [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.
| virtual void vtkMapper::UseLookupTableScalarRangeOff | ( | ) | [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.
| virtual void vtkMapper::SetScalarRange | ( | double | , |
| double | |||
| ) | [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 vtkMapper::SetScalarRange | ( | double | [2] | ) |
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 double* 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 vtkMapper::GetScalarRange | ( | double | data[2] | ) | [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 vtkMapper::SetImmediateModeRendering | ( | int | ) | [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 int vtkMapper::GetImmediateModeRendering | ( | ) | [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 vtkMapper::ImmediateModeRenderingOn | ( | ) | [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 vtkMapper::ImmediateModeRenderingOff | ( | ) | [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.
| static void 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.
| static void vtkMapper::GlobalImmediateModeRenderingOn | ( | ) | [inline, 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.
Definition at line 202 of file vtkMapper.h.
| static void vtkMapper::GlobalImmediateModeRenderingOff | ( | ) | [inline, 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.
Definition at line 204 of file vtkMapper.h.
| static int vtkMapper::GetGlobalImmediateModeRendering | ( | ) | [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 int vtkMapper::GetForceCompileOnly | ( | ) | [virtual] |
Force compile only mode in case display lists are used (ImmediateModeRendering is false). If ImmediateModeRendering is true, no rendering happens. Changing the value of this flag does not change modified time of the mapper. Initial value is false. This can be used by another rendering class which also uses display lists (call of display lists can be nested but not their creation.) There is no good reason to expose it to wrappers.
| void vtkMapper::SetForceCompileOnly | ( | int | value | ) |
Force compile only mode in case display lists are used (ImmediateModeRendering is false). If ImmediateModeRendering is true, no rendering happens. Changing the value of this flag does not change modified time of the mapper. Initial value is false. This can be used by another rendering class which also uses display lists (call of display lists can be nested but not their creation.) There is no good reason to expose it to wrappers.
| virtual void vtkMapper::SetScalarMode | ( | int | ) | [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.
| virtual int 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.
| void vtkMapper::SetScalarModeToDefault | ( | ) | [inline] |
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.
Definition at line 241 of file vtkMapper.h.
| void vtkMapper::SetScalarModeToUsePointData | ( | ) | [inline] |
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.
Definition at line 243 of file vtkMapper.h.
| void vtkMapper::SetScalarModeToUseCellData | ( | ) | [inline] |
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.
Definition at line 245 of file vtkMapper.h.
| void vtkMapper::SetScalarModeToUsePointFieldData | ( | ) | [inline] |
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.
Definition at line 247 of file vtkMapper.h.
| void vtkMapper::SetScalarModeToUseCellFieldData | ( | ) | [inline] |
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.
Definition at line 249 of file vtkMapper.h.
| void vtkMapper::SetScalarModeToUseFieldData | ( | ) | [inline] |
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.
Definition at line 251 of file vtkMapper.h.
| void vtkMapper::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 vtkMapper::SelectColorArray | ( | const char * | 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.
| void 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 vtkMapper::ColorByArrayComponent | ( | const char * | 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.
| char* vtkMapper::GetArrayName | ( | ) | [inline] |
Get the array name or number and component to color by.
Definition at line 272 of file vtkMapper.h.
| int vtkMapper::GetArrayId | ( | ) | [inline] |
Get the array name or number and component to color by.
Definition at line 273 of file vtkMapper.h.
| int vtkMapper::GetArrayAccessMode | ( | ) | [inline] |
Get the array name or number and component to color by.
Definition at line 274 of file vtkMapper.h.
| int vtkMapper::GetArrayComponent | ( | ) | [inline] |
Get the array name or number and component to color by.
Definition at line 275 of file vtkMapper.h.
| const char* vtkMapper::GetScalarModeAsString | ( | ) |
Return the method for obtaining scalar data.
| static void 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.)
| static int vtkMapper::GetResolveCoincidentTopology | ( | ) | [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.)
| static void vtkMapper::SetResolveCoincidentTopologyToDefault | ( | ) | [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.)
| static void vtkMapper::SetResolveCoincidentTopologyToOff | ( | ) | [inline, 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.)
Definition at line 295 of file vtkMapper.h.
| static void vtkMapper::SetResolveCoincidentTopologyToPolygonOffset | ( | ) | [inline, 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.)
Definition at line 297 of file vtkMapper.h.
| static void vtkMapper::SetResolveCoincidentTopologyToShiftZBuffer | ( | ) | [inline, 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.)
Definition at line 299 of file vtkMapper.h.
| static void 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.
| static void vtkMapper::GetResolveCoincidentTopologyPolygonOffsetParameters | ( | 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.
| static void vtkMapper::SetResolveCoincidentTopologyPolygonOffsetFaces | ( | int | faces | ) | [static] |
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 int vtkMapper::GetResolveCoincidentTopologyPolygonOffsetFaces | ( | ) | [static] |
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 vtkMapper::SetResolveCoincidentTopologyZShift | ( | double | val | ) | [static] |
Used to set the z-shift if ResolveCoincidentTopology is set to ShiftZBuffer. This is a global variable.
| static double vtkMapper::GetResolveCoincidentTopologyZShift | ( | ) | [static] |
Used to set the z-shift if ResolveCoincidentTopology is set to ShiftZBuffer. This is a global variable.
| virtual double* vtkMapper::GetBounds | ( | ) | [virtual] |
Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).
Implements vtkAbstractMapper3D.
Reimplemented in vtkGraphMapper, vtkMoleculeMapper, vtkGlyph3DMapper, vtkPolyDataMapper, vtkPistonMapper, and vtkCompositePolyDataMapper.
| virtual void vtkMapper::GetBounds | ( | double | bounds[6] | ) | [inline, virtual] |
Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).
Reimplemented from vtkAbstractMapper3D.
Reimplemented in vtkMoleculeMapper, vtkGlyph3DMapper, vtkPolyDataMapper, vtkPistonMapper, and vtkCompositePolyDataMapper.
Definition at line 334 of file vtkMapper.h.
| void vtkMapper::SetRenderTime | ( | double | time | ) | [inline] |
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.
Definition at line 342 of file vtkMapper.h.
| virtual double 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.
Get the input as a vtkDataSet. This method is overridden in the specialized mapper classes to return more specific data types.
Reimplemented in vtkGraphMapper, vtkDataSetMapper, vtkPolyDataMapper, and vtkMoleculeMapper.
| vtkDataSet* vtkMapper::GetInputAsDataSet | ( | ) | [inline] |
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.
Definition at line 359 of file vtkMapper.h.
| vtkUnsignedCharArray* vtkMapper::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.)
| virtual void vtkMapper::SetScalarMaterialMode | ( | int | ) | [virtual] |
Set/Get the light-model color mode.
| virtual int vtkMapper::GetScalarMaterialMode | ( | ) | [virtual] |
Set/Get the light-model color mode.
| void vtkMapper::SetScalarMaterialModeToDefault | ( | ) | [inline] |
Set/Get the light-model color mode.
Definition at line 374 of file vtkMapper.h.
| void vtkMapper::SetScalarMaterialModeToAmbient | ( | ) | [inline] |
Set/Get the light-model color mode.
Definition at line 376 of file vtkMapper.h.
| void vtkMapper::SetScalarMaterialModeToDiffuse | ( | ) | [inline] |
Set/Get the light-model color mode.
Definition at line 378 of file vtkMapper.h.
| void vtkMapper::SetScalarMaterialModeToAmbientAndDiffuse | ( | ) | [inline] |
Set/Get the light-model color mode.
Definition at line 380 of file vtkMapper.h.
| const char* vtkMapper::GetScalarMaterialModeAsString | ( | ) |
Return the light-model color mode.
| virtual bool vtkMapper::GetIsOpaque | ( | ) | [inline, virtual] |
Returns if the mapper does not expect to have translucent geometry. This may happen when using ColorMode is set to not map scalars i.e. render the scalar array directly as colors and the scalar array has opacity i.e. alpha component. Default implementation simply returns true. Note that even if this method returns true, an actor may treat the geometry as translucent since a constant translucency is set on the property, for example.
Reimplemented in vtkPainterPolyDataMapper, and vtkCompositePolyDataMapper2.
Definition at line 395 of file vtkMapper.h.
| virtual bool vtkMapper::GetSupportsSelection | ( | ) | [inline, 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 vtkGlyph3DMapper, vtkMoleculeMapper, vtkPainterPolyDataMapper, and vtkPistonMapper.
Definition at line 404 of file vtkMapper.h.
| void vtkMapper::MapScalarsToTexture | ( | vtkDataArray * | scalars, |
| double | alpha | ||
| ) | [protected] |
Member Data Documentation
vtkUnsignedCharArray* vtkMapper::Colors [protected] |
Definition at line 411 of file vtkMapper.h.
int vtkMapper::InterpolateScalarsBeforeMapping [protected] |
Definition at line 414 of file vtkMapper.h.
vtkFloatArray* vtkMapper::ColorCoordinates [protected] |
Definition at line 416 of file vtkMapper.h.
vtkImageData* vtkMapper::ColorTextureMap [protected] |
Definition at line 418 of file vtkMapper.h.
vtkScalarsToColors* vtkMapper::LookupTable [protected] |
Definition at line 421 of file vtkMapper.h.
int vtkMapper::ScalarVisibility [protected] |
Definition at line 422 of file vtkMapper.h.
vtkTimeStamp vtkMapper::BuildTime [protected] |
Definition at line 423 of file vtkMapper.h.
double vtkMapper::ScalarRange[2] [protected] |
Definition at line 424 of file vtkMapper.h.
int vtkMapper::UseLookupTableScalarRange [protected] |
Definition at line 425 of file vtkMapper.h.
int vtkMapper::ImmediateModeRendering [protected] |
Definition at line 426 of file vtkMapper.h.
int vtkMapper::ColorMode [protected] |
Definition at line 427 of file vtkMapper.h.
int vtkMapper::ScalarMode [protected] |
Definition at line 428 of file vtkMapper.h.
int vtkMapper::ScalarMaterialMode [protected] |
Definition at line 429 of file vtkMapper.h.
double vtkMapper::RenderTime [protected] |
Definition at line 431 of file vtkMapper.h.
int vtkMapper::ArrayId [protected] |
Definition at line 434 of file vtkMapper.h.
char vtkMapper::ArrayName[256] [protected] |
Definition at line 435 of file vtkMapper.h.
int vtkMapper::ArrayComponent [protected] |
Definition at line 436 of file vtkMapper.h.
int vtkMapper::ArrayAccessMode [protected] |
Definition at line 437 of file vtkMapper.h.
int vtkMapper::Static [protected] |
Definition at line 439 of file vtkMapper.h.
int vtkMapper::ForceCompileOnly [protected] |
Definition at line 441 of file vtkMapper.h.
The documentation for this class was generated from the following file:
- dox/Rendering/Core/vtkMapper.h
