breadth first search iterator through a vtkTree More...

#include <vtkTreeBFSIterator.h>

Inheritance diagram for vtkTreeBFSIterator:

Collaboration diagram for vtkTreeBFSIterator:

Public Types
typedef vtkTreeIterator	Superclass

Public Types inherited from vtkTreeIterator
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...

vtkTreeBFSIterator *	NewInstance () const

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

Public Member Functions inherited from vtkTreeIterator
virtual vtkTypeBool	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...

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

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

virtual vtkTree *	GetTree ()
	Set/get the graph to iterate over. More...

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

virtual vtkIdType	GetStartVertex ()
	The start vertex of the traversal. 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 vtkTreeBFSIterator *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkTreeBFSIterator *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkTreeIterator
static vtkTypeBool	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 ()
	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 Types
enum	ColorType { WHITE , GRAY , BLACK }

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkTreeBFSIterator ()

	~vtkTreeBFSIterator () override

void	Initialize () override

vtkIdType	NextInternal () override

Protected Member Functions inherited from vtkTreeIterator
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=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
vtkTreeBFSIteratorInternals *	Internals

vtkIntArray *	Color

Protected Attributes inherited from vtkTreeIterator
vtkTree *	Tree

vtkIdType	StartVertex

vtkIdType	NextId

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

breadth first search iterator through a vtkTree

vtkTreeBFSIterator performs a breadth first search traversal of a tree.

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.

Thanks:: Thanks to David Doria for submitting this class.

Online Examples:

TreeBFSIterator

Definition at line 59 of file vtkTreeBFSIterator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkTreeIterator vtkTreeBFSIterator::Superclass

Definition at line 63 of file vtkTreeBFSIterator.h.

Member Enumeration Documentation

◆ ColorType

enum vtkTreeBFSIterator::ColorType

protected

Enumerator
WHITE
GRAY
BLACK

Definition at line 76 of file vtkTreeBFSIterator.h.

Constructor & Destructor Documentation

◆ vtkTreeBFSIterator()

vtkTreeBFSIterator::vtkTreeBFSIterator ( )

protected

◆ ~vtkTreeBFSIterator()

vtkTreeBFSIterator::~vtkTreeBFSIterator ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkTreeBFSIterator * vtkTreeBFSIterator::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkTreeBFSIterator::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 vtkTreeIterator.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkTreeBFSIterator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkTreeIterator.

◆ NewInstance()

vtkTreeBFSIterator * vtkTreeBFSIterator::NewInstance ( ) const

◆ PrintSelf()

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

◆ Initialize()

void vtkTreeBFSIterator::Initialize ( )

overrideprotectedvirtual

Implements vtkTreeIterator.

◆ NextInternal()

vtkIdType vtkTreeBFSIterator::NextInternal ( )

overrideprotectedvirtual

Implements vtkTreeIterator.

Member Data Documentation

◆ Internals

vtkTreeBFSIteratorInternals* vtkTreeBFSIterator::Internals

protected

Definition at line 73 of file vtkTreeBFSIterator.h.

◆ Color

vtkIntArray* vtkTreeBFSIterator::Color

protected

Definition at line 74 of file vtkTreeBFSIterator.h.

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

Common/DataModel/vtkTreeBFSIterator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ ColorType

Constructor & Destructor Documentation

◆ vtkTreeBFSIterator()

◆ ~vtkTreeBFSIterator()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Initialize()

◆ NextInternal()

Member Data Documentation

◆ Internals

◆ Color