vtkHyperTreeGridNonOrientedUnlimitedSuperCursor.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 vtkHyperTreeGridNonOrientedUnlimitedSuperCursor_h
#define vtkHyperTreeGridNonOrientedUnlimitedSuperCursor_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkObject.h"
#include "vtkSmartPointer.h" // Used internally

#include "vtkHyperTreeGridGeometryUnlimitedLevelEntry.h" // Used Internally

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

VTK_ABI_NAMESPACE_BEGIN
class vtkHyperTree;
class vtkHyperTreeGrid;
class vtkHyperTreeGridNonOrientedGeometryCursor;
class vtkHyperTreeGridOrientedGeometryCursor;
class vtkHyperTreeGridNonOrientedUnlimitedGeometryCursor;

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

  virtual vtkHyperTreeGridNonOrientedUnlimitedSuperCursor* Clone();

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


  vtkHyperTreeGrid* GetGrid();


  bool HasTree();

  bool HasTree(unsigned int icursor);


  vtkHyperTree* GetTree();
  vtkHyperTree* GetTree(unsigned int icursor);


  vtkIdType GetVertexId();
  vtkIdType GetVertexId(unsigned int icursor);

  vtkIdType GetGlobalNodeIndex();

  vtkIdType GetGlobalNodeIndex(unsigned int icursor);

  vtkHyperTree* GetInformation(
    unsigned int icursor, unsigned int& level, bool& leaf, vtkIdType& id);

  unsigned char GetDimension();

  unsigned char GetNumberOfChildren();

  void SetGlobalIndexStart(vtkIdType index);

  void SetGlobalIndexFromLocal(vtkIdType index);

  double* GetOrigin();
  double* GetSize();

  void SetMask(bool state);
  void SetMask(unsigned int icursor, bool state);

  bool IsMasked();
  bool IsMasked(unsigned int icursor);

  void GetBounds(double bounds[6]);
  void GetBounds(unsigned int icursor, double bounds[6]);

  void GetPoint(double point[3]);
  void GetPoint(unsigned int icursor, double point[3]);


  bool IsLeaf();
  bool IsLeaf(unsigned int icursor);
  bool IsRealLeaf();
  bool IsRealLeaf(unsigned int icursor);


  bool IsVirtualLeaf();
  bool IsVirtualLeaf(unsigned int icursor);


  double GetExtensivePropertyRatio();
  double GetExtensivePropertyRatio(vtkIdType index);

  bool IsRoot();


  unsigned int GetLevel();
  unsigned int GetLevel(unsigned int icursor);
  unsigned int GetLastRealLevel();
  unsigned int GetLastRealLevel(unsigned int icursor);

  void ToChild(unsigned char ichild);

  void ToRoot();

  void ToParent();

  unsigned int GetNumberOfCursors() { return this->NumberOfCursors; }

  vtkSmartPointer<vtkHyperTreeGridOrientedGeometryCursor> GetOrientedGeometryCursor(
    unsigned int icursor);

  vtkSmartPointer<vtkHyperTreeGridNonOrientedGeometryCursor> GetNonOrientedGeometryCursor(
    unsigned int icursor);

protected:
  vtkHyperTreeGridNonOrientedUnlimitedSuperCursor();

  ~vtkHyperTreeGridNonOrientedUnlimitedSuperCursor() override;

  vtkHyperTreeGrid* Grid = nullptr;

  vtkSmartPointer<vtkHyperTreeGridNonOrientedUnlimitedGeometryCursor> CentralCursor;

  unsigned int CurrentFirstNonValidEntryByLevel = 0;
  std::vector<unsigned int> FirstNonValidEntryByLevel;
  std::vector<vtkHyperTreeGridGeometryUnlimitedLevelEntry> Entries;

  unsigned int FirstCurrentNeighboorReferenceEntry = 0;
  std::vector<unsigned int> ReferenceEntries;

  unsigned int GetIndiceEntry(unsigned int icursor);

  unsigned int GetIndicePreviousEntry(unsigned int icursor);

  unsigned int IndiceCentralCursor = 0;

  // Number of cursors in supercursor
  unsigned int NumberOfCursors = 0;

  // Super cursor traversal table to go retrieve the parent index for each cursor
  // of the child node. There are f^d * NumberOfCursors entries in the table.
  const unsigned int* ChildCursorToParentCursorTable = nullptr;

  // Super cursor traversal table to go retrieve the child index for each cursor
  // of the child node. There are f^d * NumberOfCursors entries in the table.
  const unsigned int* ChildCursorToChildTable = nullptr;

private:
  vtkHyperTreeGridNonOrientedUnlimitedSuperCursor(
    const vtkHyperTreeGridNonOrientedUnlimitedSuperCursor&) = delete;
  void operator=(const vtkHyperTreeGridNonOrientedUnlimitedSuperCursor&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif