VTK  9.0.1
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 =========================================================================*/
37 #ifndef vtkHyperTreeGridGeometryLevelEntry_h
38 #define vtkHyperTreeGridGeometryLevelEntry_h
39 
40 #ifndef __VTK_WRAP__
41 
42 #include "assert.h"
43 
44 #include "vtkObject.h"
45 #include "vtkSmartPointer.h"
46 
49 
50 class vtkHyperTree;
51 class vtkHyperTreeGrid;
52 
54 {
55 public:
59  void PrintSelf(ostream& os, vtkIndent indent);
60 
65  {
66  this->Tree = nullptr;
67  this->Level = 0;
68  this->Index = 0;
69  for (unsigned int d = 0; d < 3; ++d)
70  {
71  this->Origin[d] = 0.;
72  }
73  }
74 
79 
83  void Dump(ostream& os);
84 
88  void Initialize(vtkHyperTree* tree, unsigned int level, vtkIdType index, const double* origin)
89  {
90  this->Tree = tree;
91  this->Level = level;
92  this->Index = index;
93  for (unsigned int d = 0; d < 3; ++d)
94  {
95  this->Origin[d] = origin[d];
96  }
97  }
98 
102  vtkHyperTree* Initialize(vtkHyperTreeGrid* grid, vtkIdType treeIndex, bool create = false);
103 
107  void Reset()
108  {
109  this->Tree = nullptr;
110  this->Index = 0;
111  }
112 
117  {
118  this->Initialize(entry->Tree, entry->Level, entry->Index, entry->Origin);
119  }
120 
126  vtkHyperTreeGrid* grid)
127  {
130  cursor->Initialize(grid, this->Tree, this->Level, this->Index, this->Origin);
131  return cursor;
132  }
133 
140  {
141  assert("pre: level==0" && this->Level == 0);
144  cursor->Initialize(grid, this->Tree, this->Level, this->Index, this->Origin);
145  return cursor;
146  }
147 
152  vtkIdType GetVertexId() const { return this->Index; }
153 
160 
166 
172 
177  void SetMask(const vtkHyperTreeGrid* grid, bool state);
178 
183  bool IsMasked(const vtkHyperTreeGrid* grid) const;
184 
190  bool IsLeaf(const vtkHyperTreeGrid* grid) const;
191 
199  void SubdivideLeaf(const vtkHyperTreeGrid* grid);
200 
205  bool IsTerminalNode(const vtkHyperTreeGrid* grid) const;
206 
210  bool IsRoot() { return (this->Index == 0); }
211 
220  void ToChild(const vtkHyperTreeGrid* grid, unsigned char ichild);
221 
225  vtkHyperTree* GetTree() const { return this->Tree; }
226 
230  unsigned int GetLevel() const { return this->Level; }
231 
235  double* GetOrigin() { return this->Origin; }
236  const double* GetOrigin() const { return this->Origin; }
237 
241  void GetBounds(double bounds[6]) const;
242 
246  void GetPoint(double point[3]) const;
247 
248 private:
252  vtkHyperTree* Tree;
253 
257  unsigned int Level;
258 
262  vtkIdType Index;
263 
267  double Origin[3];
268 };
269 
270 #endif // __VTK_WRAP__
271 
272 #endif // vtkHyperTreeGridGeometryLevelEntry
273 // VTK-HeaderTest-Exclude: vtkHyperTreeGridGeometryLevelEntry.h
vtkHyperTreeGridGeometryLevelEntry::Initialize
void Initialize(vtkHyperTree *tree, unsigned int level, vtkIdType index, const double *origin)
Initialize cache entry from explicit required data.
Definition: vtkHyperTreeGridGeometryLevelEntry.h:88
vtkHyperTreeGridGeometryLevelEntry::GetHyperTreeGridOrientedGeometryCursor
vtkSmartPointer< vtkHyperTreeGridOrientedGeometryCursor > GetHyperTreeGridOrientedGeometryCursor(vtkHyperTreeGrid *grid)
Create a vtkHyperTreeGridOrientedCursor from input grid and current entry data.
Definition: vtkHyperTreeGridGeometryLevelEntry.h:125
vtkHyperTreeGridGeometryLevelEntry::GetOrigin
const double * GetOrigin() const
Definition: vtkHyperTreeGridGeometryLevelEntry.h:236
vtkHyperTreeGridGeometryLevelEntry::GetOrigin
double * GetOrigin()
Getter for origin coordinates of the current cell.
Definition: vtkHyperTreeGridGeometryLevelEntry.h:235
vtkHyperTreeGridGeometryLevelEntry::SetGlobalIndexStart
void SetGlobalIndexStart(vtkIdType index)
Set the global index for the root cell of the HyperTree.
vtkHyperTreeGridGeometryLevelEntry::IsTerminalNode
bool IsTerminalNode(const vtkHyperTreeGrid *grid) const
Is the cursor pointing to a coarse with all childrens being leaves ?
vtkIdType
int vtkIdType
Definition: vtkType.h:338
vtkHyperTreeGridGeometryLevelEntry::IsMasked
bool IsMasked(const vtkHyperTreeGrid *grid) const
Determine whether blanking mask is empty or not.
vtkHyperTreeGridGeometryLevelEntry::SetMask
void SetMask(const vtkHyperTreeGrid *grid, bool state)
Set the blanking mask is empty or not.
vtkSmartPointer
Hold a reference to a vtkObjectBase instance.
Definition: vtkMeta.h:32
vtkHyperTreeGridGeometryLevelEntry::GetHyperTreeGridNonOrientedGeometryCursor
vtkSmartPointer< vtkHyperTreeGridNonOrientedGeometryCursor > GetHyperTreeGridNonOrientedGeometryCursor(vtkHyperTreeGrid *grid)
Create a vtkHyperTreeGridNonOrientedCursor from input grid and current entry data.
Definition: vtkHyperTreeGridGeometryLevelEntry.h:139
vtkHyperTreeGridGeometryLevelEntry::GetPoint
void GetPoint(double point[3]) const
Getter for center of the current cell.
vtkHyperTreeGridGeometryLevelEntry::Dump
void Dump(ostream &os)
Dump information.
vtkHyperTreeGridGeometryLevelEntry
Cursor cache data with coordinates and level info.
Definition: vtkHyperTreeGridGeometryLevelEntry.h:53
vtkX3D::level
@ level
Definition: vtkX3D.h:401
vtkX3D::point
@ point
Definition: vtkX3D.h:242
vtkHyperTreeGridGeometryLevelEntry::ToChild
void ToChild(const vtkHyperTreeGrid *grid, unsigned char ichild)
Move the cursor to child ‘child’ of the current vertex.
vtkHyperTreeGridOrientedGeometryCursor.h
vtkHyperTreeGridGeometryLevelEntry::Copy
void Copy(const vtkHyperTreeGridGeometryLevelEntry *entry)
Copy function.
Definition: vtkHyperTreeGridGeometryLevelEntry.h:116
vtkHyperTreeGridGeometryLevelEntry::vtkHyperTreeGridGeometryLevelEntry
vtkHyperTreeGridGeometryLevelEntry()
Constructor.
Definition: vtkHyperTreeGridGeometryLevelEntry.h:64
vtkSmartPointer::New
static vtkSmartPointer< T > New()
Create an instance of a VTK object.
Definition: vtkSmartPointer.h:218
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkHyperTreeGridGeometryLevelEntry::GetGlobalNodeIndex
vtkIdType GetGlobalNodeIndex() const
Return the global index (relative to the grid) of the current vertex in the tree.
vtkSmartPointer.h
vtkHyperTreeGridGeometryLevelEntry::SubdivideLeaf
void SubdivideLeaf(const vtkHyperTreeGrid *grid)
Change the current cell's status: if leaf then becomes coarse and all its children are created,...
vtkHyperTree
A data object structured as a tree.
Definition: vtkHyperTree.h:178
vtkHyperTreeGridGeometryLevelEntry::IsLeaf
bool IsLeaf(const vtkHyperTreeGrid *grid) const
Is the cursor pointing to a leaf?
vtkObject.h
vtkHyperTreeGridGeometryLevelEntry::GetBounds
void GetBounds(double bounds[6]) const
Getter for bounding box of the current cell.
vtkHyperTreeGridGeometryLevelEntry::IsRoot
bool IsRoot()
Is the cursor at tree root?
Definition: vtkHyperTreeGridGeometryLevelEntry.h:210
vtkHyperTreeGridGeometryLevelEntry::Reset
void Reset()
Reset function.
Definition: vtkHyperTreeGridGeometryLevelEntry.h:107
vtkHyperTreeGridGeometryLevelEntry::GetTree
vtkHyperTree * GetTree() const
Get HyperTree from current cache entry.
Definition: vtkHyperTreeGridGeometryLevelEntry.h:225
vtkHyperTreeGridGeometryLevelEntry::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
Display info about the entry.
vtkHyperTreeGridGeometryLevelEntry::~vtkHyperTreeGridGeometryLevelEntry
~vtkHyperTreeGridGeometryLevelEntry()=default
Destructor.
vtkHyperTreeGridGeometryLevelEntry::GetVertexId
vtkIdType GetVertexId() const
Return the index of the current vertex in the tree.
Definition: vtkHyperTreeGridGeometryLevelEntry.h:152
vtkX3D::index
@ index
Definition: vtkX3D.h:252
vtkHyperTreeGridGeometryLevelEntry::GetLevel
unsigned int GetLevel() const
Get level info from current cache entry.
Definition: vtkHyperTreeGridGeometryLevelEntry.h:230
vtkHyperTreeGridGeometryLevelEntry::SetGlobalIndexFromLocal
void SetGlobalIndexFromLocal(vtkIdType index)
Set the global index for the current cell of the HyperTree.
vtkHyperTreeGridNonOrientedGeometryCursor.h
vtkHyperTreeGrid
A dataset containing a grid of vtkHyperTree instances arranged as a rectilinear grid.
Definition: vtkHyperTreeGrid.h:96