ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkTree Class Reference

vtkTree - A rooted tree data structure. More...

Inheritance diagram for Kitware.VTK.vtkTree:
[legend]
Collaboration diagram for Kitware.VTK.vtkTree:
[legend]

List of all members.

Public Member Functions

 vtkTree (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkTree ()
 Undocumented Block.
int GetChild (int v, int i)
 Get the i-th child of a parent vertex.
void GetChildren (int v, vtkAdjacentVertexIterator it)
 Get the child vertices of a vertex. This is a convenience method that functions exactly like GetAdjacentVertices.
override int GetDataObjectType ()
 Return what type of dataset this is.
int GetLevel (int v)
 Get the level of the vertex in the tree. The root vertex has level 0. Returns -1 if the vertex id is < 0 or greater than the number of vertices in the tree.
int GetNumberOfChildren (int v)
 Get the number of children of a vertex.
int GetParent (int v)
 Get the parent of a vertex.
virtual int GetRoot ()
 Get the root vertex of the tree.
override int IsA (string type)
 Undocumented Block.
bool IsLeaf (int vertex)
 Return whether the vertex is a leaf (i.e. it has no children).
new vtkTree NewInstance ()
 Undocumented Block.
virtual void ReorderChildren (int parent, vtkIdTypeArray children)
 Reorder the children of a parent vertex. The children array must contain all the children of parent, just in a different order. This does not change the topology of the tree.

Static Public Member Functions

static new vtkTree New ()
 Undocumented Block.
static new vtkTree GetData (vtkInformation info)
 Return whether the vertex is a leaf (i.e. it has no children).
static new vtkTree GetData (vtkInformationVector v, int i)
 Return whether the vertex is a leaf (i.e. it has no children).
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkTree SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkTree"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "7vtkTree"
 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 vtkTree_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkTree_GetChild_01 (HandleRef pThis, int v, int i)
static internal void vtkTree_GetChildren_02 (HandleRef pThis, int v, HandleRef it)
static internal IntPtr vtkTree_GetData_03 (HandleRef info, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkTree_GetData_04 (HandleRef v, int i, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkTree_GetDataObjectType_05 (HandleRef pThis)
static internal int vtkTree_GetLevel_06 (HandleRef pThis, int v)
static internal int vtkTree_GetNumberOfChildren_07 (HandleRef pThis, int v)
static internal int vtkTree_GetParent_08 (HandleRef pThis, int v)
static internal int vtkTree_GetRoot_09 (HandleRef pThis)
static internal int vtkTree_IsA_10 (HandleRef pThis, string type)
static internal byte vtkTree_IsLeaf_11 (HandleRef pThis, int vertex)
static internal int vtkTree_IsTypeOf_12 (string type)
static internal IntPtr vtkTree_NewInstance_14 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTree_ReorderChildren_15 (HandleRef pThis, int parent, HandleRef children)
static internal IntPtr vtkTree_SafeDownCast_16 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)

Static Private Member Functions

static vtkTree ()
 Automatically generated type registration mechanics.

Detailed Description

vtkTree - A rooted tree data structure.

Description vtkTree is a connected directed graph with no cycles. A tree is a type of directed graph, so works with all graph algorithms.

vtkTree is a read-only data structure. To construct a tree, create an instance of vtkMutableDirectedGraph. Add vertices and edges with AddVertex() and AddEdge(). You may alternately start by adding a single vertex as the root then call graph->AddChild(parent) which adds a new vertex and connects the parent to the child. The tree MUST have all edges in the proper direction, from parent to child. After building the tree, call tree->CheckedShallowCopy(graph) to copy the structure into a vtkTree. This method will return false if the graph is an invalid tree.

vtkTree provides some convenience methods for obtaining the parent and children of a vertex, for finding the root, and determining if a vertex is a leaf (a vertex with no children).

vtkDirectedGraph vtkMutableDirectedGraph vtkGraph


Constructor & Destructor Documentation

static Kitware.VTK.vtkTree.vtkTree ( ) [static, private]

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

override void Kitware.VTK.vtkTree.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.vtkDirectedAcyclicGraph.

int Kitware.VTK.vtkTree.GetChild ( int  v,
int  i 
)

Get the i-th child of a parent vertex.

Get the child vertices of a vertex. This is a convenience method that functions exactly like GetAdjacentVertices.

static new vtkTree Kitware.VTK.vtkTree.GetData ( vtkInformation  info) [static]

Return whether the vertex is a leaf (i.e. it has no children).

Reimplemented from Kitware.VTK.vtkDirectedAcyclicGraph.

Here is the call graph for this function:

static new vtkTree Kitware.VTK.vtkTree.GetData ( vtkInformationVector  v,
int  i 
) [static]

Return whether the vertex is a leaf (i.e. it has no children).

Reimplemented from Kitware.VTK.vtkDirectedAcyclicGraph.

Here is the call graph for this function:

override int Kitware.VTK.vtkTree.GetDataObjectType ( ) [virtual]

Return what type of dataset this is.

Reimplemented from Kitware.VTK.vtkDirectedAcyclicGraph.

Get the level of the vertex in the tree. The root vertex has level 0. Returns -1 if the vertex id is < 0 or greater than the number of vertices in the tree.

Get the number of children of a vertex.

Get the parent of a vertex.

virtual int Kitware.VTK.vtkTree.GetRoot ( ) [virtual]

Get the root vertex of the tree.

override int Kitware.VTK.vtkTree.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDirectedAcyclicGraph.

bool Kitware.VTK.vtkTree.IsLeaf ( int  vertex)

Return whether the vertex is a leaf (i.e. it has no children).

static new int Kitware.VTK.vtkTree.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDirectedAcyclicGraph.

static new vtkTree Kitware.VTK.vtkTree.New ( ) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDirectedAcyclicGraph.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDirectedAcyclicGraph.

virtual void Kitware.VTK.vtkTree.ReorderChildren ( int  parent,
vtkIdTypeArray  children 
) [virtual]

Reorder the children of a parent vertex. The children array must contain all the children of parent, just in a different order. This does not change the topology of the tree.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDirectedAcyclicGraph.

Here is the call graph for this function:

static internal int Kitware.VTK.vtkTree.vtkTree_GetChild_01 ( HandleRef  pThis,
int  v,
int  i 
) [private]
static internal void Kitware.VTK.vtkTree.vtkTree_GetChildren_02 ( HandleRef  pThis,
int  v,
HandleRef  it 
) [private]
static internal IntPtr Kitware.VTK.vtkTree.vtkTree_GetData_03 ( HandleRef  info,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTree.vtkTree_GetData_04 ( HandleRef  v,
int  i,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkTree.vtkTree_GetDataObjectType_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTree.vtkTree_GetLevel_06 ( HandleRef  pThis,
int  v 
) [private]
static internal int Kitware.VTK.vtkTree.vtkTree_GetNumberOfChildren_07 ( HandleRef  pThis,
int  v 
) [private]
static internal int Kitware.VTK.vtkTree.vtkTree_GetParent_08 ( HandleRef  pThis,
int  v 
) [private]
static internal int Kitware.VTK.vtkTree.vtkTree_GetRoot_09 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTree.vtkTree_IsA_10 ( HandleRef  pThis,
string  type 
) [private]
static internal byte Kitware.VTK.vtkTree.vtkTree_IsLeaf_11 ( HandleRef  pThis,
int  vertex 
) [private]
static internal int Kitware.VTK.vtkTree.vtkTree_IsTypeOf_12 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkTree.vtkTree_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTree.vtkTree_NewInstance_14 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkTree.vtkTree_ReorderChildren_15 ( HandleRef  pThis,
int  parent,
HandleRef  children 
) [private]
static internal IntPtr Kitware.VTK.vtkTree.vtkTree_SafeDownCast_16 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkTree.MRClassNameKey = "7vtkTree" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkDirectedAcyclicGraph.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkDirectedAcyclicGraph.


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