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

Abstract class that can sort cell data along a viewpoint. More...

#include <vtkVisibilitySort.h>

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

Public Types

enum  { BACK_TO_FRONT, FRONT_TO_BACK }
 
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...
 
vtkVisibilitySortNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void InitTraversal ()=0
 To facilitate incremental sorting algorithms, the cells are retrieved in an iteration process. More...
 
virtual vtkIdTypeArrayGetNextCells ()=0
 
virtual void SetMaxCellsReturned (int)
 Set/Get the maximum number of cells that GetNextCells will return in one invocation. More...
 
virtual int GetMaxCellsReturned ()
 
virtual void SetModelTransform (vtkMatrix4x4 *mat)
 Set/Get the matrix that transforms from object space to world space. More...
 
virtual vtkMatrix4x4GetModelTransform ()
 
virtual vtkMatrix4x4GetInverseModelTransform ()
 
virtual void SetCamera (vtkCamera *camera)
 Set/Get the camera that specifies the viewing parameters. More...
 
virtual vtkCameraGetCamera ()
 
virtual void SetInput (vtkDataSet *data)
 Set/Get the data set containing the cells to sort. More...
 
virtual vtkDataSetGetInput ()
 
virtual int GetDirection ()
 Set/Get the sorting direction. More...
 
virtual void SetDirection (int)
 
void SetDirectionToBackToFront ()
 
void SetDirectionToFrontToBack ()
 
void Register (vtkObjectBase *o) override
 Overwritten to enable garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). 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)
 
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 vtkTypeBool IsTypeOf (const char *type)
 
static vtkVisibilitySortSafeDownCast (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
 
 vtkVisibilitySort ()
 
 ~vtkVisibilitySort () override
 
void ReportReferences (vtkGarbageCollector *collector) 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 &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkTimeStamp LastSortTime
 
vtkMatrix4x4ModelTransform
 
vtkMatrix4x4InverseModelTransform
 
vtkCameraCamera
 
vtkDataSetInput
 
int MaxCellsReturned
 
int Direction
 
- 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

Abstract class that can sort cell data along a viewpoint.

vtkVisibilitySort encapsulates a method for depth sorting the cells of a vtkDataSet for a given viewpoint. It should be noted that subclasses are not required to give an absolutely correct sorting. Many types of unstructured grids may have sorting cycles, meaning that there is no possible correct sorting. Some subclasses also only give an approximate sorting in the interest of speed.

Attention
The Input field of this class tends to causes reference cycles. To help break these cycles, garbage collection is enabled on this object and the input parameter is traced. For this to work, though, an object in the loop holding the visibility sort should also report that to the garbage collector.

Definition at line 57 of file vtkVisibilitySort.h.

Member Typedef Documentation

◆ Superclass

Definition at line 60 of file vtkVisibilitySort.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
BACK_TO_FRONT 
FRONT_TO_BACK 

Definition at line 127 of file vtkVisibilitySort.h.

Constructor & Destructor Documentation

◆ vtkVisibilitySort()

vtkVisibilitySort::vtkVisibilitySort ( )
protected

◆ ~vtkVisibilitySort()

vtkVisibilitySort::~vtkVisibilitySort ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkVisibilitySort::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 vtkCellCenterDepthSort.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkVisibilitySort::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkCellCenterDepthSort.

◆ NewInstance()

vtkVisibilitySort* vtkVisibilitySort::NewInstance ( ) const

◆ PrintSelf()

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

◆ InitTraversal()

virtual void vtkVisibilitySort::InitTraversal ( )
pure virtual

To facilitate incremental sorting algorithms, the cells are retrieved in an iteration process.

That is, call InitTraversal to start the iteration and call GetNextCells to get the cell IDs in order. However, for efficiencies sake, GetNextCells returns an ordered list of several id's in once call (but not necessarily all). GetNextCells will return NULL once the entire sorted list is output. The vtkIdTypeArray returned from GetNextCells is a cached array, so do not delete it. At the same note, do not expect the array to be valid after subsequent calls to GetNextCells.

Implemented in vtkCellCenterDepthSort.

◆ GetNextCells()

virtual vtkIdTypeArray* vtkVisibilitySort::GetNextCells ( )
pure virtual

Implemented in vtkCellCenterDepthSort.

◆ SetMaxCellsReturned()

virtual void vtkVisibilitySort::SetMaxCellsReturned ( int  )
virtual

Set/Get the maximum number of cells that GetNextCells will return in one invocation.

◆ GetMaxCellsReturned()

virtual int vtkVisibilitySort::GetMaxCellsReturned ( )
virtual

◆ SetModelTransform()

virtual void vtkVisibilitySort::SetModelTransform ( vtkMatrix4x4 mat)
virtual

Set/Get the matrix that transforms from object space to world space.

Generally, you get this matrix from a call to GetMatrix of a vtkProp3D (vtkActor).

◆ GetModelTransform()

virtual vtkMatrix4x4* vtkVisibilitySort::GetModelTransform ( )
virtual

◆ GetInverseModelTransform()

virtual vtkMatrix4x4* vtkVisibilitySort::GetInverseModelTransform ( )
virtual

◆ SetCamera()

virtual void vtkVisibilitySort::SetCamera ( vtkCamera camera)
virtual

Set/Get the camera that specifies the viewing parameters.

◆ GetCamera()

virtual vtkCamera* vtkVisibilitySort::GetCamera ( )
virtual

◆ SetInput()

virtual void vtkVisibilitySort::SetInput ( vtkDataSet data)
virtual

Set/Get the data set containing the cells to sort.

◆ GetInput()

virtual vtkDataSet* vtkVisibilitySort::GetInput ( )
virtual

◆ GetDirection()

virtual int vtkVisibilitySort::GetDirection ( )
virtual

Set/Get the sorting direction.

Be default, the direction is set to back to front.

◆ SetDirection()

virtual void vtkVisibilitySort::SetDirection ( int  )
virtual

◆ SetDirectionToBackToFront()

void vtkVisibilitySort::SetDirectionToBackToFront ( )
inline

Definition at line 123 of file vtkVisibilitySort.h.

◆ SetDirectionToFrontToBack()

void vtkVisibilitySort::SetDirectionToFrontToBack ( )
inline

Definition at line 124 of file vtkVisibilitySort.h.

◆ Register()

void vtkVisibilitySort::Register ( vtkObjectBase o)
overridevirtual

Overwritten to enable garbage collection.

Reimplemented from vtkObjectBase.

◆ UnRegister()

void vtkVisibilitySort::UnRegister ( vtkObjectBase o)
overridevirtual

Decrease the reference count (release by another object).

This has the same effect as invoking Delete() (i.e., it reduces the reference count by 1).

Reimplemented from vtkObjectBase.

◆ ReportReferences()

void vtkVisibilitySort::ReportReferences ( vtkGarbageCollector collector)
overrideprotectedvirtual

Reimplemented from vtkObjectBase.

Member Data Documentation

◆ LastSortTime

vtkTimeStamp vtkVisibilitySort::LastSortTime
protected

Definition at line 145 of file vtkVisibilitySort.h.

◆ ModelTransform

vtkMatrix4x4* vtkVisibilitySort::ModelTransform
protected

Definition at line 147 of file vtkVisibilitySort.h.

◆ InverseModelTransform

vtkMatrix4x4* vtkVisibilitySort::InverseModelTransform
protected

Definition at line 148 of file vtkVisibilitySort.h.

◆ Camera

vtkCamera* vtkVisibilitySort::Camera
protected

Definition at line 149 of file vtkVisibilitySort.h.

◆ Input

vtkDataSet* vtkVisibilitySort::Input
protected

Definition at line 150 of file vtkVisibilitySort.h.

◆ MaxCellsReturned

int vtkVisibilitySort::MaxCellsReturned
protected

Definition at line 152 of file vtkVisibilitySort.h.

◆ Direction

int vtkVisibilitySort::Direction
protected

Definition at line 154 of file vtkVisibilitySort.h.


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