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"

class vtkHyperTree;

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

  virtual void SetTree( vtkHyperTree* ) = 0;

  virtual vtkHyperTree* GetTree() = 0;

  virtual vtkIdType GetVertexId() = 0;

  virtual bool IsLeaf() = 0;

  virtual bool IsRoot() = 0;

  virtual unsigned int GetLevel() = 0;

  virtual int GetChildIndex() = 0;

  virtual void ToRoot() = 0;

  virtual void ToParent() = 0;

  virtual void ToChild( int child ) = 0;

  virtual void ToSameVertex( vtkHyperTreeCursor* other ) = 0;

  virtual bool IsEqual( vtkHyperTreeCursor* other ) = 0;

  virtual vtkHyperTreeCursor* Clone() = 0;

  virtual int SameTree( vtkHyperTreeCursor* other ) = 0;

  virtual int GetNumberOfChildren() = 0;

  virtual int GetDimension() = 0;

protected:
  // Constructor
  vtkHyperTreeCursor();
  ~vtkHyperTreeCursor() override;

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