VTK: vtkGenericPointIterator Class Reference

VTK

iterator used to traverse points More...

#include <vtkGenericPointIterator.h>

Inheritance diagram for vtkGenericPointIterator:

Inheritance graph

Collaboration diagram for vtkGenericPointIterator:

Collaboration graph

List of all members.

Public Member Functions
virtual void	Begin ()=0
virtual int	IsAtEnd ()=0
virtual void	Next ()=0
virtual double *	GetPosition ()=0
virtual void	GetPosition (double x[3])=0
virtual vtkIdType	GetId ()=0
Protected Member Functions

	vtkGenericPointIterator ()
virtual	~vtkGenericPointIterator ()
typedef vtkObject	Superclass
static int	IsTypeOf (const char *type)
static vtkGenericPointIterator *	SafeDownCast (vtkObjectBase *o)
virtual int	IsA (const char *type)
vtkGenericPointIterator *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkObjectBase *	NewInstanceInternal () const

Detailed Description

iterator used to traverse points

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

Typical use is:

 vtkGenericDataSet *dataset;
 vtkGenericPointIterator *it = dataset->NewPointIterator();
 for (it->Begin(); !it->IsAtEnd(); it->Next());
   {
   x=it->GetPosition();
   }

Tests:: vtkGenericPointIterator (Tests)

Definition at line 41 of file vtkGenericPointIterator.h.

Member Typedef Documentation

typedef vtkObject vtkGenericPointIterator::Superclass

Standard VTK construction and type macros.

Reimplemented from vtkObject.

Reimplemented in vtkBridgePointIterator, vtkBridgePointIteratorOnCell, vtkBridgePointIteratorOnDataSet, and vtkBridgePointIteratorOne.

Definition at line 46 of file vtkGenericPointIterator.h.

Constructor & Destructor Documentation

vtkGenericPointIterator::vtkGenericPointIterator ( ) [protected]

Destructor.

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

Destructor.

Member Function Documentation

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

Standard VTK construction and type macros.

Reimplemented from vtkObject.

Reimplemented in vtkBridgePointIterator, vtkBridgePointIteratorOnCell, vtkBridgePointIteratorOnDataSet, and vtkBridgePointIteratorOne.

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

Standard VTK construction and type macros.

Reimplemented from vtkObject.

Reimplemented in vtkBridgePointIterator, vtkBridgePointIteratorOnCell, vtkBridgePointIteratorOnDataSet, and vtkBridgePointIteratorOne.

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

Standard VTK construction and type macros.

Reimplemented from vtkObject.

Reimplemented in vtkBridgePointIterator, vtkBridgePointIteratorOnCell, vtkBridgePointIteratorOnDataSet, and vtkBridgePointIteratorOne.

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

Standard VTK construction and type macros.

Reimplemented from vtkObject.

Reimplemented in vtkBridgePointIterator, vtkBridgePointIteratorOnCell, vtkBridgePointIteratorOnDataSet, and vtkBridgePointIteratorOne.

vtkGenericPointIterator* vtkGenericPointIterator::NewInstance ( ) const

Standard VTK construction and type macros.

Reimplemented from vtkObject.

Reimplemented in vtkBridgePointIterator, vtkBridgePointIteratorOnCell, vtkBridgePointIteratorOnDataSet, and vtkBridgePointIteratorOne.

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

Standard VTK construction and type macros.

Reimplemented from vtkObject.

Reimplemented in vtkBridgePointIterator, vtkBridgePointIteratorOnCell, vtkBridgePointIteratorOnDataSet, and vtkBridgePointIteratorOne.

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

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

Implemented in vtkBridgePointIterator, vtkBridgePointIteratorOnCell, vtkBridgePointIteratorOnDataSet, and vtkBridgePointIteratorOne.

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

Is the iterator at the end of traversal?

Implemented in vtkBridgePointIterator, vtkBridgePointIteratorOnCell, vtkBridgePointIteratorOnDataSet, and vtkBridgePointIteratorOne.

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

Move the iterator to the next position in the list.

Precondition:: not_off: !IsAtEnd()

Implemented in vtkBridgePointIterator, vtkBridgePointIteratorOnCell, vtkBridgePointIteratorOnDataSet, and vtkBridgePointIteratorOne.

virtual double* vtkGenericPointIterator::GetPosition ( ) [pure virtual]

Get the coordinates of the point at the current iterator position.

Precondition:: not_off: !IsAtEnd()

Postcondition:: result_exists: result!=0

Implemented in vtkBridgePointIterator, vtkBridgePointIteratorOnCell, vtkBridgePointIteratorOnDataSet, and vtkBridgePointIteratorOne.

virtual void vtkGenericPointIterator::GetPosition ( double x[3] ) [pure virtual]

Get the coordinates of the point at the current iterator position.

Precondition:: not_off: !IsAtEnd(); x_exists: x!=0

Implemented in vtkBridgePointIterator, vtkBridgePointIteratorOnCell, vtkBridgePointIteratorOnDataSet, and vtkBridgePointIteratorOne.

virtual vtkIdType vtkGenericPointIterator::GetId ( ) [pure virtual]

Return the unique identifier for the point, could be non-contiguous.

Precondition:: not_off: !IsAtEnd()

Implemented in vtkBridgePointIterator, vtkBridgePointIteratorOnCell, vtkBridgePointIteratorOnDataSet, and vtkBridgePointIteratorOne.

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

dox/Common/DataModel/vtkGenericPointIterator.h