vtkHyperTreeCursor.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkHyperTreeCursor.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 vtkHyperTreeCursor_h
#define vtkHyperTreeCursor_h

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

enum
{
  VTK_3TREE_CHILD_ZMIN_YMIN_XMIN=0,
  VTK_3TREE_CHILD_ZMIN_YMIN_XMAX,
  VTK_3TREE_CHILD_ZMIN_YMAX_XMIN,
  VTK_3TREE_CHILD_ZMIN_YMAX_XMAX,
  VTK_3TREE_CHILD_ZMAX_YMIN_XMIN,
  VTK_3TREE_CHILD_ZMAX_YMIN_XMAX,
  VTK_3TREE_CHILD_ZMAX_YMAX_XMIN,
  VTK_3TREE_CHILD_ZMAX_YMAX_XMAX
};

const int VTK_2TREE_CHILD_SW=VTK_3TREE_CHILD_ZMIN_YMIN_XMIN;
const int VTK_2TREE_CHILD_SE=VTK_3TREE_CHILD_ZMIN_YMIN_XMAX;
const int VTK_2TREE_CHILD_NW=VTK_3TREE_CHILD_ZMIN_YMAX_XMIN;
const int VTK_2TREE_CHILD_NE=VTK_3TREE_CHILD_ZMIN_YMAX_XMAX;

const int VTK_1TREE_TREE_CHILD_LEFT=VTK_2TREE_CHILD_SW;
const int VTK_1TREE_TREE_CHILD_RIGHT=VTK_2TREE_CHILD_SE;

class vtkHyperTree;

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

  virtual vtkHyperTree* GetTree() = 0;

  virtual vtkIdType GetLeafId() = 0;

  virtual vtkIdType GetNodeId() = 0;

  virtual bool IsLeaf() = 0;

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

  virtual bool IsRoot() = 0;

  virtual int GetCurrentLevel() = 0;

  virtual int GetChildIndex() = 0;

  virtual void ToRoot() = 0;

  virtual void ToParent() = 0;

  virtual void ToChild( int child ) = 0;

  virtual void ToSameNode( vtkHyperTreeCursor* other ) = 0;

  virtual bool IsEqual( vtkHyperTreeCursor* other ) = 0;

  virtual vtkHyperTreeCursor* Clone() = 0;

  virtual int SameTree( vtkHyperTreeCursor* 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 bool Found() = 0;

protected:
  // Constructor.
  vtkHyperTreeCursor();
  ~vtkHyperTreeCursor() VTK_OVERRIDE;

private:
  vtkHyperTreeCursor(const vtkHyperTreeCursor&) VTK_DELETE_FUNCTION;
  void operator=(const vtkHyperTreeCursor&) VTK_DELETE_FUNCTION;
};
#endif