Efficient cell iterator for vtkDataSet topologies. More...

#include <vtkCellIterator.h>

Inheritance diagram for vtkCellIterator:

Collaboration diagram for vtkCellIterator:

Public Member Functions
virtual void	PrintSelf (ostream &os, vtkIndent indent)

	vtkAbstractTypeMacro (vtkCellIterator, vtkObject) void InitTraversal()

void	GoToNextCell ()

virtual bool	IsDoneWithTraversal ()=0

int	GetCellType ()

virtual vtkIdType	GetCellId ()=0

vtkIdList *	GetPointIds ()

vtkPoints *	GetPoints ()

vtkIdList *	GetFaces ()

void	GetCell (vtkGenericCell *cell)

vtkIdType	GetNumberOfPoints ()

vtkIdType	GetNumberOfFaces ()

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

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)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Protected Member Functions
	vtkCellIterator ()

	~vtkCellIterator ()

virtual void	ResetToFirstCell ()=0

virtual void	IncrementToNextCell ()=0

virtual void	FetchCellType ()=0

virtual void	FetchPointIds ()=0

virtual void	FetchPoints ()=0

virtual void	FetchFaces ()

Protected Member Functions inherited from vtkObject
virtual vtkObjectBase *	NewInstanceInternal () const

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

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	CellType

vtkPoints *	Points

vtkIdList *	PointIds

vtkIdList *	Faces

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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

Detailed Description

Efficient cell iterator for vtkDataSet topologies.

vtkCellIterator provides a method for traversing cells in a data set. Call the vtkDataSet::NewCellIterator() method to use this class.

The cell is represented as a set of three pieces of information: The cell type, the ids of the points constituting the cell, and the points themselves. This iterator fetches these as needed. If only the cell type is used, the type is not looked up until GetCellType is called, and the point information is left uninitialized. This allows efficient screening of cells, since expensive point lookups may be skipped depending on the cell type/etc.

An example usage of this class:

void myWorkerFunction(vtkDataSet *ds)
{
  vtkCellIterator *it = ds->NewCellIterator();
  for (it->InitTraversal(); it->IsDoneWithTraversal(); it->GoToNextCell())
    {
    if (it->GetCellType() != VTK_TETRA)
      {
      continue; /* Skip non-tetrahedral cells */
      }
    vtkIdList *pointIds = it->GetPointIds();
    /* Do screening on the point ids, maybe figure out scalar range and skip
       cells that do not lie in a certain range? */
    vtkPoints *points = it->GetPoints();
    /* Do work using the cell points, or ... */
    vtkGenericCell *cell = ...;
    it->GetCell(cell);
    /* ... do work with a vtkCell. */
    }
  it->Delete();
}

The example above pulls in bits of information as needed to filter out cells that aren't relevent. The least expensive lookups are performed first (cell type, then point ids, then points/full cell) to prevent wasted cycles fetching unnecessary data. Also note that at the end of the loop, the iterator must be deleted as these iterators are vtkObject subclasses.

Tests:: vtkCellIterator (Tests)

Definition at line 78 of file vtkCellIterator.h.

Constructor & Destructor Documentation

vtkCellIterator::vtkCellIterator ( )

protected

vtkCellIterator::~vtkCellIterator ( )

protected

Member Function Documentation

virtual void vtkCellIterator::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 vtkMappedUnstructuredGridCellIterator< Implementation >, vtkUnstructuredGridCellIterator, vtkCPExodusIIElementBlockCellIterator, vtkPointSetCellIterator, and vtkDataSetCellIterator.

vtkCellIterator::vtkAbstractTypeMacro	(	vtkCellIterator	,
		vtkObject
	)

Reset to the first cell.

void vtkCellIterator::GoToNextCell ( )

inline

Increment to next cell. Always safe to call.

Definition at line 203 of file vtkCellIterator.h.

virtual bool vtkCellIterator::IsDoneWithTraversal ( )

pure virtual

Returns false while the iterator is valid. Always safe to call.

Implemented in vtkMappedUnstructuredGridCellIterator< Implementation >, vtkUnstructuredGridCellIterator, vtkPointSetCellIterator, and vtkDataSetCellIterator.

int vtkCellIterator::GetCellType ( )

inline

Get the current cell type (e.g. VTK_LINE, VTK_VERTEX, VTK_TETRA, etc). This should only be called when IsDoneWithTraversal() returns false.

Definition at line 210 of file vtkCellIterator.h.

virtual vtkIdType vtkCellIterator::GetCellId ( )

pure virtual

Get the id of the current cell.

Implemented in vtkMappedUnstructuredGridCellIterator< Implementation >, vtkUnstructuredGridCellIterator, vtkCPExodusIIElementBlockCellIterator, vtkPointSetCellIterator, and vtkDataSetCellIterator.

vtkIdList * vtkCellIterator::GetPointIds ( )

inline

Get the ids of the points in the current cell. This should only be called when IsDoneWithTraversal() returns false.

Definition at line 221 of file vtkCellIterator.h.

vtkPoints * vtkCellIterator::GetPoints ( )

inline

Get the points in the current cell. This is usually a very expensive call, and should be avoided when possible. This should only be called when IsDoneWithTraversal() returns false.

Definition at line 232 of file vtkCellIterator.h.

vtkIdList * vtkCellIterator::GetFaces ( )

inline

Get the faces for a polyhedral cell.

Definition at line 243 of file vtkCellIterator.h.

void vtkCellIterator::GetCell ( vtkGenericCell * cell )

Write the current full cell information into the argument. This is usually a very expensive call, and should be avoided when possible. This should only be called when IsDoneWithTraversal() returns false.

vtkIdType vtkCellIterator::GetNumberOfPoints ( )

inline

Return the number of points in the current cell. This should only be called when IsDoneWithTraversal() returns false.

Definition at line 254 of file vtkCellIterator.h.

vtkIdType vtkCellIterator::GetNumberOfFaces ( )

inline

Return the number of faces in the current polyhedral cell. This should only be called when IsDoneWithTraversal() returns false.

Definition at line 265 of file vtkCellIterator.h.

virtual void vtkCellIterator::ResetToFirstCell ( )

protectedpure virtual

Update internal state to point to the first cell.

Implemented in vtkMappedUnstructuredGridCellIterator< Implementation >, vtkUnstructuredGridCellIterator, vtkCPExodusIIElementBlockCellIterator, vtkPointSetCellIterator, and vtkDataSetCellIterator.

virtual void vtkCellIterator::IncrementToNextCell ( )

protectedpure virtual

Update internal state to point to the next cell.

Implemented in vtkMappedUnstructuredGridCellIterator< Implementation >, vtkUnstructuredGridCellIterator, vtkCPExodusIIElementBlockCellIterator, vtkPointSetCellIterator, and vtkDataSetCellIterator.

virtual void vtkCellIterator::FetchCellType ( )

protectedpure virtual

Lookup the cell type in the data set and store it in this->CellType.

Implemented in vtkMappedUnstructuredGridCellIterator< Implementation >, vtkUnstructuredGridCellIterator, vtkCPExodusIIElementBlockCellIterator, vtkPointSetCellIterator, and vtkDataSetCellIterator.

virtual void vtkCellIterator::FetchPointIds ( )

protectedpure virtual

Lookup the cell point ids in the data set and store them in this->PointIds.

Implemented in vtkMappedUnstructuredGridCellIterator< Implementation >, vtkUnstructuredGridCellIterator, vtkCPExodusIIElementBlockCellIterator, vtkPointSetCellIterator, and vtkDataSetCellIterator.

virtual void vtkCellIterator::FetchPoints ( )

protectedpure virtual

Lookup the cell points in the data set and store them in this->Points.

Implemented in vtkMappedUnstructuredGridCellIterator< Implementation >, vtkUnstructuredGridCellIterator, vtkCPExodusIIElementBlockCellIterator, vtkPointSetCellIterator, and vtkDataSetCellIterator.

virtual void vtkCellIterator::FetchFaces ( )

inlineprotectedvirtual

Lookup the cell faces in the data set and store them in this->Points. Few data sets support faces, so this method has a no-op default implementation. See vtkUnstructuredGrid::GetFaceStream for a description of the layout that Faces should have.

Reimplemented in vtkUnstructuredGridCellIterator.

Definition at line 151 of file vtkCellIterator.h.

Member Data Documentation

int vtkCellIterator::CellType

protected

Definition at line 153 of file vtkCellIterator.h.

vtkPoints* vtkCellIterator::Points

protected

Definition at line 154 of file vtkCellIterator.h.

vtkIdList* vtkCellIterator::PointIds

protected

Definition at line 155 of file vtkCellIterator.h.

vtkIdList* vtkCellIterator::Faces

protected

Definition at line 156 of file vtkCellIterator.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/DataModel/vtkCellIterator.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation