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

#include <vtkVisibilitySort.h>

Inheritance diagram for vtkVisibilitySort:

Collaboration diagram for vtkVisibilitySort:

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

vtkVisibilitySort *	NewInstance () const

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

virtual vtkMatrix4x4 *	GetInverseModelTransform ()


virtual void	InitTraversal ()=0
	To facilitate incremental sorting algorithms, the cells are retrieved in an iteration process. More...

virtual vtkIdTypeArray *	GetNextCells ()=0
	To facilitate incremental sorting algorithms, the cells are retrieved in an iteration process. More...


virtual void	SetMaxCellsReturned (int)
	Set/Get the maximum number of cells that GetNextCells will return in one invocation. More...

virtual int	GetMaxCellsReturned ()
	Set/Get the maximum number of cells that GetNextCells will return in one invocation. More...


virtual void	SetModelTransform (vtkMatrix4x4 *mat)
	Set/Get the matrix that transforms from object space to world space. More...

virtual vtkMatrix4x4 *	GetModelTransform ()
	Set/Get the matrix that transforms from object space to world space. More...


virtual void	SetCamera (vtkCamera *camera)
	Set/Get the camera that specifies the viewing parameters. More...

virtual vtkCamera *	GetCamera ()
	Set/Get the camera that specifies the viewing parameters. More...


virtual void	SetInput (vtkDataSet *data)
	Set/Get the data set containing the cells to sort. More...

virtual vtkDataSet *	GetInput ()
	Set/Get the data set containing the cells to sort. More...


virtual int	GetDirection ()
	Set/Get the sorting direction. More...

virtual void	SetDirection (int)
	Set/Get the sorting direction. More...

void	SetDirectionToBackToFront ()
	Set/Get the sorting direction. More...

void	SetDirectionToFrontToBack ()
	Set/Get the sorting direction. More...


void	Register (vtkObjectBase *o) override
	Overwritten to enable garbage collection. More...

void	UnRegister (vtkObjectBase *o) override
	Overwritten to enable garbage collection. 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	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. 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...

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

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 vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

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

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. 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 vtkVisibilitySort *	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 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). More...

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

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

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

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () 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 ()
	These methods allow a command to exclusively grab all events. More...

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
vtkTimeStamp	LastSortTime

vtkMatrix4x4 *	ModelTransform

vtkMatrix4x4 *	InverseModelTransform

vtkCamera *	Camera

vtkDataSet *	Input

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

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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

typedef vtkObject vtkVisibilitySort::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

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.

◆ 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

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

◆ 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

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

◆ 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

Set/Get the camera that specifies the viewing parameters.

◆ SetInput()

virtual void vtkVisibilitySort::SetInput ( vtkDataSet * data )

virtual

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

◆ GetInput()

virtual vtkDataSet * vtkVisibilitySort::GetInput ( )

virtual

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

◆ 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

Set/Get the sorting direction.

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

◆ SetDirectionToBackToFront()

void vtkVisibilitySort::SetDirectionToBackToFront ( )

inline

Set/Get the sorting direction.

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

Definition at line 123 of file vtkVisibilitySort.h.

◆ SetDirectionToFrontToBack()

void vtkVisibilitySort::SetDirectionToFrontToBack ( )

inline

Set/Get the sorting direction.

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

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

Overwritten to enable garbage collection.

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:

Rendering/Core/vtkVisibilitySort.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkVisibilitySort()

◆ ~vtkVisibilitySort()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ InitTraversal()

◆ GetNextCells()

◆ SetMaxCellsReturned()

◆ GetMaxCellsReturned()

◆ SetModelTransform()

◆ GetModelTransform()

◆ GetInverseModelTransform()

◆ SetCamera()

◆ GetCamera()

◆ SetInput()

◆ GetInput()

◆ GetDirection()

◆ SetDirection()

◆ SetDirectionToBackToFront()

◆ SetDirectionToFrontToBack()

◆ Register()

◆ UnRegister()

◆ ReportReferences()

Member Data Documentation

◆ LastSortTime

◆ ModelTransform

◆ InverseModelTransform

◆ Camera

◆ Input

◆ MaxCellsReturned

◆ Direction