---

vtkVolumeRayCastFunction Class Reference

a superclass for ray casting functions. More...

#include <vtkVolumeRayCastFunction.h>

Inheritance diagram for vtkVolumeRayCastFunction:

[legend]Collaboration diagram for vtkVolumeRayCastFunction:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	FunctionInitialize (vtkRenderer *ren, vtkVolume *vol, VTKRayCastVolumeInfo *volumeInfo, vtkVolumeRayCastMapper *mapper)
virtual void	CastRay (VTKRayCastRayInfo *rayInfo, VTKRayCastVolumeInfo *volumeInfo)=0
virtual float	GetZeroOpacityThreshold (vtkVolume *vol)=0
Static Public Methods
int	IsTypeOf (const char *type)
vtkVolumeRayCastFunction *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkVolumeRayCastFunction ()
	~vtkVolumeRayCastFunction ()
	vtkVolumeRayCastFunction (const vtkVolumeRayCastFunction &)
void	operator= (const vtkVolumeRayCastFunction &)
virtual void	SpecificFunctionInitialize (vtkRenderer *ren, vtkVolume *vol, VTKRayCastVolumeInfo *volumeInfo, vtkVolumeRayCastMapper *mapper)=0

---

Detailed Description

a superclass for ray casting functions.

Date:

2000/12/10 20:08:59

Revision:

1.18

vtkVolumeRayCastFunction is a superclass for ray casting functions that can be used within a vtkVolumeRayCastMapper. This includes for example, vtkVolumeRayCastCompositeFunction, vtkVolumeRayCastMIPFunction, and vtkVolumeRayCastIsosurfaceFunction.

See also:

vtkVolumeRayCastCompositeFunction vtkVolumeRayCastMIPFunction vtkVolumeRayCastIsosurfaceFunction vtkVolumeRayCastMapper

Definition at line 68 of file vtkVolumeRayCastFunction.h.

---

Constructor & Destructor Documentation

vtkVolumeRayCastFunction::vtkVolumeRayCastFunction (    )  [inline, protected]

Definition at line 92 of file vtkVolumeRayCastFunction.h.

vtkVolumeRayCastFunction::~vtkVolumeRayCastFunction (    )  [inline, protected]

Definition at line 93 of file vtkVolumeRayCastFunction.h.

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

Definition at line 94 of file vtkVolumeRayCastFunction.h.

---

Member Function Documentation

virtual const char* vtkVolumeRayCastFunction::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 vtkObject. Reimplemented in vtkVolumeRayCastCompositeFunction, vtkVolumeRayCastIsosurfaceFunction, and vtkVolumeRayCastMIPFunction.

int vtkVolumeRayCastFunction::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 vtkObject. Reimplemented in vtkVolumeRayCastCompositeFunction, vtkVolumeRayCastIsosurfaceFunction, and vtkVolumeRayCastMIPFunction.

virtual int vtkVolumeRayCastFunction::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 vtkObject. Reimplemented in vtkVolumeRayCastCompositeFunction, vtkVolumeRayCastIsosurfaceFunction, and vtkVolumeRayCastMIPFunction.

vtkVolumeRayCastFunction* vtkVolumeRayCastFunction::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 vtkObject. Reimplemented in vtkVolumeRayCastCompositeFunction, vtkVolumeRayCastIsosurfaceFunction, and vtkVolumeRayCastMIPFunction.

void vtkVolumeRayCastFunction::FunctionInitialize (  vtkRenderer *    ren, vtkVolume *    vol, VTKRayCastVolumeInfo *    volumeInfo, vtkVolumeRayCastMapper *    mapper )

Do the basic initialization. This includes saving the parameters passed in into local variables, as well as grabbing some useful info from the volume property and normal encoder. This initialize routine is called once per render. It also calls the SpecificFunctionInitialize of the subclass function. BTX

virtual void vtkVolumeRayCastFunction::CastRay (  VTKRayCastRayInfo *    rayInfo, VTKRayCastVolumeInfo *    volumeInfo )  [pure virtual]

Reimplemented in vtkVolumeRayCastCompositeFunction, vtkVolumeRayCastIsosurfaceFunction, and vtkVolumeRayCastMIPFunction.

virtual float vtkVolumeRayCastFunction::GetZeroOpacityThreshold (  vtkVolume *    vol )  [pure virtual]

Get the value below which all scalar values are considered to have 0 opacity. Reimplemented in vtkVolumeRayCastCompositeFunction, vtkVolumeRayCastIsosurfaceFunction, and vtkVolumeRayCastMIPFunction.

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

Definition at line 95 of file vtkVolumeRayCastFunction.h.

virtual void vtkVolumeRayCastFunction::SpecificFunctionInitialize (  vtkRenderer *    ren, vtkVolume *    vol, VTKRayCastVolumeInfo *    volumeInfo, vtkVolumeRayCastMapper *    mapper )  [protected, pure virtual]

This method gives the subclass a chance to do any special initialization that it may need to do BTX Reimplemented in vtkVolumeRayCastCompositeFunction, vtkVolumeRayCastIsosurfaceFunction, and vtkVolumeRayCastMIPFunction.

---

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

• graphics/vtkVolumeRayCastFunction.h

---