a superclass for ray casting functions More...

#include <vtkUnstructuredGridBunykRayCastFunction.h>

Inheritance diagram for vtkUnstructuredGridBunykRayCastFunction:

Collaboration diagram for vtkUnstructuredGridBunykRayCastFunction:

Classes
class	Intersection

class	Triangle

Public Types
typedef vtkUnstructuredGridVolumeRayCastFunction	Superclass

Public Types inherited from vtkUnstructuredGridVolumeRayCastFunction
typedef vtkObject	Superclass

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

vtkUnstructuredGridBunykRayCastFunction *	NewInstance () const

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

void	Initialize (vtkRenderer ren, vtkVolume vol) override
	Called by the ray cast mapper at the start of rendering.

void	Finalize () override
	Called by the ray cast mapper at the end of rendering.

vtkUnstructuredGridVolumeRayCastIterator *	NewIterator () override
	Returns a new object that will iterate over all the intersections of a ray with the cells of the input.

int	InTriangle (double x, double y, Triangle *triPtr)
	Is the point x, y, in the given triangle? Public for access from the templated function.

double *	GetPoints ()
	Access to an internal structure for the templated method.

Triangle **	GetTetraTriangles ()
	Access to an internal structure for the templated method.

Intersection *	GetIntersectionList (int x, int y)
	Access to an internal structure for the templated method.


virtual vtkMatrix4x4 *	GetViewToWorldMatrix ()
	Access to an internal structure for the templated method.


virtual int *	GetImageOrigin ()
	Access to an internal structure for the templated method.

virtual void	GetImageOrigin (int data[2])
	Access to an internal structure for the templated method.


virtual int *	GetImageViewportSize ()
	Access to an internal structure for the templated method.

virtual void	GetImageViewportSize (int data[2])
	Access to an internal structure for the templated method.

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

vtkUnstructuredGridVolumeRayCastFunction *	NewInstance () const

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

virtual void	Initialize (vtkRenderer ren, vtkVolume vol)=0

virtual void	Finalize ()=0

virtual vtkUnstructuredGridVolumeRayCastIterator *	NewIterator ()=0
	Returns a new object that will iterate over all the intersections of a ray with the cells of the input.

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

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

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

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

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

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

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

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

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

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

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

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

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

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

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

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

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.

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.

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.

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

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

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

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

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

void	InitializeObjectBase ()

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

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

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

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

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

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

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

Static Public Member Functions
static vtkUnstructuredGridBunykRayCastFunction *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkUnstructuredGridBunykRayCastFunction *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkUnstructuredGridVolumeRayCastFunction
static vtkTypeBool	IsTypeOf (const char *type)

static vtkUnstructuredGridVolumeRayCastFunction *	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.

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

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

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

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

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

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.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

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

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkUnstructuredGridBunykRayCastFunction ()

	~vtkUnstructuredGridBunykRayCastFunction () override

int	IsTriangleFrontFacing (Triangle *triPtr, vtkIdType tetraIndex)

void	ClearImage ()

void *	NewIntersection ()

int	CheckValidity (vtkRenderer ren, vtkVolume vol)

void	TransformPoints ()

void	UpdateTriangleList ()

void	ComputeViewDependentInfo ()

void	ComputePixelIntersections ()

Protected Member Functions inherited from vtkUnstructuredGridVolumeRayCastFunction
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkUnstructuredGridVolumeRayCastFunction ()=default

	~vtkUnstructuredGridVolumeRayCastFunction () override=default

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=nullptr)
	These methods allow a command to exclusively grab all events.

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

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkRenderer *	Renderer

vtkVolume *	Volume

vtkUnstructuredGridVolumeRayCastMapper *	Mapper

int	Valid

int	NumberOfPoints

double *	Points

vtkMatrix4x4 *	ViewToWorldMatrix

Intersection **	Image

int	ImageSize [2]

int	ImageOrigin [2]

int	ImageViewportSize [2]

vtkUnstructuredGridBase *	SavedTriangleListInput

vtkTimeStamp	SavedTriangleListMTime

Triangle **	TetraTriangles

vtkIdType	TetraTrianglesSize

Triangle *	TriangleList

Intersection *	IntersectionBuffer [VTK_BUNYKRCF_MAX_ARRAYS]

int	IntersectionBufferCount [VTK_BUNYKRCF_MAX_ARRAYS]

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

a superclass for ray casting functions

vtkUnstructuredGridBunykRayCastFunction is a concrete implementation of a ray cast function for unstructured grid data. This class was based on the paper "Simple, Fast, Robust Ray Casting of Irregular Grids" by Paul Bunyk, Arie Kaufmna, and Claudio Silva. This method is quite memory intensive (with extra explicit copies of the data) and therefore should not be used for very large data. This method assumes that the input data is composed entirely of tetras - use vtkDataSetTriangleFilter before setting the input on the mapper.

The basic idea of this method is as follows:

1) Enumerate the triangles. At each triangle have space for some information that will be used during rendering. This includes which tetra the triangles belong to, the plane equation and the Barycentric coefficients.

2) Keep a reference to all four triangles for each tetra.

3) At the beginning of each render, do the precomputation. This includes creating an array of transformed points (in view coordinates) and computing the view dependent info per triangle (plane equations and barycentric coords in view space)

4) Find all front facing boundary triangles (a triangle is on the boundary if it belongs to only one tetra). For each triangle, find all pixels in the image that intersect the triangle, and add this to the sorted (by depth) intersection list at each pixel.

5) For each ray cast, traverse the intersection list. At each intersection, accumulate opacity and color contribution per tetra along the ray until you reach an exiting triangle (on the boundary).

See also: vtkUnstructuredGridVolumeRayCastMapper

Definition at line 83 of file vtkUnstructuredGridBunykRayCastFunction.h.

Member Typedef Documentation

◆ Superclass

typedef vtkUnstructuredGridVolumeRayCastFunction vtkUnstructuredGridBunykRayCastFunction::Superclass

Definition at line 88 of file vtkUnstructuredGridBunykRayCastFunction.h.

Constructor & Destructor Documentation

◆ vtkUnstructuredGridBunykRayCastFunction()

vtkUnstructuredGridBunykRayCastFunction::vtkUnstructuredGridBunykRayCastFunction ( )

protected

◆ ~vtkUnstructuredGridBunykRayCastFunction()

vtkUnstructuredGridBunykRayCastFunction::~vtkUnstructuredGridBunykRayCastFunction ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkUnstructuredGridBunykRayCastFunction * vtkUnstructuredGridBunykRayCastFunction::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkUnstructuredGridBunykRayCastFunction::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkUnstructuredGridBunykRayCastFunction::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 vtkUnstructuredGridVolumeRayCastFunction.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkUnstructuredGridBunykRayCastFunction::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkUnstructuredGridVolumeRayCastFunction.

◆ NewInstance()

vtkUnstructuredGridBunykRayCastFunction * vtkUnstructuredGridBunykRayCastFunction::NewInstance ( ) const

◆ PrintSelf()

void vtkUnstructuredGridBunykRayCastFunction::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.

◆ Initialize()

void vtkUnstructuredGridBunykRayCastFunction::Initialize	(	vtkRenderer *	ren,
		vtkVolume *	vol
	)

overridevirtual

Called by the ray cast mapper at the start of rendering.

Implements vtkUnstructuredGridVolumeRayCastFunction.

◆ Finalize()

void vtkUnstructuredGridBunykRayCastFunction::Finalize ( )

overridevirtual

Called by the ray cast mapper at the end of rendering.

Implements vtkUnstructuredGridVolumeRayCastFunction.

◆ NewIterator()

vtkUnstructuredGridVolumeRayCastIterator * vtkUnstructuredGridBunykRayCastFunction::NewIterator ( )

overridevirtual

Returns a new object that will iterate over all the intersections of a ray with the cells of the input.

The calling code is responsible for deleting the returned object.

Implements vtkUnstructuredGridVolumeRayCastFunction.

◆ InTriangle()

int vtkUnstructuredGridBunykRayCastFunction::InTriangle	(	double	x,
		double	y,
		Triangle *	triPtr
	)

Is the point x, y, in the given triangle? Public for access from the templated function.