superclass for composite data iterators More...

#include <vtkDataObjectTreeIterator.h>

Inheritance diagram for vtkDataObjectTreeIterator:

Collaboration diagram for vtkDataObjectTreeIterator:

Public Types
typedef vtkCompositeDataIterator	Superclass

Public Types inherited from vtkCompositeDataIterator
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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

vtkDataObjectTreeIterator *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	GoToFirstItem ()

virtual void	GoToNextItem ()

virtual int	IsDoneWithTraversal ()

virtual vtkDataObject *	GetCurrentDataObject ()

virtual vtkInformation *	GetCurrentMetaData ()

virtual int	HasCurrentMetaData ()

virtual unsigned int	GetCurrentFlatIndex ()


virtual void	SetVisitOnlyLeaves (int)

virtual int	GetVisitOnlyLeaves ()

virtual void	VisitOnlyLeavesOn ()

virtual void	VisitOnlyLeavesOff ()


virtual void	SetTraverseSubTree (int)

virtual int	GetTraverseSubTree ()

virtual void	TraverseSubTreeOn ()

virtual void	TraverseSubTreeOff ()

Public Member Functions inherited from vtkCompositeDataIterator
vtkCompositeDataIterator *	NewInstance () const

virtual void	InitTraversal ()

virtual void	InitReverseTraversal ()

virtual void	SetDataSet (vtkCompositeDataSet *ds)

virtual vtkCompositeDataSet *	GetDataSet ()

virtual void	SetSkipEmptyNodes (int)

virtual int	GetSkipEmptyNodes ()

virtual void	SkipEmptyNodesOn ()

virtual void	SkipEmptyNodesOff ()

virtual int	GetReverse ()

Public Member Functions inherited from vtkObject
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 ()

Static Public Member Functions
static vtkDataObjectTreeIterator *	New ()

static int	IsTypeOf (const char *type)

static vtkDataObjectTreeIterator *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkCompositeDataIterator
static int	IsTypeOf (const char *type)

static vtkCompositeDataIterator *	SafeDownCast (vtkObjectBase *o)

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

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDataObjectTreeIterator ()

virtual	~vtkDataObjectTreeIterator ()

void	NextInternal ()

vtkDataObjectTreeIndex	GetCurrentIndex ()

Protected Member Functions inherited from vtkCompositeDataIterator
	vtkCompositeDataIterator ()

virtual	~vtkCompositeDataIterator ()

Protected Member Functions inherited from vtkObject
	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
unsigned int	CurrentFlatIndex

Protected Attributes inherited from vtkCompositeDataIterator
int	SkipEmptyNodes

int	Reverse

vtkCompositeDataSet *	DataSet

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkDataObjectTree

class	vtkMultiDataSetInternal

class	vtkInternals

Detailed Description

superclass for composite data iterators

vtkDataObjectTreeIterator provides an interface for accessing datasets in a collection (vtkDataObjectTreeIterator).

Examples:: vtkDataObjectTreeIterator (Examples)

Tests:: vtkDataObjectTreeIterator (Tests)

Definition at line 41 of file vtkDataObjectTreeIterator.h.

Member Typedef Documentation

typedef vtkCompositeDataIterator vtkDataObjectTreeIterator::Superclass

Definition at line 45 of file vtkDataObjectTreeIterator.h.

Constructor & Destructor Documentation

vtkDataObjectTreeIterator::vtkDataObjectTreeIterator ( )

protected

virtual vtkDataObjectTreeIterator::~vtkDataObjectTreeIterator ( )

protectedvirtual

Member Function Documentation

static vtkDataObjectTreeIterator* vtkDataObjectTreeIterator::New ( )

static

static int vtkDataObjectTreeIterator::IsTypeOf ( const char * type )

static

virtual int vtkDataObjectTreeIterator::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkCompositeDataIterator.

static vtkDataObjectTreeIterator* vtkDataObjectTreeIterator::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkDataObjectTreeIterator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCompositeDataIterator.

vtkDataObjectTreeIterator* vtkDataObjectTreeIterator::NewInstance ( ) const

void vtkDataObjectTreeIterator::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 vtkCompositeDataIterator.

virtual void vtkDataObjectTreeIterator::GoToFirstItem ( )

virtual

Move the iterator to the beginning of the collection.

Implements vtkCompositeDataIterator.

virtual void vtkDataObjectTreeIterator::GoToNextItem ( )

virtual

Move the iterator to the next item in the collection.

Implements vtkCompositeDataIterator.

virtual int vtkDataObjectTreeIterator::IsDoneWithTraversal ( )

virtual

Test whether the iterator is finished with the traversal. Returns 1 for yes, and 0 for no. It is safe to call any of the GetCurrent...() methods only when IsDoneWithTraversal() returns 0.

Implements vtkCompositeDataIterator.

virtual vtkDataObject* vtkDataObjectTreeIterator::GetCurrentDataObject ( )

virtual

Returns the current item. Valid only when IsDoneWithTraversal() returns 0.

Implements vtkCompositeDataIterator.

virtual vtkInformation* vtkDataObjectTreeIterator::GetCurrentMetaData ( )

virtual

Returns the meta-data associated with the current item. Note that, depending on iterator implementation, the returned information is not necessarily stored on the current object. So modifying the information is forbidden.

Implements vtkCompositeDataIterator.

virtual int vtkDataObjectTreeIterator::HasCurrentMetaData ( )

virtual

Returns if the a meta-data information object is present for the current item. Return 1 on success, 0 otherwise.

Implements vtkCompositeDataIterator.

virtual unsigned int vtkDataObjectTreeIterator::GetCurrentFlatIndex ( )

virtual

Flat index is an index obtained by traversing the tree in preorder. This can be used to uniquely identify nodes in the tree. Not valid if IsDoneWithTraversal() returns true.

Implements vtkCompositeDataIterator.

virtual void vtkDataObjectTreeIterator::SetVisitOnlyLeaves ( int )

virtual

If VisitOnlyLeaves is true, the iterator will only visit nodes (sub-datasets) that are not composite. If it encounters a composite data set, it will automatically traverse that composite dataset until it finds non-composite datasets. With this options, it is possible to visit all non-composite datasets in tree of composite datasets (composite of composite of composite for example :-) ) If VisitOnlyLeaves is false, GetCurrentDataObject() may return vtkCompositeDataSet. By default, VisitOnlyLeaves is 1.

virtual int vtkDataObjectTreeIterator::GetVisitOnlyLeaves ( )

virtual

If VisitOnlyLeaves is true, the iterator will only visit nodes (sub-datasets) that are not composite. If it encounters a composite data set, it will automatically traverse that composite dataset until it finds non-composite datasets. With this options, it is possible to visit all non-composite datasets in tree of composite datasets (composite of composite of composite for example :-) ) If VisitOnlyLeaves is false, GetCurrentDataObject() may return vtkCompositeDataSet. By default, VisitOnlyLeaves is 1.

virtual void vtkDataObjectTreeIterator::VisitOnlyLeavesOn ( )

virtual

If VisitOnlyLeaves is true, the iterator will only visit nodes (sub-datasets) that are not composite. If it encounters a composite data set, it will automatically traverse that composite dataset until it finds non-composite datasets. With this options, it is possible to visit all non-composite datasets in tree of composite datasets (composite of composite of composite for example :-) ) If VisitOnlyLeaves is false, GetCurrentDataObject() may return vtkCompositeDataSet. By default, VisitOnlyLeaves is 1.

virtual void vtkDataObjectTreeIterator::VisitOnlyLeavesOff ( )

virtual

If VisitOnlyLeaves is true, the iterator will only visit nodes (sub-datasets) that are not composite. If it encounters a composite data set, it will automatically traverse that composite dataset until it finds non-composite datasets. With this options, it is possible to visit all non-composite datasets in tree of composite datasets (composite of composite of composite for example :-) ) If VisitOnlyLeaves is false, GetCurrentDataObject() may return vtkCompositeDataSet. By default, VisitOnlyLeaves is 1.

virtual void vtkDataObjectTreeIterator::SetTraverseSubTree ( int )

virtual

If TraverseSubTree is set to true, the iterator will visit the entire tree structure, otherwise it only visits the first level children. Set to 1 by default.

virtual int vtkDataObjectTreeIterator::GetTraverseSubTree ( )

virtual

If TraverseSubTree is set to true, the iterator will visit the entire tree structure, otherwise it only visits the first level children. Set to 1 by default.

virtual void vtkDataObjectTreeIterator::TraverseSubTreeOn ( )

virtual

If TraverseSubTree is set to true, the iterator will visit the entire tree structure, otherwise it only visits the first level children. Set to 1 by default.

virtual void vtkDataObjectTreeIterator::TraverseSubTreeOff ( )

virtual

If TraverseSubTree is set to true, the iterator will visit the entire tree structure, otherwise it only visits the first level children. Set to 1 by default.

void vtkDataObjectTreeIterator::NextInternal ( )

protected

vtkDataObjectTreeIndex vtkDataObjectTreeIterator::GetCurrentIndex ( )

protected

Returns the index for the current data object.