VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkUnstructuredGridBunykRayCastFunction Class Reference

a superclass for ray casting functions More...

#include <vtkUnstructuredGridBunykRayCastFunction.h>

Inheritance diagram for vtkUnstructuredGridBunykRayCastFunction:
[legend]
Collaboration diagram for vtkUnstructuredGridBunykRayCastFunction:
[legend]

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. More...
 
vtkUnstructuredGridBunykRayCastFunctionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Initialize (vtkRenderer *ren, vtkVolume *vol) override
 Called by the ray cast mapper at the start of rendering. More...
 
void Finalize () override
 Called by the ray cast mapper at the end of rendering. More...
 
vtkUnstructuredGridVolumeRayCastIteratorNewIterator () override
 Returns a new object that will iterate over all the intersections of a ray with the cells of the input. More...
 
int InTriangle (double x, double y, Triangle *triPtr)
 Is the point x, y, in the given triangle? Public for access from the templated function. More...
 
double * GetPoints ()
 Access to an internal structure for the templated method. More...
 
virtual vtkMatrix4x4GetViewToWorldMatrix ()
 Access to an internal structure for the templated method. More...
 
virtual int * GetImageOrigin ()
 Access to an internal structure for the templated method. More...
 
virtual void GetImageOrigin (int data[2])
 
virtual int * GetImageViewportSize ()
 Access to an internal structure for the templated method. More...
 
virtual void GetImageViewportSize (int data[2])
 
Triangle ** GetTetraTriangles ()
 Access to an internal structure for the templated method. More...
 
IntersectionGetIntersectionList (int x, int y)
 Access to an internal structure for the templated method. More...
 
- Public Member Functions inherited from vtkUnstructuredGridVolumeRayCastFunction
vtkUnstructuredGridVolumeRayCastFunctionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkUnstructuredGridBunykRayCastFunctionNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkUnstructuredGridBunykRayCastFunctionSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkUnstructuredGridVolumeRayCastFunction
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkUnstructuredGridVolumeRayCastFunctionSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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
 vtkUnstructuredGridVolumeRayCastFunction ()
 
 ~vtkUnstructuredGridVolumeRayCastFunction () override
 
- 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. More...
 
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 &)
 

Protected Attributes

vtkRendererRenderer
 
vtkVolumeVolume
 
vtkUnstructuredGridVolumeRayCastMapperMapper
 
int Valid
 
int NumberOfPoints
 
double * Points
 
vtkMatrix4x4ViewToWorldMatrix
 
Intersection ** Image
 
int ImageSize [2]
 
int ImageOrigin [2]
 
int ImageViewportSize [2]
 
vtkUnstructuredGridBaseSavedTriangleListInput
 
vtkTimeStamp SavedTriangleListMTime
 
Triangle ** TetraTriangles
 
vtkIdType TetraTrianglesSize
 
TriangleTriangleList
 
IntersectionIntersectionBuffer [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
 

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

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

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

◆ GetPoints()

double* vtkUnstructuredGridBunykRayCastFunction::GetPoints ( )
inline

Access to an internal structure for the templated method.

Definition at line 137 of file vtkUnstructuredGridBunykRayCastFunction.h.

◆ GetViewToWorldMatrix()

virtual vtkMatrix4x4* vtkUnstructuredGridBunykRayCastFunction::GetViewToWorldMatrix ( )
virtual

Access to an internal structure for the templated method.

◆ GetImageOrigin() [1/2]

virtual int* vtkUnstructuredGridBunykRayCastFunction::GetImageOrigin ( )
virtual

Access to an internal structure for the templated method.

◆ GetImageOrigin() [2/2]

virtual void vtkUnstructuredGridBunykRayCastFunction::GetImageOrigin ( int  data[2])
virtual

◆ GetImageViewportSize() [1/2]

virtual int* vtkUnstructuredGridBunykRayCastFunction::GetImageViewportSize ( )
virtual

Access to an internal structure for the templated method.

◆ GetImageViewportSize() [2/2]

virtual void vtkUnstructuredGridBunykRayCastFunction::GetImageViewportSize ( int  data[2])
virtual

◆ GetTetraTriangles()

Triangle** vtkUnstructuredGridBunykRayCastFunction::GetTetraTriangles ( )
inline

Access to an internal structure for the templated method.

Definition at line 163 of file vtkUnstructuredGridBunykRayCastFunction.h.

◆ GetIntersectionList()

Intersection* vtkUnstructuredGridBunykRayCastFunction::GetIntersectionList ( int  x,
int  y 
)
inline

Access to an internal structure for the templated method.

Definition at line 168 of file vtkUnstructuredGridBunykRayCastFunction.h.

◆ IsTriangleFrontFacing()

int vtkUnstructuredGridBunykRayCastFunction::IsTriangleFrontFacing ( Triangle triPtr,
vtkIdType  tetraIndex 
)
protected

◆ ClearImage()

void vtkUnstructuredGridBunykRayCastFunction::ClearImage ( )
protected

◆ NewIntersection()

void* vtkUnstructuredGridBunykRayCastFunction::NewIntersection ( )
protected

◆ CheckValidity()

int vtkUnstructuredGridBunykRayCastFunction::CheckValidity ( vtkRenderer ren,
vtkVolume vol 
)
protected

◆ TransformPoints()

void vtkUnstructuredGridBunykRayCastFunction::TransformPoints ( )
protected

◆ UpdateTriangleList()

void vtkUnstructuredGridBunykRayCastFunction::UpdateTriangleList ( )
protected

◆ ComputeViewDependentInfo()

void vtkUnstructuredGridBunykRayCastFunction::ComputeViewDependentInfo ( )
protected

◆ ComputePixelIntersections()

void vtkUnstructuredGridBunykRayCastFunction::ComputePixelIntersections ( )
protected

Member Data Documentation

◆ Renderer

vtkRenderer* vtkUnstructuredGridBunykRayCastFunction::Renderer
protected

Definition at line 179 of file vtkUnstructuredGridBunykRayCastFunction.h.

◆ Volume

vtkVolume* vtkUnstructuredGridBunykRayCastFunction::Volume
protected

Definition at line 180 of file vtkUnstructuredGridBunykRayCastFunction.h.

◆ Mapper

vtkUnstructuredGridVolumeRayCastMapper* vtkUnstructuredGridBunykRayCastFunction::Mapper
protected

Definition at line 181 of file vtkUnstructuredGridBunykRayCastFunction.h.

◆ Valid

int vtkUnstructuredGridBunykRayCastFunction::Valid
protected

Definition at line 186 of file vtkUnstructuredGridBunykRayCastFunction.h.

◆ NumberOfPoints

int vtkUnstructuredGridBunykRayCastFunction::NumberOfPoints
protected

Definition at line 189 of file vtkUnstructuredGridBunykRayCastFunction.h.

◆ Points

double* vtkUnstructuredGridBunykRayCastFunction::Points
protected

Definition at line 190 of file vtkUnstructuredGridBunykRayCastFunction.h.

◆ ViewToWorldMatrix

vtkMatrix4x4* vtkUnstructuredGridBunykRayCastFunction::ViewToWorldMatrix
protected

Definition at line 194 of file vtkUnstructuredGridBunykRayCastFunction.h.

◆ Image

Intersection** vtkUnstructuredGridBunykRayCastFunction::Image
protected

Definition at line 197 of file vtkUnstructuredGridBunykRayCastFunction.h.

◆ ImageSize

int vtkUnstructuredGridBunykRayCastFunction::ImageSize[2]
protected

Definition at line 201 of file vtkUnstructuredGridBunykRayCastFunction.h.

◆ ImageOrigin

int vtkUnstructuredGridBunykRayCastFunction::ImageOrigin[2]
protected

Definition at line 208 of file vtkUnstructuredGridBunykRayCastFunction.h.

◆ ImageViewportSize

int vtkUnstructuredGridBunykRayCastFunction::ImageViewportSize[2]
protected

Definition at line 211 of file vtkUnstructuredGridBunykRayCastFunction.h.

◆ SavedTriangleListInput

vtkUnstructuredGridBase* vtkUnstructuredGridBunykRayCastFunction::SavedTriangleListInput
protected

Definition at line 215 of file vtkUnstructuredGridBunykRayCastFunction.h.

◆ SavedTriangleListMTime

vtkTimeStamp vtkUnstructuredGridBunykRayCastFunction::SavedTriangleListMTime
protected

Definition at line 216 of file vtkUnstructuredGridBunykRayCastFunction.h.

◆ TetraTriangles

Triangle** vtkUnstructuredGridBunykRayCastFunction::TetraTriangles
protected

Definition at line 224 of file vtkUnstructuredGridBunykRayCastFunction.h.

◆ TetraTrianglesSize

vtkIdType vtkUnstructuredGridBunykRayCastFunction::TetraTrianglesSize
protected

Definition at line 225 of file vtkUnstructuredGridBunykRayCastFunction.h.

◆ TriangleList

Triangle* vtkUnstructuredGridBunykRayCastFunction::TriangleList
protected

Definition at line 227 of file vtkUnstructuredGridBunykRayCastFunction.h.

◆ IntersectionBuffer

Intersection* vtkUnstructuredGridBunykRayCastFunction::IntersectionBuffer[VTK_BUNYKRCF_MAX_ARRAYS]
protected

Definition at line 243 of file vtkUnstructuredGridBunykRayCastFunction.h.

◆ IntersectionBufferCount

int vtkUnstructuredGridBunykRayCastFunction::IntersectionBufferCount[VTK_BUNYKRCF_MAX_ARRAYS]
protected

Definition at line 244 of file vtkUnstructuredGridBunykRayCastFunction.h.


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