VTK  9.1.0
vtkHyperTreeGridGeometryLevelEntry.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkHyperTreeGridGeometryLevelEntry.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=========================================================================*/
36#ifndef vtkHyperTreeGridGeometryLevelEntry_h
37#define vtkHyperTreeGridGeometryLevelEntry_h
38
39#ifndef __VTK_WRAP__
40
41#include "assert.h"
42
43#include "vtkObject.h"
44#include "vtkSmartPointer.h"
45
48
49class vtkHyperTree;
51
53{
54public:
58 void PrintSelf(ostream& os, vtkIndent indent);
59
64 {
65 this->Tree = nullptr;
66 this->Level = 0;
67 this->Index = 0;
68 for (unsigned int d = 0; d < 3; ++d)
69 {
70 this->Origin[d] = 0.;
71 }
72 }
73
78
82 void Dump(ostream& os);
83
87 void Initialize(vtkHyperTree* tree, unsigned int level, vtkIdType index, const double* origin)
88 {
89 this->Tree = tree;
90 this->Level = level;
91 this->Index = index;
92 for (unsigned int d = 0; d < 3; ++d)
93 {
94 this->Origin[d] = origin[d];
95 }
96 }
97
101 vtkHyperTree* Initialize(vtkHyperTreeGrid* grid, vtkIdType treeIndex, bool create = false);
102
106 void Reset()
107 {
108 this->Tree = nullptr;
109 this->Index = 0;
110 }
111
116 {
117 this->Initialize(entry->Tree, entry->Level, entry->Index, entry->Origin);
118 }
119
125 vtkHyperTreeGrid* grid)
126 {
129 cursor->Initialize(grid, this->Tree, this->Level, this->Index, this->Origin);
130 return cursor;
131 }
132
139 {
140 assert("pre: level==0" && this->Level == 0);
143 cursor->Initialize(grid, this->Tree, this->Level, this->Index, this->Origin);
144 return cursor;
145 }
146
151 vtkIdType GetVertexId() const { return this->Index; }
152
159
165
171
176 void SetMask(const vtkHyperTreeGrid* grid, bool state);
177
182 bool IsMasked(const vtkHyperTreeGrid* grid) const;
183
189 bool IsLeaf(const vtkHyperTreeGrid* grid) const;
190
199
204 bool IsTerminalNode(const vtkHyperTreeGrid* grid) const;
205
209 bool IsRoot() { return (this->Index == 0); }
210
219 void ToChild(const vtkHyperTreeGrid* grid, unsigned char ichild);
220
224 vtkHyperTree* GetTree() const { return this->Tree; }
225
229 unsigned int GetLevel() const { return this->Level; }
230
234 double* GetOrigin() { return this->Origin; }
235 const double* GetOrigin() const { return this->Origin; }
236
240 void GetBounds(double bounds[6]) const;
241
245 void GetPoint(double point[3]) const;
246
247private:
251 vtkHyperTree* Tree;
252
256 unsigned int Level;
257
261 vtkIdType Index;
262
266 double Origin[3];
267};
268
269#endif // __VTK_WRAP__
270
271#endif // vtkHyperTreeGridGeometryLevelEntry
272// VTK-HeaderTest-Exclude: vtkHyperTreeGridGeometryLevelEntry.h
Cursor cache data with coordinates and level info.
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?
bool IsTerminalNode(const vtkHyperTreeGrid *grid) const
Is the cursor pointing to a coarse with all childrens being leaves ?
void GetBounds(double bounds[6]) const
Getter for bounding box of the current cell.
vtkHyperTree * GetTree() const
Get HyperTree from current cache entry.
vtkIdType GetVertexId() const
Return the index of the current vertex in the tree.
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.
vtkSmartPointer< vtkHyperTreeGridOrientedGeometryCursor > GetHyperTreeGridOrientedGeometryCursor(vtkHyperTreeGrid *grid)
Create a vtkHyperTreeGridOrientedCursor from input grid and current entry data.
void Copy(const vtkHyperTreeGridGeometryLevelEntry *entry)
Copy function.
void Initialize(vtkHyperTree *tree, unsigned int level, vtkIdType index, const double *origin)
Initialize cache entry from explicit required data.
void Dump(ostream &os)
Dump information.
~vtkHyperTreeGridGeometryLevelEntry()=default
Destructor.
bool IsMasked(const vtkHyperTreeGrid *grid) const
Determine whether blanking mask is empty or not.
void SetGlobalIndexStart(vtkIdType index)
Set the global index for the root cell of the HyperTree.
vtkHyperTree * Initialize(vtkHyperTreeGrid *grid, vtkIdType treeIndex, bool create=false)
Initialize cache entry at root of given tree index in grid.
double * GetOrigin()
Getter for origin coordinates of the current cell.
void GetPoint(double point[3]) const
Getter for center of the current cell.
void SetGlobalIndexFromLocal(vtkIdType index)
Set the global index for the current cell of the HyperTree.
void ToChild(const vtkHyperTreeGrid *grid, unsigned char ichild)
Move the cursor to child ‘child’ of the current vertex.
void SubdivideLeaf(const vtkHyperTreeGrid *grid)
Change the current cell's status: if leaf then becomes coarse and all its children are created,...
unsigned int GetLevel() const
Get level info from current cache entry.
void PrintSelf(ostream &os, vtkIndent indent)
Display info about the entry.
A dataset containing a grid of vtkHyperTree instances arranged as a rectilinear grid.
A data object structured as a tree.
Definition: vtkHyperTree.h:177
a simple class to control print indentation
Definition: vtkIndent.h:113
Hold a reference to a vtkObjectBase instance.
static vtkSmartPointer< T > New()
Create an instance of a VTK object.
int vtkIdType
Definition: vtkType.h:332