VTK
vtkHyperOctreeCursor.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkHyperOctreeCursor.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 =========================================================================*/
25 #ifndef vtkHyperOctreeCursor_h
26 #define vtkHyperOctreeCursor_h
27 
28 #include "vtkCommonDataModelModule.h" // For export macro
29 #include "vtkObject.h"
30 
31 #if !defined(VTK_LEGACY_REMOVE)
32 enum
33 {
42 };
43 
48 
51 
52 class VTKCOMMONDATAMODEL_EXPORT vtkHyperOctreeCursor : public vtkObject
53 {
54 public:
56  void PrintSelf(ostream& os, vtkIndent indent) override;
57 
62  virtual int GetLeafId()=0;
63 
67  virtual int CurrentIsLeaf()=0;
68 
72  virtual int CurrentIsRoot()=0;
73 
78  virtual int GetCurrentLevel()=0;
79 
85  virtual int GetChildIndex()=0;
86 
87  // Are the children of the current node all leaves?
88  // This query can be called also on a leaf node.
89  // \post compatible: result implies !CurrentIsLeaf()
90  virtual int CurrentIsTerminalNode()=0;
91 
97  virtual void ToRoot()=0;
98 
103  virtual void ToParent()=0;
104 
110  virtual void ToChild(int child)=0;
111 
118  virtual void ToSameNode(vtkHyperOctreeCursor *other)=0;
119 
125  virtual int IsEqual(vtkHyperOctreeCursor *other)=0;
126 
132  virtual vtkHyperOctreeCursor *Clone()=0;
133 
138  virtual int SameTree(vtkHyperOctreeCursor *other)=0;
139 
146  virtual int GetIndex(int d)=0;
147 
152  virtual int GetNumberOfChildren()=0;
153 
158  virtual int GetDimension()=0;
159 
170  virtual void MoveToNode(int *indices,
171  int level)=0;
172 
176  virtual int Found()=0;
177 
178 protected:
179  // Constructor.
181  ~vtkHyperOctreeCursor() override;
182 private:
184  void operator=(const vtkHyperOctreeCursor&) = delete;
185 };
186 #endif // LEGACY remove
187 
188 #endif
const int VTK_QUADTREE_CHILD_NE
abstract base class for most VTK objects
Definition: vtkObject.h:59
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
const int VTK_QUADTREE_CHILD_NW
const int VTK_QUADTREE_CHILD_SW
a simple class to control print indentation
Definition: vtkIndent.h:39
const int VTK_QUADTREE_CHILD_SE
const int VTK_BINARY_TREE_CHILD_RIGHT
Objects that can traverse hyperoctree nodes.
const int VTK_BINARY_TREE_CHILD_LEFT