vtkHyperTreeGridNonOrientedSuperCursorLight.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 vtkHyperTreeGridNonOrientedSuperCursorLight_h
#define vtkHyperTreeGridNonOrientedSuperCursorLight_h

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

#include "vtkHyperTreeGridLevelEntry.h" // Used internally

#include <cassert> // Used internally
#include <vector>  // std::vector

VTK_ABI_NAMESPACE_BEGIN
class vtkHyperTree;
class vtkHyperTreeGrid;
class vtkHyperTreeGridNonOrientedGeometryCursor;

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

  virtual vtkHyperTreeGridNonOrientedSuperCursorLight* 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 GetPoint(double point[3]);

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

  void SubdivideLeaf();

  bool IsRoot();

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

  void ToChild(unsigned char);

  void ToRoot();

  void ToParent();

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

protected:
  vtkHyperTreeGridNonOrientedSuperCursorLight();

  ~vtkHyperTreeGridNonOrientedSuperCursorLight() override;

  vtkHyperTreeGrid* Grid;

  vtkSmartPointer<vtkHyperTreeGridNonOrientedGeometryCursor> CentralCursor;

  unsigned int CurrentFirstNonValidEntryByLevel;
  std::vector<unsigned int> FirstNonValidEntryByLevel;
  std::vector<vtkHyperTreeGridLevelEntry> Entries;

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

  unsigned int GetIndiceEntry(unsigned int icursor)
  {
    assert("pre: icursor != IndiceCentralCursor" && icursor != this->IndiceCentralCursor);
    assert("pre: valid_icursor" && icursor < this->NumberOfCursors);
    if (icursor > this->IndiceCentralCursor)
    {
      assert("pre: valid_icursor" &&
        0 <= long(this->FirstCurrentNeighboorReferenceEntry + icursor) - 1 &&
        long(this->FirstCurrentNeighboorReferenceEntry + icursor) - 1 <
          long(this->ReferenceEntries.size()));
      assert("pre: valid_icursor" &&
        this->ReferenceEntries[this->FirstCurrentNeighboorReferenceEntry + icursor - 1] <
          this->Entries.size());
      return this->ReferenceEntries[this->FirstCurrentNeighboorReferenceEntry + icursor - 1];
    }
    else
    {
      assert("pre: valid_icursor" &&
        this->FirstCurrentNeighboorReferenceEntry + icursor < this->ReferenceEntries.size());
      assert("pre: valid_icursor" &&
        this->ReferenceEntries[this->FirstCurrentNeighboorReferenceEntry + icursor] <
          this->Entries.size());
      return this->ReferenceEntries[this->FirstCurrentNeighboorReferenceEntry + icursor];
    }
  }

  unsigned int GetIndicePreviousEntry(unsigned int icursor)
  {
    assert("pre: icursor != IndiceCentralCursor" && icursor != IndiceCentralCursor);
    assert("pre: valid_icursor" && icursor < this->NumberOfCursors);
    if (icursor > this->IndiceCentralCursor)
    {
      assert("pre: valid_icursor" &&
        0 <=
          long(this->FirstCurrentNeighboorReferenceEntry - (this->NumberOfCursors - 1) + icursor) -
            1 &&
        long(this->FirstCurrentNeighboorReferenceEntry - (this->NumberOfCursors - 1) + icursor) -
            1 <
          long(this->ReferenceEntries.size()));
      assert("pre: valid_icursor" &&
        this->ReferenceEntries[this->FirstCurrentNeighboorReferenceEntry -
          (this->NumberOfCursors - 1) + icursor - 1] < this->Entries.size());
      return this->ReferenceEntries[this->FirstCurrentNeighboorReferenceEntry -
        (this->NumberOfCursors - 1) + icursor - 1];
    }
    else
    {
      assert("pre: valid_icursor" &&
        this->FirstCurrentNeighboorReferenceEntry - (this->NumberOfCursors - 1) + icursor <
          this->ReferenceEntries.size());
      assert("pre: valid_icursor" &&
        this->ReferenceEntries[this->FirstCurrentNeighboorReferenceEntry -
          (this->NumberOfCursors - 1) + icursor] < this->Entries.size());
      return this->ReferenceEntries[this->FirstCurrentNeighboorReferenceEntry -
        (this->NumberOfCursors - 1) + icursor];
    }
  }

  unsigned int IndiceCentralCursor;

  // Number of cursors in supercursor
  unsigned int NumberOfCursors;

  // 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;

  // 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;

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

VTK_ABI_NAMESPACE_END
#endif