vtkHyperTreeGridNonOrientedCursor.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkHyperTreeGridNonOrientedCursor.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 Nonice for more information.
 
=========================================================================*/
#ifndef vtkHyperTreeGridNonOrientedCursor_h
#define vtkHyperTreeGridNonOrientedCursor_h
 
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkObject.h"
 
#include <vector> // For std::vector
 
class vtkHyperTree;
class vtkHyperTreeGrid;
class vtkHyperTreeGridEntry;
 
class VTKCOMMONDATAMODEL_EXPORT vtkHyperTreeGridNonOrientedCursor : public vtkObject
{
public:
  vtkTypeMacro(vtkHyperTreeGridNonOrientedCursor, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static vtkHyperTreeGridNonOrientedCursor* New();
 
  vtkHyperTreeGridNonOrientedCursor* Clone();
 
  void Initialize(vtkHyperTreeGrid* grid, vtkIdType treeIndex, bool create = false);
 
  void Initialize(
    vtkHyperTreeGrid* grid, vtkHyperTree* tree, unsigned int level, vtkHyperTreeGridEntry& entry);
 
  void Initialize(vtkHyperTreeGrid* grid, vtkHyperTree* tree, unsigned int level, vtkIdType index);
 
 
  vtkHyperTreeGrid* GetGrid();
 
 
  bool HasTree() const;
 
 
  vtkHyperTree* GetTree() const;
 
  vtkIdType GetVertexId();
 
  vtkIdType GetGlobalNodeIndex();
 
  unsigned char GetDimension();
 
  unsigned char GetNumberOfChildren();
 
  void SetGlobalIndexStart(vtkIdType index);
 
  void SetGlobalIndexFromLocal(vtkIdType index);
 
  void SetMask(bool state);
 
  bool IsMasked();
 
  bool IsLeaf();
 
  void SubdivideLeaf();
 
  bool IsRoot();
 
  unsigned int GetLevel();
 
  void ToChild(unsigned char ichild);
 
  void ToRoot();
 
  void ToParent();
 
protected:
  vtkHyperTreeGridNonOrientedCursor();
 
  ~vtkHyperTreeGridNonOrientedCursor() override;
 
  vtkHyperTreeGrid* Grid;
 
  vtkHyperTree* Tree;
 
  unsigned int Level;
 
  int LastValidEntry;
 
  std::vector<vtkHyperTreeGridEntry> Entries;
 
private:
  vtkHyperTreeGridNonOrientedCursor(const vtkHyperTreeGridNonOrientedCursor&) = delete;
  void operator=(const vtkHyperTreeGridNonOrientedCursor&) = delete;
};
#endif