a superclass for ray casting functions More...

#include <vtkVolumeRayCastFunction.h>

Inheritance diagram for vtkVolumeRayCastFunction:

Collaboration diagram for vtkVolumeRayCastFunction:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkVolumeRayCastFunction *	NewInstance () const

virtual void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	CastRay (vtkVolumeRayCastDynamicInfo dynamicInfo, vtkVolumeRayCastStaticInfo staticInfo)=0

virtual float	GetZeroOpacityThreshold (vtkVolume *vol)=0


void	FunctionInitialize (vtkRenderer ren, vtkVolume vol, vtkVolumeRayCastStaticInfo *staticInfo)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkVolumeRayCastFunction *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkVolumeRayCastFunction ()

	~vtkVolumeRayCastFunction ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

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

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

Member Typedef Documentation

typedef vtkObject vtkVolumeRayCastFunction::Superclass

Definition at line 136 of file vtkVolumeRayCastFunction.h.

Constructor & Destructor Documentation

vtkVolumeRayCastFunction::vtkVolumeRayCastFunction ( )

inlineprotected

Definition at line 160 of file vtkVolumeRayCastFunction.h.

vtkVolumeRayCastFunction::~vtkVolumeRayCastFunction ( )

inlineprotected

Definition at line 161 of file vtkVolumeRayCastFunction.h.

Member Function Documentation

static int vtkVolumeRayCastFunction::IsTypeOf ( const char * type )

static

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

Reimplemented from vtkObject.

Reimplemented in vtkVolumeRayCastMIPFunction, vtkVolumeRayCastCompositeFunction, and vtkVolumeRayCastIsosurfaceFunction.

static vtkVolumeRayCastFunction* vtkVolumeRayCastFunction::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkVolumeRayCastFunction::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkVolumeRayCastMIPFunction, vtkVolumeRayCastCompositeFunction, and vtkVolumeRayCastIsosurfaceFunction.

vtkVolumeRayCastFunction* vtkVolumeRayCastFunction::NewInstance ( ) const

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 vtkVolumeRayCastMIPFunction, vtkVolumeRayCastCompositeFunction, and vtkVolumeRayCastIsosurfaceFunction.

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.

virtual void vtkVolumeRayCastFunction::CastRay	(	vtkVolumeRayCastDynamicInfo *	dynamicInfo,
		vtkVolumeRayCastStaticInfo *	staticInfo
	)

pure virtual

Implemented in vtkVolumeRayCastMIPFunction, vtkVolumeRayCastIsosurfaceFunction, and vtkVolumeRayCastCompositeFunction.

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, vtkVolumeRayCastMIPFunction, and vtkVolumeRayCastIsosurfaceFunction.

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

protectedpure virtual

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

Implemented in vtkVolumeRayCastMIPFunction, vtkVolumeRayCastIsosurfaceFunction, and vtkVolumeRayCastCompositeFunction.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/Volume/vtkVolumeRayCastFunction.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation