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 Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkDataObjectTreeIterator *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	GoToFirstItem () override
	Move the iterator to the beginning of the collection. More...

void	GoToNextItem () override
	Move the iterator to the next item in the collection. More...

int	IsDoneWithTraversal () override
	Test whether the iterator is finished with the traversal. More...

vtkDataObject *	GetCurrentDataObject () override
	Returns the current item. More...

vtkInformation *	GetCurrentMetaData () override
	Returns the meta-data associated with the current item. More...

int	HasCurrentMetaData () override
	Returns if the a meta-data information object is present for the current item. More...

unsigned int	GetCurrentFlatIndex () override
	Flat index is an index obtained by traversing the tree in preorder. More...


virtual void	SetVisitOnlyLeaves (vtkTypeBool)
	If VisitOnlyLeaves is true, the iterator will only visit nodes (sub-datasets) that are not composite. More...

virtual vtkTypeBool	GetVisitOnlyLeaves ()
	If VisitOnlyLeaves is true, the iterator will only visit nodes (sub-datasets) that are not composite. More...

virtual void	VisitOnlyLeavesOn ()
	If VisitOnlyLeaves is true, the iterator will only visit nodes (sub-datasets) that are not composite. More...

virtual void	VisitOnlyLeavesOff ()
	If VisitOnlyLeaves is true, the iterator will only visit nodes (sub-datasets) that are not composite. More...


virtual void	SetTraverseSubTree (vtkTypeBool)
	If TraverseSubTree is set to true, the iterator will visit the entire tree structure, otherwise it only visits the first level children. More...

virtual vtkTypeBool	GetTraverseSubTree ()
	If TraverseSubTree is set to true, the iterator will visit the entire tree structure, otherwise it only visits the first level children. More...

virtual void	TraverseSubTreeOn ()
	If TraverseSubTree is set to true, the iterator will visit the entire tree structure, otherwise it only visits the first level children. More...

virtual void	TraverseSubTreeOff ()
	If TraverseSubTree is set to true, the iterator will visit the entire tree structure, otherwise it only visits the first level children. More...

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

virtual void	InitTraversal ()
	Begin iterating over the composite dataset structure. More...

virtual void	InitReverseTraversal ()
	Begin iterating over the composite dataset structure in reverse order. More...

virtual void	SetDataSet (vtkCompositeDataSet *ds)
	Set the composite dataset this iterator is iterating over. More...

virtual vtkCompositeDataSet *	GetDataSet ()
	Set the composite dataset this iterator is iterating over. More...

virtual void	SetSkipEmptyNodes (vtkTypeBool)
	If SkipEmptyNodes is true, then nullptr datasets will be skipped. More...

virtual vtkTypeBool	GetSkipEmptyNodes ()
	If SkipEmptyNodes is true, then nullptr datasets will be skipped. More...

virtual void	SkipEmptyNodesOn ()
	If SkipEmptyNodes is true, then nullptr datasets will be skipped. More...

virtual void	SkipEmptyNodesOff ()
	If SkipEmptyNodes is true, then nullptr datasets will be skipped. More...

virtual int	GetReverse ()
	Returns if the iteration is in reverse order. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkDataObjectTreeIterator *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataObjectTreeIterator *	SafeDownCast (vtkObjectBase *o)

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

static vtkCompositeDataIterator *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDataObjectTreeIterator ()

	~vtkDataObjectTreeIterator () override

void	NextInternal ()

vtkDataObjectTreeIndex	GetCurrentIndex ()
	Returns the index for the current data object. More...

Protected Member Functions inherited from vtkCompositeDataIterator
	vtkCompositeDataIterator ()

	~vtkCompositeDataIterator () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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

Definition at line 39 of file vtkDataObjectTreeIterator.h.

Member Typedef Documentation

typedef vtkCompositeDataIterator vtkDataObjectTreeIterator::Superclass

Definition at line 43 of file vtkDataObjectTreeIterator.h.

Constructor & Destructor Documentation

vtkDataObjectTreeIterator::vtkDataObjectTreeIterator ( )

protected

vtkDataObjectTreeIterator::~vtkDataObjectTreeIterator ( )

overrideprotected

Member Function Documentation

static vtkDataObjectTreeIterator* vtkDataObjectTreeIterator::New ( )

static

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

static

virtual vtkTypeBool 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
	)

overridevirtual

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.

void vtkDataObjectTreeIterator::GoToFirstItem ( )

overridevirtual

Move the iterator to the beginning of the collection.

Implements vtkCompositeDataIterator.

void vtkDataObjectTreeIterator::GoToNextItem ( )

overridevirtual

Move the iterator to the next item in the collection.

Implements vtkCompositeDataIterator.

int vtkDataObjectTreeIterator::IsDoneWithTraversal ( )

overridevirtual

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.

vtkDataObject* vtkDataObjectTreeIterator::GetCurrentDataObject ( )

overridevirtual

Returns the current item.

Valid only when IsDoneWithTraversal() returns 0.

Implements vtkCompositeDataIterator.

vtkInformation* vtkDataObjectTreeIterator::GetCurrentMetaData ( )

overridevirtual

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.

int vtkDataObjectTreeIterator::HasCurrentMetaData ( )

overridevirtual

Returns if the a meta-data information object is present for the current item.

Return 1 on success, 0 otherwise.

Implements vtkCompositeDataIterator.

unsigned int vtkDataObjectTreeIterator::GetCurrentFlatIndex ( )

overridevirtual

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

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

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

Friends And Related Function Documentation

friend class vtkDataObjectTree

friend

Definition at line 135 of file vtkDataObjectTreeIterator.h.

friend class vtkMultiDataSetInternal

friend

Definition at line 136 of file vtkDataObjectTreeIterator.h.

friend class vtkInternals

friend

Definition at line 146 of file vtkDataObjectTreeIterator.h.

Member Data Documentation

unsigned int vtkDataObjectTreeIterator::CurrentFlatIndex

protected

Definition at line 138 of file vtkDataObjectTreeIterator.h.

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

/home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Common/DataModel/vtkDataObjectTreeIterator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation