| VTK
    9.0.1
    | 
Entries are cache data for cursors. More...
#include <vtkHyperTreeGridEntry.h>
| Public Member Functions | |
| void | PrintSelf (ostream &os, vtkIndent indent) | 
| Display info about the entry.  More... | |
| void | Dump (ostream &os) | 
| Dump information.  More... | |
| vtkHyperTreeGridEntry () | |
| Constructor.  More... | |
| vtkHyperTreeGridEntry (vtkIdType index) | |
| Constructor.  More... | |
| ~vtkHyperTreeGridEntry ()=default | |
| Destructor.  More... | |
| vtkHyperTree * | Initialize (vtkHyperTreeGrid *grid, vtkIdType treeIndex, bool create=false) | 
| Initialize cursor at root of given tree index in grid.  More... | |
| void | Initialize (vtkIdType index) | 
| Initialize cursor at root of given tree index in grid.  More... | |
| void | Copy (const vtkHyperTreeGridEntry *entry) | 
| Copy function.  More... | |
| vtkIdType | GetVertexId () const | 
| Return the index of the current vertex in the tree.  More... | |
| vtkIdType | GetGlobalNodeIndex (const vtkHyperTree *tree) const | 
| Return the global index for the current cell (cf.  More... | |
| void | SetGlobalIndexStart (vtkHyperTree *tree, vtkIdType index) | 
| Set the global index for the root cell of the HyperTree.  More... | |
| void | SetGlobalIndexFromLocal (vtkHyperTree *tree, vtkIdType index) | 
| Set the global index for the current cell of the HyperTree.  More... | |
| void | SetMask (const vtkHyperTreeGrid *grid, const vtkHyperTree *tree, bool state) | 
| Set the blanking mask is empty or not.  More... | |
| bool | IsMasked (const vtkHyperTreeGrid *grid, const vtkHyperTree *tree) const | 
| Determine whether blanking mask is empty or not.  More... | |
| bool | IsLeaf (const vtkHyperTreeGrid *grid, const vtkHyperTree *tree, unsigned int level) const | 
| Is the cursor pointing to a leaf?  More... | |
| 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, cf.  More... | |
| bool | IsTerminalNode (const vtkHyperTreeGrid *grid, const vtkHyperTree *tree, unsigned int level) const | 
| Is the cursor pointing to a coarse with all childrens being leaves?  More... | |
| bool | IsRoot () const | 
| Is the cursor at HyperTree root?  More... | |
| 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.  More... | |
| Protected Attributes | |
| vtkIdType | Index | 
| index of the current cell in the HyperTree.  More... | |
Entries are cache data for cursors.
Entries are relevant for cursor/supercursor developers. Filters developers should have a look at cursors/supercursors documentation. (cf. vtkHyperTreeGridNonOrientedCursor). When writing a new cursor or supercursor the choice of the entry is very important: it will drive the performance and memory cost. This is even more important for supercursors which have several neighbors: 6x for VonNeuman and 26x for Moore.
Several types of Entries exist:
Definition at line 74 of file vtkHyperTreeGridEntry.h.
| 
 | inline | 
Constructor.
Definition at line 90 of file vtkHyperTreeGridEntry.h.
| 
 | inline | 
Constructor.
Definition at line 95 of file vtkHyperTreeGridEntry.h.
| 
 | default | 
Destructor.
| void vtkHyperTreeGridEntry::PrintSelf | ( | ostream & | os, | 
| vtkIndent | indent | ||
| ) | 
Display info about the entry.
| void vtkHyperTreeGridEntry::Dump | ( | ostream & | os | ) | 
Dump information.
| vtkHyperTree* vtkHyperTreeGridEntry::Initialize | ( | vtkHyperTreeGrid * | grid, | 
| vtkIdType | treeIndex, | ||
| bool | create = false | ||
| ) | 
Initialize cursor at root of given tree index in grid.
| 
 | inline | 
Initialize cursor at root of given tree index in grid.
Definition at line 110 of file vtkHyperTreeGridEntry.h.
| 
 | inline | 
Copy function.
Definition at line 115 of file vtkHyperTreeGridEntry.h.
| 
 | inline | 
Return the index of the current vertex in the tree.
Definition at line 120 of file vtkHyperTreeGridEntry.h.
| vtkIdType vtkHyperTreeGridEntry::GetGlobalNodeIndex | ( | const vtkHyperTree * | tree | ) | const | 
| void vtkHyperTreeGridEntry::SetGlobalIndexStart | ( | vtkHyperTree * | tree, | 
| vtkIdType | index | ||
| ) | 
Set the global index for the root cell of the HyperTree.
| void vtkHyperTreeGridEntry::SetGlobalIndexFromLocal | ( | vtkHyperTree * | tree, | 
| vtkIdType | index | ||
| ) | 
Set the global index for the current cell of the HyperTree.
| void vtkHyperTreeGridEntry::SetMask | ( | const vtkHyperTreeGrid * | grid, | 
| const vtkHyperTree * | tree, | ||
| bool | state | ||
| ) | 
Set the blanking mask is empty or not.
| bool vtkHyperTreeGridEntry::IsMasked | ( | const vtkHyperTreeGrid * | grid, | 
| const vtkHyperTree * | tree | ||
| ) | const | 
Determine whether blanking mask is empty or not.
| bool vtkHyperTreeGridEntry::IsLeaf | ( | const vtkHyperTreeGrid * | grid, | 
| const vtkHyperTree * | tree, | ||
| unsigned int | level | ||
| ) | const | 
Is the cursor pointing to a leaf?
| void vtkHyperTreeGridEntry::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, cf.
HyperTree.
| bool vtkHyperTreeGridEntry::IsTerminalNode | ( | const vtkHyperTreeGrid * | grid, | 
| const vtkHyperTree * | tree, | ||
| unsigned int | level | ||
| ) | const | 
Is the cursor pointing to a coarse with all childrens being leaves?
| 
 | inline | 
Is the cursor at HyperTree root?
Definition at line 178 of file vtkHyperTreeGridEntry.h.
| void vtkHyperTreeGridEntry::ToChild | ( | const vtkHyperTreeGrid * | grid, | 
| const vtkHyperTree * | tree, | ||
| unsigned int | level, | ||
| unsigned char | ichild | ||
| ) | 
Move the cursor to i-th child of the current cell.
| 
 | protected | 
index of the current cell in the HyperTree.
Definition at line 195 of file vtkHyperTreeGridEntry.h.
 1.8.17
 1.8.17