Abstract class for a volume mapper. More...

#include <vtkAbstractVolumeMapper.h>

Inheritance diagram for vtkAbstractVolumeMapper:

Collaboration diagram for vtkAbstractVolumeMapper:

Public Types
typedef vtkAbstractMapper3D	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkAbstractVolumeMapper *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
const char *	GetScalarModeAsString ()
virtual void	Render (vtkRenderer ren, vtkVolume vol)=0
virtual void	ReleaseGraphicsResources (vtkWindow *)

vtkDataSet *	GetDataSetInput ()
vtkDataObject *	GetDataObjectInput ()

virtual double *	GetBounds ()
virtual void	GetBounds (double bounds[6])

virtual void	SetScalarMode (int)
virtual int	GetScalarMode ()
void	SetScalarModeToDefault ()
void	SetScalarModeToUsePointData ()
void	SetScalarModeToUseCellData ()
void	SetScalarModeToUsePointFieldData ()
void	SetScalarModeToUseCellFieldData ()

virtual void	SelectScalarArray (int arrayNum)
virtual void	SelectScalarArray (const char *arrayName)

virtual char *	GetArrayName ()
virtual int	GetArrayId ()
virtual int	GetArrayAccessMode ()

virtual float	GetGradientMagnitudeScale ()
virtual float	GetGradientMagnitudeBias ()
virtual float	GetGradientMagnitudeScale (int)
virtual float	GetGradientMagnitudeBias (int)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkAbstractVolumeMapper *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAbstractVolumeMapper ()
	~vtkAbstractVolumeMapper ()
virtual int	FillInputPortInformation (int port, vtkInformation *info)
Protected Attributes
int	ScalarMode
char *	ArrayName
int	ArrayId
int	ArrayAccessMode

Detailed Description

Abstract class for a volume mapper.

vtkAbstractVolumeMapper is the abstract definition of a volume mapper. Specific subclasses deal with different specific types of data input

See also:: vtkVolumeMapper vtkUnstructuredGridVolumeMapper

Definition at line 37 of file vtkAbstractVolumeMapper.h.

Member Typedef Documentation

typedef vtkAbstractMapper3D vtkAbstractVolumeMapper::Superclass

Constructor & Destructor Documentation

vtkAbstractVolumeMapper::vtkAbstractVolumeMapper ( ) [protected]

vtkAbstractVolumeMapper::~vtkAbstractVolumeMapper ( ) [protected]

Member Function Documentation

static int vtkAbstractVolumeMapper::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 vtkAbstractMapper3D.

Reimplemented in vtkHAVSVolumeMapper, vtkOpenGLHAVSVolumeMapper, vtkSmartVolumeMapper, vtkFixedPointVolumeRayCastMapper, vtkVolumeTextureMapper3D, vtkUnstructuredGridVolumeZSweepMapper, vtkVolumeRayCastMapper, vtkOpenGLGPUVolumeRayCastMapper, vtkProjectedTetrahedraMapper, vtkUnstructuredGridVolumeRayCastMapper, vtkOpenGLProjectedTetrahedraMapper, vtkProjectedAAHexahedraMapper, vtkOpenGLProjectedAAHexahedraMapper, vtkVolumeMapper, vtkGPUVolumeRayCastMapper, vtkAMRVolumeMapper, vtkUnstructuredGridVolumeMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, and vtkOpenGLVolumeTextureMapper2D.

virtual int vtkAbstractVolumeMapper::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 vtkAbstractMapper3D.

Reimplemented in vtkHAVSVolumeMapper, vtkOpenGLHAVSVolumeMapper, vtkSmartVolumeMapper, vtkFixedPointVolumeRayCastMapper, vtkVolumeTextureMapper3D, vtkUnstructuredGridVolumeZSweepMapper, vtkVolumeRayCastMapper, vtkOpenGLGPUVolumeRayCastMapper, vtkProjectedTetrahedraMapper, vtkUnstructuredGridVolumeRayCastMapper, vtkOpenGLProjectedTetrahedraMapper, vtkProjectedAAHexahedraMapper, vtkOpenGLProjectedAAHexahedraMapper, vtkVolumeMapper, vtkGPUVolumeRayCastMapper, vtkAMRVolumeMapper, vtkUnstructuredGridVolumeMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, and vtkOpenGLVolumeTextureMapper2D.

static vtkAbstractVolumeMapper* vtkAbstractVolumeMapper::SafeDownCast ( vtkObjectBase * o ) [static]

virtual vtkObjectBase* vtkAbstractVolumeMapper::NewInstanceInternal ( ) const [protected, virtual]

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

Reimplemented in vtkHAVSVolumeMapper, vtkOpenGLHAVSVolumeMapper, vtkSmartVolumeMapper, vtkFixedPointVolumeRayCastMapper, vtkVolumeTextureMapper3D, vtkUnstructuredGridVolumeZSweepMapper, vtkVolumeRayCastMapper, vtkOpenGLGPUVolumeRayCastMapper, vtkProjectedTetrahedraMapper, vtkOpenGLProjectedTetrahedraMapper, vtkProjectedAAHexahedraMapper, vtkUnstructuredGridVolumeRayCastMapper, vtkOpenGLProjectedAAHexahedraMapper, vtkVolumeMapper, vtkGPUVolumeRayCastMapper, vtkAMRVolumeMapper, vtkUnstructuredGridVolumeMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, vtkOpenGLVolumeTextureMapper3D, and vtkOpenGLVolumeTextureMapper2D.

vtkDataSet* vtkAbstractVolumeMapper::GetDataSetInput ( )

Set/Get the input data

vtkDataObject* vtkAbstractVolumeMapper::GetDataObjectInput ( )

Set/Get the input data

virtual double* vtkAbstractVolumeMapper::GetBounds ( ) [virtual]

Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).

Implements vtkAbstractMapper3D.

Reimplemented in vtkAMRVolumeMapper.

virtual void vtkAbstractVolumeMapper::GetBounds ( double bounds[6] ) [inline, virtual]

Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).

Reimplemented from vtkAbstractMapper3D.

Reimplemented in vtkAMRVolumeMapper.

Definition at line 53 of file vtkAbstractVolumeMapper.h.

virtual void vtkAbstractVolumeMapper::SetScalarMode ( int ) [virtual]

Control how the mapper works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the mapper will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the mapper to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectScalarArray.

Reimplemented in vtkAMRVolumeMapper.

virtual int vtkAbstractVolumeMapper::GetScalarMode ( ) [virtual]

Control how the mapper works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the mapper will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the mapper to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectScalarArray.

void vtkAbstractVolumeMapper::SetScalarModeToDefault ( ) [inline]

Control how the mapper works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the mapper will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the mapper to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectScalarArray.

Definition at line 69 of file vtkAbstractVolumeMapper.h.

void vtkAbstractVolumeMapper::SetScalarModeToUsePointData ( ) [inline]

Control how the mapper works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the mapper will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the mapper to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectScalarArray.

Definition at line 71 of file vtkAbstractVolumeMapper.h.

void vtkAbstractVolumeMapper::SetScalarModeToUseCellData ( ) [inline]

Control how the mapper works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the mapper will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the mapper to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectScalarArray.

Definition at line 73 of file vtkAbstractVolumeMapper.h.

void vtkAbstractVolumeMapper::SetScalarModeToUsePointFieldData ( ) [inline]

Control how the mapper works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the mapper will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the mapper to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectScalarArray.

Definition at line 75 of file vtkAbstractVolumeMapper.h.

void vtkAbstractVolumeMapper::SetScalarModeToUseCellFieldData ( ) [inline]

Control how the mapper works with scalar point data and cell attribute data. By default (ScalarModeToDefault), the mapper will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the mapper to use point data (ScalarModeToUsePointData) or cell data (ScalarModeToUseCellData). You can also choose to get the scalars from an array in point field data (ScalarModeToUsePointFieldData) or cell field data (ScalarModeToUseCellFieldData). If scalars are coming from a field data array, you must call SelectScalarArray.

Definition at line 77 of file vtkAbstractVolumeMapper.h.

virtual void vtkAbstractVolumeMapper::SelectScalarArray ( int arrayNum ) [virtual]

When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which scalar array to use during rendering. The transfer function in the vtkVolumeProperty (attached to the calling vtkVolume) will decide how to convert vectors to colors.

Reimplemented in vtkAMRVolumeMapper.

virtual void vtkAbstractVolumeMapper::SelectScalarArray ( const char * arrayName ) [virtual]

When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which scalar array to use during rendering. The transfer function in the vtkVolumeProperty (attached to the calling vtkVolume) will decide how to convert vectors to colors.

Reimplemented in vtkAMRVolumeMapper.

virtual char* vtkAbstractVolumeMapper::GetArrayName ( ) [inline, virtual]

Get the array name or number and component to use for rendering.

Reimplemented in vtkAMRVolumeMapper.

Definition at line 92 of file vtkAbstractVolumeMapper.h.

virtual int vtkAbstractVolumeMapper::GetArrayId ( ) [inline, virtual]

Get the array name or number and component to use for rendering.

Reimplemented in vtkAMRVolumeMapper.

Definition at line 93 of file vtkAbstractVolumeMapper.h.

virtual int vtkAbstractVolumeMapper::GetArrayAccessMode ( ) [inline, virtual]

Get the array name or number and component to use for rendering.

Reimplemented in vtkAMRVolumeMapper.

Definition at line 94 of file vtkAbstractVolumeMapper.h.

const char* vtkAbstractVolumeMapper::GetScalarModeAsString ( )

Return the method for obtaining scalar data.

Reimplemented in vtkAMRVolumeMapper.

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

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE

Reimplemented in vtkVolumeRayCastMapper, and vtkVolumeTextureMapper.

Definition at line 103 of file vtkAbstractVolumeMapper.h.

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

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE

Reimplemented in vtkVolumeRayCastMapper, and vtkVolumeTextureMapper.

Definition at line 104 of file vtkAbstractVolumeMapper.h.

virtual float vtkAbstractVolumeMapper::GetGradientMagnitudeScale ( int ) [inline, virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE

Reimplemented in vtkVolumeRayCastMapper, and vtkVolumeTextureMapper.

Definition at line 105 of file vtkAbstractVolumeMapper.h.

virtual float vtkAbstractVolumeMapper::GetGradientMagnitudeBias ( int ) [inline, virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE

Reimplemented in vtkVolumeRayCastMapper, and vtkVolumeTextureMapper.

Definition at line 106 of file vtkAbstractVolumeMapper.h.

virtual void vtkAbstractVolumeMapper::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

Implemented in vtkSmartVolumeMapper, vtkAMRVolumeMapper, vtkFixedPointVolumeRayCastMapper, vtkGPUVolumeRayCastMapper, vtkVolumeRayCastMapper, vtkUnstructuredGridVolumeZSweepMapper, vtkVolumeTextureMapper3D, vtkOpenGLHAVSVolumeMapper, vtkVolumeMapper, vtkUnstructuredGridVolumeRayCastMapper, vtkVolumeTextureMapper, vtkVolumeTextureMapper2D, vtkUnstructuredGridVolumeMapper, vtkOpenGLProjectedAAHexahedraMapper, vtkOpenGLProjectedTetrahedraMapper, vtkOpenGLVolumeTextureMapper3D, and vtkOpenGLVolumeTextureMapper2D.

virtual void vtkAbstractVolumeMapper::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 vtkSmartVolumeMapper, vtkAMRVolumeMapper, vtkGPUVolumeRayCastMapper, vtkVolumeRayCastMapper, vtkOpenGLHAVSVolumeMapper, vtkVolumeMapper, vtkUnstructuredGridVolumeRayCastMapper, vtkOpenGLGPUVolumeRayCastMapper, vtkUnstructuredGridVolumeMapper, vtkOpenGLVolumeTextureMapper3D, vtkOpenGLProjectedAAHexahedraMapper, and vtkOpenGLProjectedTetrahedraMapper.

Definition at line 118 of file vtkAbstractVolumeMapper.h.

virtual int vtkAbstractVolumeMapper::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 vtkAlgorithm.

Reimplemented in vtkAMRVolumeMapper, vtkOpenGLHAVSVolumeMapper, vtkVolumeMapper, and vtkUnstructuredGridVolumeMapper.