Abstract class for a volume mapper. More...
#include <vtkVolumeMapper.h>
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.
Definition at line 45 of file vtkVolumeMapper.h.
Member Typedef Documentation
Reimplemented from vtkAbstractVolumeMapper.
Reimplemented in vtkSmartVolumeMapper, vtkFixedPointVolumeRayCastMapper, vtkVolumeTextureMapper3D, vtkVolumeRayCastMapper, vtkOpenGLGPUVolumeRayCastMapper, vtkGPUVolumeRayCastMapper, vtkAMRVolumeMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, and vtkOpenGLVolumeTextureMapper2D.
Definition at line 48 of file vtkVolumeMapper.h.
Member Enumeration Documentation
| anonymous enum |
Definition at line 135 of file vtkVolumeMapper.h.
Constructor & Destructor Documentation
| vtkVolumeMapper::vtkVolumeMapper | ( | ) | [protected] |
| vtkVolumeMapper::~vtkVolumeMapper | ( | ) | [protected] |
Member Function Documentation
| static int vtkVolumeMapper::IsTypeOf | ( | const char * | name | ) | [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 vtkAbstractVolumeMapper.
Reimplemented in vtkSmartVolumeMapper, vtkFixedPointVolumeRayCastMapper, vtkVolumeTextureMapper3D, vtkVolumeRayCastMapper, vtkOpenGLGPUVolumeRayCastMapper, vtkGPUVolumeRayCastMapper, vtkAMRVolumeMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, and vtkOpenGLVolumeTextureMapper2D.
| virtual int vtkVolumeMapper::IsA | ( | const char * | name | ) | [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 vtkAbstractVolumeMapper.
Reimplemented in vtkSmartVolumeMapper, vtkFixedPointVolumeRayCastMapper, vtkVolumeTextureMapper3D, vtkVolumeRayCastMapper, vtkOpenGLGPUVolumeRayCastMapper, vtkGPUVolumeRayCastMapper, vtkAMRVolumeMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, and vtkOpenGLVolumeTextureMapper2D.
| static vtkVolumeMapper* vtkVolumeMapper::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkAbstractVolumeMapper.
Reimplemented in vtkSmartVolumeMapper, vtkFixedPointVolumeRayCastMapper, vtkVolumeTextureMapper3D, vtkVolumeRayCastMapper, vtkOpenGLGPUVolumeRayCastMapper, vtkGPUVolumeRayCastMapper, vtkAMRVolumeMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, and vtkOpenGLVolumeTextureMapper2D.
| virtual vtkObjectBase* vtkVolumeMapper::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkAbstractVolumeMapper.
Reimplemented in vtkSmartVolumeMapper, vtkFixedPointVolumeRayCastMapper, vtkVolumeTextureMapper3D, vtkVolumeRayCastMapper, vtkOpenGLGPUVolumeRayCastMapper, vtkGPUVolumeRayCastMapper, vtkAMRVolumeMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, and vtkOpenGLVolumeTextureMapper2D.
| vtkVolumeMapper* vtkVolumeMapper::NewInstance | ( | ) | const |
Reimplemented from vtkAbstractVolumeMapper.
Reimplemented in vtkSmartVolumeMapper, vtkFixedPointVolumeRayCastMapper, vtkVolumeTextureMapper3D, vtkVolumeRayCastMapper, vtkOpenGLGPUVolumeRayCastMapper, vtkGPUVolumeRayCastMapper, vtkAMRVolumeMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, and vtkOpenGLVolumeTextureMapper2D.
| 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, vtkVolumeTextureMapper3D, vtkVolumeRayCastMapper, vtkOpenGLGPUVolumeRayCastMapper, vtkGPUVolumeRayCastMapper, vtkAMRVolumeMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, and vtkOpenGLVolumeTextureMapper2D.
| virtual void vtkVolumeMapper::SetInputData | ( | vtkImageData * | ) | [virtual] |
Set/Get the input data
Reimplemented in vtkAMRVolumeMapper.
| virtual void vtkVolumeMapper::SetInputData | ( | vtkDataSet * | ) | [virtual] |
Set/Get the input data
Reimplemented in vtkAMRVolumeMapper.
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 vtkAMRVolumeMapper.
| 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.
Definition at line 66 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.
Definition at line 68 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.
Definition at line 70 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 72 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 vtkAMRVolumeMapper.
| virtual void vtkVolumeMapper::SetCropping | ( | int | ) | [virtual] |
Turn On/Off orthogonal cropping. (Clipping planes are perpendicular to the coordinate axes.)
Reimplemented in vtkAMRVolumeMapper.
| virtual int vtkVolumeMapper::GetCropping | ( | ) | [virtual] |
Turn On/Off orthogonal cropping. (Clipping planes are perpendicular to the coordinate axes.)
Reimplemented in vtkAMRVolumeMapper.
| 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.
Reimplemented in vtkAMRVolumeMapper.
| 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.
Reimplemented in vtkAMRVolumeMapper.
| 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.
Reimplemented in vtkAMRVolumeMapper.
| 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.
Reimplemented in vtkAMRVolumeMapper.
| 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 111 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 113 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 115 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 117 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 119 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
Implements vtkAbstractVolumeMapper.
Implemented in vtkSmartVolumeMapper, vtkAMRVolumeMapper, vtkFixedPointVolumeRayCastMapper, vtkGPUVolumeRayCastMapper, vtkVolumeRayCastMapper, vtkVolumeTextureMapper3D, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, and vtkOpenGLVolumeTextureMapper2D.
| 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, vtkAMRVolumeMapper, vtkGPUVolumeRayCastMapper, vtkVolumeRayCastMapper, vtkOpenGLGPUVolumeRayCastMapper, and vtkOpenGLVolumeTextureMapper3D.
Definition at line 133 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.
Reimplemented in vtkAMRVolumeMapper.
Member Data Documentation
int vtkVolumeMapper::BlendMode [protected] |
Definition at line 148 of file vtkVolumeMapper.h.
int vtkVolumeMapper::Cropping [protected] |
Definition at line 152 of file vtkVolumeMapper.h.
double vtkVolumeMapper::CroppingRegionPlanes[6] [protected] |
Definition at line 153 of file vtkVolumeMapper.h.
double vtkVolumeMapper::VoxelCroppingRegionPlanes[6] [protected] |
Definition at line 154 of file vtkVolumeMapper.h.
int vtkVolumeMapper::CroppingRegionFlags [protected] |
Definition at line 155 of file vtkVolumeMapper.h.
The documentation for this class was generated from the following file:
- dox/Rendering/Volume/vtkVolumeMapper.h
