---

vtkVolumeRayCastMapper Class Reference

Abstract class for ray casting mappers. More...

#include <vtkVolumeRayCastMapper.h>

Inheritance diagram for vtkVolumeRayCastMapper:

[legend]Collaboration diagram for vtkVolumeRayCastMapper:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent index)
virtual void	SetSampleDistance (float)
virtual float	GetSampleDistance ()
virtual void	SetRayBounder (vtkRayBounder *)
virtual vtkRayBounder *	GetRayBounder ()
virtual void	SetVolumeRayCastFunction (vtkVolumeRayCastFunction *)
virtual vtkVolumeRayCastFunction *	GetVolumeRayCastFunction ()
void	SetGradientEstimator (vtkEncodedGradientEstimator *gradest)
virtual vtkEncodedGradientEstimator *	GetGradientEstimator ()
virtual vtkEncodedGradientShader *	GetGradientShader ()
void	Render (vtkRenderer *, vtkVolume *)
void	InitializeRender (vtkRenderer *ren, vtkVolume *vol, VTKRayCastVolumeInfo *volumeInfo)
void	ReleaseGraphicsResources (vtkWindow *)
float	GetZeroOpacityThreshold (vtkVolume *vol)
void	CastViewRay (VTKRayCastRayInfo *rayInfo, VTKRayCastVolumeInfo *volumeInfo)
int	GetMapperType ()
virtual int	IsARayCastMapper ()
virtual float	GetGradientMagnitudeScale ()
virtual float	GetGradientMagnitudeBias ()
Static Public Methods
vtkVolumeRayCastMapper *	New ()
int	IsTypeOf (const char *type)
vtkVolumeRayCastMapper *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkVolumeRayCastMapper ()
	~vtkVolumeRayCastMapper ()
	vtkVolumeRayCastMapper (const vtkVolumeRayCastMapper &)
void	operator= (const vtkVolumeRayCastMapper &)
int	ClipRayAgainstVolume (VTKRayCastRayInfo *rayInfo, VTKRayCastVolumeInfo *volumeInfo, float bounds[6])
int	ClipRayAgainstClippingPlanes (VTKRayCastRayInfo *rayInfo, VTKRayCastVolumeInfo *volumeInfo, vtkPlaneCollection *planes)
void	GeneralImageInitialization (vtkRenderer *ren, vtkVolume *vol)
void	UpdateShadingTables (vtkRenderer *ren, vtkVolume *vol)
Protected Attributes
vtkVolumeRayCastFunction *	VolumeRayCastFunction
vtkEncodedGradientEstimator *	GradientEstimator
vtkEncodedGradientShader *	GradientShader
float	SampleDistance
float	WorldSampleDistance
int	ScalarDataType
void *	ScalarDataPointer
float *	DepthRangeBufferPointer
vtkRayBounder *	RayBounder
float	RayStart [3]
float	RayEnd [3]
int	RayPixel [2]
float	RayColor [4]
float	VolumeBounds [6]
float	WorldToVolumeMatrix [16]
float	VolumeToWorldMatrix [16]
float	ViewToVolumeMatrix [16]

---

Detailed Description

Abstract class for ray casting mappers.

Date:

2000/12/10 20:08:59

Revision:

1.33

This is the abstract class for mappers that use volumetric ray casting

See also:

vtkVolumeMapper

Examples:

vtkVolumeRayCastMapper (examples)

Definition at line 88 of file vtkVolumeRayCastMapper.h.

---

Constructor & Destructor Documentation

vtkVolumeRayCastMapper::vtkVolumeRayCastMapper (    )  [protected]

vtkVolumeRayCastMapper::~vtkVolumeRayCastMapper (    )  [protected]

vtkVolumeRayCastMapper::vtkVolumeRayCastMapper (  const vtkVolumeRayCastMapper &    )  [inline, protected]

Definition at line 161 of file vtkVolumeRayCastMapper.h.

---

Member Function Documentation

vtkVolumeRayCastMapper* vtkVolumeRayCastMapper::New (    )  [static]

Instantiate object with no start, end, or progress methods. Reimplemented from vtkProcessObject.

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.

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.

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.

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.

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. Note: this distance is in volume coordinates. This means that if you set the scale to 4 in the vtkVolume, you will NOT have 4 times as many samples.

virtual float vtkVolumeRayCastMapper::GetSampleDistance (    )  [virtual]

virtual void vtkVolumeRayCastMapper::SetRayBounder (  vtkRayBounder *    )  [virtual]

Get / Set the ray bounder. This is used to clip the rays during ray casting.

virtual vtkRayBounder* vtkVolumeRayCastMapper::GetRayBounder (    )  [virtual]

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]

void vtkVolumeRayCastMapper::SetGradientEstimator (  vtkEncodedGradientEstimator *    gradest )

Set / Get the gradient estimator used to estimate normals

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

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

Get the gradient shader.

void vtkVolumeRayCastMapper::Render (  vtkRenderer *    ren, vtkVolume *    vol )  [inline, virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Initialize rendering for this volume. Reimplemented from vtkVolumeMapper. Definition at line 124 of file vtkVolumeRayCastMapper.h.

void vtkVolumeRayCastMapper::InitializeRender (  vtkRenderer *    ren, vtkVolume *    vol, VTKRayCastVolumeInfo *    volumeInfo )

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE

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

void vtkVolumeRayCastMapper::CastViewRay (  VTKRayCastRayInfo *    rayInfo, VTKRayCastVolumeInfo *    volumeInfo )

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE

int vtkVolumeRayCastMapper::GetMapperType (    )  [inline, virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Reimplemented from vtkVolumeMapper. Definition at line 145 of file vtkVolumeRayCastMapper.h.

virtual int vtkVolumeRayCastMapper::IsARayCastMapper (    )  [inline, virtual]

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE This is a ray cast mapper. Reimplemented from vtkAbstractMapper3D. Definition at line 149 of file vtkVolumeRayCastMapper.h.

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]

Reimplemented from vtkVolumeMapper.

void vtkVolumeRayCastMapper::operator= (  const vtkVolumeRayCastMapper &    )  [inline, protected]

Definition at line 162 of file vtkVolumeRayCastMapper.h.

int vtkVolumeRayCastMapper::ClipRayAgainstVolume (  VTKRayCastRayInfo *    rayInfo, VTKRayCastVolumeInfo *    volumeInfo, float    bounds[6] )  [protected]

int vtkVolumeRayCastMapper::ClipRayAgainstClippingPlanes (  VTKRayCastRayInfo *    rayInfo, VTKRayCastVolumeInfo *    volumeInfo, vtkPlaneCollection *    planes )  [protected]

void vtkVolumeRayCastMapper::GeneralImageInitialization (  vtkRenderer *    ren, vtkVolume *    vol )  [protected]

void vtkVolumeRayCastMapper::UpdateShadingTables (  vtkRenderer *    ren, vtkVolume *    vol )  [protected]

---

Member Data Documentation

vtkVolumeRayCastFunction* vtkVolumeRayCastMapper::VolumeRayCastFunction [protected]

Definition at line 164 of file vtkVolumeRayCastMapper.h.

vtkEncodedGradientEstimator* vtkVolumeRayCastMapper::GradientEstimator [protected]

Definition at line 165 of file vtkVolumeRayCastMapper.h.

vtkEncodedGradientShader* vtkVolumeRayCastMapper::GradientShader [protected]

Definition at line 166 of file vtkVolumeRayCastMapper.h.

float vtkVolumeRayCastMapper::SampleDistance [protected]

Definition at line 169 of file vtkVolumeRayCastMapper.h.

float vtkVolumeRayCastMapper::WorldSampleDistance [protected]

Definition at line 171 of file vtkVolumeRayCastMapper.h.

int vtkVolumeRayCastMapper::ScalarDataType [protected]

Definition at line 172 of file vtkVolumeRayCastMapper.h.

void* vtkVolumeRayCastMapper::ScalarDataPointer [protected]

Definition at line 173 of file vtkVolumeRayCastMapper.h.

float* vtkVolumeRayCastMapper::DepthRangeBufferPointer [protected]

Definition at line 174 of file vtkVolumeRayCastMapper.h.

vtkRayBounder* vtkVolumeRayCastMapper::RayBounder [protected]

Definition at line 192 of file vtkVolumeRayCastMapper.h.

float vtkVolumeRayCastMapper::RayStart[3] [protected]

Definition at line 194 of file vtkVolumeRayCastMapper.h.

float vtkVolumeRayCastMapper::RayEnd[3] [protected]

Definition at line 195 of file vtkVolumeRayCastMapper.h.

int vtkVolumeRayCastMapper::RayPixel[2] [protected]

Definition at line 196 of file vtkVolumeRayCastMapper.h.

float vtkVolumeRayCastMapper::RayColor[4] [protected]

Definition at line 197 of file vtkVolumeRayCastMapper.h.

float vtkVolumeRayCastMapper::VolumeBounds[6] [protected]

Definition at line 198 of file vtkVolumeRayCastMapper.h.

float vtkVolumeRayCastMapper::WorldToVolumeMatrix[16] [protected]

Definition at line 199 of file vtkVolumeRayCastMapper.h.

float vtkVolumeRayCastMapper::VolumeToWorldMatrix[16] [protected]

Definition at line 200 of file vtkVolumeRayCastMapper.h.

float vtkVolumeRayCastMapper::ViewToVolumeMatrix[16] [protected]

Definition at line 201 of file vtkVolumeRayCastMapper.h.

---

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

• graphics/vtkVolumeRayCastMapper.h

---