vtkHyperTreeGridCursor.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 vtkHyperTreeGridCursor_h
#define vtkHyperTreeGridCursor_h

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

class vtkHyperTree;
class vtkHyperTreeGrid;
class vtkIdList;

class VTKCOMMONDATAMODEL_EXPORT vtkHyperTreeGridCursor : public vtkHyperTreeCursor
{
public:
  vtkTypeMacro(vtkHyperTreeGridCursor, vtkHyperTreeCursor);
  void PrintSelf( ostream& os, vtkIndent indent ) override;
  static vtkHyperTreeGridCursor* New();

  vtkHyperTreeGridCursor* Clone() override;

  virtual void Initialize( vtkHyperTreeGrid*, vtkIdType );


  virtual void SetGrid( vtkHyperTreeGrid* );
  vtkGetObjectMacro(Grid,vtkHyperTreeGrid);


  void SetTree( vtkHyperTree* ) override;
  vtkHyperTree* GetTree() override {return this->Tree;};
  //vtkGetObjectMacro(Tree,vtkHyperTree);

  vtkIdType GetVertexId() override;

  virtual vtkIdType GetGlobalNodeIndex();

  bool IsLeaf() override;

  bool IsRoot() override;

  unsigned int GetLevel() override {return this->Level;};

  int GetChildIndex() override;

  void ToRoot() override;

  void ToParent() override;

  void ToChild( int child ) override;

  void ToSameVertex( vtkHyperTreeCursor* vtkNotUsed(other) ) override { return; }

  bool IsEqual( vtkHyperTreeCursor* vtkNotUsed(other) ) override { return false; }

  int SameTree( vtkHyperTreeCursor* vtkNotUsed(other) ) override { return 0; }

  int GetNumberOfChildren() override;

  int GetDimension() override;

  virtual double* GetOrigin() { return nullptr; }

  virtual double* GetSize() { return nullptr; }

  virtual void GetBounds( double pt[6] )
    { pt[0] = pt[1] = pt[2] = pt[3] = pt[4] = pt[5] = 0.; }

  virtual void GetPoint( double pt[3] ) { pt[0] = pt[1] = pt[2] = 0.; }

  virtual unsigned int GetNumberOfCursors() { return 0; }

  virtual vtkHyperTreeGridCursor* GetCursor( unsigned int )
    { return nullptr; }

  virtual bool GetCornerCursors( unsigned int, unsigned int, vtkIdList* )
    { return false; }

protected:
  vtkHyperTreeGridCursor();

  ~vtkHyperTreeGridCursor() override;

  // Hyper tree grid to which the cursor is attached
  vtkHyperTreeGrid* Grid;

  // Hyper tree to which the cursor is attached
  vtkHyperTree* Tree;

  // Level in the tree at which the cursor is positioned
  unsigned int Level;

  // Index either in the nodes or parent (if leaf)
  vtkIdType Index;

  // Is center of cursor at a leaf?
  bool Leaf;

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