Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkVolumeRayCastFunction Class Reference

#include <vtkVolumeRayCastFunction.h>

Inheritance diagram for vtkVolumeRayCastFunction:

Inheritance graph
[legend]
Collaboration diagram for vtkVolumeRayCastFunction:

Collaboration graph
[legend]
List of all members.

Detailed Description

a superclass for ray casting functions

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 132 of file vtkVolumeRayCastFunction.h.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void CastRay (vtkVolumeRayCastDynamicInfo *dynamicInfo, vtkVolumeRayCastStaticInfo *staticInfo)=0
virtual float GetZeroOpacityThreshold (vtkVolume *vol)=0
virtual void PrintSelf (ostream &os, vtkIndent indent)
void FunctionInitialize (vtkRenderer *ren, vtkVolume *vol, vtkVolumeRayCastStaticInfo *staticInfo)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkVolumeRayCastFunctionSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkVolumeRayCastFunction ()
 ~vtkVolumeRayCastFunction ()
virtual void SpecificFunctionInitialize (vtkRenderer *ren, vtkVolume *vol, vtkVolumeRayCastStaticInfo *staticInfo, vtkVolumeRayCastMapper *mapper)=0


Member Typedef Documentation

typedef vtkObject vtkVolumeRayCastFunction::Superclass
 

Reimplemented from vtkObject.

Reimplemented in vtkVolumeRayCastCompositeFunction, vtkVolumeRayCastIsosurfaceFunction, and vtkVolumeRayCastMIPFunction.

Definition at line 135 of file vtkVolumeRayCastFunction.h.


Constructor & Destructor Documentation

vtkVolumeRayCastFunction::vtkVolumeRayCastFunction  )  [inline, protected]
 

Definition at line 158 of file vtkVolumeRayCastFunction.h.

vtkVolumeRayCastFunction::~vtkVolumeRayCastFunction  )  [inline, protected]
 

Definition at line 159 of file vtkVolumeRayCastFunction.h.


Member Function Documentation

virtual const char* vtkVolumeRayCastFunction::GetClassName  )  [virtual]
 

Reimplemented from vtkObject.

Reimplemented in vtkVolumeRayCastCompositeFunction, vtkVolumeRayCastIsosurfaceFunction, and vtkVolumeRayCastMIPFunction.

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

Reimplemented from vtkObject.

Reimplemented in vtkVolumeRayCastCompositeFunction, vtkVolumeRayCastIsosurfaceFunction, and vtkVolumeRayCastMIPFunction.

static vtkVolumeRayCastFunction* vtkVolumeRayCastFunction::SafeDownCast vtkObject o  )  [static]
 

Reimplemented from vtkObject.

Reimplemented in vtkVolumeRayCastCompositeFunction, vtkVolumeRayCastIsosurfaceFunction, and vtkVolumeRayCastMIPFunction.

virtual void vtkVolumeRayCastFunction::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 vtkObject.

Reimplemented in vtkVolumeRayCastCompositeFunction, vtkVolumeRayCastIsosurfaceFunction, and vtkVolumeRayCastMIPFunction.

void vtkVolumeRayCastFunction::FunctionInitialize vtkRenderer ren,
vtkVolume vol,
vtkVolumeRayCastStaticInfo staticInfo
 

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 vtkVolumeRayCastDynamicInfo dynamicInfo,
vtkVolumeRayCastStaticInfo staticInfo
[pure virtual]
 

Implemented 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.

Implemented in vtkVolumeRayCastCompositeFunction, vtkVolumeRayCastIsosurfaceFunction, and vtkVolumeRayCastMIPFunction.

virtual void vtkVolumeRayCastFunction::SpecificFunctionInitialize vtkRenderer ren,
vtkVolume vol,
vtkVolumeRayCastStaticInfo staticInfo,
vtkVolumeRayCastMapper mapper
[protected, pure virtual]
 

This method gives the subclass a chance to do any special initialization that it may need to do BTX

Implemented in vtkVolumeRayCastCompositeFunction, vtkVolumeRayCastIsosurfaceFunction, and vtkVolumeRayCastMIPFunction.


The documentation for this class was generated from the following file:
Generated on Tue Jan 22 00:29:03 2008 for VTK by  doxygen 1.4.3-20050530