VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkUnstructuredGridVolumeRayCastIterator Class Referenceabstract

vtkUnstructuredGridVolumeRayCastIterator is a superclass for iterating over the intersections of a viewing ray with a group of unstructured cells. More...

#include <vtkUnstructuredGridVolumeRayCastIterator.h>

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

Public Types

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...
 
vtkUnstructuredGridVolumeRayCastIteratorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Initialize (int x, int y)=0
 Initializes the iteration to the start of the ray at the given screen coordinates. More...
 
virtual vtkIdType GetNextIntersections (vtkIdList *intersectedCells, vtkDoubleArray *intersectionLengths, vtkDataArray *scalars, vtkDataArray *nearIntersections, vtkDataArray *farIntersections)=0
 Get the intersections of the next several cells. More...
 
virtual void SetMaxNumberOfIntersections (vtkIdType)
 
virtual vtkIdType GetMaxNumberOfIntersections ()
 
virtual void SetBounds (double, double)
 Set/get the bounds of the cast ray (in viewing coordinates). More...
 
void SetBounds (double[2])
 Set/get the bounds of the cast ray (in viewing coordinates). More...
 
virtual doubleGetBounds ()
 Set/get the bounds of the cast ray (in viewing coordinates). More...
 
virtual void GetBounds (double &, double &)
 Set/get the bounds of the cast ray (in viewing coordinates). More...
 
virtual void GetBounds (double[2])
 Set/get the bounds of the cast ray (in viewing coordinates). 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 ()
 
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. 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...
 
vtkCommandGetCommand (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...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool 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 vtkTypeBool IsTypeOf (const char *type)
 
static vtkUnstructuredGridVolumeRayCastIteratorSafeDownCast (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 ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkUnstructuredGridVolumeRayCastIterator ()
 
 ~vtkUnstructuredGridVolumeRayCastIterator () 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 ()
 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 &)
 

Protected Attributes

double Bounds [2]
 
vtkIdType MaxNumberOfIntersections
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

vtkUnstructuredGridVolumeRayCastIterator is a superclass for iterating over the intersections of a viewing ray with a group of unstructured cells.

These iterators are created with a vtkUnstructuredGridVolumeRayCastFunction.

See also
vtkUnstructuredGridVolumeRayCastFunction

Definition at line 43 of file vtkUnstructuredGridVolumeRayCastIterator.h.

Member Typedef Documentation

Definition at line 46 of file vtkUnstructuredGridVolumeRayCastIterator.h.

Constructor & Destructor Documentation

vtkUnstructuredGridVolumeRayCastIterator::vtkUnstructuredGridVolumeRayCastIterator ( )
protected
vtkUnstructuredGridVolumeRayCastIterator::~vtkUnstructuredGridVolumeRayCastIterator ( )
overrideprotected

Member Function Documentation

static vtkTypeBool vtkUnstructuredGridVolumeRayCastIterator::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkUnstructuredGridVolumeRayCastIterator::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.

static vtkUnstructuredGridVolumeRayCastIterator* vtkUnstructuredGridVolumeRayCastIterator::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkUnstructuredGridVolumeRayCastIterator::NewInstanceInternal ( ) const
protectedvirtual
vtkUnstructuredGridVolumeRayCastIterator* vtkUnstructuredGridVolumeRayCastIterator::NewInstance ( ) const
void vtkUnstructuredGridVolumeRayCastIterator::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.

virtual void vtkUnstructuredGridVolumeRayCastIterator::Initialize ( int  x,
int  y 
)
pure virtual

Initializes the iteration to the start of the ray at the given screen coordinates.

virtual vtkIdType vtkUnstructuredGridVolumeRayCastIterator::GetNextIntersections ( vtkIdList intersectedCells,
vtkDoubleArray intersectionLengths,
vtkDataArray scalars,
vtkDataArray nearIntersections,
vtkDataArray farIntersections 
)
pure virtual

Get the intersections of the next several cells.

The cell ids are stored in intersectedCells and the length of each ray segment within the cell is stored in intersectionLengths. The point scalars scalars are interpolated and stored in nearIntersections and farIntersections. intersectedCells, intersectionLengths, or scalars may be NULL to suppress passing the associated information. The number of intersections actually encountered is returned. 0 is returned if and only if no more intersections are to be found.

virtual void vtkUnstructuredGridVolumeRayCastIterator::SetBounds ( double  ,
double   
)
virtual

Set/get the bounds of the cast ray (in viewing coordinates).

By default the range is [0,1].

void vtkUnstructuredGridVolumeRayCastIterator::SetBounds ( double  [2])

Set/get the bounds of the cast ray (in viewing coordinates).

By default the range is [0,1].

virtual double* vtkUnstructuredGridVolumeRayCastIterator::GetBounds ( )
virtual

Set/get the bounds of the cast ray (in viewing coordinates).

By default the range is [0,1].

virtual void vtkUnstructuredGridVolumeRayCastIterator::GetBounds ( double ,
double  
)
virtual

Set/get the bounds of the cast ray (in viewing coordinates).

By default the range is [0,1].

virtual void vtkUnstructuredGridVolumeRayCastIterator::GetBounds ( double  [2])
virtual

Set/get the bounds of the cast ray (in viewing coordinates).

By default the range is [0,1].

virtual void vtkUnstructuredGridVolumeRayCastIterator::SetMaxNumberOfIntersections ( vtkIdType  )
virtual
virtual vtkIdType vtkUnstructuredGridVolumeRayCastIterator::GetMaxNumberOfIntersections ( )
virtual

Member Data Documentation

double vtkUnstructuredGridVolumeRayCastIterator::Bounds[2]
protected

Definition at line 91 of file vtkUnstructuredGridVolumeRayCastIterator.h.

vtkIdType vtkUnstructuredGridVolumeRayCastIterator::MaxNumberOfIntersections
protected

Definition at line 93 of file vtkUnstructuredGridVolumeRayCastIterator.h.


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