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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkVisibilitySort *	NewInstance () const

virtual void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkMatrix4x4 *	GetInverseModelTransform ()


virtual void	InitTraversal ()=0

virtual vtkIdTypeArray *	GetNextCells ()=0


virtual void	SetMaxCellsReturned (int)

virtual int	GetMaxCellsReturned ()


virtual void	SetModelTransform (vtkMatrix4x4 *mat)

virtual vtkMatrix4x4 *	GetModelTransform ()


virtual void	SetCamera (vtkCamera *camera)

virtual vtkCamera *	GetCamera ()


virtual void	SetInput (vtkDataSet *data)

virtual vtkDataSet *	GetInput ()


virtual int	GetDirection ()

virtual void	SetDirection (int)

void	SetDirectionToBackToFront ()

void	SetDirectionToFrontToBack ()


virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

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)

int	InvokeEvent (unsigned long event, void *callData)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkVisibilitySort *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkVisibilitySort ()

virtual	~vtkVisibilitySort ()

virtual void	ReportReferences (vtkGarbageCollector *collector)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

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

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
vtkAtomicInt32	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 56 of file vtkVisibilitySort.h.

Member Typedef Documentation

typedef vtkObject vtkVisibilitySort::Superclass

Definition at line 59 of file vtkVisibilitySort.h.

Member Enumeration Documentation

anonymous enum

Enumerator
BACK_TO_FRONT
FRONT_TO_BACK

Definition at line 115 of file vtkVisibilitySort.h.

Constructor & Destructor Documentation

vtkVisibilitySort::vtkVisibilitySort ( )

protected

virtual vtkVisibilitySort::~vtkVisibilitySort ( )

protectedvirtual

Member Function Documentation

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

static

virtual int 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 vtkObject.

Reimplemented in vtkCellCenterDepthSort.

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

static

virtual vtkObjectBase* vtkVisibilitySort::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkCellCenterDepthSort.

vtkVisibilitySort* vtkVisibilitySort::NewInstance ( ) const

virtual void vtkVisibilitySort::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

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.

Reimplemented in vtkCellCenterDepthSort.

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.

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.

virtual void vtkVisibilitySort::SetMaxCellsReturned ( int )

virtual

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

virtual int vtkVisibilitySort::GetMaxCellsReturned ( )

virtual

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

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

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

virtual vtkMatrix4x4* vtkVisibilitySort::GetInverseModelTransform ( )

virtual

virtual void vtkVisibilitySort::SetCamera ( vtkCamera * camera )

virtual

Set/Get the camera that specifies the viewing parameters.

virtual vtkCamera* vtkVisibilitySort::GetCamera ( )

virtual

Set/Get the camera that specifies the viewing parameters.

virtual void vtkVisibilitySort::SetInput ( vtkDataSet * data )

virtual

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

virtual vtkDataSet* vtkVisibilitySort::GetInput ( )

virtual

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

virtual int vtkVisibilitySort::GetDirection ( )

virtual

Set/Get the sorting direction. Be default, the direction is set to back to front.

virtual void vtkVisibilitySort::SetDirection ( int )

virtual

Set/Get the sorting direction. Be default, the direction is set to back to front.

void vtkVisibilitySort::SetDirectionToBackToFront ( )

inline

Set/Get the sorting direction. Be default, the direction is set to back to front.

Definition at line 110 of file vtkVisibilitySort.h.

void vtkVisibilitySort::SetDirectionToFrontToBack ( )

inline

Set/Get the sorting direction. Be default, the direction is set to back to front.

Definition at line 111 of file vtkVisibilitySort.h.

virtual void vtkVisibilitySort::Register ( vtkObjectBase * o )

virtual

Overwritten to enable garbage collection.

Reimplemented from vtkObjectBase.

virtual void vtkVisibilitySort::UnRegister ( vtkObjectBase * o )

virtual

Overwritten to enable garbage collection.

Reimplemented from vtkObjectBase.

virtual void vtkVisibilitySort::ReportReferences ( vtkGarbageCollector * collector )

protectedvirtual

Reimplemented from vtkObjectBase.

Member Data Documentation

vtkTimeStamp vtkVisibilitySort::LastSortTime

protected

Definition at line 128 of file vtkVisibilitySort.h.

vtkMatrix4x4* vtkVisibilitySort::ModelTransform

protected

Definition at line 130 of file vtkVisibilitySort.h.

vtkMatrix4x4* vtkVisibilitySort::InverseModelTransform

protected

Definition at line 131 of file vtkVisibilitySort.h.

vtkCamera* vtkVisibilitySort::Camera

protected

Definition at line 132 of file vtkVisibilitySort.h.

vtkDataSet* vtkVisibilitySort::Input

protected

Definition at line 133 of file vtkVisibilitySort.h.

int vtkVisibilitySort::MaxCellsReturned

protected

Definition at line 135 of file vtkVisibilitySort.h.

int vtkVisibilitySort::Direction

protected

Definition at line 137 of file vtkVisibilitySort.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/Core/vtkVisibilitySort.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation