vtkVisibilitySort Class Reference

#include <vtkVisibilitySort.h>

Inheritance diagram for vtkVisibilitySort:

[legend]Collaboration diagram for vtkVisibilitySort:

[legend]List of all members.

---

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

Public Types
typedef vtkObject	Superclass
enum	{ BACK_TO_FRONT, FRONT_TO_BACK }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	InitTraversal ()=0
virtual vtkIdTypeArray *	GetNextCells ()=0
virtual void	SetMaxCellsReturned (int)
virtual int	GetMaxCellsReturned ()
virtual void	SetModelTransform (vtkMatrix4x4 *mat)
virtual vtkMatrix4x4 *	GetModelTransform ()
virtual vtkMatrix4x4 *	GetInverseModelTransform ()
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)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkVisibilitySort *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkVisibilitySort ()
virtual	~vtkVisibilitySort ()
virtual void	ReportReferences (vtkGarbageCollector *collector)
Protected Attributes
vtkTimeStamp	LastSortTime
vtkMatrix4x4 *	ModelTransform
vtkMatrix4x4 *	InverseModelTransform
vtkCamera *	Camera
vtkDataSet *	Input
int	MaxCellsReturned
int	Direction

---

Member Typedef Documentation

typedef vtkObject vtkVisibilitySort::Superclass

Reimplemented from vtkObject. Reimplemented in vtkCellCenterDepthSort. Definition at line 58 of file vtkVisibilitySort.h.

---

Member Enumeration Documentation

anonymous enum

Enumerator: BACK_TO_FRONT  FRONT_TO_BACK  Definition at line 114 of file vtkVisibilitySort.h.

---

Constructor & Destructor Documentation

vtkVisibilitySort::vtkVisibilitySort (   )  [protected]

virtual vtkVisibilitySort::~vtkVisibilitySort (   )  [protected, virtual]

---

Member Function Documentation

virtual const char* vtkVisibilitySort::GetClassName (   )  [virtual]

Reimplemented from vtkObject. Reimplemented in vtkCellCenterDepthSort.

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

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkObject. Reimplemented in vtkCellCenterDepthSort.

virtual int vtkVisibilitySort::IsA (  const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkObject. Reimplemented in vtkCellCenterDepthSort.

static vtkVisibilitySort* vtkVisibilitySort::SafeDownCast (  vtkObject *  o  )  [static]

Reimplemented from vtkObject. Reimplemented in vtkCellCenterDepthSort.

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]

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]

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 109 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 110 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  )  [protected, virtual]

Reimplemented from vtkObjectBase.

---

Member Data Documentation

vtkTimeStamp vtkVisibilitySort::LastSortTime [protected]

Definition at line 127 of file vtkVisibilitySort.h.

vtkMatrix4x4* vtkVisibilitySort::ModelTransform [protected]

Definition at line 129 of file vtkVisibilitySort.h.

vtkMatrix4x4* vtkVisibilitySort::InverseModelTransform [protected]

Definition at line 130 of file vtkVisibilitySort.h.

vtkCamera* vtkVisibilitySort::Camera [protected]

Definition at line 131 of file vtkVisibilitySort.h.

vtkDataSet* vtkVisibilitySort::Input [protected]

Definition at line 132 of file vtkVisibilitySort.h.

int vtkVisibilitySort::MaxCellsReturned [protected]

Definition at line 134 of file vtkVisibilitySort.h.

int vtkVisibilitySort::Direction [protected]

Definition at line 136 of file vtkVisibilitySort.h.

---

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

• dox/Graphics/vtkVisibilitySort.h

---