VTK  9.4.20250304
vtkHyperTreeGridEntry.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
52#ifndef vtkHyperTreeGridEntry_h
53#define vtkHyperTreeGridEntry_h
54
55#include "vtkObject.h"
56
57VTK_ABI_NAMESPACE_BEGIN
58class vtkHyperTree;
60
62{
63public:
67 void PrintSelf(ostream& os, vtkIndent indent);
68
72 void Dump(ostream& os);
73
78
81
85 vtkHyperTreeGridEntry(vtkIdType index) { this->Index = index; }
86
91
95 vtkHyperTree* Initialize(vtkHyperTreeGrid* grid, vtkIdType treeIndex, bool create = false);
96
100 void Initialize(vtkIdType index) { this->Index = index; }
101
105 void Copy(const vtkHyperTreeGridEntry* entry) { this->Index = entry->Index; }
106
110 vtkIdType GetVertexId() const { return this->Index; }
111
117
123
129
134 void SetMask(const vtkHyperTreeGrid* grid, const vtkHyperTree* tree, bool state);
135
140 bool IsMasked(const vtkHyperTreeGrid* grid, const vtkHyperTree* tree) const;
141
147 bool IsLeaf(const vtkHyperTreeGrid* grid, const vtkHyperTree* tree, unsigned int level) const;
148
156 void SubdivideLeaf(const vtkHyperTreeGrid* grid, vtkHyperTree* tree, unsigned int level);
157
163 const vtkHyperTreeGrid* grid, const vtkHyperTree* tree, unsigned int level) const;
164
168 bool IsRoot() const { return (this->Index == 0); }
169
178 void ToChild(const vtkHyperTreeGrid* grid, const vtkHyperTree* tree, unsigned int level,
179 unsigned char ichild);
180
181protected:
186};
187
188VTK_ABI_NAMESPACE_END
189#endif // vtkHyperTreeGridEntry_h
190// VTK-HeaderTest-Exclude: vtkHyperTreeGridEntry.h
Entries are cache data for cursors.
vtkHyperTreeGridEntry(vtkIdType index)
Constructor.
void SetMask(const vtkHyperTreeGrid *grid, const vtkHyperTree *tree, bool state)
Set the blanking mask is empty or not.
void Initialize(vtkIdType index)
Initialize cursor at root of given tree index in grid.
void ToChild(const vtkHyperTreeGrid *grid, const vtkHyperTree *tree, unsigned int level, unsigned char ichild)
Move the cursor to i-th child of the current cell.
vtkIdType GetVertexId() const
Return the index of the current vertex in the tree.
void PrintSelf(ostream &os, vtkIndent indent)
Display info about the entry.
bool IsLeaf(const vtkHyperTreeGrid *grid, const vtkHyperTree *tree, unsigned int level) const
Is the cursor pointing to a leaf?
vtkIdType Index
index of the current cell in the HyperTree.
~vtkHyperTreeGridEntry()=default
Destructor.
void SetGlobalIndexFromLocal(vtkHyperTree *tree, vtkIdType index)
Set the global index for the current cell of the HyperTree.
vtkHyperTreeGridEntry(vtkHyperTreeGridEntry const &)=default
bool IsRoot() const
Is the cursor at HyperTree root?
vtkHyperTreeGridEntry & operator=(vtkHyperTreeGridEntry const &)=default
void SetGlobalIndexStart(vtkHyperTree *tree, vtkIdType index)
Set the global index for the root cell of the HyperTree.
void Copy(const vtkHyperTreeGridEntry *entry)
Copy function.
bool IsMasked(const vtkHyperTreeGrid *grid, const vtkHyperTree *tree) const
Determine whether blanking mask is empty or not.
vtkHyperTree * Initialize(vtkHyperTreeGrid *grid, vtkIdType treeIndex, bool create=false)
Initialize cursor at root of given tree index in grid.
void Dump(ostream &os)
Dump information.
vtkIdType GetGlobalNodeIndex(const vtkHyperTree *tree) const
Return the global index for the current cell (cf.
void SubdivideLeaf(const vtkHyperTreeGrid *grid, vtkHyperTree *tree, unsigned int level)
Change the current cell's status: if leaf then becomes coarse and all its children are created,...
bool IsTerminalNode(const vtkHyperTreeGrid *grid, const vtkHyperTree *tree, unsigned int level) const
Is the cursor pointing to a coarse with all children being leaves?
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
int vtkIdType
Definition vtkType.h:332