VTK  9.2.6
vtkHyperTreeCursor.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkHyperTreeCursor.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 =========================================================================*/
34 #ifndef vtkHyperTreeCursor_h
35 #define vtkHyperTreeCursor_h
36 
37 #include "vtkCommonDataModelModule.h" // For export macro
38 #include "vtkDeprecation.h" // For deprecation
39 #include "vtkObject.h"
40 
41 class vtkHyperTree;
42 
44  "Use other Hyper Tree Grid cursors instead.") VTKCOMMONDATAMODEL_EXPORT vtkHyperTreeCursor
45  : public vtkObject
46 {
47 public:
48  vtkTypeMacro(vtkHyperTreeCursor, vtkObject);
49  void PrintSelf(ostream& os, vtkIndent indent) override;
50 
54  virtual void SetTree(vtkHyperTree*) = 0;
55 
59  virtual vtkHyperTree* GetTree() = 0;
60 
64  virtual vtkIdType GetVertexId() = 0;
65 
69  virtual bool IsLeaf() = 0;
70 
74  virtual bool IsRoot() = 0;
75 
80  virtual unsigned int GetLevel() = 0;
81 
87  virtual int GetChildIndex() = 0;
88 
94  virtual void ToRoot() = 0;
95 
100  virtual void ToParent() = 0;
101 
107  virtual void ToChild(int child) = 0;
108 
115  virtual void ToSameVertex(vtkHyperTreeCursor* other) = 0;
116 
122  virtual bool IsEqual(vtkHyperTreeCursor* other) = 0;
123 
129  virtual vtkHyperTreeCursor* Clone() = 0;
130 
135  virtual int SameTree(vtkHyperTreeCursor* other) = 0;
136 
141  virtual int GetNumberOfChildren() = 0;
142 
147  virtual int GetDimension() = 0;
148 
149 protected:
150  // Constructor
153 
154 private:
155  vtkHyperTreeCursor(const vtkHyperTreeCursor&) = delete;
156  void operator=(const vtkHyperTreeCursor&) = delete;
157 };
158 #endif
159 // 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:180
a simple class to control print indentation
Definition: vtkIndent.h:119
abstract base class for most VTK objects
Definition: vtkObject.h:82
#define VTK_DEPRECATED_IN_9_2_0(reason)
int vtkIdType
Definition: vtkType.h:332