VTK  9.3.0
vtkHyperTreeGridLevelEntry.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
24#ifndef vtkHyperTreeGridLevelEntry_h
25#define vtkHyperTreeGridLevelEntry_h
26
27#include "vtkObject.h"
28#include "vtkSmartPointer.h" // Used internally
29
30VTK_ABI_NAMESPACE_BEGIN
31class vtkHyperTree;
34
36{
37public:
41 void PrintSelf(ostream& os, vtkIndent indent);
42
46 void Dump(ostream& os);
47
52 : Tree(nullptr)
53 , Level(0)
54 , Index(0)
55 {
56 }
57
62 : Tree(entry->Tree)
63 , Level(entry->Level)
64 , Index(entry->Index)
65 {
66 }
67
71 vtkHyperTreeGridLevelEntry(vtkHyperTree* tree, unsigned int level, vtkIdType index)
72 : Tree(tree)
73 , Level(level)
74 , Index(index)
75 {
76 }
77
81 vtkHyperTreeGridLevelEntry(vtkHyperTreeGrid* grid, vtkIdType treeIndex, bool create = false);
82
87
91 void Reset()
92 {
93 this->Tree = nullptr;
94 this->Level = 0;
95 this->Index = 0;
96 }
97
101 void Initialize(vtkHyperTree* tree, unsigned int level, vtkIdType index)
102 {
103 this->Tree = tree;
104 this->Level = level;
105 this->Index = index;
106 }
107
111 vtkHyperTree* Initialize(vtkHyperTreeGrid* grid, vtkIdType treeIndex, bool create = false);
112
117 {
118 this->Tree = entry->Tree;
119 this->Level = entry->Level;
120 this->Index = entry->Index;
121 }
122
128 vtkHyperTreeGrid* grid);
129
133 vtkIdType GetVertexId() const { return this->Index; }
134
140
146
152
157 void SetMask(const vtkHyperTreeGrid* grid, bool state);
158
163 bool IsMasked(const vtkHyperTreeGrid* grid) const;
164
170 bool IsLeaf(const vtkHyperTreeGrid* grid) const;
171
180
185 bool IsTerminalNode(const vtkHyperTreeGrid* grid) const;
186
190 bool IsRoot() const { return (this->Index == 0); }
191
200 void ToChild(const vtkHyperTreeGrid* grid, unsigned char ichild);
201
205 vtkHyperTree* GetTree() const { return this->Tree; }
206
210 unsigned int GetLevel() const { return this->Level; }
211
212protected:
217
221 unsigned int Level;
222
227};
228
229VTK_ABI_NAMESPACE_END
230#endif // vtkHyperTreeGridLevelEntry_h
231// VTK-HeaderTest-Exclude: vtkHyperTreeGridLevelEntry.h
LevelEntry is a cache data for cursors requiring level info.
bool IsLeaf(const vtkHyperTreeGrid *grid) const
Is the cursor pointing to a leaf?
vtkSmartPointer< vtkHyperTreeGridNonOrientedCursor > GetHyperTreeGridNonOrientedCursor(vtkHyperTreeGrid *grid)
Create a vtkHyperTreeGridNonOrientedCursor from input grid and current entry data.
vtkHyperTree * Initialize(vtkHyperTreeGrid *grid, vtkIdType treeIndex, bool create=false)
Initialize cursor at root of given tree index in grid.
~vtkHyperTreeGridLevelEntry()=default
Destructor.
bool IsMasked(const vtkHyperTreeGrid *grid) const
Determine whether blanking mask is empty or not.
vtkIdType GetGlobalNodeIndex() const
Return the global index (relative to the grid) of the current vertex in the tree.
unsigned int GetLevel() const
Get level info from current cache entry.
vtkIdType GetVertexId() const
Return the index of the current vertex in the tree.
void Initialize(vtkHyperTree *tree, unsigned int level, vtkIdType index)
Initialize cursor from explicit required data.
vtkHyperTree * GetTree() const
Get HyperTree from current cache entry.
void SetGlobalIndexStart(vtkIdType index)
Set the global index for the root cell of the HyperTree.
vtkIdType Index
index of the current cell in the HyperTree.
vtkHyperTree * Tree
pointer to the HyperTree containing the current cell.
vtkHyperTreeGridLevelEntry(vtkHyperTreeGridLevelEntry *entry)
Constructor.
bool IsRoot() const
Is the cursor at tree root?
void SetMask(const vtkHyperTreeGrid *grid, bool state)
Set the blanking mask is empty or not.
void PrintSelf(ostream &os, vtkIndent indent)
Display info about the entry.
vtkHyperTreeGridLevelEntry(vtkHyperTreeGrid *grid, vtkIdType treeIndex, bool create=false)
Constructor.
void ToChild(const vtkHyperTreeGrid *grid, unsigned char ichild)
Move the cursor to child ‘child’ of the current vertex.
void SetGlobalIndexFromLocal(vtkIdType index)
Set the global index for the current cell of the HyperTree.
void Dump(ostream &os)
Dump information.
bool IsTerminalNode(const vtkHyperTreeGrid *grid) const
Is the cursor pointing to a coarse with all childrens being leaves ?
vtkHyperTreeGridLevelEntry(vtkHyperTree *tree, unsigned int level, vtkIdType index)
Constructor.
void Copy(const vtkHyperTreeGridLevelEntry *entry)
Copy function.
unsigned int Level
level of the current cell in the HyperTree.
void SubdivideLeaf(const vtkHyperTreeGrid *grid)
Change the current cell's status: if leaf then becomes coarse and all its children are created,...
Objects for traversal a HyperTreeGrid.
A dataset containing a grid of vtkHyperTree instances arranged as a rectilinear grid.
A data object structured as a tree.
a simple class to control print indentation
Definition vtkIndent.h:29
Hold a reference to a vtkObjectBase instance.
int vtkIdType
Definition vtkType.h:315