VTK  9.1.0
vtkHyperTreeGridOrientedCursor.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkHyperTreeGridOrientedCursor.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=========================================================================*/
38#ifndef vtkHyperTreeGridOrientedCursor_h
39#define vtkHyperTreeGridOrientedCursor_h
40
41#include "vtkCommonDataModelModule.h" // For export macro
42#include "vtkHyperTreeGridEntry.h" // Used internally
43#include "vtkObject.h"
44
45class vtkHyperTree;
47
48class VTKCOMMONDATAMODEL_EXPORT vtkHyperTreeGridOrientedCursor : public vtkObject
49{
50public:
52 void PrintSelf(ostream& os, vtkIndent indent) override;
54
60
64 void Initialize(vtkHyperTreeGrid* grid, vtkIdType treeIndex, bool create = false);
65
69 void Initialize(vtkHyperTreeGrid* grid, vtkHyperTree* tree, unsigned int level, vtkIdType index);
70
75 vtkHyperTreeGrid* grid, vtkHyperTree* tree, unsigned int level, vtkHyperTreeGridEntry& entry);
76
78
83
85
88 bool HasTree() const;
90
92
97
102
108
113 unsigned char GetDimension();
114
119 unsigned char GetNumberOfChildren();
120
125
130
135 void SetMask(bool state);
136
140 bool IsMasked();
141
145 bool IsLeaf();
146
151
155 bool IsRoot();
156
160 unsigned int GetLevel();
161
169 void ToChild(unsigned char ichild);
170
171protected:
176
181
186
191
195 unsigned int Level;
196
197 // Hyper tree grid to which the cursor is attached
199
200private:
202 void operator=(const vtkHyperTreeGridOrientedCursor&) = delete;
203};
204#endif
Entries are cache data for cursors.
Objects for traversal a HyperTreeGrid.
vtkHyperTreeGridOrientedCursor()
Constructor.
void SetGlobalIndexStart(vtkIdType index)
JB.
vtkHyperTreeGrid * GetGrid()
Set the hyper tree grid to which the cursor is pointing.
bool IsMasked()
Determine whether blanking mask is empty or not.
unsigned int GetLevel()
Get the level of the tree vertex pointed by the cursor.
bool IsRoot()
Is the cursor at tree root?
vtkHyperTreeGridOrientedCursor * Clone()
Create a copy of ‘this’.
void Initialize(vtkHyperTreeGrid *grid, vtkHyperTree *tree, unsigned int level, vtkIdType index)
JB.
vtkIdType GetVertexId()
Return the index of the current vertex in the tree.
void SetMask(bool state)
Set the blanking mask is empty or not.
vtkIdType GetGlobalNodeIndex()
Return the global index (relative to the grid) of the current vertex in the tree.
void ToChild(unsigned char ichild)
Move the cursor to child ‘child’ of the current vertex.
void SetGlobalIndexFromLocal(vtkIdType index)
JB.
vtkHyperTreeGrid * Grid
JB Reference sur l'hyper tree grid parcouru actuellement.
~vtkHyperTreeGridOrientedCursor() override
Destructor.
void Initialize(vtkHyperTreeGrid *grid, vtkIdType treeIndex, bool create=false)
Initialize cursor at root of given tree index in grid.
bool HasTree() const
Return if a Tree pointing exist.
unsigned char GetNumberOfChildren()
Return the number of children for each node (non-vertex leaf) of the tree.
bool IsLeaf()
Is the cursor pointing to a leaf?
void Initialize(vtkHyperTreeGrid *grid, vtkHyperTree *tree, unsigned int level, vtkHyperTreeGridEntry &entry)
JB.
vtkHyperTree * GetTree() const
Set the hyper tree to which the cursor is pointing.
unsigned char GetDimension()
Return the dimension of the tree.
static vtkHyperTreeGridOrientedCursor * New()
void SubdivideLeaf()
JB Fait chier normalement on devrait passer par GetEntry.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
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