---

vtkAbstractMapper3D Class Reference

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

#include <vtkAbstractMapper3D.h>

Inheritance diagram for vtkAbstractMapper3D:

[legend]Collaboration diagram for vtkAbstractMapper3D:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual float *	GetBounds ()=0
virtual void	GetBounds (float bounds[6])
float *	GetCenter ()
float	GetLength ()
virtual int	IsARayCastMapper ()
virtual int	IsARenderIntoImageMapper ()
virtual void	Update ()=0
void	AddClippingPlane (vtkPlane *plane)
void	RemoveClippingPlane (vtkPlane *plane)
void	RemoveAllClippingPlanes ()
virtual void	SetClippingPlanes (vtkPlaneCollection *)
virtual vtkPlaneCollection *	GetClippingPlanes ()
void	SetClippingPlanes (vtkPlanes *planes)
Static Public Methods
int	IsTypeOf (const char *type)
vtkAbstractMapper3D *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkAbstractMapper3D ()
	~vtkAbstractMapper3D ()
	vtkAbstractMapper3D (const vtkAbstractMapper3D &)
void	operator= (const vtkAbstractMapper3D &)
Protected Attributes
float	Bounds [6]
float	Center [3]
vtkPlaneCollection *	ClippingPlanes

---

Detailed Description

abstract class specifies interface to map 3D data.

Date:

2000/12/10 20:08:29

Revision:

1.10

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

This class also defines an API to support hardware clipping planes (at most six planes can be defined). It also provides geometric data about the input data it maps, such as the bounding box and center.

See also:

vtkAbstractMapper vtkMapper vtkPolyDataMapper vtkVolumeMapper

Definition at line 69 of file vtkAbstractMapper3D.h.

---

Constructor & Destructor Documentation

vtkAbstractMapper3D::vtkAbstractMapper3D (    )  [protected]

vtkAbstractMapper3D::~vtkAbstractMapper3D (    )  [protected]

vtkAbstractMapper3D::vtkAbstractMapper3D (  const vtkAbstractMapper3D &    )  [inline, protected]

Definition at line 117 of file vtkAbstractMapper3D.h.

---

Member Function Documentation

virtual const char* vtkAbstractMapper3D::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 vtkAbstractMapper. Reimplemented in vtkOpenGLVolumeProVG500Mapper, vtkVolumeProMapper, vtkVolumeProVG500Mapper, vtkDataSetMapper, vtkMapper, vtkMesaPolyDataMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLPolyDataMapper, vtkOpenGLVolumeTextureMapper2D, vtkPolyDataMapper, vtkVolumeMapper, vtkVolumeRayCastMapper, vtkVolumeTextureMapper, and vtkVolumeTextureMapper2D.

int vtkAbstractMapper3D::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 vtkAbstractMapper. Reimplemented in vtkOpenGLVolumeProVG500Mapper, vtkVolumeProMapper, vtkVolumeProVG500Mapper, vtkDataSetMapper, vtkMapper, vtkMesaPolyDataMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLPolyDataMapper, vtkOpenGLVolumeTextureMapper2D, vtkPolyDataMapper, vtkVolumeMapper, vtkVolumeRayCastMapper, vtkVolumeTextureMapper, and vtkVolumeTextureMapper2D.

virtual int vtkAbstractMapper3D::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 vtkAbstractMapper. Reimplemented in vtkOpenGLVolumeProVG500Mapper, vtkVolumeProMapper, vtkVolumeProVG500Mapper, vtkDataSetMapper, vtkMapper, vtkMesaPolyDataMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLPolyDataMapper, vtkOpenGLVolumeTextureMapper2D, vtkPolyDataMapper, vtkVolumeMapper, vtkVolumeRayCastMapper, vtkVolumeTextureMapper, and vtkVolumeTextureMapper2D.

vtkAbstractMapper3D* vtkAbstractMapper3D::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 vtkAbstractMapper. Reimplemented in vtkOpenGLVolumeProVG500Mapper, vtkVolumeProMapper, vtkVolumeProVG500Mapper, vtkDataSetMapper, vtkMapper, vtkMesaPolyDataMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLPolyDataMapper, vtkOpenGLVolumeTextureMapper2D, vtkPolyDataMapper, vtkVolumeMapper, vtkVolumeRayCastMapper, vtkVolumeTextureMapper, and vtkVolumeTextureMapper2D.

void vtkAbstractMapper3D::PrintSelf (  ostream &    os, vtkIndent    index )  [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 vtkAbstractMapper. Reimplemented in vtkVolumeProMapper, vtkDataSetMapper, vtkMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper2D, vtkPolyDataMapper, vtkVolumeMapper, vtkVolumeRayCastMapper, vtkVolumeTextureMapper, and vtkVolumeTextureMapper2D.

virtual float* vtkAbstractMapper3D::GetBounds (    )  [pure virtual]

Return bounding box (array of six floats) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax). Reimplemented in vtkMapper, and vtkVolumeMapper. Referenced by vtkVolumeMapper::GetBounds(), and vtkMapper::GetBounds().

virtual void vtkAbstractMapper3D::GetBounds (  float    bounds[6] )  [virtual]

Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). Reimplemented in vtkMapper, and vtkVolumeMapper.

float* vtkAbstractMapper3D::GetCenter (    )

Return the Center of this mapper's data.

float vtkAbstractMapper3D::GetLength (    )

Return the diagonal length of this mappers bounding box.

virtual int vtkAbstractMapper3D::IsARayCastMapper (    )  [inline, virtual]

Is this a ray cast mapper? A subclass would return 1 if the ray caster is needed to generate an image from this mapper. Reimplemented in vtkVolumeRayCastMapper. Definition at line 90 of file vtkAbstractMapper3D.h.

virtual int vtkAbstractMapper3D::IsARenderIntoImageMapper (    )  [inline, virtual]

Is this a "render into image" mapper? A subclass would return 1 if the mapper produces an image by rendering into a software image buffer. Definition at line 95 of file vtkAbstractMapper3D.h.

virtual void vtkAbstractMapper3D::Update (    )  [pure virtual]

Update the network connected to this mapper. Reimplemented in vtkMapper, vtkPolyDataMapper, vtkVolumeMapper, and vtkVolumeTextureMapper.

void vtkAbstractMapper3D::AddClippingPlane (  vtkPlane *    plane )

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

void vtkAbstractMapper3D::RemoveClippingPlane (  vtkPlane *    plane )

void vtkAbstractMapper3D::RemoveAllClippingPlanes (    )

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

Get/Set the vtkPlaneCollection which specifies the clipping planes.

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

void vtkAbstractMapper3D::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 vtkAbstractMapper3D::operator= (  const vtkAbstractMapper3D &    )  [inline, protected]

Definition at line 118 of file vtkAbstractMapper3D.h.

---

Member Data Documentation

float vtkAbstractMapper3D::Bounds[6] [protected]

Definition at line 120 of file vtkAbstractMapper3D.h.

float vtkAbstractMapper3D::Center[3] [protected]

Definition at line 121 of file vtkAbstractMapper3D.h.

vtkPlaneCollection* vtkAbstractMapper3D::ClippingPlanes [protected]

Definition at line 123 of file vtkAbstractMapper3D.h.

---

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

• graphics/vtkAbstractMapper3D.h

---