VTK: vtkGenericCellIterator Class Reference

VTK

iterator used to traverse cells More...

#include <vtkGenericCellIterator.h>

Inheritance diagram for vtkGenericCellIterator:

Inheritance graph

Collaboration diagram for vtkGenericCellIterator:

Collaboration graph

List of all members.

Public Member Functions
virtual void	Begin ()=0
virtual int	IsAtEnd ()=0
virtual vtkGenericAdaptorCell *	NewCell ()=0
virtual void	GetCell (vtkGenericAdaptorCell *c)=0
virtual vtkGenericAdaptorCell *	GetCell ()=0
virtual void	Next ()=0
Protected Member Functions
	vtkGenericCellIterator ()
virtual	~vtkGenericCellIterator ()
typedef vtkObject	Superclass
static int	IsTypeOf (const char *type)
static vtkGenericCellIterator *	SafeDownCast (vtkObjectBase *o)
virtual int	IsA (const char *type)
vtkGenericCellIterator *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkObjectBase *	NewInstanceInternal () const

Detailed Description

iterator used to traverse cells

This class (and subclasses) are used to iterate over cells. Use it only in conjunction with vtkGenericDataSet (i.e., the adaptor framework).

Typical use is:

 vtkGenericDataSet *dataset;
 vtkGenericCellIterator *it = dataset->NewCellIterator(2);
 for (it->Begin(); !it->IsAtEnd(); it->Next());
   {
   spec=it->GetCell();
   }

Tests:: vtkGenericCellIterator (Tests)

Definition at line 43 of file vtkGenericCellIterator.h.

Member Typedef Documentation

typedef vtkObject vtkGenericCellIterator::Superclass

Standard VTK construction and type macros.

Reimplemented from vtkObject.

Reimplemented in vtkBridgeCellIterator, vtkBridgeCellIteratorStrategy, vtkBridgeCellIteratorOnCellBoundaries, vtkBridgeCellIteratorOne, vtkBridgeCellIteratorOnCellList, and vtkBridgeCellIteratorOnDataSet.

Definition at line 48 of file vtkGenericCellIterator.h.

Constructor & Destructor Documentation

vtkGenericCellIterator::vtkGenericCellIterator ( ) [protected]

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

Member Function Documentation

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

Standard VTK construction and type macros.

Reimplemented from vtkObject.

Reimplemented in vtkBridgeCellIterator, vtkBridgeCellIteratorStrategy, vtkBridgeCellIteratorOnCellBoundaries, vtkBridgeCellIteratorOne, vtkBridgeCellIteratorOnCellList, and vtkBridgeCellIteratorOnDataSet.

virtual int vtkGenericCellIterator::IsA ( const char * type ) [virtual]

Standard VTK construction and type macros.

Reimplemented from vtkObject.

Reimplemented in vtkBridgeCellIterator, vtkBridgeCellIteratorStrategy, vtkBridgeCellIteratorOnCellBoundaries, vtkBridgeCellIteratorOne, vtkBridgeCellIteratorOnCellList, and vtkBridgeCellIteratorOnDataSet.

static vtkGenericCellIterator* vtkGenericCellIterator::SafeDownCast ( vtkObjectBase * o ) [static]

Standard VTK construction and type macros.

Reimplemented from vtkObject.

Reimplemented in vtkBridgeCellIterator, vtkBridgeCellIteratorStrategy, vtkBridgeCellIteratorOnCellBoundaries, vtkBridgeCellIteratorOne, vtkBridgeCellIteratorOnCellList, and vtkBridgeCellIteratorOnDataSet.

virtual vtkObjectBase* vtkGenericCellIterator::NewInstanceInternal ( ) const [protected, virtual]

Standard VTK construction and type macros.

Reimplemented from vtkObject.

Reimplemented in vtkBridgeCellIterator, vtkBridgeCellIteratorStrategy, vtkBridgeCellIteratorOnCellBoundaries, vtkBridgeCellIteratorOne, vtkBridgeCellIteratorOnCellList, and vtkBridgeCellIteratorOnDataSet.

vtkGenericCellIterator* vtkGenericCellIterator::NewInstance ( ) const

Standard VTK construction and type macros.

Reimplemented from vtkObject.

Reimplemented in vtkBridgeCellIterator, vtkBridgeCellIteratorStrategy, vtkBridgeCellIteratorOnCellBoundaries, vtkBridgeCellIteratorOne, vtkBridgeCellIteratorOnCellList, and vtkBridgeCellIteratorOnDataSet.

void vtkGenericCellIterator::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Standard VTK construction and type macros.

Reimplemented from vtkObject.

Reimplemented in vtkBridgeCellIterator, vtkBridgeCellIteratorStrategy, vtkBridgeCellIteratorOnCellBoundaries, vtkBridgeCellIteratorOne, vtkBridgeCellIteratorOnCellList, and vtkBridgeCellIteratorOnDataSet.

virtual void vtkGenericCellIterator::Begin ( ) [pure virtual]

Move iterator to first position if any (loop initialization).

Implemented in vtkBridgeCellIterator, vtkBridgeCellIteratorOnCellBoundaries, vtkBridgeCellIteratorOne, vtkBridgeCellIteratorOnCellList, and vtkBridgeCellIteratorOnDataSet.

virtual int vtkGenericCellIterator::IsAtEnd ( ) [pure virtual]

Is the iterator at the end of traversal?

Implemented in vtkBridgeCellIterator, vtkBridgeCellIteratorOnCellBoundaries, vtkBridgeCellIteratorOne, vtkBridgeCellIteratorOnCellList, and vtkBridgeCellIteratorOnDataSet.

virtual vtkGenericAdaptorCell* vtkGenericCellIterator::NewCell ( ) [pure virtual]

Create an empty cell. The user is responsible for deleting it.

Postcondition:: result_exists: result!=0

Implemented in vtkBridgeCellIterator, and vtkBridgeCellIteratorStrategy.

virtual void vtkGenericCellIterator::GetCell ( vtkGenericAdaptorCell * c ) [pure virtual]

Get the cell at current position. The cell should be instantiated with the NewCell() method.

Precondition:: not_at_end: !IsAtEnd(); c_exists: c!=0 THREAD SAFE

Implemented in vtkBridgeCellIterator, vtkBridgeCellIteratorOnCellBoundaries, vtkBridgeCellIteratorOne, vtkBridgeCellIteratorOnCellList, and vtkBridgeCellIteratorOnDataSet.

virtual vtkGenericAdaptorCell* vtkGenericCellIterator::GetCell ( ) [pure virtual]

Get the cell at the current traversal position. NOT THREAD SAFE

Precondition:: not_at_end: !IsAtEnd()

Postcondition:: result_exits: result!=0

Implemented in vtkBridgeCellIterator, vtkBridgeCellIteratorOnCellBoundaries, vtkBridgeCellIteratorOne, vtkBridgeCellIteratorOnCellList, and vtkBridgeCellIteratorOnDataSet.

virtual void vtkGenericCellIterator::Next ( ) [pure virtual]

Move the iterator to the next position in the list.

Precondition:: not_at_end: !IsAtEnd()

Implemented in vtkBridgeCellIterator, vtkBridgeCellIteratorOnCellBoundaries, vtkBridgeCellIteratorOne, vtkBridgeCellIteratorOnCellList, and vtkBridgeCellIteratorOnDataSet.

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

dox/Common/DataModel/vtkGenericCellIterator.h