VTK  9.2.6
vtkTree.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkTree.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 /*-------------------------------------------------------------------------
16  Copyright 2008 Sandia Corporation.
17  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
18  the U.S. Government retains certain rights in this software.
19 -------------------------------------------------------------------------*/
52 #ifndef vtkTree_h
53 #define vtkTree_h
54 
55 #include "vtkCommonDataModelModule.h" // For export macro
57 
58 class vtkIdTypeArray;
59 
60 class VTKCOMMONDATAMODEL_EXPORT vtkTree : public vtkDirectedAcyclicGraph
61 {
62 public:
63  static vtkTree* New();
65  void PrintSelf(ostream& os, vtkIndent indent) override;
66 
70  int GetDataObjectType() override { return VTK_TREE; }
71 
73 
76  vtkGetMacro(Root, vtkIdType);
78 
83 
87  vtkIdType GetChild(vtkIdType v, vtkIdType i);
88 
95 
99  vtkIdType GetParent(vtkIdType v);
100 
104  vtkEdgeType GetParentEdge(vtkIdType v);
105 
111  vtkIdType GetLevel(vtkIdType v);
112 
116  bool IsLeaf(vtkIdType vertex);
117 
119 
123  static vtkTree* GetData(vtkInformationVector* v, int i = 0);
125 
132  virtual void ReorderChildren(vtkIdType parent, vtkIdTypeArray* children);
133 
134 protected:
135  vtkTree();
136  ~vtkTree() override;
137 
142  bool IsStructureValid(vtkGraph* g) override;
143 
148 
149 private:
150  vtkTree(const vtkTree&) = delete;
151  void operator=(const vtkTree&) = delete;
152 };
153 
154 #endif
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkIdType GetNumberOfChildren(vtkIdType v)
Get the number of children of a vertex.
Definition: vtkTree.h:82
Store vtkAlgorithm input/output information.
Iterates through adjacent vertices in a graph.
static vtkDirectedAcyclicGraph * New()
dynamic, self-adjusting array of vtkIdType
int vtkIdType
Definition: vtkType.h:332
virtual void GetAdjacentVertices(vtkIdType v, vtkAdjacentVertexIterator *it)
Initializes the adjacent vertex iterator to iterate over all outgoing vertices from vertex v...
Base class for graph data types.
Definition: vtkGraph.h:295
a simple class to control print indentation
Definition: vtkIndent.h:39
int GetDataObjectType() override
Return what type of dataset this is.
Definition: vtkTree.h:70
vtkIdType Root
The root of the tree.
Definition: vtkTree.h:147
static vtkDirectedAcyclicGraph * GetData(vtkInformation *info)
Retrieve a graph from an information vector.
Store zero or more vtkInformation instances.
bool IsStructureValid(vtkGraph *g) override
Check the storage, and accept it if it is a valid tree.
void GetChildren(vtkIdType v, vtkAdjacentVertexIterator *it)
Get the child vertices of a vertex.
Definition: vtkTree.h:94
A rooted tree data structure.
Definition: vtkTree.h:60
A rooted tree data structure.
#define VTK_TREE
Definition: vtkType.h:98
virtual vtkIdType GetOutDegree(vtkIdType v)
The number of outgoing edges from vertex v.