vtkHyperTreeGridGeometryUnlimitedLevelEntry.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 vtkHyperTreeGridGeometryUnlimitedLevelEntry_h
#define vtkHyperTreeGridGeometryUnlimitedLevelEntry_h
 
#include "assert.h"
 
#include "vtkDeprecation.h" // Include the macros.
#include "vtkObject.h"
#include "vtkSmartPointer.h"
 
#include "vtkHyperTreeGridNonOrientedGeometryCursor.h"
#include "vtkHyperTreeGridOrientedGeometryCursor.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkHyperTree;
class vtkHyperTreeGrid;
 
class vtkHyperTreeGridGeometryUnlimitedLevelEntry
{
public:
  void PrintSelf(ostream& os, vtkIndent indent);

  vtkHyperTreeGridGeometryUnlimitedLevelEntry(vtkHyperTree* tree = nullptr)
  {
    this->Tree = tree;
    this->Level = 0;
    this->Index = 0;
    for (unsigned int d = 0; d < 3; ++d)
    {
      this->Origin[d] = 0.;
    }
  }
 
  vtkHyperTreeGridGeometryUnlimitedLevelEntry(
    vtkHyperTreeGridGeometryUnlimitedLevelEntry const&) = default;
  vtkHyperTreeGridGeometryUnlimitedLevelEntry& operator=(
    vtkHyperTreeGridGeometryUnlimitedLevelEntry const&) = default;

  ~vtkHyperTreeGridGeometryUnlimitedLevelEntry() = default;

  void Dump(ostream& os);
 
  VTK_DEPRECATED_IN_9_7_0(
    "Please use the 'Initialize' overload specifying lastRealLevel and lastRealIndex explicitly.")
  void Initialize(vtkHyperTree* tree, unsigned int level, vtkIdType index, const double* origin);

  void Initialize(vtkHyperTree* tree, unsigned int level, vtkIdType index, const double* origin,
    unsigned int lastRealLevel, vtkIdType lastRealIndex);

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

  void Reset()
  {
    this->Tree = nullptr;
    this->Index = 0;
  }

  void Copy(const vtkHyperTreeGridGeometryUnlimitedLevelEntry* entry)
  {
    this->Initialize(entry->Tree, entry->Level, entry->Index, entry->Origin, entry->LastRealLevel,
      entry->LastRealIndex);
  }

  vtkSmartPointer<vtkHyperTreeGridOrientedGeometryCursor> GetHyperTreeGridOrientedGeometryCursor(
    vtkHyperTreeGrid* grid)
  {
    vtkSmartPointer<vtkHyperTreeGridOrientedGeometryCursor> cursor =
      vtkSmartPointer<vtkHyperTreeGridOrientedGeometryCursor>::New();
    cursor->Initialize(grid, this->Tree, this->Level, this->Index, this->Origin);
    return cursor;
  }

  vtkSmartPointer<vtkHyperTreeGridNonOrientedGeometryCursor>
  GetHyperTreeGridNonOrientedGeometryCursor(vtkHyperTreeGrid* grid)
  {
    assert("pre: level==0" && this->Level == 0);
    vtkSmartPointer<vtkHyperTreeGridNonOrientedGeometryCursor> cursor =
      vtkSmartPointer<vtkHyperTreeGridNonOrientedGeometryCursor>::New();
    cursor->Initialize(grid, this->Tree, this->Level, this->Index, this->Origin);
    return cursor;
  }

  vtkIdType GetVertexId() const { return this->LastRealIndex; }

  vtkIdType GetGlobalNodeIndex() const;

  void SetGlobalIndexStart(vtkIdType index);

  void SetGlobalIndexFromLocal(vtkIdType index);

  void SetMask(const vtkHyperTreeGrid* grid, bool state);

  bool IsMasked(const vtkHyperTreeGrid* grid) const;

  bool IsLeaf(const vtkHyperTreeGrid* grid) const;

  bool IsRealLeaf(const vtkHyperTreeGrid* grid) const;

  bool IsVirtualLeaf(const vtkHyperTreeGrid* grid) const;

  bool IsTerminalNode(const vtkHyperTreeGrid* grid) const;

  bool IsRoot() { return this->Index == 0 && this->Level == 0; }

  void ToChild(const vtkHyperTreeGrid* grid, unsigned char ichild);

  vtkHyperTree* GetTree() const { return this->Tree; }


  unsigned int GetLevel() const { return this->Level; }
  unsigned int GetLastRealLevel() const { return this->LastRealLevel; }


  double* GetOrigin() { return this->Origin; }
  const double* GetOrigin() const { return this->Origin; }

  void GetBounds(double bounds[6]) const;

  void GetPoint(double point[3]) const;
 
private:
  vtkHyperTree* Tree;

  unsigned int Level = 0;

  vtkIdType Index = 0;

  vtkIdType LastRealIndex = 0;

  vtkIdType LastRealLevel = 0;

  double Origin[3];
};
 
VTK_ABI_NAMESPACE_END
#endif // vtkHyperTreeGridGeometryUnlimitedLevelEntry
// VTK-HeaderTest-Exclude: vtkHyperTreeGridGeometryUnlimitedLevelEntry.h