vtkArrayCoordinateIterator Class Reference

#include <vtkArrayCoordinateIterator.h>

Inheritance diagram for vtkArrayCoordinateIterator:

[legend]

Collaboration diagram for vtkArrayCoordinateIterator:

[legend]

List of all members.

---

Detailed Description

Iterates over array coordinates.

vtkArrayCoordinateIterator iterates over every unique set of coordinates that are defined by a set of vtkArrayExtents. The order in which coordinates are visited is undefined.

Note that vtkArrayCoordinateIterator visits every permutation of coordinates defined by a set of array extents, *not* the array itself - if you are working with a sparse array, any of the coordinates that are visited by the iterator could be NULL within the array.

vtkArrayCoordinateIterator is mainly useful if you are writing a source that generates arbitrary-dimension arrays from scratch. Algorithms that process existing arrays can almost always be written more efficiently using vtkArray::GetCoordinatesN() and vtkTypedArray::GetValueN(), which only visit non-NULL values within an array.

See also:

vtkArray, vtkArrayExtents, vtkArrayCoordinates

Thanks:

Developed by Timothy M. Shead (tshead@sandia.gov) at Sandia National Laboratories.

Definition at line 55 of file vtkArrayCoordinateIterator.h.

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetExtents (const vtkArrayExtents &)
bool	HasNext ()
vtkArrayCoordinates	Next ()
Static Public Member Functions
static vtkArrayCoordinateIterator *	New ()
static int	IsTypeOf (const char *type)
static vtkArrayCoordinateIterator *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkArrayCoordinateIterator ()
	~vtkArrayCoordinateIterator ()

---

Member Typedef Documentation

typedef vtkObject vtkArrayCoordinateIterator::Superclass

Reimplemented from vtkObject.

Definition at line 59 of file vtkArrayCoordinateIterator.h.

---

Constructor & Destructor Documentation

vtkArrayCoordinateIterator::vtkArrayCoordinateIterator

(

)

[protected]

vtkArrayCoordinateIterator::~vtkArrayCoordinateIterator

(

)

[protected]

---

Member Function Documentation

static vtkArrayCoordinateIterator* vtkArrayCoordinateIterator::New

(

)

[static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkArrayCoordinateIterator::GetClassName

(

)

[virtual]

Reimplemented from vtkObject.

static int vtkArrayCoordinateIterator::IsTypeOf

(

const char *

name

)

[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.

virtual int vtkArrayCoordinateIterator::IsA

(

const char *

name

)

[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.

static vtkArrayCoordinateIterator* vtkArrayCoordinateIterator::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkObject.

void vtkArrayCoordinateIterator::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.

void vtkArrayCoordinateIterator::SetExtents

(

const vtkArrayExtents &

)

Sets the array extents to iterate over, and resets the iterator to the beginning of the range of unique coordinates.

bool vtkArrayCoordinateIterator::HasNext

(

)

Returns true iff the iterator has not reached the end of the range of unique coordinates.

vtkArrayCoordinates vtkArrayCoordinateIterator::Next

(

)

Returns the next set of coordinates and advances the iterator.

---

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

• dox/Common/vtkArrayCoordinateIterator.h