---

vtkVolumeMapper Class Reference

Abstract class for a volume mapper. More...

#include <vtkVolumeMapper.h>

Inheritance diagram for vtkVolumeMapper:

[legend]Collaboration diagram for vtkVolumeMapper:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent index)
virtual void	Update ()
virtual void	Render (vtkRenderer *ren, vtkVolume *vol)=0
virtual void	ReleaseGraphicsResources (vtkWindow *)
void	SetInput (vtkImageData *)
vtkImageData *	GetInput ()
virtual void	SetCropping (int)
virtual int	GetCropping ()
virtual void	CroppingOn ()
virtual void	CroppingOff ()
virtual void	SetCroppingRegionPlanes (float, float, float, float, float, float)
virtual void	SetCroppingRegionPlanes (float[6])
virtual float *	GetCroppingRegionPlanes ()
virtual void	GetCroppingRegionPlanes (float data[6])
virtual float *	GetVoxelCroppingRegionPlanes ()
virtual void	GetVoxelCroppingRegionPlanes (float data[6])
virtual void	SetCroppingRegionFlags (int)
virtual int	GetCroppingRegionFlags ()
void	SetCroppingRegionFlagsToSubVolume ()
void	SetCroppingRegionFlagsToFence ()
void	SetCroppingRegionFlagsToInvertedFence ()
void	SetCroppingRegionFlagsToCross ()
void	SetCroppingRegionFlagsToInvertedCross ()
void	SetRGBTextureInput (vtkImageData *rgbTexture)
virtual vtkImageData *	GetRGBTextureInput ()
virtual float *	GetBounds ()
virtual void	GetBounds (float bounds[6])
virtual float	GetGradientMagnitudeScale ()
virtual float	GetGradientMagnitudeBias ()
Static Public Methods
int	IsTypeOf (const char *type)
vtkVolumeMapper *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkVolumeMapper ()
	~vtkVolumeMapper ()
void	ConvertCroppingRegionPlanesToVoxels ()
Protected Attributes
int	Cropping
float	CroppingRegionPlanes [6]
float	VoxelCroppingRegionPlanes [6]
int	CroppingRegionFlags
vtkTimeStamp	BuildTime

---

Detailed Description

Abstract class for a volume mapper.

Date:

2001/11/26 17:16:46

Revision:

1.51

vtkVolumeMapper is the abstract definition of a volume mapper. Several basic types of volume mappers are supported. There are ray casters, which produce an image that must be merged with geometry, there are hardware methods that blend with geometry, and some combinations of these.

See also:

vtkVolumeRayCastMapper

Definition at line 73 of file vtkVolumeMapper.h.

---

Constructor & Destructor Documentation

vtkVolumeMapper::vtkVolumeMapper (    )  [protected]

vtkVolumeMapper::~vtkVolumeMapper (    )  [protected]

---

Member Function Documentation

virtual const char* vtkVolumeMapper::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 vtkAbstractMapper3D. Reimplemented in vtkMesaVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVG500Mapper, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeRayCastMapper, vtkOpenGLVolumeTextureMapper2D, vtkVolumeProMapper, vtkVolumeProVG500Mapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeTextureMapper, and vtkVolumeTextureMapper2D.

int vtkVolumeMapper::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 vtkAbstractMapper3D. Reimplemented in vtkMesaVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVG500Mapper, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeRayCastMapper, vtkOpenGLVolumeTextureMapper2D, vtkVolumeProMapper, vtkVolumeProVG500Mapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeTextureMapper, and vtkVolumeTextureMapper2D.

virtual int vtkVolumeMapper::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 vtkAbstractMapper3D. Reimplemented in vtkMesaVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVG500Mapper, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeRayCastMapper, vtkOpenGLVolumeTextureMapper2D, vtkVolumeProMapper, vtkVolumeProVG500Mapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeTextureMapper, and vtkVolumeTextureMapper2D.

vtkVolumeMapper* vtkVolumeMapper::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 vtkAbstractMapper3D. Reimplemented in vtkMesaVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVG500Mapper, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeRayCastMapper, vtkOpenGLVolumeTextureMapper2D, vtkVolumeProMapper, vtkVolumeProVG500Mapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeTextureMapper, and vtkVolumeTextureMapper2D.

void vtkVolumeMapper::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 vtkAbstractMapper3D. Reimplemented in vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper2D, vtkVolumeProMapper, vtkVolumeRayCastMapper, vtkVolumeTextureMapper, and vtkVolumeTextureMapper2D.

virtual void vtkVolumeMapper::Update (  void    )  [virtual]

Update the volume rendering pipeline by updating the scalar input Reimplemented from vtkAbstractMapper3D. Reimplemented in vtkVolumeTextureMapper.

void vtkVolumeMapper::SetInput (  vtkImageData *    )

Set/Get the input data

vtkImageData* vtkVolumeMapper::GetInput (    )

Set/Get the input data

virtual void vtkVolumeMapper::SetCropping (  int    )  [virtual]

Turn On/Off orthogonal cropping. (Clipping planes are perpendicular to the coordinate axes.)

virtual int vtkVolumeMapper::GetCropping (    )  [virtual]

Turn On/Off orthogonal cropping. (Clipping planes are perpendicular to the coordinate axes.)

virtual void vtkVolumeMapper::CroppingOn (    )  [virtual]

Turn On/Off orthogonal cropping. (Clipping planes are perpendicular to the coordinate axes.)

virtual void vtkVolumeMapper::CroppingOff (    )  [virtual]

Turn On/Off orthogonal cropping. (Clipping planes are perpendicular to the coordinate axes.)

virtual void vtkVolumeMapper::SetCroppingRegionPlanes (  float   , float   , float   , float   , float   , float    )  [virtual]

Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.

virtual void vtkVolumeMapper::SetCroppingRegionPlanes (  float   [6] )  [virtual]

Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.

virtual float* vtkVolumeMapper::GetCroppingRegionPlanes (    )  [virtual]

Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.

virtual void vtkVolumeMapper::GetCroppingRegionPlanes (  float    data[6] )  [virtual]

Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.

virtual float* vtkVolumeMapper::GetVoxelCroppingRegionPlanes (    )  [virtual]

Get the cropping region planes in voxels. Only valid during the rendering process

virtual void vtkVolumeMapper::GetVoxelCroppingRegionPlanes (  float    data[6] )  [virtual]

Get the cropping region planes in voxels. Only valid during the rendering process

virtual void vtkVolumeMapper::SetCroppingRegionFlags (  int    )  [virtual]

Set the flags for the cropping regions. The clipping planes divide the volume into 27 regions - there is one bit for each region. The regions start from the one containing voxel (0,0,0), moving along the x axis fastest, the y axis next, and the z axis slowest. These are represented from the lowest bit to bit number 27 in the integer containing the flags. There are several convenience functions to set some common configurations - subvolume (the default), fence (between any of the clip plane pairs), inverted fence, cross (between any two of the clip plane pairs) and inverted cross.

virtual int vtkVolumeMapper::GetCroppingRegionFlags (    )  [virtual]

Set the flags for the cropping regions. The clipping planes divide the volume into 27 regions - there is one bit for each region. The regions start from the one containing voxel (0,0,0), moving along the x axis fastest, the y axis next, and the z axis slowest. These are represented from the lowest bit to bit number 27 in the integer containing the flags. There are several convenience functions to set some common configurations - subvolume (the default), fence (between any of the clip plane pairs), inverted fence, cross (between any two of the clip plane pairs) and inverted cross.

void vtkVolumeMapper::SetCroppingRegionFlagsToSubVolume (    )  [inline]

Set the flags for the cropping regions. The clipping planes divide the volume into 27 regions - there is one bit for each region. The regions start from the one containing voxel (0,0,0), moving along the x axis fastest, the y axis next, and the z axis slowest. These are represented from the lowest bit to bit number 27 in the integer containing the flags. There are several convenience functions to set some common configurations - subvolume (the default), fence (between any of the clip plane pairs), inverted fence, cross (between any two of the clip plane pairs) and inverted cross. Definition at line 122 of file vtkVolumeMapper.h.

void vtkVolumeMapper::SetCroppingRegionFlagsToFence (    )  [inline]

Set the flags for the cropping regions. The clipping planes divide the volume into 27 regions - there is one bit for each region. The regions start from the one containing voxel (0,0,0), moving along the x axis fastest, the y axis next, and the z axis slowest. These are represented from the lowest bit to bit number 27 in the integer containing the flags. There are several convenience functions to set some common configurations - subvolume (the default), fence (between any of the clip plane pairs), inverted fence, cross (between any two of the clip plane pairs) and inverted cross. Definition at line 124 of file vtkVolumeMapper.h.

void vtkVolumeMapper::SetCroppingRegionFlagsToInvertedFence (    )  [inline]

Set the flags for the cropping regions. The clipping planes divide the volume into 27 regions - there is one bit for each region. The regions start from the one containing voxel (0,0,0), moving along the x axis fastest, the y axis next, and the z axis slowest. These are represented from the lowest bit to bit number 27 in the integer containing the flags. There are several convenience functions to set some common configurations - subvolume (the default), fence (between any of the clip plane pairs), inverted fence, cross (between any two of the clip plane pairs) and inverted cross. Definition at line 126 of file vtkVolumeMapper.h.

void vtkVolumeMapper::SetCroppingRegionFlagsToCross (    )  [inline]

Set the flags for the cropping regions. The clipping planes divide the volume into 27 regions - there is one bit for each region. The regions start from the one containing voxel (0,0,0), moving along the x axis fastest, the y axis next, and the z axis slowest. These are represented from the lowest bit to bit number 27 in the integer containing the flags. There are several convenience functions to set some common configurations - subvolume (the default), fence (between any of the clip plane pairs), inverted fence, cross (between any two of the clip plane pairs) and inverted cross. Definition at line 128 of file vtkVolumeMapper.h.

void vtkVolumeMapper::SetCroppingRegionFlagsToInvertedCross (    )  [inline]

Set the flags for the cropping regions. The clipping planes divide the volume into 27 regions - there is one bit for each region. The regions start from the one containing voxel (0,0,0), moving along the x axis fastest, the y axis next, and the z axis slowest. These are represented from the lowest bit to bit number 27 in the integer containing the flags. There are several convenience functions to set some common configurations - subvolume (the default), fence (between any of the clip plane pairs), inverted fence, cross (between any two of the clip plane pairs) and inverted cross. Definition at line 130 of file vtkVolumeMapper.h.

void vtkVolumeMapper::SetRGBTextureInput (  vtkImageData *    rgbTexture )

Set/Get the rgb texture input data

virtual vtkImageData* vtkVolumeMapper::GetRGBTextureInput (    )  [virtual]

Set/Get the rgb texture input data

virtual float* vtkVolumeMapper::GetBounds (    )  [virtual]

Return bounding box (array of six floats) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax). Reimplemented from vtkAbstractMapper3D.

virtual void vtkVolumeMapper::GetBounds (  float    bounds[6] )  [inline, virtual]

Return bounding box (array of six floats) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax). Reimplemented from vtkAbstractMapper3D. Definition at line 144 of file vtkVolumeMapper.h.

virtual float vtkVolumeMapper::GetGradientMagnitudeScale (    )  [inline, virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Reimplemented in vtkVolumeRayCastMapper, and vtkVolumeTextureMapper. Definition at line 152 of file vtkVolumeMapper.h.

virtual float vtkVolumeMapper::GetGradientMagnitudeBias (    )  [inline, virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Reimplemented in vtkVolumeRayCastMapper, and vtkVolumeTextureMapper. Definition at line 153 of file vtkVolumeMapper.h.

virtual void vtkVolumeMapper::Render (  vtkRenderer *    ren, vtkVolume *    vol )  [pure virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Render the volume Reimplemented in vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper2D, vtkVolumeProMapper, vtkVolumeProVG500Mapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeTextureMapper, and vtkVolumeTextureMapper2D.

virtual void vtkVolumeMapper::ReleaseGraphicsResources (  vtkWindow *    )  [inline, virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE 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 vtkVolumeRayCastMapper. Definition at line 165 of file vtkVolumeMapper.h.

void vtkVolumeMapper::ConvertCroppingRegionPlanesToVoxels (    )  [protected]

---

Member Data Documentation

int vtkVolumeMapper::Cropping [protected]

Definition at line 173 of file vtkVolumeMapper.h.

float vtkVolumeMapper::CroppingRegionPlanes[6] [protected]

Definition at line 174 of file vtkVolumeMapper.h.

float vtkVolumeMapper::VoxelCroppingRegionPlanes[6] [protected]

Definition at line 175 of file vtkVolumeMapper.h.

int vtkVolumeMapper::CroppingRegionFlags [protected]

Definition at line 176 of file vtkVolumeMapper.h.

vtkTimeStamp vtkVolumeMapper::BuildTime [protected]

Definition at line 177 of file vtkVolumeMapper.h.

---

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

• Rendering/vtkVolumeMapper.h

---