vtkHyperTreeGridNonOrientedUnlimitedGeometryCursor.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkHyperTreeGridNonOrientedUnlimitedGeometryCursor_h
#define vtkHyperTreeGridNonOrientedUnlimitedGeometryCursor_h
 
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkObject.h"
 
#include "vtkHyperTreeGridGeometryUnlimitedLevelEntry.h" // cache for historic
#include "vtkHyperTreeGridTools.h"                       // for HasTree
#include "vtkSmartPointer.h"                             // Used internally
#include <memory>                                        // std::shared_ptr
#include <vector>                                        // std::vector
 
VTK_ABI_NAMESPACE_BEGIN
class vtkHyperTree;
class vtkHyperTreeGrid;
class vtkHyperTreeGridScales;
class vtkHyperTreeGridOrientedGeometryCursor;
class vtkHyperTreeGridNonOrientedGeometryCursor;
 
class VTKCOMMONDATAMODEL_EXPORT vtkHyperTreeGridNonOrientedUnlimitedGeometryCursor
  : public vtkObject
{
public:
  vtkTypeMacro(vtkHyperTreeGridNonOrientedUnlimitedGeometryCursor, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static vtkHyperTreeGridNonOrientedUnlimitedGeometryCursor* New();
 
  void Dump(ostream& os);
 
  virtual vtkHyperTreeGridNonOrientedUnlimitedGeometryCursor* Clone();
 
  void Initialize(vtkHyperTreeGrid* grid, vtkIdType treeIndex, bool create = false);
 
  void Initialize(vtkHyperTreeGrid* grid, vtkHyperTree* tree, unsigned int level,
    vtkHyperTreeGridGeometryUnlimitedLevelEntry& entry);
 
  void Initialize(vtkHyperTreeGrid* grid, vtkHyperTree* tree, unsigned int level, vtkIdType index,
    double* origin);
 
  void Initialize(vtkHyperTreeGridNonOrientedUnlimitedGeometryCursor* cursor);
 
 
  bool HasTree() const { return vtk::hypertreegrid::HasTree(*this); }
 
 
  vtkHyperTree* GetTree() const { return this->Tree; }
 
  vtkIdType GetVertexId();
 
  vtkIdType GetGlobalNodeIndex();
 
  unsigned char GetDimension();
 
  unsigned char GetNumberOfChildren();
 
  void SetGlobalIndexStart(vtkIdType index);
  void SetGlobalIndexFromLocal(vtkIdType index);
 
  double* GetOrigin();
  double* GetSize();
 
  void GetBounds(double bounds[6]);
  void GetPoint(double point[3]);
 
  void SetMask(bool state);
 
  bool IsMasked();
 
  bool IsLeaf();
 
  bool IsRealLeaf();
 
  bool IsVirtualLeaf();
 
  bool IsRoot();
 
  unsigned int GetLevel();
  unsigned int GetLastRealLevel();
 
  void ToChild(unsigned char ichild);
 
  void ToRoot();
 
  void ToParent();
 
  vtkSmartPointer<vtkHyperTreeGridOrientedGeometryCursor> GetHyperTreeGridOrientedGeometryCursor(
    vtkHyperTreeGrid* grid);
 
  vtkSmartPointer<vtkHyperTreeGridNonOrientedGeometryCursor>
  GetHyperTreeGridNonOrientedGeometryCursor(vtkHyperTreeGrid* grid);
 
protected:
  vtkHyperTreeGridNonOrientedUnlimitedGeometryCursor();
 
  ~vtkHyperTreeGridNonOrientedUnlimitedGeometryCursor() override;
 
  vtkHyperTreeGrid* Grid;
 
  vtkHyperTree* Tree;
 
  std::shared_ptr<vtkHyperTreeGridScales> Scales;
 
  unsigned int Level;
 
  int LastValidEntry;
 
  // Hyper tree grid to which the cursor is attached
  std::vector<vtkHyperTreeGridGeometryUnlimitedLevelEntry> Entries;
 
private:
  vtkHyperTreeGridNonOrientedUnlimitedGeometryCursor(
    const vtkHyperTreeGridNonOrientedUnlimitedGeometryCursor&) = delete;
  void operator=(const vtkHyperTreeGridNonOrientedUnlimitedGeometryCursor&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif