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

vtkCompositeDataIterator *	NewInstance () const

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

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	GoToFirstItem ()=0
	Move the iterator to the beginning of the collection. More...

virtual void	GoToNextItem ()=0
	Move the iterator to the next item in the collection. More...

virtual int	IsDoneWithTraversal ()=0
	Test whether the iterator is finished with the traversal. More...

virtual vtkDataObject *	GetCurrentDataObject ()=0
	Returns the current item. More...

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

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

virtual unsigned int	GetCurrentFlatIndex ()=0
	Flat index is an index to identify the data in a composite data structure. 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	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. 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 vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. 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 vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

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

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDataObjectTreeIterator ()

	~vtkDataObjectTreeIterator () override

virtual void	SetCurrentFlatIndex (unsigned int)

void	NextInternal ()

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

Protected Member Functions inherited from vtkCompositeDataIterator
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCompositeDataIterator ()

	~vtkCompositeDataIterator () override

virtual void	SetReverse (int)

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	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

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
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkDataObjectTree

class	vtkMultiDataSetInternal

class	vtkInternals

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

superclass for composite data iterators

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

Online Examples:

ImportPolyDataScene

Definition at line 55 of file vtkDataObjectTreeIterator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkCompositeDataIterator vtkDataObjectTreeIterator::Superclass

Definition at line 59 of file vtkDataObjectTreeIterator.h.

Constructor & Destructor Documentation

◆ vtkDataObjectTreeIterator()

vtkDataObjectTreeIterator::vtkDataObjectTreeIterator ( )

protected

◆ ~vtkDataObjectTreeIterator()

vtkDataObjectTreeIterator::~vtkDataObjectTreeIterator ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkDataObjectTreeIterator * vtkDataObjectTreeIterator::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDataObjectTreeIterator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCompositeDataIterator.

◆ NewInstance()

vtkDataObjectTreeIterator * vtkDataObjectTreeIterator::NewInstance ( ) const

◆ PrintSelf()

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.

◆ GoToFirstItem()

void vtkDataObjectTreeIterator::GoToFirstItem ( )

overridevirtual

Move the iterator to the beginning of the collection.

Implements vtkCompositeDataIterator.

◆ GoToNextItem()

void vtkDataObjectTreeIterator::GoToNextItem ( )

overridevirtual

Move the iterator to the next item in the collection.

Implements vtkCompositeDataIterator.

◆ IsDoneWithTraversal()

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.

◆ GetCurrentDataObject()

vtkDataObject * vtkDataObjectTreeIterator::GetCurrentDataObject ( )

overridevirtual

Returns the current item.

Valid only when IsDoneWithTraversal() returns 0.

Implements vtkCompositeDataIterator.

◆ GetCurrentMetaData()

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.

◆ HasCurrentMetaData()

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.

◆ GetCurrentFlatIndex()

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.

◆ SetVisitOnlyLeaves()

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.

◆ GetVisitOnlyLeaves()

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.

◆ VisitOnlyLeavesOn()

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.

◆ VisitOnlyLeavesOff()

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.

◆ SetTraverseSubTree()

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.

◆ GetTraverseSubTree()

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.

◆ TraverseSubTreeOn()

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.

◆ TraverseSubTreeOff()

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.

◆ SetCurrentFlatIndex()

virtual void vtkDataObjectTreeIterator::SetCurrentFlatIndex ( unsigned int )

protectedvirtual

◆ NextInternal()

void vtkDataObjectTreeIterator::NextInternal ( )

protected

◆ GetCurrentIndex()

vtkDataObjectTreeIndex vtkDataObjectTreeIterator::GetCurrentIndex ( )

protected

Returns the index for the current data object.

Friends And Related Function Documentation

◆ vtkDataObjectTree

friend class vtkDataObjectTree

friend

Definition at line 154 of file vtkDataObjectTreeIterator.h.

◆ vtkMultiDataSetInternal

friend class vtkMultiDataSetInternal

friend

Definition at line 155 of file vtkDataObjectTreeIterator.h.

◆ vtkInternals

friend class vtkInternals

friend

Definition at line 165 of file vtkDataObjectTreeIterator.h.

Member Data Documentation

◆ CurrentFlatIndex

unsigned int vtkDataObjectTreeIterator::CurrentFlatIndex

protected

Definition at line 157 of file vtkDataObjectTreeIterator.h.

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

Common/DataModel/vtkDataObjectTreeIterator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkDataObjectTreeIterator()

◆ ~vtkDataObjectTreeIterator()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GoToFirstItem()

◆ GoToNextItem()

◆ IsDoneWithTraversal()

◆ GetCurrentDataObject()

◆ GetCurrentMetaData()

◆ HasCurrentMetaData()

◆ GetCurrentFlatIndex()

◆ SetVisitOnlyLeaves()

◆ GetVisitOnlyLeaves()

◆ VisitOnlyLeavesOn()

◆ VisitOnlyLeavesOff()

◆ SetTraverseSubTree()

◆ GetTraverseSubTree()

◆ TraverseSubTreeOn()

◆ TraverseSubTreeOff()

◆ SetCurrentFlatIndex()

◆ NextInternal()

◆ GetCurrentIndex()

Friends And Related Function Documentation

◆ vtkDataObjectTree

◆ vtkMultiDataSetInternal

◆ vtkInternals

Member Data Documentation

◆ CurrentFlatIndex