a superclass for ray casting functions More...

#include <vtkVolumeRayCastFunction.h>

Inheritance diagram for vtkVolumeRayCastFunction:

Collaboration diagram for vtkVolumeRayCastFunction:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkVolumeRayCastFunction *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	FunctionInitialize (vtkRenderer ren, vtkVolume vol, vtkVolumeRayCastStaticInfo *staticInfo)
	Do the basic initialization. More...

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

virtual float	GetZeroOpacityThreshold (vtkVolume *vol)=0
	Get the value below which all scalar values are considered to have 0 opacity. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

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

static vtkVolumeRayCastFunction *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkVolumeRayCastFunction ()

	~vtkVolumeRayCastFunction ()

virtual void	SpecificFunctionInitialize (vtkRenderer ren, vtkVolume vol, vtkVolumeRayCastStaticInfo staticInfo, vtkVolumeRayCastMapper mapper)=0
	This method gives the subclass a chance to do any special initialization that it may need to do. More...

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

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

Deprecated:

Definition at line 136 of file vtkVolumeRayCastFunction.h.

Member Typedef Documentation

typedef vtkObject vtkVolumeRayCastFunction::Superclass

Definition at line 139 of file vtkVolumeRayCastFunction.h.

Constructor & Destructor Documentation

vtkVolumeRayCastFunction::vtkVolumeRayCastFunction ( )

inlineprotected

Definition at line 163 of file vtkVolumeRayCastFunction.h.

vtkVolumeRayCastFunction::~vtkVolumeRayCastFunction ( )

inlineprotected

Definition at line 167 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 vtkObjectBase.

Reimplemented in vtkVolumeRayCastMIPFunction, vtkVolumeRayCastCompositeFunction, and vtkVolumeRayCastIsosurfaceFunction.

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

static

virtual vtkObjectBase* vtkVolumeRayCastFunction::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkVolumeRayCastMIPFunction, vtkVolumeRayCastCompositeFunction, and vtkVolumeRayCastIsosurfaceFunction.

vtkVolumeRayCastFunction* vtkVolumeRayCastFunction::NewInstance ( ) const

void vtkVolumeRayCastFunction::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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

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

/home/demarle/Builds/VTK/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