Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Related Pages

vtkVolumeRayCastMapper Class Reference

A slow but accurate mapper for rendering volumes. More...

#include <vtkVolumeRayCastMapper.h>

Inheritance diagram for vtkVolumeRayCastMapper:

[legend]Collaboration diagram for vtkVolumeRayCastMapper:

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent index)
void	Render (vtkRenderer , vtkVolume )
void	ReleaseGraphicsResources (vtkWindow *)
float	GetZeroOpacityThreshold (vtkVolume *vol)

virtual void	SetSampleDistance (float)
virtual float	GetSampleDistance ()

virtual void	SetVolumeRayCastFunction (vtkVolumeRayCastFunction *)
virtual vtkVolumeRayCastFunction *	GetVolumeRayCastFunction ()

void	SetGradientEstimator (vtkEncodedGradientEstimator *gradest)
virtual vtkEncodedGradientEstimator *	GetGradientEstimator ()

virtual vtkEncodedGradientShader *	GetGradientShader ()

virtual void	SetImageSampleDistance (float)
virtual float	GetImageSampleDistance ()

virtual void	SetMinimumImageSampleDistance (float)
virtual float	GetMinimumImageSampleDistance ()

virtual void	SetMaximumImageSampleDistance (float)
virtual float	GetMaximumImageSampleDistance ()

virtual void	SetAutoAdjustSampleDistances (int)
virtual int	GetAutoAdjustSampleDistances ()
virtual void	AutoAdjustSampleDistancesOn ()
virtual void	AutoAdjustSampleDistancesOff ()

void	SetNumberOfThreads (int num)
virtual int	GetNumberOfThreads ()

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

virtual float	GetGradientMagnitudeScale ()
virtual float	GetGradientMagnitudeBias ()
Static Public Methods
vtkVolumeRayCastMapper *	New ()
int	IsTypeOf (const char *type)
vtkVolumeRayCastMapper *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkVolumeRayCastMapper ()
	~vtkVolumeRayCastMapper ()
void	UpdateShadingTables (vtkRenderer ren, vtkVolume vol)
void	ComputeMatrices (vtkImageData data, vtkVolume vol)
virtual void	RenderTexture (vtkVolume vol, vtkRenderer ren)=0
int	ComputeRowBounds (vtkVolume vol, vtkRenderer ren)
void	StoreRenderTime (vtkRenderer ren, vtkVolume vol, float t)
float	RetrieveRenderTime (vtkRenderer ren, vtkVolume vol)
int	ClipRayAgainstVolume (VTKVRCDynamicInfo *dynamicInfo, float bounds[6])
void	InitializeClippingPlanes (VTKVRCStaticInfo staticInfo, vtkPlaneCollection planes)
int	ClipRayAgainstClippingPlanes (VTKVRCDynamicInfo dynamicInfo, VTKVRCStaticInfo staticInfo)
float	GetZBufferValue (int x, int y)
Protected Attributes
vtkVolumeRayCastFunction *	VolumeRayCastFunction
vtkEncodedGradientEstimator *	GradientEstimator
vtkEncodedGradientShader *	GradientShader
float	SampleDistance
float	ImageSampleDistance
float	MinimumImageSampleDistance
float	MaximumImageSampleDistance
int	AutoAdjustSampleDistances
float	WorldSampleDistance
int	ScalarDataType
void *	ScalarDataPointer
vtkMultiThreader *	Threader
int	NumberOfThreads
vtkMatrix4x4 *	PerspectiveMatrix
vtkMatrix4x4 *	ViewToWorldMatrix
vtkMatrix4x4 *	ViewToVoxelsMatrix
vtkMatrix4x4 *	VoxelsToViewMatrix
vtkMatrix4x4 *	WorldToVoxelsMatrix
vtkMatrix4x4 *	VoxelsToWorldMatrix
int	ImageViewportSize [2]
int	ImageMemorySize [2]
int	ImageInUseSize [2]
int	ImageOrigin [2]
unsigned char *	Image
int *	RowBounds
int *	OldRowBounds
float *	RenderTimeTable
vtkVolume **	RenderVolumeTable
vtkRenderer **	RenderRendererTable
int	RenderTableSize
int	RenderTableEntries
int	IntermixIntersectingGeometry
float *	ZBuffer
int	ZBufferSize [2]
int	ZBufferOrigin [2]
float	MinimumViewDistance
Friends
VTK_THREAD_RETURN_TYPE	VolumeRayCastMapper_CastRays (void *arg)

Detailed Description

A slow but accurate mapper for rendering volumes.

Date:: 2001/11/13 14:17:33

Revision:: 1.42

This is a software ray caster for rendering volumes in vtkImageData.

See also:: vtkVolumeMapper

Examples:: vtkVolumeRayCastMapper (Examples)

Tests:: vtkVolumeRayCastMapper (Tests)

Definition at line 100 of file vtkVolumeRayCastMapper.h.

Constructor & Destructor Documentation

vtkVolumeRayCastMapper::vtkVolumeRayCastMapper ( ) [protected]

vtkVolumeRayCastMapper::~vtkVolumeRayCastMapper ( ) [protected]

Member Function Documentation

vtkVolumeRayCastMapper* vtkVolumeRayCastMapper::New ( ) [static]

Instantiate object with no start, end, or progress methods.
Reimplemented from vtkProcessObject.
Reimplemented in vtkMesaVolumeRayCastMapper, and vtkOpenGLVolumeRayCastMapper.

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkVolumeMapper.
Reimplemented in vtkMesaVolumeRayCastMapper, and vtkOpenGLVolumeRayCastMapper.

int vtkVolumeRayCastMapper::IsTypeOf ( const char * type ) [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.
Reimplemented in vtkMesaVolumeRayCastMapper, and vtkOpenGLVolumeRayCastMapper.

virtual int vtkVolumeRayCastMapper::IsA ( const char * type ) [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.
Reimplemented in vtkMesaVolumeRayCastMapper, and vtkOpenGLVolumeRayCastMapper.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkVolumeMapper.
Reimplemented in vtkMesaVolumeRayCastMapper, and vtkOpenGLVolumeRayCastMapper.

void vtkVolumeRayCastMapper::PrintSelf ( ostream & os,

vtkIndent index

) [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 vtkVolumeRayCastMapper::SetSampleDistance ( float ) [virtual]

Set/Get the distance between samples. This variable is only used for sampling ray casting methods. Methods that compute a ray value by stepping cell-by-cell are not affected by this value.

virtual float vtkVolumeRayCastMapper::GetSampleDistance ( ) [virtual]

Set/Get the distance between samples. This variable is only used for sampling ray casting methods. Methods that compute a ray value by stepping cell-by-cell are not affected by this value.

virtual void vtkVolumeRayCastMapper::SetVolumeRayCastFunction ( vtkVolumeRayCastFunction * ) [virtual]

Get / Set the volume ray cast function. This is used to process values found along the ray to compute a final pixel value.

virtual vtkVolumeRayCastFunction* vtkVolumeRayCastMapper::GetVolumeRayCastFunction ( ) [virtual]

Get / Set the volume ray cast function. This is used to process values found along the ray to compute a final pixel value.

void vtkVolumeRayCastMapper::SetGradientEstimator ( vtkEncodedGradientEstimator * gradest )

Set / Get the gradient estimator used to estimate normals

virtual vtkEncodedGradientEstimator* vtkVolumeRayCastMapper::GetGradientEstimator ( ) [virtual]

Set / Get the gradient estimator used to estimate normals

virtual vtkEncodedGradientShader* vtkVolumeRayCastMapper::GetGradientShader ( ) [virtual]

Get the gradient shader.

virtual void vtkVolumeRayCastMapper::SetImageSampleDistance ( float ) [virtual]

Sampling distance in the XY image dimensions. Default value of 1 meaning 1 ray cast per pixel. If set to 0.5, 4 rays will be cast per pixel. If set to 2.0, 1 ray will be cast for every 4 (2 by 2) pixels.

virtual float vtkVolumeRayCastMapper::GetImageSampleDistance ( ) [virtual]

Sampling distance in the XY image dimensions. Default value of 1 meaning 1 ray cast per pixel. If set to 0.5, 4 rays will be cast per pixel. If set to 2.0, 1 ray will be cast for every 4 (2 by 2) pixels.

virtual void vtkVolumeRayCastMapper::SetMinimumImageSampleDistance ( float ) [virtual]

This is the minimum image sample distance allow when the image sample distance is being automatically adjusted

virtual float vtkVolumeRayCastMapper::GetMinimumImageSampleDistance ( ) [virtual]

This is the minimum image sample distance allow when the image sample distance is being automatically adjusted

virtual void vtkVolumeRayCastMapper::SetMaximumImageSampleDistance ( float ) [virtual]

This is the maximum image sample distance allow when the image sample distance is being automatically adjusted

virtual float vtkVolumeRayCastMapper::GetMaximumImageSampleDistance ( ) [virtual]

This is the maximum image sample distance allow when the image sample distance is being automatically adjusted

virtual void vtkVolumeRayCastMapper::SetAutoAdjustSampleDistances ( int ) [virtual]

If AutoAdjustSampleDistances is on, the the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).

virtual int vtkVolumeRayCastMapper::GetAutoAdjustSampleDistances ( ) [virtual]

If AutoAdjustSampleDistances is on, the the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).

virtual void vtkVolumeRayCastMapper::AutoAdjustSampleDistancesOn ( ) [virtual]

If AutoAdjustSampleDistances is on, the the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).

virtual void vtkVolumeRayCastMapper::AutoAdjustSampleDistancesOff ( ) [virtual]

If AutoAdjustSampleDistances is on, the the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).

void vtkVolumeRayCastMapper::SetNumberOfThreads ( int num )

Set/Get the number of threads to use. This by default is equal to the number of available processors detected.

virtual int vtkVolumeRayCastMapper::GetNumberOfThreads ( ) [virtual]

Set/Get the number of threads to use. This by default is equal to the number of available processors detected.

virtual void vtkVolumeRayCastMapper::SetIntermixIntersectingGeometry ( int ) [virtual]

If IntermixIntersectingGeometry is turned on, the zbuffer will be captured and used to limit the traversal of the rays.

virtual int vtkVolumeRayCastMapper::GetIntermixIntersectingGeometry ( ) [virtual]

If IntermixIntersectingGeometry is turned on, the zbuffer will be captured and used to limit the traversal of the rays.

virtual void vtkVolumeRayCastMapper::IntermixIntersectingGeometryOn ( ) [virtual]

If IntermixIntersectingGeometry is turned on, the zbuffer will be captured and used to limit the traversal of the rays.

virtual void vtkVolumeRayCastMapper::IntermixIntersectingGeometryOff ( ) [virtual]

If IntermixIntersectingGeometry is turned on, the zbuffer will be captured and used to limit the traversal of the rays.

void vtkVolumeRayCastMapper::Render ( vtkRenderer * ren,

vtkVolume * vol

) [virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Initialize rendering for this volume.
Reimplemented from vtkVolumeMapper.

void vtkVolumeRayCastMapper::ReleaseGraphicsResources ( vtkWindow * ) [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 vtkVolumeMapper.

float vtkVolumeRayCastMapper::GetZeroOpacityThreshold ( vtkVolume * vol )

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Return the scalar value below which all opacities are zero

virtual float vtkVolumeRayCastMapper::GetGradientMagnitudeScale ( ) [virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Values needed by the volume
Reimplemented from vtkVolumeMapper.

virtual float vtkVolumeRayCastMapper::GetGradientMagnitudeBias ( ) [virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Values needed by the volume
Reimplemented from vtkVolumeMapper.

void vtkVolumeRayCastMapper::UpdateShadingTables ( vtkRenderer * ren,

vtkVolume * vol

) [protected]

void vtkVolumeRayCastMapper::ComputeMatrices ( vtkImageData * data,

vtkVolume * vol

) [protected]

virtual void vtkVolumeRayCastMapper::RenderTexture ( vtkVolume * vol,

vtkRenderer * ren

) [protected, pure virtual]

Reimplemented in vtkMesaVolumeRayCastMapper, and vtkOpenGLVolumeRayCastMapper.

int vtkVolumeRayCastMapper::ComputeRowBounds ( vtkVolume * vol,

vtkRenderer * ren

) [protected]

void vtkVolumeRayCastMapper::StoreRenderTime ( vtkRenderer * ren,

vtkVolume * vol,

float t

) [protected]

float vtkVolumeRayCastMapper::RetrieveRenderTime ( vtkRenderer * ren,

vtkVolume * vol

) [protected]

int vtkVolumeRayCastMapper::ClipRayAgainstVolume ( VTKVRCDynamicInfo * dynamicInfo,

float bounds[6]

) [protected]

void vtkVolumeRayCastMapper::InitializeClippingPlanes ( VTKVRCStaticInfo * staticInfo,

vtkPlaneCollection * planes

) [protected]

int vtkVolumeRayCastMapper::ClipRayAgainstClippingPlanes ( VTKVRCDynamicInfo * dynamicInfo,

VTKVRCStaticInfo * staticInfo

) [protected]

float vtkVolumeRayCastMapper::GetZBufferValue ( int x,

int y

) [protected]

Friends And Related Function Documentation

VTK_THREAD_RETURN_TYPE VolumeRayCastMapper_CastRays ( void * arg ) [friend]

Member Data Documentation

vtkVolumeRayCastFunction* vtkVolumeRayCastMapper::VolumeRayCastFunction [protected]

Definition at line 207 of file vtkVolumeRayCastMapper.h.

vtkEncodedGradientEstimator* vtkVolumeRayCastMapper::GradientEstimator [protected]

Definition at line 208 of file vtkVolumeRayCastMapper.h.

vtkEncodedGradientShader* vtkVolumeRayCastMapper::GradientShader [protected]

Definition at line 209 of file vtkVolumeRayCastMapper.h.

float vtkVolumeRayCastMapper::SampleDistance [protected]

Definition at line 212 of file vtkVolumeRayCastMapper.h.

float vtkVolumeRayCastMapper::ImageSampleDistance [protected]

Definition at line 213 of file vtkVolumeRayCastMapper.h.

float vtkVolumeRayCastMapper::MinimumImageSampleDistance [protected]

Definition at line 214 of file vtkVolumeRayCastMapper.h.

float vtkVolumeRayCastMapper::MaximumImageSampleDistance [protected]

Definition at line 215 of file vtkVolumeRayCastMapper.h.

int vtkVolumeRayCastMapper::AutoAdjustSampleDistances [protected]

Definition at line 216 of file vtkVolumeRayCastMapper.h.

float vtkVolumeRayCastMapper::WorldSampleDistance [protected]

Definition at line 218 of file vtkVolumeRayCastMapper.h.

int vtkVolumeRayCastMapper::ScalarDataType [protected]

Definition at line 219 of file vtkVolumeRayCastMapper.h.

void* vtkVolumeRayCastMapper::ScalarDataPointer [protected]

Definition at line 220 of file vtkVolumeRayCastMapper.h.

vtkMultiThreader* vtkVolumeRayCastMapper::Threader [protected]

Definition at line 231 of file vtkVolumeRayCastMapper.h.

int vtkVolumeRayCastMapper::NumberOfThreads [protected]

Definition at line 232 of file vtkVolumeRayCastMapper.h.

vtkMatrix4x4* vtkVolumeRayCastMapper::PerspectiveMatrix [protected]

Definition at line 234 of file vtkVolumeRayCastMapper.h.

vtkMatrix4x4* vtkVolumeRayCastMapper::ViewToWorldMatrix [protected]

Definition at line 235 of file vtkVolumeRayCastMapper.h.

vtkMatrix4x4* vtkVolumeRayCastMapper::ViewToVoxelsMatrix [protected]

Definition at line 236 of file vtkVolumeRayCastMapper.h.

vtkMatrix4x4* vtkVolumeRayCastMapper::VoxelsToViewMatrix [protected]

Definition at line 237 of file vtkVolumeRayCastMapper.h.

vtkMatrix4x4* vtkVolumeRayCastMapper::WorldToVoxelsMatrix [protected]

Definition at line 238 of file vtkVolumeRayCastMapper.h.

vtkMatrix4x4* vtkVolumeRayCastMapper::VoxelsToWorldMatrix [protected]

Definition at line 239 of file vtkVolumeRayCastMapper.h.

int vtkVolumeRayCastMapper::ImageViewportSize[2] [protected]

Definition at line 242 of file vtkVolumeRayCastMapper.h.

int vtkVolumeRayCastMapper::ImageMemorySize[2] [protected]

Definition at line 248 of file vtkVolumeRayCastMapper.h.

int vtkVolumeRayCastMapper::ImageInUseSize[2] [protected]

Definition at line 254 of file vtkVolumeRayCastMapper.h.

int vtkVolumeRayCastMapper::ImageOrigin[2] [protected]

Definition at line 258 of file vtkVolumeRayCastMapper.h.

unsigned char* vtkVolumeRayCastMapper::Image [protected]

Definition at line 261 of file vtkVolumeRayCastMapper.h.

int* vtkVolumeRayCastMapper::RowBounds [protected]

Definition at line 263 of file vtkVolumeRayCastMapper.h.

int* vtkVolumeRayCastMapper::OldRowBounds [protected]

Definition at line 264 of file vtkVolumeRayCastMapper.h.

float* vtkVolumeRayCastMapper::RenderTimeTable [protected]

Definition at line 266 of file vtkVolumeRayCastMapper.h.

vtkVolume** vtkVolumeRayCastMapper::RenderVolumeTable [protected]

Definition at line 267 of file vtkVolumeRayCastMapper.h.

vtkRenderer** vtkVolumeRayCastMapper::RenderRendererTable [protected]

Definition at line 268 of file vtkVolumeRayCastMapper.h.

int vtkVolumeRayCastMapper::RenderTableSize [protected]

Definition at line 269 of file vtkVolumeRayCastMapper.h.

int vtkVolumeRayCastMapper::RenderTableEntries [protected]

Definition at line 270 of file vtkVolumeRayCastMapper.h.

int vtkVolumeRayCastMapper::IntermixIntersectingGeometry [protected]

Definition at line 275 of file vtkVolumeRayCastMapper.h.

float* vtkVolumeRayCastMapper::ZBuffer [protected]

Definition at line 277 of file vtkVolumeRayCastMapper.h.

int vtkVolumeRayCastMapper::ZBufferSize[2] [protected]

Definition at line 278 of file vtkVolumeRayCastMapper.h.

int vtkVolumeRayCastMapper::ZBufferOrigin[2] [protected]

Definition at line 279 of file vtkVolumeRayCastMapper.h.

float vtkVolumeRayCastMapper::MinimumViewDistance [protected]

Definition at line 281 of file vtkVolumeRayCastMapper.h.

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

Rendering/vtkVolumeRayCastMapper.h

Generated on Thu Mar 28 14:46:03 2002 for VTK by

vtkVolumeRayCastMapper Class Reference

Public Methods

Static Public Methods

Protected Methods

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation