Main Page | Directories | Class Hierarchy | Alphabetical List | Class List | 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
Created by:
  • Avila, Lisa
CVS contributions (if > 5%):
  • Avila, Lisa (64%)
  • Martin, Ken (9%)
  • Schroeder, Will (7%)
  • Barre, Sebastien (7%)
CVS logs (CVSweb):
  • .cxx (/Rendering/vtkVolumeMapper.cxx)
  • .h (/Rendering/vtkVolumeMapper.h)

Definition at line 58 of file vtkVolumeMapper.h.

Public Types

typedef vtkAbstractVolumeMapper Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Render (vtkRenderer *ren, vtkVolume *vol)=0
virtual void ReleaseGraphicsResources (vtkWindow *)
virtual void SetInput (vtkImageData *)
virtual void SetInput (vtkDataSet *)
vtkImageDataGetInput ()
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 ()
virtual void SetUseImageClipper (int)
virtual int GetUseImageClipper ()
virtual void UseImageClipperOn ()
virtual void UseImageClipperOff ()

Static Public Member Functions

int IsTypeOf (const char *type)
vtkVolumeMapperSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkVolumeMapper ()
 ~vtkVolumeMapper ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void RemoveReferences ()
void ConvertCroppingRegionPlanesToVoxels ()

Protected Attributes

int Cropping
double CroppingRegionPlanes [6]
double VoxelCroppingRegionPlanes [6]
int CroppingRegionFlags
int UseImageClipper
vtkImageClipImageClipper


Member Typedef Documentation

typedef vtkAbstractVolumeMapper vtkVolumeMapper::Superclass
 

Reimplemented from vtkAbstractVolumeMapper.

Reimplemented in vtkMesaVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeRayCastMapper, vtkOpenGLVolumeShearWarpMapper, vtkOpenGLVolumeTextureMapper2D, vtkVolumeProMapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeShearWarpMapper, vtkVolumeTextureMapper, and vtkVolumeTextureMapper2D.

Definition at line 61 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 vtkMesaVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeRayCastMapper, vtkOpenGLVolumeShearWarpMapper, vtkOpenGLVolumeTextureMapper2D, vtkVolumeProMapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeShearWarpMapper, 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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkAbstractVolumeMapper.

Reimplemented in vtkMesaVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeRayCastMapper, vtkOpenGLVolumeShearWarpMapper, vtkOpenGLVolumeTextureMapper2D, vtkVolumeProMapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeShearWarpMapper, 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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkAbstractVolumeMapper.

Reimplemented in vtkMesaVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeRayCastMapper, vtkOpenGLVolumeShearWarpMapper, vtkOpenGLVolumeTextureMapper2D, vtkVolumeProMapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeShearWarpMapper, vtkVolumeTextureMapper, and vtkVolumeTextureMapper2D.

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

Reimplemented from vtkAbstractVolumeMapper.

Reimplemented in vtkMesaVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeRayCastMapper, vtkOpenGLVolumeShearWarpMapper, vtkOpenGLVolumeTextureMapper2D, vtkVolumeProMapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeShearWarpMapper, vtkVolumeTextureMapper, and vtkVolumeTextureMapper2D.

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 vtkMesaVolumeRayCastMapper, vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeProVP1000Mapper, vtkOpenGLVolumeRayCastMapper, vtkOpenGLVolumeShearWarpMapper, vtkOpenGLVolumeTextureMapper2D, vtkVolumeProMapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeShearWarpMapper, vtkVolumeTextureMapper, and vtkVolumeTextureMapper2D.

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  ) 
 

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 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 vtkMesaVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper2D, vtkVolumeProMapper, vtkVolumeProVP1000Mapper, vtkVolumeRayCastMapper, vtkVolumeShearWarpMapper, 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 vtkAbstractVolumeMapper.

Reimplemented in vtkVolumeRayCastMapper.

Definition at line 127 of file vtkVolumeMapper.h.

virtual void vtkVolumeMapper::SetUseImageClipper int   )  [virtual]
 

The default behaviour is to use a vtkImageClip on input to ensure it is the right size. Allow the user to turn that behaviour off.

virtual int vtkVolumeMapper::GetUseImageClipper  )  [virtual]
 

The default behaviour is to use a vtkImageClip on input to ensure it is the right size. Allow the user to turn that behaviour off.

virtual void vtkVolumeMapper::UseImageClipperOn  )  [virtual]
 

The default behaviour is to use a vtkImageClip on input to ensure it is the right size. Allow the user to turn that behaviour off.

virtual void vtkVolumeMapper::UseImageClipperOff  )  [virtual]
 

The default behaviour is to use a vtkImageClip on input to ensure it is the right size. Allow the user to turn that behaviour off.

virtual void vtkVolumeMapper::ReportReferences vtkGarbageCollector  )  [protected, virtual]
 

Reimplemented from vtkProcessObject.

Reimplemented in vtkVolumeRayCastMapper, and vtkVolumeTextureMapper.

virtual void vtkVolumeMapper::RemoveReferences  )  [protected, virtual]
 

Reimplemented from vtkProcessObject.

Reimplemented in vtkVolumeRayCastMapper, and vtkVolumeTextureMapper.

void vtkVolumeMapper::ConvertCroppingRegionPlanesToVoxels  )  [protected]
 


Member Data Documentation

int vtkVolumeMapper::Cropping [protected]
 

Definition at line 148 of file vtkVolumeMapper.h.

double vtkVolumeMapper::CroppingRegionPlanes[6] [protected]
 

Definition at line 149 of file vtkVolumeMapper.h.

double vtkVolumeMapper::VoxelCroppingRegionPlanes[6] [protected]
 

Definition at line 150 of file vtkVolumeMapper.h.

int vtkVolumeMapper::CroppingRegionFlags [protected]
 

Definition at line 151 of file vtkVolumeMapper.h.

int vtkVolumeMapper::UseImageClipper [protected]
 

Definition at line 155 of file vtkVolumeMapper.h.

vtkImageClip* vtkVolumeMapper::ImageClipper [protected]
 

Definition at line 156 of file vtkVolumeMapper.h.


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