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 ()
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 Attributes
int	CellType
vtkPoints *	Points
vtkIdList *	PointIds
vtkIdList *	Faces

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 <em>ds) { vtkCellIterator *it = ds->NewCellIterator(); for (it->InitTraversal(); it->IsDoneWithTraversal(); it->GoToNextCell()) { if (it->GetCellType() != VTK_TETRA) { continue; / Skip non-tetrahedral cells

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 ( ) [protected, pure virtual]

Update internal state to point to the first cell.

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

virtual void vtkCellIterator::IncrementToNextCell ( ) [protected, pure virtual]

Update internal state to point to the next cell.

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

virtual void vtkCellIterator::FetchCellType ( ) [protected, pure 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 ( ) [protected, pure 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 ( ) [protected, pure 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 ( ) [inline, protected, virtual]

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.