Kitware.VTK.vtkTreeBFSIterator Class Reference

vtkTreeBFSIterator - breadth first search iterator through a vtkTree More...

Inheritance diagram for Kitware.VTK.vtkTreeBFSIterator:

Collaboration diagram for Kitware.VTK.vtkTreeBFSIterator:

List of all members.

Public Types
enum	ModeType { DISCOVER = 0, FINISH = 1 }
	Undocumented Block. More...
Public Member Functions
	vtkTreeBFSIterator (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkTreeBFSIterator ()
	Undocumented Block.
virtual int	GetMode ()
	Set the visit mode of the iterator. Mode can be DISCOVER (0): Order by discovery time FINISH (1): Order by finish time Default is DISCOVER. Use DISCOVER for top-down algorithms where parents need to be processed before children. Use FINISH for bottom-up algorithms where children need to be processed before parents.
virtual long	GetStartVertex ()
	The start vertex of the seedgeh. 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.
bool	HasNext ()
	Return true when all vertices have been visited.
override int	IsA (string type)
	Undocumented Block.
new vtkTreeBFSIterator	NewInstance ()
	Undocumented Block.
long	Next ()
	The next vertex visited in the graph.
void	SetMode (int mode)
	Set the visit mode of the iterator. Mode can be DISCOVER (0): Order by discovery time FINISH (1): Order by finish time Default is DISCOVER. Use DISCOVER for top-down algorithms where parents need to be processed before children. Use FINISH for bottom-up algorithms where children need to be processed before parents.
void	SetStartVertex (long vertex)
	The start vertex of the seedgeh. 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.
void	SetTree (vtkTree graph)
	Set the graph to iterate over.
Static Public Member Functions
static new vtkTreeBFSIterator	New ()
	Undocumented Block.
static new int	IsTypeOf (string type)
	Undocumented Block.
static new vtkTreeBFSIterator	SafeDownCast (vtkObjectBase o)
	Undocumented Block.
Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkTreeBFSIterator"
	Automatically generated type registration mechanics.
Static Public Attributes
static new readonly string	MRClassNameKey = "18vtkTreeBFSIterator"
	Automatically generated type registration mechanics.
Protected Member Functions
override void	Dispose (bool disposing)
	Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.
Private Member Functions
static internal IntPtr	vtkTreeBFSIterator_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int	vtkTreeBFSIterator_GetMode_01 (HandleRef pThis)
static internal long	vtkTreeBFSIterator_GetStartVertex_02 (HandleRef pThis)
static internal byte	vtkTreeBFSIterator_HasNext_03 (HandleRef pThis)
static internal int	vtkTreeBFSIterator_IsA_04 (HandleRef pThis, string type)
static internal int	vtkTreeBFSIterator_IsTypeOf_05 (string type)
static internal IntPtr	vtkTreeBFSIterator_NewInstance_07 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal long	vtkTreeBFSIterator_Next_08 (HandleRef pThis)
static internal IntPtr	vtkTreeBFSIterator_SafeDownCast_09 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void	vtkTreeBFSIterator_SetMode_10 (HandleRef pThis, int mode)
static internal void	vtkTreeBFSIterator_SetStartVertex_11 (HandleRef pThis, long vertex)
static internal void	vtkTreeBFSIterator_SetTree_12 (HandleRef pThis, HandleRef graph)
Static Private Member Functions
static	vtkTreeBFSIterator ()
	Automatically generated type registration mechanics.

---

Detailed Description

vtkTreeBFSIterator - breadth first search iterator through a vtkTree

Description vtkTreeBFSIterator performs a breadth first search of a tree.

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

Thanks Thanks to David Doria for submitting this class.

---

Member Enumeration Documentation

enum Kitware::VTK::vtkTreeBFSIterator::ModeType

Undocumented Block.

Enumerator:

DISCOVER	enum member
FINISH	enum member

---

Constructor & Destructor Documentation

static Kitware.VTK.vtkTreeBFSIterator.vtkTreeBFSIterator

(

)

[static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkTreeBFSIterator.vtkTreeBFSIterator	(	IntPtr	rawCppThis,
		bool	callDisposalMethod,
		bool	strong
	)

Automatically generated constructor - called from generated code. DO NOT call directly.

Kitware.VTK.vtkTreeBFSIterator.vtkTreeBFSIterator

(

)

Undocumented Block.

---

Member Function Documentation

override void Kitware.VTK.vtkTreeBFSIterator.Dispose

(

bool

disposing

)

[protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkObject.

virtual int Kitware.VTK.vtkTreeBFSIterator.GetMode

(

)

[virtual]

Set the visit mode of the iterator. Mode can be DISCOVER (0): Order by discovery time FINISH (1): Order by finish time Default is DISCOVER. Use DISCOVER for top-down algorithms where parents need to be processed before children. Use FINISH for bottom-up algorithms where children need to be processed before parents.

virtual long Kitware.VTK.vtkTreeBFSIterator.GetStartVertex

(

)

[virtual]

The start vertex of the seedgeh. 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.

bool Kitware.VTK.vtkTreeBFSIterator.HasNext

(

)

Return true when all vertices have been visited.

override int Kitware.VTK.vtkTreeBFSIterator.IsA

(

string

type

)

[virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

static new int Kitware.VTK.vtkTreeBFSIterator.IsTypeOf

(

string

type

)

[static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

static new vtkTreeBFSIterator Kitware.VTK.vtkTreeBFSIterator.New

(

)

[static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

new vtkTreeBFSIterator Kitware.VTK.vtkTreeBFSIterator.NewInstance

(

)

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

long Kitware.VTK.vtkTreeBFSIterator.Next

(

)

The next vertex visited in the graph.

static new vtkTreeBFSIterator Kitware.VTK.vtkTreeBFSIterator.SafeDownCast

(

vtkObjectBase

o

)

[static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

void Kitware.VTK.vtkTreeBFSIterator.SetMode

(

int

mode

)

Set the visit mode of the iterator. Mode can be DISCOVER (0): Order by discovery time FINISH (1): Order by finish time Default is DISCOVER. Use DISCOVER for top-down algorithms where parents need to be processed before children. Use FINISH for bottom-up algorithms where children need to be processed before parents.

void Kitware.VTK.vtkTreeBFSIterator.SetStartVertex

(

long

vertex

)

The start vertex of the seedgeh. 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.

void Kitware.VTK.vtkTreeBFSIterator.SetTree

(

vtkTree

graph

)

Set the graph to iterate over.

static internal int Kitware.VTK.vtkTreeBFSIterator.vtkTreeBFSIterator_GetMode_01

(

HandleRef

pThis

)

[private]

static internal long Kitware.VTK.vtkTreeBFSIterator.vtkTreeBFSIterator_GetStartVertex_02

(

HandleRef

pThis

)

[private]

static internal byte Kitware.VTK.vtkTreeBFSIterator.vtkTreeBFSIterator_HasNext_03

(

HandleRef

pThis

)

[private]

static internal int Kitware.VTK.vtkTreeBFSIterator.vtkTreeBFSIterator_IsA_04	(	HandleRef	pThis,
		string	type
	)		[private]

static internal int Kitware.VTK.vtkTreeBFSIterator.vtkTreeBFSIterator_IsTypeOf_05

(

string

type

)

[private]

static internal IntPtr Kitware.VTK.vtkTreeBFSIterator.vtkTreeBFSIterator_New	(	ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		[private]

static internal IntPtr Kitware.VTK.vtkTreeBFSIterator.vtkTreeBFSIterator_NewInstance_07	(	HandleRef	pThis,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		[private]

static internal long Kitware.VTK.vtkTreeBFSIterator.vtkTreeBFSIterator_Next_08

(

HandleRef

pThis

)

[private]

static internal IntPtr Kitware.VTK.vtkTreeBFSIterator.vtkTreeBFSIterator_SafeDownCast_09	(	HandleRef	o,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		[private]

static internal void Kitware.VTK.vtkTreeBFSIterator.vtkTreeBFSIterator_SetMode_10	(	HandleRef	pThis,
		int	mode
	)		[private]

static internal void Kitware.VTK.vtkTreeBFSIterator.vtkTreeBFSIterator_SetStartVertex_11	(	HandleRef	pThis,
		long	vertex
	)		[private]

static internal void Kitware.VTK.vtkTreeBFSIterator.vtkTreeBFSIterator_SetTree_12	(	HandleRef	pThis,
		HandleRef	graph
	)		[private]

---

Member Data Documentation

new readonly string Kitware.VTK.vtkTreeBFSIterator.MRClassNameKey = "18vtkTreeBFSIterator" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

new const string Kitware.VTK.vtkTreeBFSIterator.MRFullTypeName = "Kitware.VTK.vtkTreeBFSIterator"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

---

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

• csharp/vtkTreeBFSIterator.cs