vtkHyperOctreeCursor.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkHyperOctreeCursor.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkHyperOctreeCursor_h
#define vtkHyperOctreeCursor_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkObject.h"

enum
{
  VTK_OCTREE_CHILD_ZMIN_YMIN_XMIN=0,
  VTK_OCTREE_CHILD_ZMIN_YMIN_XMAX,
  VTK_OCTREE_CHILD_ZMIN_YMAX_XMIN,
  VTK_OCTREE_CHILD_ZMIN_YMAX_XMAX,
  VTK_OCTREE_CHILD_ZMAX_YMIN_XMIN,
  VTK_OCTREE_CHILD_ZMAX_YMIN_XMAX,
  VTK_OCTREE_CHILD_ZMAX_YMAX_XMIN,
  VTK_OCTREE_CHILD_ZMAX_YMAX_XMAX
};

const int VTK_QUADTREE_CHILD_SW=VTK_OCTREE_CHILD_ZMIN_YMIN_XMIN;
const int VTK_QUADTREE_CHILD_SE=VTK_OCTREE_CHILD_ZMIN_YMIN_XMAX;
const int VTK_QUADTREE_CHILD_NW=VTK_OCTREE_CHILD_ZMIN_YMAX_XMIN;
const int VTK_QUADTREE_CHILD_NE=VTK_OCTREE_CHILD_ZMIN_YMAX_XMAX;

const int VTK_BINARY_TREE_CHILD_LEFT=VTK_QUADTREE_CHILD_SW;
const int VTK_BINARY_TREE_CHILD_RIGHT=VTK_QUADTREE_CHILD_SE;

class VTKCOMMONDATAMODEL_EXPORT vtkHyperOctreeCursor : public vtkObject
{
public:
  vtkTypeMacro(vtkHyperOctreeCursor,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  virtual int GetLeafId()=0;

  virtual int CurrentIsLeaf()=0;

  virtual int CurrentIsRoot()=0;

  virtual int GetCurrentLevel()=0;

  virtual int GetChildIndex()=0;

  // Are the children of the current node all leaves?
  // This query can be called also on a leaf node.
  // \post compatible: result implies !CurrentIsLeaf()
  virtual int CurrentIsTerminalNode()=0;

  virtual void ToRoot()=0;

  virtual void ToParent()=0;

  virtual void ToChild(int child)=0;

  virtual void ToSameNode(vtkHyperOctreeCursor *other)=0;

  virtual int IsEqual(vtkHyperOctreeCursor *other)=0;

  virtual vtkHyperOctreeCursor *Clone()=0;

  virtual int SameTree(vtkHyperOctreeCursor *other)=0;

  virtual int GetIndex(int d)=0;

  virtual int GetNumberOfChildren()=0;

  virtual int GetDimension()=0;

  virtual void MoveToNode(int *indices,
                          int level)=0;

  virtual int Found()=0;

protected:
  // Constructor.
  vtkHyperOctreeCursor();
  ~vtkHyperOctreeCursor() VTK_OVERRIDE;
private:
  vtkHyperOctreeCursor(const vtkHyperOctreeCursor&) VTK_DELETE_FUNCTION;
  void operator=(const vtkHyperOctreeCursor&) VTK_DELETE_FUNCTION;
};
#endif