VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkVolumeMapper Class Reference

Abstract class for a volume mapper. More...

#include <vtkVolumeMapper.h>

Inheritance diagram for vtkVolumeMapper:
Inheritance graph
[legend]
Collaboration diagram for vtkVolumeMapper:
Collaboration graph
[legend]

List of all members.

Public Types

enum  { COMPOSITE_BLEND, MAXIMUM_INTENSITY_BLEND, MINIMUM_INTENSITY_BLEND, ADDITIVE_BLEND }
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 SetBlendMode (int)
void SetBlendModeToComposite ()
void SetBlendModeToMaximumIntensity ()
void SetBlendModeToMinimumIntensity ()
void SetBlendModeToAdditive ()
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 doubleGetCroppingRegionPlanes ()
virtual void GetCroppingRegionPlanes (double data[6])
virtual doubleGetVoxelCroppingRegionPlanes ()
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 vtkVolumeMapperSafeDownCast (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

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.


Member Typedef Documentation


Member Enumeration Documentation

anonymous enum
Enumerator:
COMPOSITE_BLEND 
MAXIMUM_INTENSITY_BLEND 
MINIMUM_INTENSITY_BLEND 
ADDITIVE_BLEND 

Definition at line 134 of file vtkVolumeMapper.h.


Constructor & Destructor Documentation

vtkVolumeMapper::vtkVolumeMapper ( ) [protected]
vtkVolumeMapper::~vtkVolumeMapper ( ) [protected]

Member Function Documentation

virtual const char* vtkVolumeMapper::GetClassName ( ) [virtual]
static int vtkVolumeMapper::IsTypeOf ( const char *  name) [static]
virtual int vtkVolumeMapper::IsA ( const char *  name) [virtual]
static vtkVolumeMapper* vtkVolumeMapper::SafeDownCast ( vtkObject o) [static]
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 vtkSmartVolumeMapper, vtkFixedPointVolumeRayCastMapper, vtkVolumeProMapper, vtkVolumeTextureMapper3D, vtkVolumeRayCastMapper, vtkVolumeProVP1000Mapper, vtkOpenGLGPUVolumeRayCastMapper, vtkOpenGLVolumeProVP1000Mapper, vtkGPUVolumeRayCastMapper, vtkOpenGLVolumeTextureMapper3D, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, vtkMesaVolumeTextureMapper2D, and vtkOpenGLVolumeTextureMapper2D.

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::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). Additive blend mode adds scalars along the ray and multiply them by their opacity mapping value.

Reimplemented in vtkVolumeProMapper.

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). Additive blend mode adds scalars along the ray and multiply them by their opacity mapping value.

Reimplemented in vtkVolumeProMapper.

Definition at line 65 of file vtkVolumeMapper.h.

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). Additive blend mode adds scalars along the ray and multiply them by their opacity mapping value.

Reimplemented in vtkVolumeProMapper.

Definition at line 67 of file vtkVolumeMapper.h.

void vtkVolumeMapper::SetBlendModeToMinimumIntensity ( ) [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). Additive blend mode adds scalars along the ray and multiply them by their opacity mapping value.

Reimplemented in vtkVolumeProMapper.

Definition at line 69 of file vtkVolumeMapper.h.

void vtkVolumeMapper::SetBlendModeToAdditive ( ) [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). Additive blend mode adds scalars along the ray and multiply them by their opacity mapping value.

Definition at line 71 of file vtkVolumeMapper.h.

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). Additive blend mode adds scalars along the ray and multiply them by their opacity mapping value.

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 110 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 112 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 114 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 116 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 118 of file vtkVolumeMapper.h.

virtual void vtkVolumeMapper::Render ( vtkRenderer ren,
vtkVolume vol 
) [pure virtual]
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 vtkSmartVolumeMapper, vtkGPUVolumeRayCastMapper, vtkVolumeRayCastMapper, vtkOpenGLGPUVolumeRayCastMapper, and vtkOpenGLVolumeTextureMapper3D.

Definition at line 132 of file vtkVolumeMapper.h.

void vtkVolumeMapper::ConvertCroppingRegionPlanesToVoxels ( ) [protected]
virtual int vtkVolumeMapper::FillInputPortInformation ( int  port,
vtkInformation info 
) [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

Reimplemented in vtkVolumeProMapper.

Definition at line 147 of file vtkVolumeMapper.h.

Definition at line 151 of file vtkVolumeMapper.h.

Definition at line 152 of file vtkVolumeMapper.h.

Definition at line 153 of file vtkVolumeMapper.h.

Definition at line 154 of file vtkVolumeMapper.h.


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