AMR class for a volume mapper. More...

#include <vtkAMRVolumeMapper.h>

Inheritance diagram for vtkAMRVolumeMapper:

Collaboration diagram for vtkAMRVolumeMapper:

Public Types
enum	{ DefaultRenderMode = 0, RayCastAndTextureRenderMode, RayCastRenderMode, TextureRenderMode, GPURenderMode, UndefinedRenderMode, InvalidRenderMode }
typedef vtkVolumeMapper	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkAMRVolumeMapper *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetScalarMode (int mode)
const char *	GetScalarModeAsString ()
void	SetInterpolationModeToNearestNeighbor ()
void	SetInterpolationModeToLinear ()
void	SetInterpolationModeToCubic ()
virtual void	SetInteractiveUpdateRate (double rate)
virtual double	GetInteractiveUpdateRate ()
virtual void	Render (vtkRenderer ren, vtkVolume vol)
virtual void	ReleaseGraphicsResources (vtkWindow *)
void	ProcessUpdateExtentRequest (vtkRenderer renderer, vtkInformation info, vtkInformationVector *inputVector, vtkInformationVector outputVector)
void	ProcessInformationRequest (vtkRenderer renderer, vtkInformation info, vtkInformationVector *inputVector, vtkInformationVector outputVector)
void	UpdateResampler (vtkRenderer ren, vtkOverlappingAMR amr)
void	UpdateResamplerFrustrumMethod (vtkRenderer ren, vtkOverlappingAMR amr)

virtual void	SetInputData (vtkImageData *)
virtual void	SetInputData (vtkDataSet *)
virtual void	SetInputData (vtkOverlappingAMR *)
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	SetInputConnection (vtkAlgorithmOutput *input)

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

virtual void	SetBlendMode (int mode)
virtual int	GetBlendMode ()

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

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

virtual void	SetCropping (int mode)
virtual int	GetCropping ()

virtual void	SetCroppingRegionPlanes (double arg1, double arg2, double arg3, double arg4, double arg5, double arg6)
virtual void	SetCroppingRegionPlanes (double *planes)
virtual void	GetCroppingRegionPlanes (double *planes)
virtual double *	GetCroppingRegionPlanes ()

virtual void	SetCroppingRegionFlags (int mode)
virtual int	GetCroppingRegionFlags ()

void	SetRequestedRenderMode (int mode)
int	GetRequestedRenderMode ()

void	SetRequestedRenderModeToDefault ()

void	SetRequestedRenderModeToRayCastAndTexture ()

void	SetRequestedRenderModeToRayCast ()

void	SetRequestedRenderModeToTexture ()

void	SetRequestedRenderModeToGPU ()

void	SetInterpolationMode (int mode)
int	GetInterpolationMode ()

virtual void	SetNumberOfSamples (int, int, int)
virtual void	SetNumberOfSamples (int[3])
virtual int *	GetNumberOfSamples ()
virtual void	GetNumberOfSamples (int &, int &, int &)
virtual void	GetNumberOfSamples (int[3])

virtual void	SetRequestedResamplingMode (int)
virtual int	GetRequestedResamplingMode ()
virtual void	SetFreezeFocalPoint (bool)
virtual bool	GetFreezeFocalPoint ()

virtual void	SetResamplerUpdateTolerance (double)
virtual double	GetResamplerUpdateTolerance ()

virtual void	SetUseDefaultThreading (bool)
virtual bool	GetUseDefaultThreading ()
Static Public Member Functions
static vtkAMRVolumeMapper *	New ()
static int	IsTypeOf (const char *type)
static vtkAMRVolumeMapper *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
virtual int	FillInputPortInformation (int port, vtkInformation *info)
void	UpdateGrid ()
Protected Attributes
vtkSmartVolumeMapper *	InternalMapper
vtkAMRResampleFilter *	Resampler
vtkUniformGrid *	Grid
int	NumberOfSamples [3]
double	Bounds [6]
bool	HasMetaData
int	RequestedResamplingMode
bool	FreezeFocalPoint
double	LastFocalPointPosition [3]
double	LastPostionFPDistance
double	ResamplerUpdateTolerance
bool	GridNeedsToBeUpdated
bool	UseDefaultThreading
static bool	ComputeResamplerBoundsFrustumMethod (vtkCamera camera, vtkRenderer renderer, const double data_bounds[6], double out_bounds[6])
	vtkAMRVolumeMapper ()
	~vtkAMRVolumeMapper ()

Detailed Description

AMR class for a volume mapper.

vtkAMRVolumeMapper is the definition of a volume mapper. for AMR Structured Data

Definition at line 39 of file vtkAMRVolumeMapper.h.

Member Typedef Documentation

typedef vtkVolumeMapper vtkAMRVolumeMapper::Superclass

Reimplemented from vtkVolumeMapper.

Definition at line 43 of file vtkAMRVolumeMapper.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

DefaultRenderMode
RayCastAndTextureRenderMode
RayCastRenderMode
TextureRenderMode
GPURenderMode
UndefinedRenderMode
InvalidRenderMode

Definition at line 140 of file vtkAMRVolumeMapper.h.

Constructor & Destructor Documentation

vtkAMRVolumeMapper::vtkAMRVolumeMapper ( ) [protected]

Utility method used by UpdateResamplerFrustrumMethod() to compute the bounds.

vtkAMRVolumeMapper::~vtkAMRVolumeMapper ( ) [protected]

Utility method used by UpdateResamplerFrustrumMethod() to compute the bounds.

Member Function Documentation

static vtkAMRVolumeMapper* vtkAMRVolumeMapper::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

static int vtkAMRVolumeMapper::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 vtkVolumeMapper.

virtual int vtkAMRVolumeMapper::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 vtkVolumeMapper.

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

Reimplemented from vtkVolumeMapper.

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

Reimplemented from vtkVolumeMapper.

vtkAMRVolumeMapper* vtkAMRVolumeMapper::NewInstance ( ) const

Reimplemented from vtkVolumeMapper.

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

virtual void vtkAMRVolumeMapper::SetInputData ( vtkImageData * ) [virtual]

Set the input data

Reimplemented from vtkVolumeMapper.

virtual void vtkAMRVolumeMapper::SetInputData ( vtkDataSet * ) [virtual]

Set the input data

Reimplemented from vtkVolumeMapper.

virtual void vtkAMRVolumeMapper::SetInputData ( vtkOverlappingAMR * ) [virtual]

Set the input data

virtual void vtkAMRVolumeMapper::SetInputConnection	(	int	port,
		vtkAlgorithmOutput *	input
	)		`[virtual]`

Set the input data

Reimplemented from vtkAlgorithm.

virtual void vtkAMRVolumeMapper::SetInputConnection ( vtkAlgorithmOutput * input ) [inline, virtual]

Set the input data

Reimplemented from vtkAlgorithm.

Definition at line 52 of file vtkAMRVolumeMapper.h.

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

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

Reimplemented from vtkAbstractVolumeMapper.

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

Definition at line 60 of file vtkAMRVolumeMapper.h.

virtual void vtkAMRVolumeMapper::SetScalarMode ( int mode ) [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 from vtkAbstractVolumeMapper.

virtual void vtkAMRVolumeMapper::SetBlendMode ( int mode ) [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 from vtkVolumeMapper.

virtual int vtkAMRVolumeMapper::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 from vtkVolumeMapper.

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

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

virtual char* vtkAMRVolumeMapper::GetArrayName ( ) [virtual]

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

Reimplemented from vtkAbstractVolumeMapper.

virtual int vtkAMRVolumeMapper::GetArrayId ( ) [virtual]

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

Reimplemented from vtkAbstractVolumeMapper.

virtual int vtkAMRVolumeMapper::GetArrayAccessMode ( ) [virtual]

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

Reimplemented from vtkAbstractVolumeMapper.

const char* vtkAMRVolumeMapper::GetScalarModeAsString ( )

Return the method for obtaining scalar data.

Reimplemented from vtkAbstractVolumeMapper.

virtual void vtkAMRVolumeMapper::SetCropping ( int mode ) [virtual]

Turn On/Off orthogonal cropping. (Clipping planes are perpendicular to the coordinate axes.)

Reimplemented from vtkVolumeMapper.

virtual int vtkAMRVolumeMapper::GetCropping ( ) [virtual]

Turn On/Off orthogonal cropping. (Clipping planes are perpendicular to the coordinate axes.)

Reimplemented from vtkVolumeMapper.

virtual void vtkAMRVolumeMapper::SetCroppingRegionPlanes	(	double	arg1,
		double	arg2,
		double	arg3,
		double	arg4,
		double	arg5,
		double	arg6
	)		`[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 from vtkVolumeMapper.

virtual void vtkAMRVolumeMapper::SetCroppingRegionPlanes ( double * planes ) [inline, 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.

Definition at line 117 of file vtkAMRVolumeMapper.h.

virtual void vtkAMRVolumeMapper::GetCroppingRegionPlanes ( double * planes ) [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* vtkAMRVolumeMapper::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 from vtkVolumeMapper.

virtual void vtkAMRVolumeMapper::SetCroppingRegionFlags ( int mode ) [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 from vtkVolumeMapper.

virtual int vtkAMRVolumeMapper::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 from vtkVolumeMapper.

void vtkAMRVolumeMapper::SetRequestedRenderMode ( int mode )

Set the requested render mode. The default is vtkSmartVolumeMapper::DefaultRenderMode.

int vtkAMRVolumeMapper::GetRequestedRenderMode ( )

Set the requested render mode. The default is vtkSmartVolumeMapper::DefaultRenderMode.

void vtkAMRVolumeMapper::SetRequestedRenderModeToDefault ( ) [inline]

Set the requested render mode to vtkAMRVolumeMapper::DefaultRenderMode. This is the best option for an application that must adapt to different data types, hardware, and rendering parameters.

Definition at line 164 of file vtkAMRVolumeMapper.h.

void vtkAMRVolumeMapper::SetRequestedRenderModeToRayCastAndTexture ( ) [inline]

Set the requested render mode to vtkAMRVolumeMapper::RayCastAndTextureRenderMode. This is a good option if you want to avoid using advanced OpenGL functionality, but would still like to used 3D texture mapping, if available, for interactive rendering.

Definition at line 174 of file vtkAMRVolumeMapper.h.

void vtkAMRVolumeMapper::SetRequestedRenderModeToRayCast ( ) [inline]

Set the requested render mode to vtkAMRVolumeMapper::RayCastRenderMode. This option will use software rendering exclusively. This is a good option if you know there is no hardware acceleration.

Definition at line 183 of file vtkAMRVolumeMapper.h.

void vtkAMRVolumeMapper::SetRequestedRenderModeToTexture ( ) [inline]

Set the requested render mode to vtkAMRVolumeMapper::TextureRenderMode. This is a good option if you want to use 3D texture mapping, if available, for interactive rendering.

Definition at line 192 of file vtkAMRVolumeMapper.h.

void vtkAMRVolumeMapper::SetRequestedRenderModeToGPU ( ) [inline]

Set the requested render mode to vtkAMRVolumeMapper::GPURenderMode. This will do the volume rendering on the GPU

Definition at line 199 of file vtkAMRVolumeMapper.h.

void vtkAMRVolumeMapper::SetInterpolationMode ( int mode )

Set interpolation mode for downsampling (lowres GPU) (initial value: cubic).

int vtkAMRVolumeMapper::GetInterpolationMode ( )

Set interpolation mode for downsampling (lowres GPU) (initial value: cubic).

void vtkAMRVolumeMapper::SetInterpolationModeToNearestNeighbor ( ) [inline]

Definition at line 210 of file vtkAMRVolumeMapper.h.

void vtkAMRVolumeMapper::SetInterpolationModeToLinear ( ) [inline]

Definition at line 213 of file vtkAMRVolumeMapper.h.

void vtkAMRVolumeMapper::SetInterpolationModeToCubic ( ) [inline]

Definition at line 216 of file vtkAMRVolumeMapper.h.

virtual void vtkAMRVolumeMapper::SetNumberOfSamples	(	int	,
		int	,
		int
	)		`[virtual]`