VTK
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) VTK_OVERRIDE;
66 
70  int GetDataObjectType() VTK_OVERRIDE {return VTK_TREE;}
71 
73 
76  vtkGetMacro(Root, vtkIdType);
78 
83  { return this->GetOutDegree(v); }
84 
89 
96  { this->GetAdjacentVertices(v, it); }
97 
102 
107 
114 
118  bool IsLeaf(vtkIdType vertex);
119 
121 
125  static vtkTree *GetData(vtkInformationVector *v, int i=0);
127 
134  virtual void ReorderChildren(vtkIdType parent, vtkIdTypeArray *children);
135 
136 protected:
138  ~vtkTree() VTK_OVERRIDE;
139 
144  bool IsStructureValid(vtkGraph *g) VTK_OVERRIDE;
145 
149  vtkIdType Root;
150 
151 private:
152  vtkTree(const vtkTree&) VTK_DELETE_FUNCTION;
153  void operator=(const vtkTree&) VTK_DELETE_FUNCTION;
154 };
155 
156 #endif
Iterates through adjacent vertices in a graph.
A rooted tree data structure.
Base class for graph data types.
Definition: vtkGraph.h:288
virtual vtkIdType GetOutDegree(vtkIdType v)
The number of outgoing edges from vertex v.
virtual void GetAdjacentVertices(vtkIdType v, vtkAdjacentVertexIterator *it)
Initializes the adjacent vertex iterator to iterate over all outgoing vertices from vertex v.
dynamic, self-adjusting array of vtkIdType
a simple class to control print indentation
Definition: vtkIndent.h:40
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
A rooted tree data structure.
Definition: vtkTree.h:61
vtkIdType GetChild(vtkIdType v, vtkIdType i)
Get the i-th child of a parent vertex.
static vtkTree * GetData(vtkInformation *info)
Retrieve a graph from an information vector.
vtkIdType GetNumberOfChildren(vtkIdType v)
Get the number of children of a vertex.
Definition: vtkTree.h:82
virtual void ReorderChildren(vtkIdType parent, vtkIdTypeArray *children)
Reorder the children of a parent vertex.
vtkEdgeType GetParentEdge(vtkIdType v)
Get the edge connecting the vertex to its parent.
static vtkTree * New()
void GetChildren(vtkIdType v, vtkAdjacentVertexIterator *it)
Get the child vertices of a vertex.
Definition: vtkTree.h:95
static vtkTree * GetData(vtkInformationVector *v, int i=0)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkIdType GetParent(vtkIdType v)
Get the parent of a vertex.
int GetDataObjectType() override
Return what type of dataset this is.
Definition: vtkTree.h:70
vtkIdType GetLevel(vtkIdType v)
Get the level of the vertex in the tree.
bool IsLeaf(vtkIdType vertex)
Return whether the vertex is a leaf (i.e.
~vtkTree() override
@ info
Definition: vtkX3D.h:376
int vtkIdType
Definition: vtkType.h:287
#define VTK_TREE
Definition: vtkType.h:108