vtkHyperTreeGridOrientedGeometryCursor.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 vtkHyperTreeGridOrientedGeometryCursor_h
#define vtkHyperTreeGridOrientedGeometryCursor_h

#include "vtkCommonDataModelModule.h"      // For export macro
#include "vtkHyperTreeGridGeometryEntry.h" // Used internally
#include "vtkHyperTreeGridTools.h"         // for HasTree
#include "vtkObject.h"

#include <memory> // For std::shared_ptr
#include <vector> // For std::vector

VTK_ABI_NAMESPACE_BEGIN
class vtkHyperTree;
class vtkHyperTreeGrid;
class vtkHyperTreeGridScales;

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

  void Dump(ostream& os);

  virtual vtkHyperTreeGridOrientedGeometryCursor* Clone();

  void Initialize(vtkHyperTreeGrid* grid, vtkIdType treeIndex, bool create = false);


  void Initialize(vtkHyperTreeGrid* grid, vtkHyperTree* tree, unsigned int level,
    vtkHyperTreeGridGeometryEntry& entry);
  void Initialize(vtkHyperTreeGrid* grid, vtkHyperTree* tree, unsigned int level, vtkIdType index,
    double* origin);
  void Initialize(vtkHyperTreeGridOrientedGeometryCursor* 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();

  void SubdivideLeaf();

  bool IsRoot();

  unsigned int GetLevel();

  void ToChild(unsigned char ichild);

protected:
  vtkHyperTreeGridOrientedGeometryCursor();

  ~vtkHyperTreeGridOrientedGeometryCursor() override;

  vtkHyperTreeGrid* Grid;

  vtkHyperTree* Tree;

  std::shared_ptr<vtkHyperTreeGridScales> Scales;

  unsigned int Level;

  // Hyper tree grid to which the cursor is attached
  vtkHyperTreeGridGeometryEntry Entry;

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