VTK  9.3.20240425
vtkHyperTreeGridGeometryUnlimitedLevelEntry.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
25#ifndef vtkHyperTreeGridGeometryUnlimitedLevelEntry_h
26#define vtkHyperTreeGridGeometryUnlimitedLevelEntry_h
27
28#include "assert.h"
29
30#include "vtkObject.h"
31#include "vtkSmartPointer.h"
32
35
36VTK_ABI_NAMESPACE_BEGIN
37class vtkHyperTree;
39
41{
42public:
46 void PrintSelf(ostream& os, vtkIndent indent);
47
52 {
53 this->Tree = tree;
54 this->Level = 0;
55 this->Index = 0;
56 for (unsigned int d = 0; d < 3; ++d)
57 {
58 this->Origin[d] = 0.;
59 }
60 }
61
66
71
75 void Dump(ostream& os);
76
80 void Initialize(vtkHyperTree* tree, unsigned int level, vtkIdType index, const double* origin);
81
85 vtkHyperTree* Initialize(vtkHyperTreeGrid* grid, vtkIdType treeIndex, bool create = false);
86
90 void Reset()
91 {
92 this->Tree = nullptr;
93 this->Index = 0;
94 }
95
100 {
101 this->Initialize(entry->Tree, entry->Level, entry->Index, entry->Origin);
102 this->LastRealIndex = entry->LastRealIndex;
103 this->LastRealLevel = entry->LastRealLevel;
104 }
105
111 vtkHyperTreeGrid* grid)
112 {
115 cursor->Initialize(grid, this->Tree, this->Level, this->Index, this->Origin);
116 return cursor;
117 }
118
125 {
126 assert("pre: level==0" && this->Level == 0);
129 cursor->Initialize(grid, this->Tree, this->Level, this->Index, this->Origin);
130 return cursor;
131 }
132
137 vtkIdType GetVertexId() const { return this->LastRealIndex; }
138
145
151
157
162 void SetMask(const vtkHyperTreeGrid* grid, bool state);
163
168 bool IsMasked(const vtkHyperTreeGrid* grid) const;
169
175 bool IsLeaf(const vtkHyperTreeGrid* grid) const;
176
181 bool IsRealLeaf(const vtkHyperTreeGrid* grid) const;
182
187 bool IsVirtualLeaf(const vtkHyperTreeGrid* grid) const;
188
193 bool IsTerminalNode(const vtkHyperTreeGrid* grid) const;
194
198 bool IsRoot() { return this->Index == 0 && this->Level == 0; }
199
208 void ToChild(const vtkHyperTreeGrid* grid, unsigned char ichild);
209
213 vtkHyperTree* GetTree() const { return this->Tree; }
214
216
219 unsigned int GetLevel() const { return this->Level; }
220 unsigned int GetLastRealLevel() const { return this->LastRealLevel; }
222
224
227 double* GetOrigin() { return this->Origin; }
228 const double* GetOrigin() const { return this->Origin; }
230
234 void GetBounds(double bounds[6]) const;
235
239 void GetPoint(double point[3]) const;
240
241private:
245 vtkHyperTree* Tree;
246
250 unsigned int Level = 0;
251
255 vtkIdType Index = 0;
256
260 vtkIdType LastRealIndex = 0;
261
265 vtkIdType LastRealLevel = 0;
266
270 double Origin[3];
271};
272
273VTK_ABI_NAMESPACE_END
274#endif // vtkHyperTreeGridGeometryUnlimitedLevelEntry
275// VTK-HeaderTest-Exclude: vtkHyperTreeGridGeometryUnlimitedLevelEntry.h
Cursor cache data with coordinates and level info.
void Copy(const vtkHyperTreeGridGeometryUnlimitedLevelEntry *entry)
Copy function.
vtkHyperTreeGridGeometryUnlimitedLevelEntry & operator=(vtkHyperTreeGridGeometryUnlimitedLevelEntry const &)=default
bool IsVirtualLeaf(const vtkHyperTreeGrid *grid) const
Is the cursor pointing to a virually subdivided leaf?
void PrintSelf(ostream &os, vtkIndent indent)
Display info about the entry.
void Dump(ostream &os)
Dump information.
void SetMask(const vtkHyperTreeGrid *grid, bool state)
Set the blanking mask is empty or not.
bool IsLeaf(const vtkHyperTreeGrid *grid) const
Is the cursor pointing to a leaf?
unsigned int GetLastRealLevel() const
Get level info from current cache entry.
unsigned int GetLevel() const
Get level info from current cache entry.
double * GetOrigin()
Getter for origin coordinates of the current cell.
vtkIdType GetVertexId() const
Return the index of the current vertex in the tree.
void Initialize(vtkHyperTree *tree, unsigned int level, vtkIdType index, const double *origin)
Initialize cache entry from explicit required data.
vtkSmartPointer< vtkHyperTreeGridOrientedGeometryCursor > GetHyperTreeGridOrientedGeometryCursor(vtkHyperTreeGrid *grid)
Create a vtkHyperTreeGridOrientedCursor from input grid and current entry data.
void GetPoint(double point[3]) const
Getter for center of the current cell.
vtkHyperTreeGridGeometryUnlimitedLevelEntry(vtkHyperTree *tree=nullptr)
Constructor.
~vtkHyperTreeGridGeometryUnlimitedLevelEntry()=default
Destructor.
void ToChild(const vtkHyperTreeGrid *grid, unsigned char ichild)
Move the cursor to child ‘child’ of the current vertex.
vtkHyperTreeGridGeometryUnlimitedLevelEntry(vtkHyperTreeGridGeometryUnlimitedLevelEntry const &)=default
const double * GetOrigin() const
Getter for origin coordinates of the current cell.
void SetGlobalIndexFromLocal(vtkIdType index)
Set the global index for the current cell of the HyperTree.
bool IsRealLeaf(const vtkHyperTreeGrid *grid) const
Is the cursor pointing to a leaf?
void GetBounds(double bounds[6]) const
Getter for bounding box of the current cell.
void SetGlobalIndexStart(vtkIdType index)
Set the global index for the root cell of the HyperTree.
bool IsTerminalNode(const vtkHyperTreeGrid *grid) const
Is the cursor pointing to a coarse with all children being leaves ?
vtkHyperTree * GetTree() const
Get HyperTree from current cache entry.
bool IsMasked(const vtkHyperTreeGrid *grid) const
Determine whether blanking mask is empty or not.
vtkHyperTree * Initialize(vtkHyperTreeGrid *grid, vtkIdType treeIndex, bool create=false)
Initialize cache entry at root of given tree index in grid.
vtkIdType GetGlobalNodeIndex() const
Return the global index (relative to the grid) of the current vertex in the tree.
vtkSmartPointer< vtkHyperTreeGridNonOrientedGeometryCursor > GetHyperTreeGridNonOrientedGeometryCursor(vtkHyperTreeGrid *grid)
Create a vtkHyperTreeGridNonOrientedCursor from input grid and current entry data.
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:108
Hold a reference to a vtkObjectBase instance.
static vtkSmartPointer< T > New()
Create an instance of a VTK object.
int vtkIdType
Definition vtkType.h:315