A rooted tree data structure. More...
#include <vtkTree.h>
Detailed Description
A rooted tree data structure.
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).
- Examples:
- vtkTree (Examples)
- Tests:
- vtkTree (Tests)
Member Typedef Documentation
Reimplemented from vtkDirectedAcyclicGraph.
Constructor & Destructor Documentation
| vtkTree::vtkTree | ( | ) | [protected] |
| vtkTree::~vtkTree | ( | ) | [protected] |
Member Function Documentation
| static vtkTree* vtkTree::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkDirectedAcyclicGraph.
| static int vtkTree::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type 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 vtkDirectedAcyclicGraph.
| virtual int vtkTree::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 vtkDirectedAcyclicGraph.
| static vtkTree* vtkTree::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkDirectedAcyclicGraph.
| virtual vtkObjectBase* vtkTree::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkDirectedAcyclicGraph.
| vtkTree* vtkTree::NewInstance | ( | ) | const |
Reimplemented from vtkDirectedAcyclicGraph.
| void vtkTree::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
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 vtkDirectedAcyclicGraph.
| virtual int vtkTree::GetDataObjectType | ( | ) | [inline, virtual] |
Return what type of dataset this is.
Reimplemented from vtkDirectedAcyclicGraph.
| virtual vtkIdType vtkTree::GetRoot | ( | ) | [virtual] |
Get the root vertex of the tree.
| vtkIdType vtkTree::GetNumberOfChildren | ( | vtkIdType | v | ) | [inline] |
| vtkIdType vtkTree::GetChild | ( | vtkIdType | v, |
| vtkIdType | i | ||
| ) |
Get the i-th child of a parent vertex.
| void vtkTree::GetChildren | ( | vtkIdType | v, |
| vtkAdjacentVertexIterator * | it | ||
| ) | [inline] |
Get the parent of a vertex.
Get the edge connecting the vertex to its parent.
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.
| bool vtkTree::IsLeaf | ( | vtkIdType | vertex | ) |
Return whether the vertex is a leaf (i.e. it has no children).
| static vtkTree* vtkTree::GetData | ( | vtkInformation * | info | ) | [static] |
Retrieve a graph from an information vector.
Reimplemented from vtkDirectedAcyclicGraph.
| static vtkTree* vtkTree::GetData | ( | vtkInformationVector * | v, |
| int | i = 0 |
||
| ) | [static] |
Retrieve a graph from an information vector.
Reimplemented from vtkDirectedAcyclicGraph.
| virtual void vtkTree::ReorderChildren | ( | vtkIdType | 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.
| virtual bool vtkTree::IsStructureValid | ( | vtkGraph * | g | ) | [protected, virtual] |
Check the storage, and accept it if it is a valid tree.
Reimplemented from vtkDirectedAcyclicGraph.
Member Data Documentation
vtkIdType vtkTree::Root [protected] |
The documentation for this class was generated from the following file:
- dox/Common/DataModel/vtkTree.h
