vtkVolumeProMapper Class Reference

#include <vtkVolumeProMapper.h>

Inheritance diagram for vtkVolumeProMapper:

[legend]

Collaboration diagram for vtkVolumeProMapper:

[legend]

List of all members.

Detailed Description

Superclass for VolumePRO volume rendering mappers.

vtkVolumeProMapper is the superclass for VolumePRO volume rendering mappers. Any functionality that is general across all VolumePRO implementations is placed here in this class. Subclasses of this class are for the specific board implementations. Subclasses of that are for underlying graphics languages. Users should not create subclasses directly - a vtkVolumeProMapper will automatically create the object of the right type.

If you do not have the VolumePRO libraries when building this object, then the New method will create a default renderer that will not render. You can check the NumberOfBoards ivar to see if it is a real rendering class. To build with the VolumePRO board see vtkVolumeProVP1000Mapper.h for instructions.

For more information on the VolumePRO hardware, please see:

http://www.terarecon.com/products/volumepro_prod.html

If you encounter any problems with this class, please inform Kitware, Inc. at kitware@kitware.com.

See also:: vtkVolumeMapper vtkVolumeProVP1000Mapper vtkOpenGLVolumeProVP1000Mapper

Tests:: vtkVolumeProMapper (Tests)

Definition at line 92 of file vtkVolumeProMapper.h.


Public Types
typedef vtkVolumeMapper	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Render (vtkRenderer , vtkVolume )

virtual void	SetBlendMode (int)
virtual int	GetBlendMode ()
void	SetBlendModeToComposite ()
void	SetBlendModeToMaximumIntensity ()
void	SetBlendModeToMinimumIntensity ()
const char *	GetBlendModeAsString (void)

virtual void	SetSubVolume (int, int, int, int, int, int)
virtual void	SetSubVolume (int[6])
virtual int *	GetSubVolume ()
virtual void	GetSubVolume (int data[6])

virtual void	SetCursor (int)
virtual int	GetCursor ()
virtual void	CursorOn ()
virtual void	CursorOff ()

virtual void	SetCursorType (int)
virtual int	GetCursorType ()
void	SetCursorTypeToCrossHair ()
void	SetCursorTypeToPlane ()
const char *	GetCursorTypeAsString (void)

virtual void	SetCursorPosition (double, double, double)
virtual void	SetCursorPosition (double[3])
virtual double *	GetCursorPosition ()
virtual void	GetCursorPosition (double data[3])

virtual void	SetCursorXAxisColor (double, double, double)
virtual void	SetCursorXAxisColor (double[3])
virtual double *	GetCursorXAxisColor ()
virtual void	GetCursorXAxisColor (double data[3])
virtual void	SetCursorYAxisColor (double, double, double)
virtual void	SetCursorYAxisColor (double[3])
virtual double *	GetCursorYAxisColor ()
virtual void	GetCursorYAxisColor (double data[3])
virtual void	SetCursorZAxisColor (double, double, double)
virtual void	SetCursorZAxisColor (double[3])
virtual double *	GetCursorZAxisColor ()
virtual void	GetCursorZAxisColor (double data[3])

virtual void	SetSuperSampling (int)
virtual int	GetSuperSampling ()
virtual void	SuperSamplingOn ()
virtual void	SuperSamplingOff ()

virtual void	SetSuperSamplingFactor (double x, double y, double z)
void	SetSuperSamplingFactor (double f[3])
virtual double *	GetSuperSamplingFactor ()
virtual void	GetSuperSamplingFactor (double data[3])

virtual void	SetCutPlane (int)
virtual int	GetCutPlane ()
virtual void	CutPlaneOn ()
virtual void	CutPlaneOff ()

virtual void	SetCutPlaneEquation (double, double, double, double)
virtual void	SetCutPlaneEquation (double[4])
virtual double *	GetCutPlaneEquation ()
virtual void	GetCutPlaneEquation (double data[4])

virtual void	SetCutPlaneThickness (double)
virtual double	GetCutPlaneThickness ()

virtual void	SetCutPlaneFallOffDistance (int)
virtual int	GetCutPlaneFallOffDistance ()

virtual void	SetGradientOpacityModulation (int)
virtual int	GetGradientOpacityModulation ()
virtual void	GradientOpacityModulationOn ()
virtual void	GradientOpacityModulationOff ()

virtual void	SetGradientDiffuseModulation (int)
virtual int	GetGradientDiffuseModulation ()
virtual void	GradientDiffuseModulationOn ()
virtual void	GradientDiffuseModulationOff ()

virtual void	SetGradientSpecularModulation (int)
virtual int	GetGradientSpecularModulation ()
virtual void	GradientSpecularModulationOn ()
virtual void	GradientSpecularModulationOff ()

virtual int	GetNoHardware ()
virtual int	GetWrongVLIVersion ()

virtual int	GetNumberOfBoards ()
virtual int	GetMajorBoardVersion ()
virtual int	GetMinorBoardVersion ()
virtual int	GetAvailableBoardMemory ()
virtual void	GetLockSizesForBoardMemory (unsigned int vtkNotUsed(type), unsigned int vtkNotUsed(xSize), unsigned int vtkNotUsed(ySize), unsigned int *vtkNotUsed(zSize))

virtual void	SetIntermixIntersectingGeometry (int)
virtual int	GetIntermixIntersectingGeometry ()
virtual void	IntermixIntersectingGeometryOn ()
virtual void	IntermixIntersectingGeometryOff ()

virtual void	SetAutoAdjustMipmapLevels (int)
virtual int	GetAutoAdjustMipmapLevels ()
virtual void	AutoAdjustMipmapLevelsOn ()
virtual void	AutoAdjustMipmapLevelsOff ()

virtual void	SetMinimumMipmapLevel (int)
virtual int	GetMinimumMipmapLevel ()

virtual void	SetMaximumMipmapLevel (int)
virtual int	GetMaximumMipmapLevel ()

virtual void	SetMipmapLevel (int)
virtual int	GetMipmapLevel ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkVolumeProMapper *	SafeDownCast (vtkObject *o)
static vtkVolumeProMapper *	New ()
Protected Member Functions
	vtkVolumeProMapper ()
	~vtkVolumeProMapper ()
int	StatusOK ()
void	StoreRenderTime (vtkRenderer ren, vtkVolume vol, float t)
float	RetrieveRenderTime (vtkRenderer ren, vtkVolume vol)
Protected Attributes
VLIContext *	Context
VLIVolume *	Volume
vtkImageData *	VolumeInput
vtkTimeStamp *	VolumeBuildTime
int	VolumeDataType
VLILookupTable *	LookupTable
int	BlendMode
VLILight **	Lights
int	NumberOfLights
int	SubVolume [6]
int	Cursor
int	CursorType
double	CursorPosition [3]
double	CursorXAxisColor [3]
double	CursorYAxisColor [3]
double	CursorZAxisColor [3]
int	CutPlane
VLICutPlane *	Cut
double	CutPlaneEquation [4]
double	CutPlaneThickness
int	CutPlaneFallOffDistance
int	SuperSampling
double	SuperSamplingFactor [3]
int	GradientOpacityModulation
int	GradientDiffuseModulation
int	GradientSpecularModulation
int	NumberOfBoards
int	MajorBoardVersion
int	MinorBoardVersion
int	GradientTableSize
int	NoHardware
int	WrongVLIVersion
int	DisplayedMessage
float *	RenderTimeTable
vtkVolume **	RenderVolumeTable
vtkRenderer **	RenderRendererTable
int	RenderTableSize
int	RenderTableEntries
vtkTimerLog *	RenderTimer
int	IntermixIntersectingGeometry
int	AutoAdjustMipmapLevels
int	MinimumMipmapLevel
int	MaximumMipmapLevel
int	MipmapLevel

Member Typedef Documentation

typedef vtkVolumeMapper vtkVolumeProMapper::Superclass

Reimplemented from vtkVolumeMapper.

Reimplemented in vtkOpenGLVolumeProVP1000Mapper, and vtkVolumeProVP1000Mapper.

Definition at line 95 of file vtkVolumeProMapper.h.

Constructor & Destructor Documentation

vtkVolumeProMapper::vtkVolumeProMapper ( ) [protected]

vtkVolumeProMapper::~vtkVolumeProMapper ( ) [protected]

Member Function Documentation

virtual const char* vtkVolumeProMapper::GetClassName ( ) [virtual]

Reimplemented from vtkVolumeMapper.

Reimplemented in vtkOpenGLVolumeProVP1000Mapper, and vtkVolumeProVP1000Mapper.

static int vtkVolumeProMapper::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkVolumeMapper.

Reimplemented in vtkOpenGLVolumeProVP1000Mapper, and vtkVolumeProVP1000Mapper.

virtual int vtkVolumeProMapper::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkVolumeMapper.

Reimplemented in vtkOpenGLVolumeProVP1000Mapper, and vtkVolumeProVP1000Mapper.

static vtkVolumeProMapper* vtkVolumeProMapper::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkVolumeMapper.

Reimplemented in vtkOpenGLVolumeProVP1000Mapper, and vtkVolumeProVP1000Mapper.

void vtkVolumeProMapper::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.

Reimplemented in vtkOpenGLVolumeProVP1000Mapper, and vtkVolumeProVP1000Mapper.

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

Automatically create the proper subclass

Reimplemented from vtkAlgorithm.

Reimplemented in vtkOpenGLVolumeProVP1000Mapper, and vtkVolumeProVP1000Mapper.

virtual void vtkVolumeProMapper::Render	(	vtkRenderer *	,
		vtkVolume *
	)			`[inline, virtual]`

Render the image using the hardware and place it in the frame buffer

Implements vtkVolumeMapper.

Reimplemented in vtkVolumeProVP1000Mapper.

Definition at line 102 of file vtkVolumeProMapper.h.

virtual void vtkVolumeProMapper::SetBlendMode ( int ) [virtual]

Set the blend mode

Reimplemented from vtkVolumeMapper.

virtual int vtkVolumeProMapper::GetBlendMode ( ) [virtual]

Set the blend mode

Reimplemented from vtkVolumeMapper.

void vtkVolumeProMapper::SetBlendModeToComposite ( ) [inline]

Set the blend mode

Reimplemented from vtkVolumeMapper.

Definition at line 109 of file vtkVolumeProMapper.h.

void vtkVolumeProMapper::SetBlendModeToMaximumIntensity ( ) [inline]

Set the blend mode

Reimplemented from vtkVolumeMapper.

Definition at line 111 of file vtkVolumeProMapper.h.

void vtkVolumeProMapper::SetBlendModeToMinimumIntensity ( ) [inline]

Set the blend mode

Reimplemented from vtkVolumeMapper.

Definition at line 113 of file vtkVolumeProMapper.h.

const char * vtkVolumeProMapper::GetBlendModeAsString ( void ) [inline]

Get the blending mode as a descriptive string

Definition at line 380 of file vtkVolumeProMapper.h.

virtual void vtkVolumeProMapper::SetSubVolume	(	int	,
		int	,
		int	,
		int	,
		int	,
		int
	)			`[virtual]`

Set the subvolume

virtual void vtkVolumeProMapper::SetSubVolume ( int [6] ) [virtual]

Set the subvolume

virtual int* vtkVolumeProMapper::GetSubVolume ( ) [virtual]

Set the subvolume

virtual void vtkVolumeProMapper::GetSubVolume ( int data[6] ) [virtual]

Set the subvolume

virtual void vtkVolumeProMapper::SetCursor ( int ) [virtual]

Turn the cursor on / off

virtual int vtkVolumeProMapper::GetCursor ( ) [virtual]

Turn the cursor on / off

virtual void vtkVolumeProMapper::CursorOn ( ) [virtual]

Turn the cursor on / off

virtual void vtkVolumeProMapper::CursorOff ( ) [virtual]

Turn the cursor on / off

virtual void vtkVolumeProMapper::SetCursorType ( int ) [virtual]

Set the type of the cursor

virtual int vtkVolumeProMapper::GetCursorType ( ) [virtual]

Set the type of the cursor

void vtkVolumeProMapper::SetCursorTypeToCrossHair ( ) [inline]

Set the type of the cursor

Definition at line 136 of file vtkVolumeProMapper.h.

void vtkVolumeProMapper::SetCursorTypeToPlane ( ) [inline]

Set the type of the cursor

Definition at line 138 of file vtkVolumeProMapper.h.

const char * vtkVolumeProMapper::GetCursorTypeAsString ( void ) [inline]

Get the cursor type as a descriptive string

Definition at line 396 of file vtkVolumeProMapper.h.

virtual void vtkVolumeProMapper::SetCursorPosition	(	double	,
		double	,
		double
	)			`[virtual]`

Set/Get the cursor position

virtual void vtkVolumeProMapper::SetCursorPosition ( double [3] ) [virtual]

Set/Get the cursor position

virtual double* vtkVolumeProMapper::GetCursorPosition ( ) [virtual]

Set/Get the cursor position

virtual void vtkVolumeProMapper::GetCursorPosition ( double data[3] ) [virtual]

Set/Get the cursor position

virtual void vtkVolumeProMapper::SetCursorXAxisColor	(	double	,
		double	,
		double
	)			`[virtual]`

Set/Get the cursor color

virtual void vtkVolumeProMapper::SetCursorXAxisColor ( double [3] ) [virtual]

Set/Get the cursor color

virtual double* vtkVolumeProMapper::GetCursorXAxisColor ( ) [virtual]

Set/Get the cursor color

virtual void vtkVolumeProMapper::GetCursorXAxisColor ( double data[3] ) [virtual]

Set/Get the cursor color

virtual void vtkVolumeProMapper::SetCursorYAxisColor	(	double	,
		double	,
		double
	)			`[virtual]`

Set/Get the cursor color

virtual void vtkVolumeProMapper::SetCursorYAxisColor ( double [3] ) [virtual]

Set/Get the cursor color

virtual double* vtkVolumeProMapper::GetCursorYAxisColor ( ) [virtual]

Set/Get the cursor color

virtual void vtkVolumeProMapper::GetCursorYAxisColor ( double data[3] ) [virtual]

Set/Get the cursor color

virtual void vtkVolumeProMapper::SetCursorZAxisColor	(	double	,
		double	,
		double
	)			`[virtual]`

Set/Get the cursor color

virtual void vtkVolumeProMapper::SetCursorZAxisColor ( double [3] ) [virtual]

Set/Get the cursor color

virtual double* vtkVolumeProMapper::GetCursorZAxisColor ( ) [virtual]

Set/Get the cursor color

virtual void vtkVolumeProMapper::GetCursorZAxisColor ( double data[3] ) [virtual]

Set/Get the cursor color

virtual void vtkVolumeProMapper::SetSuperSampling ( int ) [virtual]

Turn supersampling on/off

virtual int vtkVolumeProMapper::GetSuperSampling ( ) [virtual]

Turn supersampling on/off

virtual void vtkVolumeProMapper::SuperSamplingOn ( ) [virtual]

Turn supersampling on/off

virtual void vtkVolumeProMapper::SuperSamplingOff ( ) [virtual]

Turn supersampling on/off

virtual void vtkVolumeProMapper::SetSuperSamplingFactor	(	double	x,
		double	y,
		double	z
	)			`[virtual]`

Set the supersampling factors

Reimplemented in vtkVolumeProVP1000Mapper.

void vtkVolumeProMapper::SetSuperSamplingFactor ( double f[3] ) [inline]

Set the supersampling factors

Definition at line 169 of file vtkVolumeProMapper.h.

virtual double* vtkVolumeProMapper::GetSuperSamplingFactor ( ) [virtual]

Set the supersampling factors

virtual void vtkVolumeProMapper::GetSuperSamplingFactor ( double data[3] ) [virtual]

Set the supersampling factors

virtual void vtkVolumeProMapper::SetCutPlane ( int ) [virtual]

Turn on / off the cut plane

virtual int vtkVolumeProMapper::GetCutPlane ( ) [virtual]

Turn on / off the cut plane

virtual void vtkVolumeProMapper::CutPlaneOn ( ) [virtual]

Turn on / off the cut plane

virtual void vtkVolumeProMapper::CutPlaneOff ( ) [virtual]

Turn on / off the cut plane

virtual void vtkVolumeProMapper::SetCutPlaneEquation	(	double	,
		double	,
		double	,
		double
	)			`[virtual]`

Set/Get the cut plane equation

virtual void vtkVolumeProMapper::SetCutPlaneEquation ( double [4] ) [virtual]

Set/Get the cut plane equation

virtual double* vtkVolumeProMapper::GetCutPlaneEquation ( ) [virtual]

Set/Get the cut plane equation

virtual void vtkVolumeProMapper::GetCutPlaneEquation ( double data[4] ) [virtual]

Set/Get the cut plane equation

virtual void vtkVolumeProMapper::SetCutPlaneThickness ( double ) [virtual]

Set / Get the cut plane thickness

virtual double vtkVolumeProMapper::GetCutPlaneThickness ( ) [virtual]

Set / Get the cut plane thickness

virtual void vtkVolumeProMapper::SetCutPlaneFallOffDistance ( int ) [virtual]

Set / Get the cut plane falloff value for intensities

virtual int vtkVolumeProMapper::GetCutPlaneFallOffDistance ( ) [virtual]

Set / Get the cut plane falloff value for intensities

virtual void vtkVolumeProMapper::SetGradientOpacityModulation ( int ) [virtual]

Set/Get the gradient magnitude opacity modulation

virtual int vtkVolumeProMapper::GetGradientOpacityModulation ( ) [virtual]

Set/Get the gradient magnitude opacity modulation

virtual void vtkVolumeProMapper::GradientOpacityModulationOn ( ) [virtual]

Set/Get the gradient magnitude opacity modulation

virtual void vtkVolumeProMapper::GradientOpacityModulationOff ( ) [virtual]

Set/Get the gradient magnitude opacity modulation

virtual void vtkVolumeProMapper::SetGradientDiffuseModulation ( int ) [virtual]

Set/Get the gradient magnitude diffuse modulation

virtual int vtkVolumeProMapper::GetGradientDiffuseModulation ( ) [virtual]

Set/Get the gradient magnitude diffuse modulation

virtual void vtkVolumeProMapper::GradientDiffuseModulationOn ( ) [virtual]

Set/Get the gradient magnitude diffuse modulation

virtual void vtkVolumeProMapper::GradientDiffuseModulationOff ( ) [virtual]

Set/Get the gradient magnitude diffuse modulation

virtual void vtkVolumeProMapper::SetGradientSpecularModulation ( int ) [virtual]

Set/Get the gradient magnitude specular modulation

virtual int vtkVolumeProMapper::GetGradientSpecularModulation ( ) [virtual]

Set/Get the gradient magnitude specular modulation

virtual void vtkVolumeProMapper::GradientSpecularModulationOn ( ) [virtual]

Set/Get the gradient magnitude specular modulation

virtual void vtkVolumeProMapper::GradientSpecularModulationOff ( ) [virtual]

Set/Get the gradient magnitude specular modulation

virtual int vtkVolumeProMapper::GetNoHardware ( ) [virtual]

Conveniece methods for debugging

virtual int vtkVolumeProMapper::GetWrongVLIVersion ( ) [virtual]

Conveniece methods for debugging

virtual int vtkVolumeProMapper::GetNumberOfBoards ( ) [virtual]