vtkAbstractMapper Class Reference

#include <vtkAbstractMapper.h>

Inheritance diagram for vtkAbstractMapper:

[legend]Collaboration diagram for vtkAbstractMapper:

[legend]List of all members.

---

Detailed Description

abstract class specifies interface to map data

vtkAbstractMapper is an abstract class to specify interface between data and graphics primitives or software rendering techniques. Subclasses of vtkAbstractMapper can be used for rendering 2D data, geometry, or volumetric data.

See also:

vtkAbstractMapper3D vtkMapper vtkPolyDataMapper vtkVolumeMapper

Definition at line 50 of file vtkAbstractMapper.h.

void	ShallowCopy (vtkAbstractMapper *m)
static vtkDataArray *	GetScalars (vtkDataSet *input, int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int &cellFlag)
Public Types
typedef vtkAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual unsigned long	GetMTime ()
void	SetClippingPlanes (vtkPlanes *planes)
virtual void	ReleaseGraphicsResources (vtkWindow *)
virtual double	GetTimeToDraw ()
void	AddClippingPlane (vtkPlane *plane)
void	RemoveClippingPlane (vtkPlane *plane)
void	RemoveAllClippingPlanes ()
virtual void	SetClippingPlanes (vtkPlaneCollection *)
virtual vtkPlaneCollection *	GetClippingPlanes ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkAbstractMapper *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkAbstractMapper ()
	~vtkAbstractMapper ()
Protected Attributes
vtkTimerLog *	Timer
double	TimeToDraw
vtkWindow *	LastWindow
vtkPlaneCollection *	ClippingPlanes

---

Member Typedef Documentation

typedef vtkAlgorithm vtkAbstractMapper::Superclass

Reimplemented from vtkAlgorithm. Reimplemented in vtkMapper2D, vtkAbstractMapper3D, vtkAbstractVolumeMapper, vtkDataSetMapper, vtkHierarchicalPolyDataMapper, vtkImageMapper, vtkLabeledDataMapper, vtkMapper, vtkMesaFreeTypeTextMapper, vtkMesaImageMapper, vtkMesaPolyDataMapper, vtkMesaPolyDataMapper2D, vtkOpenGLFreeTypeTextMapper, vtkOpenGLImageMapper, vtkOpenGLPolyDataMapper, vtkOpenGLPolyDataMapper2D, vtkPolyDataMapper, vtkPolyDataMapper2D, vtkTextMapper, vtkUnstructuredGridVolumeZSweepMapper, vtkFixedPointVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeShearWarpMapper, vtkOpenGLVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, vtkProjectedTetrahedraMapper, vtkUnstructuredGridVolumeMapper, vtkUnstructuredGridVolumeRayCastMapper, vtkUnstructuredGridVolumeZSweepMapper, vtkVolumeMapper, vtkVolumeProMapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeShearWarpMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, and vtkVolumeTextureMapper3D. Definition at line 53 of file vtkAbstractMapper.h.

---

Constructor & Destructor Documentation

vtkAbstractMapper::vtkAbstractMapper (   )  [protected]

vtkAbstractMapper::~vtkAbstractMapper (   )  [protected]

---

Member Function Documentation

virtual const char* vtkAbstractMapper::GetClassName (   )  [virtual]

Reimplemented from vtkAlgorithm. Reimplemented in vtkMapper2D, vtkAbstractMapper3D, vtkAbstractVolumeMapper, vtkDataSetMapper, vtkHierarchicalPolyDataMapper, vtkImageMapper, vtkLabeledDataMapper, vtkMapper, vtkMesaFreeTypeTextMapper, vtkMesaImageMapper, vtkMesaPolyDataMapper, vtkMesaPolyDataMapper2D, vtkOpenGLFreeTypeTextMapper, vtkOpenGLImageMapper, vtkOpenGLPolyDataMapper, vtkOpenGLPolyDataMapper2D, vtkPolyDataMapper, vtkPolyDataMapper2D, vtkTextMapper, vtkUnstructuredGridVolumeZSweepMapper, vtkFixedPointVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeShearWarpMapper, vtkOpenGLVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, vtkProjectedTetrahedraMapper, vtkUnstructuredGridVolumeMapper, vtkUnstructuredGridVolumeRayCastMapper, vtkUnstructuredGridVolumeZSweepMapper, vtkVolumeMapper, vtkVolumeProMapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeShearWarpMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, and vtkVolumeTextureMapper3D.

static int vtkAbstractMapper::IsTypeOf (  const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkAlgorithm. Reimplemented in vtkMapper2D, vtkAbstractMapper3D, vtkAbstractVolumeMapper, vtkDataSetMapper, vtkHierarchicalPolyDataMapper, vtkImageMapper, vtkLabeledDataMapper, vtkMapper, vtkMesaFreeTypeTextMapper, vtkMesaImageMapper, vtkMesaPolyDataMapper, vtkMesaPolyDataMapper2D, vtkOpenGLFreeTypeTextMapper, vtkOpenGLImageMapper, vtkOpenGLPolyDataMapper, vtkOpenGLPolyDataMapper2D, vtkPolyDataMapper, vtkPolyDataMapper2D, vtkTextMapper, vtkUnstructuredGridVolumeZSweepMapper, vtkFixedPointVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeShearWarpMapper, vtkOpenGLVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, vtkProjectedTetrahedraMapper, vtkUnstructuredGridVolumeMapper, vtkUnstructuredGridVolumeRayCastMapper, vtkUnstructuredGridVolumeZSweepMapper, vtkVolumeMapper, vtkVolumeProMapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeShearWarpMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, and vtkVolumeTextureMapper3D.

virtual int vtkAbstractMapper::IsA (  const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkAlgorithm. Reimplemented in vtkMapper2D, vtkAbstractMapper3D, vtkAbstractVolumeMapper, vtkDataSetMapper, vtkHierarchicalPolyDataMapper, vtkImageMapper, vtkLabeledDataMapper, vtkMapper, vtkMesaFreeTypeTextMapper, vtkMesaImageMapper, vtkMesaPolyDataMapper, vtkMesaPolyDataMapper2D, vtkOpenGLFreeTypeTextMapper, vtkOpenGLImageMapper, vtkOpenGLPolyDataMapper, vtkOpenGLPolyDataMapper2D, vtkPolyDataMapper, vtkPolyDataMapper2D, vtkTextMapper, vtkUnstructuredGridVolumeZSweepMapper, vtkFixedPointVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeShearWarpMapper, vtkOpenGLVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, vtkProjectedTetrahedraMapper, vtkUnstructuredGridVolumeMapper, vtkUnstructuredGridVolumeRayCastMapper, vtkUnstructuredGridVolumeZSweepMapper, vtkVolumeMapper, vtkVolumeProMapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeShearWarpMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, and vtkVolumeTextureMapper3D.

static vtkAbstractMapper* vtkAbstractMapper::SafeDownCast (  vtkObject *  o  )  [static]

Reimplemented from vtkAlgorithm. Reimplemented in vtkMapper2D, vtkAbstractMapper3D, vtkAbstractVolumeMapper, vtkDataSetMapper, vtkHierarchicalPolyDataMapper, vtkImageMapper, vtkLabeledDataMapper, vtkMapper, vtkMesaFreeTypeTextMapper, vtkMesaImageMapper, vtkMesaPolyDataMapper, vtkMesaPolyDataMapper2D, vtkOpenGLFreeTypeTextMapper, vtkOpenGLImageMapper, vtkOpenGLPolyDataMapper, vtkOpenGLPolyDataMapper2D, vtkPolyDataMapper, vtkPolyDataMapper2D, vtkTextMapper, vtkUnstructuredGridVolumeZSweepMapper, vtkFixedPointVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeShearWarpMapper, vtkOpenGLVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, vtkProjectedTetrahedraMapper, vtkUnstructuredGridVolumeMapper, vtkUnstructuredGridVolumeRayCastMapper, vtkUnstructuredGridVolumeZSweepMapper, vtkVolumeMapper, vtkVolumeProMapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeShearWarpMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, and vtkVolumeTextureMapper3D.

void vtkAbstractMapper::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 vtkAlgorithm. Reimplemented in vtkMapper2D, vtkAbstractMapper3D, vtkAbstractVolumeMapper, vtkDataSetMapper, vtkHierarchicalPolyDataMapper, vtkImageMapper, vtkLabeledDataMapper, vtkMapper, vtkMesaFreeTypeTextMapper, vtkMesaImageMapper, vtkMesaPolyDataMapper, vtkMesaPolyDataMapper2D, vtkOpenGLFreeTypeTextMapper, vtkOpenGLImageMapper, vtkOpenGLPolyDataMapper, vtkOpenGLPolyDataMapper2D, vtkPolyDataMapper, vtkPolyDataMapper2D, vtkTextMapper, vtkUnstructuredGridVolumeZSweepMapper, vtkFixedPointVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeShearWarpMapper, vtkOpenGLVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, vtkProjectedTetrahedraMapper, vtkUnstructuredGridVolumeMapper, vtkUnstructuredGridVolumeRayCastMapper, vtkUnstructuredGridVolumeZSweepMapper, vtkVolumeMapper, vtkVolumeProMapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeShearWarpMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, and vtkVolumeTextureMapper3D.

virtual unsigned long vtkAbstractMapper::GetMTime (   )  [virtual]

Override Modifiedtime as we have added Clipping planes Reimplemented from vtkObject. Reimplemented in vtkDataSetMapper, vtkImageMapper, vtkMapper, and vtkPolyDataMapper2D.

virtual void vtkAbstractMapper::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 in vtkAbstractVolumeMapper, vtkDataSetMapper, vtkHierarchicalPolyDataMapper, vtkLabeledDataMapper, vtkMapper, vtkMesaFreeTypeTextMapper, vtkMesaPolyDataMapper, vtkOpenGLFreeTypeTextMapper, vtkOpenGLPolyDataMapper, vtkOpenGLVolumeTextureMapper3D, vtkProjectedTetrahedraMapper, vtkUnstructuredGridVolumeMapper, vtkUnstructuredGridVolumeRayCastMapper, vtkVolumeMapper, and vtkVolumeRayCastMapper. Definition at line 62 of file vtkAbstractMapper.h.

virtual double vtkAbstractMapper::GetTimeToDraw (   )  [virtual]

Get the time required to draw the geometry last time it was rendered

void vtkAbstractMapper::AddClippingPlane (  vtkPlane *  plane  )

Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified).

void vtkAbstractMapper::RemoveClippingPlane (  vtkPlane *  plane  )

Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified).

void vtkAbstractMapper::RemoveAllClippingPlanes (   )

Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified).

virtual void vtkAbstractMapper::SetClippingPlanes (  vtkPlaneCollection *   )  [virtual]

Get/Set the vtkPlaneCollection which specifies the clipping planes.

virtual vtkPlaneCollection* vtkAbstractMapper::GetClippingPlanes (   )  [virtual]

Get/Set the vtkPlaneCollection which specifies the clipping planes.

void vtkAbstractMapper::SetClippingPlanes (  vtkPlanes *  planes  )

An alternative way to set clipping planes: use up to six planes found in the supplied instance of the implicit function vtkPlanes.

void vtkAbstractMapper::ShallowCopy (  vtkAbstractMapper *  m  )

Make a shallow copy of this mapper. Reimplemented in vtkMapper, vtkPolyDataMapper, and vtkPolyDataMapper2D.

static vtkDataArray* vtkAbstractMapper::GetScalars (  vtkDataSet *  input, int  scalarMode, int  arrayAccessMode, int  arrayId, const char *  arrayName, int &  cellFlag )  [static]

Internal helper function for getting the active scalars. The scalar mode indicates where the scalars come from. The cellFlag is a return value that is set when the scalars actually are cell scalars. the arrayAccessMode is used to indicate how to retrieve the scalars from field data (if the scalarMode indicates that). The component is used to indicate which component in the data array to use as the scalars.

---

Member Data Documentation

vtkTimerLog* vtkAbstractMapper::Timer [protected]

Definition at line 106 of file vtkAbstractMapper.h.

double vtkAbstractMapper::TimeToDraw [protected]

Definition at line 107 of file vtkAbstractMapper.h.

vtkWindow* vtkAbstractMapper::LastWindow [protected]

Definition at line 108 of file vtkAbstractMapper.h.

vtkPlaneCollection* vtkAbstractMapper::ClippingPlanes [protected]

Definition at line 109 of file vtkAbstractMapper.h.

---

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

• dox/Filtering/vtkAbstractMapper.h

---