Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkVolumeMapper Class Reference

#include <vtkVolumeMapper.h>

Inheritance diagram for vtkVolumeMapper:

Inheritance graph
[legend]
Collaboration diagram for vtkVolumeMapper:

Collaboration graph
[legend]
List of all members.

Detailed Description

Abstract class for a volume mapper.

vtkVolumeMapper is the abstract definition of a volume mapper for regular rectilinear data (vtkImageData). Several basic types of volume mappers are supported.

See also:
vtkVolumeRayCastMapper vtkVolumeTextureMapper2D

Definition at line 44 of file vtkVolumeMapper.h.

Public Types

typedef vtkAbstractVolumeMapper Superclass
enum  { COMPOSITE_BLEND, MAXIMUM_INTENSITY_BLEND }

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void Render (vtkRenderer *ren, vtkVolume *vol)=0
virtual void ReleaseGraphicsResources (vtkWindow *)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetInput (vtkImageData *)
virtual void SetInput (vtkDataSet *)
vtkImageData * GetInput ()
virtual void SetBlendMode (int)
void SetBlendModeToComposite ()
void SetBlendModeToMaximumIntensity ()
virtual int GetBlendMode ()
virtual void SetCropping (int)
virtual int GetCropping ()
virtual void CroppingOn ()
virtual void CroppingOff ()
virtual void SetCroppingRegionPlanes (double, double, double, double, double, double)
virtual void SetCroppingRegionPlanes (double[6])
virtual double * GetCroppingRegionPlanes ()
virtual void GetCroppingRegionPlanes (double data[6])
virtual double * GetVoxelCroppingRegionPlanes ()
virtual void GetVoxelCroppingRegionPlanes (double data[6])
virtual void SetCroppingRegionFlags (int)
virtual int GetCroppingRegionFlags ()
void SetCroppingRegionFlagsToSubVolume ()
void SetCroppingRegionFlagsToFence ()
void SetCroppingRegionFlagsToInvertedFence ()
void SetCroppingRegionFlagsToCross ()
void SetCroppingRegionFlagsToInvertedCross ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkVolumeMapper * SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkVolumeMapper ()
 ~vtkVolumeMapper ()
void ConvertCroppingRegionPlanesToVoxels ()
virtual int FillInputPortInformation (int, vtkInformation *)

Protected Attributes

int BlendMode
int Cropping
double CroppingRegionPlanes [6]
double VoxelCroppingRegionPlanes [6]
int CroppingRegionFlags

Member Typedef Documentation

typedef vtkAbstractVolumeMapper vtkVolumeMapper::Superclass
 

Reimplemented from vtkAbstractVolumeMapper.

Reimplemented in vtkFixedPointVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeShearWarpMapper, vtkOpenGLVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, vtkVolumeProMapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeShearWarpMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, and vtkVolumeTextureMapper3D.

Definition at line 47 of file vtkVolumeMapper.h.

Member Enumeration Documentation

anonymous enum
 

Enumerator:
COMPOSITE_BLEND 
MAXIMUM_INTENSITY_BLEND 

Definition at line 129 of file vtkVolumeMapper.h.

Constructor & Destructor Documentation

vtkVolumeMapper::vtkVolumeMapper (   )  [protected]
 

vtkVolumeMapper::~vtkVolumeMapper (   )  [protected]
 

Member Function Documentation

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

Reimplemented from vtkAbstractVolumeMapper.

Reimplemented in vtkFixedPointVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeShearWarpMapper, vtkOpenGLVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, vtkVolumeProMapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeShearWarpMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, and vtkVolumeTextureMapper3D.

static 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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkAbstractVolumeMapper.

Reimplemented in vtkFixedPointVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeShearWarpMapper, vtkOpenGLVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, vtkVolumeProMapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeShearWarpMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, and vtkVolumeTextureMapper3D.

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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkAbstractVolumeMapper.

Reimplemented in vtkFixedPointVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeShearWarpMapper, vtkOpenGLVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, vtkVolumeProMapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeShearWarpMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, and vtkVolumeTextureMapper3D.

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

Reimplemented from vtkAbstractVolumeMapper.

Reimplemented in vtkFixedPointVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeShearWarpMapper, vtkOpenGLVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, vtkVolumeProMapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeShearWarpMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, and vtkVolumeTextureMapper3D.

void vtkVolumeMapper::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 vtkAbstractVolumeMapper.

Reimplemented in vtkFixedPointVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeShearWarpMapper, vtkOpenGLVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, vtkVolumeProMapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeShearWarpMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, and vtkVolumeTextureMapper3D.

virtual void vtkVolumeMapper::SetInput (  vtkImageData *   )  [virtual]
 

Set/Get the input data

virtual void vtkVolumeMapper::SetInput (  vtkDataSet *   )  [virtual]
 

Set/Get the input data

Reimplemented from vtkAbstractVolumeMapper.

vtkImageData* vtkVolumeMapper::GetInput (   ) 
 

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

Set/Get the blend mode. Currently this is only supported by the vtkFixedPointVolumeRayCastMapper - other mappers have different ways to set this (supplying a function to a vtkVolumeRayCastMapper) or don't have any options (vtkVolumeTextureMapper2D supports only compositing)

Reimplemented in vtkVolumeProMapper.

Referenced by vtkVolumeProMapper::SetBlendModeToComposite(), vtkVolumeProMapper::SetBlendModeToMaximumIntensity(), and vtkVolumeProMapper::SetBlendModeToMinimumIntensity().

void vtkVolumeMapper::SetBlendModeToComposite (   )  [inline]
 

Set/Get the blend mode. Currently this is only supported by the vtkFixedPointVolumeRayCastMapper - other mappers have different ways to set this (supplying a function to a vtkVolumeRayCastMapper) or don't have any options (vtkVolumeTextureMapper2D supports only compositing)

Reimplemented in vtkVolumeProMapper.

Definition at line 64 of file vtkVolumeMapper.h.

References COMPOSITE_BLEND.

void vtkVolumeMapper::SetBlendModeToMaximumIntensity (   )  [inline]
 

Set/Get the blend mode. Currently this is only supported by the vtkFixedPointVolumeRayCastMapper - other mappers have different ways to set this (supplying a function to a vtkVolumeRayCastMapper) or don't have any options (vtkVolumeTextureMapper2D supports only compositing)

Reimplemented in vtkVolumeProMapper.

Definition at line 66 of file vtkVolumeMapper.h.

References MAXIMUM_INTENSITY_BLEND.

virtual int vtkVolumeMapper::GetBlendMode (   )  [virtual]
 

Set/Get the blend mode. Currently this is only supported by the vtkFixedPointVolumeRayCastMapper - other mappers have different ways to set this (supplying a function to a vtkVolumeRayCastMapper) or don't have any options (vtkVolumeTextureMapper2D supports only compositing)

Reimplemented in vtkVolumeProMapper.

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 (  double  ,
double  ,
double  ,
double  ,
double  ,
double 
)  [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 (  double  [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 double* 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 (  double  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 double* vtkVolumeMapper::GetVoxelCroppingRegionPlanes (   )  [virtual]
 

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

virtual void vtkVolumeMapper::GetVoxelCroppingRegionPlanes (  double  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 105 of file vtkVolumeMapper.h.

References VTK_CROP_SUBVOLUME.

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 107 of file vtkVolumeMapper.h.

References VTK_CROP_FENCE.

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 109 of file vtkVolumeMapper.h.

References VTK_CROP_INVERTED_FENCE.

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 111 of file vtkVolumeMapper.h.

References VTK_CROP_CROSS.

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 113 of file vtkVolumeMapper.h.

References VTK_CROP_INVERTED_CROSS.

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

Implements vtkAbstractVolumeMapper.

Implemented in vtkFixedPointVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, vtkVolumeProMapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeShearWarpMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, and vtkVolumeTextureMapper3D.

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 vtkAbstractVolumeMapper.

Reimplemented in vtkOpenGLVolumeTextureMapper3D, and vtkVolumeRayCastMapper.

Definition at line 127 of file vtkVolumeMapper.h.

void vtkVolumeMapper::ConvertCroppingRegionPlanesToVoxels (   )  [protected]
 

virtual int vtkVolumeMapper::FillInputPortInformation (  int  ,
vtkInformation * 
)  [protected, virtual]
 

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAbstractVolumeMapper.

Member Data Documentation

int vtkVolumeMapper::BlendMode [protected]
 

Reimplemented in vtkVolumeProMapper.

Definition at line 140 of file vtkVolumeMapper.h.

int vtkVolumeMapper::Cropping [protected]
 

Definition at line 144 of file vtkVolumeMapper.h.

double vtkVolumeMapper::CroppingRegionPlanes[6] [protected]
 

Definition at line 145 of file vtkVolumeMapper.h.

double vtkVolumeMapper::VoxelCroppingRegionPlanes[6] [protected]
 

Definition at line 146 of file vtkVolumeMapper.h.

int vtkVolumeMapper::CroppingRegionFlags [protected]
 

Definition at line 147 of file vtkVolumeMapper.h.

Referenced by vtkFixedPointVolumeRayCastMapper::CheckIfCropped().

The documentation for this class was generated from the following file:
Generated on Tue Jan 22 00:28:38 2008 for VTK by  doxygen 1.4.3-20050530