VTK  9.3.0
vtkHyperTreeCursor.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
22 #ifndef vtkHyperTreeCursor_h
23 #define vtkHyperTreeCursor_h
24 
25 #include "vtkCommonDataModelModule.h" // For export macro
26 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
27 #include "vtkObject.h"
28 
29 VTK_ABI_NAMESPACE_BEGIN
30 class vtkHyperTree;
31 
33  "Use other Hyper Tree Grid cursors instead.") VTKCOMMONDATAMODEL_EXPORT vtkHyperTreeCursor
34  : public vtkObject
35 {
36 public:
37  vtkTypeMacro(vtkHyperTreeCursor, vtkObject);
38  void PrintSelf(ostream& os, vtkIndent indent) override;
39 
43  virtual void SetTree(vtkHyperTree*) = 0;
44 
48  virtual vtkHyperTree* GetTree() = 0;
49 
53  virtual vtkIdType GetVertexId() = 0;
54 
58  virtual bool IsLeaf() = 0;
59 
63  virtual bool IsRoot() = 0;
64 
69  virtual unsigned int GetLevel() = 0;
70 
76  virtual int GetChildIndex() = 0;
77 
83  virtual void ToRoot() = 0;
84 
89  virtual void ToParent() = 0;
90 
96  virtual void ToChild(int child) = 0;
97 
104  virtual void ToSameVertex(vtkHyperTreeCursor* other) = 0;
105 
111  virtual bool IsEqual(vtkHyperTreeCursor* other) = 0;
112 
118  virtual vtkHyperTreeCursor* Clone() = 0;
119 
124  virtual int SameTree(vtkHyperTreeCursor* other) = 0;
125 
130  virtual int GetNumberOfChildren() = 0;
131 
136  virtual int GetDimension() = 0;
137 
138 protected:
139  // Constructor
142 
143 private:
144  vtkHyperTreeCursor(const vtkHyperTreeCursor&) = delete;
145  void operator=(const vtkHyperTreeCursor&) = delete;
146 };
147 VTK_ABI_NAMESPACE_END
148 #endif
149 // VTK-HeaderTest-Exclude: vtkHyperTreeCursor.h
Objects for depth-first traversal HyperTrees.
virtual int SameTree(vtkHyperTreeCursor *other)=0
Are ‘this’ and ‘other’ pointing on the same hypertree?
virtual void ToParent()=0
Move the cursor to the parent of the current vertex.
virtual bool IsRoot()=0
Is the cursor at tree root?
virtual vtkHyperTree * GetTree()=0
Return the HyperTree to which the cursor is pointing.
~vtkHyperTreeCursor() override
virtual void SetTree(vtkHyperTree *)=0
Set the HyperTree to which the cursor is pointing.
virtual void ToChild(int child)=0
Move the cursor to child ‘child’ of the current vertex.
virtual void ToSameVertex(vtkHyperTreeCursor *other)=0
Move the cursor to the same vertex pointed by ‘other’.
virtual int GetChildIndex()=0
Return the child number of the current vertex relative to its parent.
virtual bool IsEqual(vtkHyperTreeCursor *other)=0
Is ‘this’ equal to ‘other’?
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual int GetDimension()=0
Return the dimension of the tree.
virtual void ToRoot()=0
Move the cursor to the root vertex.
virtual vtkHyperTreeCursor * Clone()=0
Create a copy of ‘this’.
virtual unsigned int GetLevel()=0
Return the level of the vertex pointed by the cursor.
virtual vtkIdType GetVertexId()=0
Return the index of the current vertex in the tree.
virtual int GetNumberOfChildren()=0
Return the number of children for each node (non-vertex leaf) of the tree.
virtual bool IsLeaf()=0
Is the cursor pointing to a leaf?
A data object structured as a tree.
Definition: vtkHyperTree.h:169
a simple class to control print indentation
Definition: vtkIndent.h:29
abstract base class for most VTK objects
Definition: vtkObject.h:52
#define VTK_DEPRECATED_IN_9_2_0(reason)
int vtkIdType
Definition: vtkType.h:315