Abstract class for iterator over a vtkTree. More...

#include <vtkTreeIterator.h>

Inheritance diagram for vtkTreeIterator:

Collaboration diagram for vtkTreeIterator:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkTreeIterator *	NewInstance () const

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

void	SetTree (vtkTree *graph)
	Set/get the graph to iterate over. More...

virtual vtkTree *	GetTree ()

void	SetStartVertex (vtkIdType vertex)
	The start vertex of the traversal. More...

virtual vtkIdType	GetStartVertex ()

vtkIdType	Next ()
	The next vertex visited in the graph. More...

bool	HasNext ()
	Return true when all vertices have been visited. More...

void	Restart ()
	Reset the iterator to its start vertex. 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...

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)

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

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

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

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

static vtkTreeIterator *	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 ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

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

	vtkTreeIterator ()

	~vtkTreeIterator () override

virtual void	Initialize ()=0

virtual vtkIdType	NextInternal ()=0

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=NULL)
	These methods allow a command to exclusively grab all events. More...

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
vtkTree *	Tree

vtkIdType	StartVertex

vtkIdType	NextId

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Abstract class for iterator over a vtkTree.

The base class for tree iterators vtkTreeBFSIterator and vtkTreeDFSIterator.

After setting up the iterator, the normal mode of operation is to set up a while(iter->HasNext()) loop, with the statement vtkIdType vertex = iter->Next() inside the loop.

See also: vtkTreeBFSIterator vtkTreeDFSIterator

Definition at line 39 of file vtkTreeIterator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkTreeIterator::Superclass

Definition at line 42 of file vtkTreeIterator.h.

Constructor & Destructor Documentation

◆ vtkTreeIterator()

vtkTreeIterator::vtkTreeIterator ( )

protected

◆ ~vtkTreeIterator()

vtkTreeIterator::~vtkTreeIterator ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual int vtkTreeIterator::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 vtkObjectBase.

Reimplemented in vtkTreeDFSIterator, and vtkTreeBFSIterator.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkTreeIterator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkTreeDFSIterator, and vtkTreeBFSIterator.

◆ NewInstance()

vtkTreeIterator* vtkTreeIterator::NewInstance ( ) const

◆ PrintSelf()

void vtkTreeIterator::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 vtkObject.

◆ SetTree()

void vtkTreeIterator::SetTree ( vtkTree * graph )

Set/get the graph to iterate over.

◆ GetTree()

virtual vtkTree* vtkTreeIterator::GetTree ( )

virtual

◆ SetStartVertex()

void vtkTreeIterator::SetStartVertex ( vtkIdType vertex )

The start vertex of the traversal.

The tree iterator will only iterate over the subtree rooted at vertex. If not set (or set to a negative value), starts at the root of the tree.

◆ GetStartVertex()

virtual vtkIdType vtkTreeIterator::GetStartVertex ( )

virtual

◆ Next()

vtkIdType vtkTreeIterator::Next ( )

The next vertex visited in the graph.

◆ HasNext()

bool vtkTreeIterator::HasNext ( )

Return true when all vertices have been visited.

◆ Restart()

void vtkTreeIterator::Restart ( )

Reset the iterator to its start vertex.

◆ Initialize()

virtual void vtkTreeIterator::Initialize ( )

protectedpure virtual

Implemented in vtkTreeDFSIterator, and vtkTreeBFSIterator.

◆ NextInternal()

virtual vtkIdType vtkTreeIterator::NextInternal ( )

protectedpure virtual

Implemented in vtkTreeDFSIterator, and vtkTreeBFSIterator.

Member Data Documentation

◆ Tree

vtkTree* vtkTreeIterator::Tree

protected

Definition at line 85 of file vtkTreeIterator.h.

◆ StartVertex

vtkIdType vtkTreeIterator::StartVertex

protected

Definition at line 86 of file vtkTreeIterator.h.

◆ NextId

vtkIdType vtkTreeIterator::NextId

protected

Definition at line 87 of file vtkTreeIterator.h.

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

dox/Common/DataModel/vtkTreeIterator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkTreeIterator()

◆ ~vtkTreeIterator()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetTree()

◆ GetTree()

◆ SetStartVertex()

◆ GetStartVertex()

◆ Next()

◆ HasNext()

◆ Restart()

◆ Initialize()

◆ NextInternal()

Member Data Documentation

◆ Tree

◆ StartVertex

◆ NextId