---

vtkAbstractMapper Class Reference

abstract class specifies interface to map data. More...

#include <vtkAbstractMapper.h>

Inheritance diagram for vtkAbstractMapper:

[legend]Collaboration diagram for vtkAbstractMapper:

[legend]List of all members.

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

---

Detailed Description

abstract class specifies interface to map data.

Date:

2001/10/21 14:05:06

Revision:

1.24

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 76 of file vtkAbstractMapper.h.

---

Constructor & Destructor Documentation

vtkAbstractMapper::vtkAbstractMapper (    )  [protected]

vtkAbstractMapper::~vtkAbstractMapper (    )  [protected]

---

Member Function Documentation

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkProcessObject. Reimplemented in vtkMapper2D, vtkAbstractMapper3D, vtkDataSetMapper, vtkImageMapper, vtkLabeledDataMapper, vtkMapper, vtkMesaImageMapper, vtkMesaPolyDataMapper, vtkMesaPolyDataMapper2D, vtkMesaVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLImageMapper, vtkOpenGLPolyDataMapper, vtkOpenGLPolyDataMapper2D, vtkOpenGLVolumeProVG500Mapper, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeRayCastMapper, vtkOpenGLVolumeTextureMapper2D, vtkPolyDataMapper, vtkPolyDataMapper2D, vtkQuartzImageMapper, vtkQuartzTextMapper, vtkTextMapper, vtkVolumeMapper, vtkVolumeProMapper, vtkVolumeProVG500Mapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, vtkWin32ImageMapper, vtkWin32OpenGLTextMapper, vtkWin32PolyDataMapper2D, vtkWin32TextMapper, vtkXImageMapper, vtkXMesaTextMapper, vtkXOpenGLTextMapper, vtkXPolyDataMapper2D, and vtkXTextMapper.

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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkProcessObject. Reimplemented in vtkMapper2D, vtkAbstractMapper3D, vtkDataSetMapper, vtkImageMapper, vtkLabeledDataMapper, vtkMapper, vtkMesaImageMapper, vtkMesaPolyDataMapper, vtkMesaPolyDataMapper2D, vtkMesaVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLImageMapper, vtkOpenGLPolyDataMapper, vtkOpenGLPolyDataMapper2D, vtkOpenGLVolumeProVG500Mapper, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeRayCastMapper, vtkOpenGLVolumeTextureMapper2D, vtkPolyDataMapper, vtkPolyDataMapper2D, vtkQuartzImageMapper, vtkQuartzTextMapper, vtkTextMapper, vtkVolumeMapper, vtkVolumeProMapper, vtkVolumeProVG500Mapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, vtkWin32ImageMapper, vtkWin32OpenGLTextMapper, vtkWin32PolyDataMapper2D, vtkWin32TextMapper, vtkXImageMapper, vtkXMesaTextMapper, vtkXOpenGLTextMapper, vtkXPolyDataMapper2D, and vtkXTextMapper.

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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkProcessObject. Reimplemented in vtkMapper2D, vtkAbstractMapper3D, vtkDataSetMapper, vtkImageMapper, vtkLabeledDataMapper, vtkMapper, vtkMesaImageMapper, vtkMesaPolyDataMapper, vtkMesaPolyDataMapper2D, vtkMesaVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLImageMapper, vtkOpenGLPolyDataMapper, vtkOpenGLPolyDataMapper2D, vtkOpenGLVolumeProVG500Mapper, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeRayCastMapper, vtkOpenGLVolumeTextureMapper2D, vtkPolyDataMapper, vtkPolyDataMapper2D, vtkQuartzImageMapper, vtkQuartzTextMapper, vtkTextMapper, vtkVolumeMapper, vtkVolumeProMapper, vtkVolumeProVG500Mapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, vtkWin32ImageMapper, vtkWin32OpenGLTextMapper, vtkWin32PolyDataMapper2D, vtkWin32TextMapper, vtkXImageMapper, vtkXMesaTextMapper, vtkXOpenGLTextMapper, vtkXPolyDataMapper2D, and vtkXTextMapper.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkProcessObject. Reimplemented in vtkMapper2D, vtkAbstractMapper3D, vtkDataSetMapper, vtkImageMapper, vtkLabeledDataMapper, vtkMapper, vtkMesaImageMapper, vtkMesaPolyDataMapper, vtkMesaPolyDataMapper2D, vtkMesaVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLImageMapper, vtkOpenGLPolyDataMapper, vtkOpenGLPolyDataMapper2D, vtkOpenGLVolumeProVG500Mapper, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeRayCastMapper, vtkOpenGLVolumeTextureMapper2D, vtkPolyDataMapper, vtkPolyDataMapper2D, vtkQuartzImageMapper, vtkQuartzTextMapper, vtkTextMapper, vtkVolumeMapper, vtkVolumeProMapper, vtkVolumeProVG500Mapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, vtkWin32ImageMapper, vtkWin32OpenGLTextMapper, vtkWin32PolyDataMapper2D, vtkWin32TextMapper, vtkXImageMapper, vtkXMesaTextMapper, vtkXOpenGLTextMapper, vtkXPolyDataMapper2D, and vtkXTextMapper.

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 vtkProcessObject. Reimplemented in vtkMapper2D, vtkAbstractMapper3D, vtkDataSetMapper, vtkImageMapper, vtkLabeledDataMapper, vtkMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper2D, vtkPolyDataMapper, vtkPolyDataMapper2D, vtkTextMapper, vtkVolumeMapper, vtkVolumeProMapper, vtkVolumeRayCastMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, vtkWin32ImageMapper, and vtkXImageMapper.

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

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

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 vtkDataSetMapper, vtkLabeledDataMapper, vtkMapper, vtkMesaPolyDataMapper, vtkOpenGLPolyDataMapper, vtkVolumeMapper, vtkVolumeRayCastMapper, vtkWin32OpenGLTextMapper, vtkXMesaTextMapper, and vtkXOpenGLTextMapper. Definition at line 88 of file vtkAbstractMapper.h.

virtual float 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.

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

Internal helper function for getting the active scalars. The scalar mode indicates where the scalars come from; 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 130 of file vtkAbstractMapper.h.

float vtkAbstractMapper::TimeToDraw [protected]

Definition at line 131 of file vtkAbstractMapper.h.

vtkWindow* vtkAbstractMapper::LastWindow [protected]

Definition at line 132 of file vtkAbstractMapper.h.

vtkPlaneCollection* vtkAbstractMapper::ClippingPlanes [protected]

Definition at line 133 of file vtkAbstractMapper.h.

---

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

• Common/vtkAbstractMapper.h

---