1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkHyperTreeGridOrientedCursor
* @brief Objects for traversal a HyperTreeGrid.
*
* Objects that can perform depth traversal of a hyper tree grid,
* take into account more parameters (related to the grid structure) than
* the compact hyper tree cursor implemented in vtkHyperTree can.
* This is an abstract class.
* Cursors are created by the HyperTreeGrid implementation.
*
* oriented cursors are used for simple recursive DFS. A cursor has no
* knowledge of its parent, only its children.
*
* @sa
* vtkHyperTree vtkHyperTreeGrid
*
* @par Thanks:
* This class was written by Guenole Harel and Jacques-Bernard Lekien, 2014.
* This class was re-written by Philippe Pebay, 2016.
* This class was re-written for more optimisation by Jacques-Bernard Lekien,
* Guenole Harel and Jerome Dubois, 2018.
* This work was supported by Commissariat a l'Energie Atomique
* CEA, DAM, DIF, F-91297 Arpajon, France.
*/
#ifndef vtkHyperTreeGridOrientedCursor_h
#define vtkHyperTreeGridOrientedCursor_h
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkHyperTreeGridEntry.h" // Used internally
#include "vtkObject.h"
VTK_ABI_NAMESPACE_BEGIN
class vtkHyperTree;
class vtkHyperTreeGrid;
class VTKCOMMONDATAMODEL_EXPORT vtkHyperTreeGridOrientedCursor : public vtkObject
{
public:
vtkTypeMacro(vtkHyperTreeGridOrientedCursor, vtkObject);
void PrintSelf(ostream& os, vtkIndent indent) override;
static vtkHyperTreeGridOrientedCursor* New();
/**
* Create a copy of `this'.
* \post results_exists:result!=0
*/
vtkHyperTreeGridOrientedCursor* Clone();
///@{
/**
* Initialize cursor at root of given tree index in grid.
*/
void Initialize(vtkHyperTreeGrid* grid, vtkIdType treeIndex, bool create = false);
void Initialize(vtkHyperTreeGrid* grid, vtkHyperTree* tree, unsigned int level, vtkIdType index);
void Initialize(
vtkHyperTreeGrid* grid, vtkHyperTree* tree, unsigned int level, vtkHyperTreeGridEntry& entry);
///@}
///@{
/**
* Set the hyper tree grid to which the cursor is pointing.
*/
vtkHyperTreeGrid* GetGrid();
///@}
///@{
/**
* Return if a Tree pointing exist
*/
bool HasTree() const;
///@}
///@{
/**
* Set the hyper tree to which the cursor is pointing.
*/
vtkHyperTree* GetTree() const;
///@}
/**
* Return the index of the current vertex in the tree.
*/
vtkIdType GetVertexId();
/**
* Return the global index (relative to the grid) of the
* current vertex in the tree.
*/
vtkIdType GetGlobalNodeIndex();
/**
* Return the dimension of the tree.
* \post positive_result: result>0
*/
unsigned char GetDimension();
/**
* Return the number of children for each node (non-vertex leaf) of the tree.
* \post positive_number: result>0
*/
unsigned char GetNumberOfChildren();
void SetGlobalIndexStart(vtkIdType index);
void SetGlobalIndexFromLocal(vtkIdType index);
/**
* Set the blanking mask is empty or not
* \pre not_tree: tree
*/
void SetMask(bool state);
/**
* Determine whether blanking mask is empty or not
*/
bool IsMasked();
/**
* Is the cursor pointing to a leaf?
*/
bool IsLeaf();
void SubdivideLeaf();
/**
* Is the cursor at tree root?
*/
bool IsRoot();
/**
* Get the level of the tree vertex pointed by the cursor.
*/
unsigned int GetLevel();
/**
* Move the cursor to child `child' of the current vertex.
* \pre not_tree: HasTree()
* \pre not_leaf: !IsLeaf()
* \pre valid_child: ichild>=0 && ichild<GetNumberOfChildren()
* \pre depth_limiter: GetLevel() <= GetDepthLimiter()
*/
void ToChild(unsigned char ichild);
protected:
/**
* Constructor
*/
vtkHyperTreeGridOrientedCursor();
/**
* Destructor
*/
~vtkHyperTreeGridOrientedCursor() override;
/**
* Reference to the HTG currently processed
*/
vtkHyperTreeGrid* Grid;
vtkHyperTree* Tree;
unsigned int Level;
// Hyper tree grid to which the cursor is attached
vtkHyperTreeGridEntry Entry;
private:
vtkHyperTreeGridOrientedCursor(const vtkHyperTreeGridOrientedCursor&) = delete;
void operator=(const vtkHyperTreeGridOrientedCursor&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif
|
