VTK  9.1.0
vtkHyperTreeGridNonOrientedCursor.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkHyperTreeGridNonOrientedCursor.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 Nonice for more information.
13
14=========================================================================*/
38#ifndef vtkHyperTreeGridNonOrientedCursor_h
39#define vtkHyperTreeGridNonOrientedCursor_h
40
41#include "vtkCommonDataModelModule.h" // For export macro
42#include "vtkObject.h"
43
44#include <vector> // For std::vector
45
46class vtkHyperTree;
49
50class VTKCOMMONDATAMODEL_EXPORT vtkHyperTreeGridNonOrientedCursor : public vtkObject
51{
52public:
54 void PrintSelf(ostream& os, vtkIndent indent) override;
56
62
66 void Initialize(vtkHyperTreeGrid* grid, vtkIdType treeIndex, bool create = false);
67
72 vtkHyperTreeGrid* grid, vtkHyperTree* tree, unsigned int level, vtkHyperTreeGridEntry& entry);
73
77 void Initialize(vtkHyperTreeGrid* grid, vtkHyperTree* tree, unsigned int level, vtkIdType index);
78
80
85
87
90 bool HasTree() const;
92
94
99
104
110
115 unsigned char GetDimension();
116
121 unsigned char GetNumberOfChildren();
122
127
132
137 void SetMask(bool state);
138
142 bool IsMasked();
143
147 bool IsLeaf();
148
153
157 bool IsRoot();
158
162 unsigned int GetLevel();
163
171 void ToChild(unsigned char ichild);
172
178 void ToRoot();
179
185 void ToParent();
186
187protected:
192
197
202
207
211 unsigned int Level;
212
217
221 std::vector<vtkHyperTreeGridEntry> Entries;
222
223private:
225 void operator=(const vtkHyperTreeGridNonOrientedCursor&) = delete;
226};
227#endif
Entries are cache data for cursors.
Objects for traversal a HyperTreeGrid.
void Initialize(vtkHyperTreeGrid *grid, vtkHyperTree *tree, unsigned int level, vtkIdType index)
Initialize cursor at root of given tree index in grid.
vtkHyperTreeGrid * GetGrid()
Set the hyper tree grid to which the cursor is pointing.
static vtkHyperTreeGridNonOrientedCursor * New()
~vtkHyperTreeGridNonOrientedCursor() override
Destructor.
void ToChild(unsigned char ichild)
Move the cursor to child ‘child’ of the current vertex.
vtkHyperTreeGrid * Grid
JB Reference sur l'hyper tree grid parcouru actuellement.
int LastValidEntry
JB Le dernier noeud valid enregistre.
void SetMask(bool state)
Set the blanking mask is empty or not.
bool IsRoot()
Is the cursor at tree root?
unsigned int GetLevel()
Get the level of the tree vertex pointed by the cursor.
void ToRoot()
Move the cursor to the root vertex.
unsigned char GetNumberOfChildren()
Return the number of children for each node (non-vertex leaf) of the tree.
void Initialize(vtkHyperTreeGrid *grid, vtkHyperTree *tree, unsigned int level, vtkHyperTreeGridEntry &entry)
Initialize cursor at root of given tree index in grid.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
unsigned char GetDimension()
Return the dimension of the tree.
bool HasTree() const
Return if a Tree pointing exist.
bool IsMasked()
Determine whether blanking mask is empty or not.
void SetGlobalIndexStart(vtkIdType index)
JB.
vtkHyperTreeGridNonOrientedCursor()
Constructor.
vtkIdType GetVertexId()
Return the index of the current vertex in the tree.
bool IsLeaf()
Is the cursor pointing to a leaf?
vtkIdType GetGlobalNodeIndex()
Return the global index (relative to the grid) of the current vertex in the tree.
void SetGlobalIndexFromLocal(vtkIdType index)
JB.
void Initialize(vtkHyperTreeGrid *grid, vtkIdType treeIndex, bool create=false)
Initialize cursor at root of given tree index in grid.
vtkHyperTreeGridNonOrientedCursor * Clone()
Create a copy of ‘this’.
std::vector< vtkHyperTreeGridEntry > Entries
JB Hyper tree grid to which the cursor is attached.
vtkHyperTree * GetTree() const
Set the hyper tree to which the cursor is pointing.
void ToParent()
Move the cursor to the parent of the current vertex.
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
abstract base class for most VTK objects
Definition: vtkObject.h:82
int vtkIdType
Definition: vtkType.h:332