vtkHyperTreeGridLevelEntry.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 vtkHyperTreeGridLevelEntry_h
#define vtkHyperTreeGridLevelEntry_h

#include "vtkObject.h"
#include "vtkSmartPointer.h" // Used internally

VTK_ABI_NAMESPACE_BEGIN
class vtkHyperTree;
class vtkHyperTreeGrid;
class vtkHyperTreeGridNonOrientedCursor;

class vtkHyperTreeGridLevelEntry
{
public:
  void PrintSelf(ostream& os, vtkIndent indent);

  void Dump(ostream& os);

  vtkHyperTreeGridLevelEntry()
    : Tree(nullptr)
    , Level(0)
    , Index(0)
  {
  }

  vtkHyperTreeGridLevelEntry(vtkHyperTreeGridLevelEntry const&) = default;
  vtkHyperTreeGridLevelEntry& operator=(vtkHyperTreeGridLevelEntry const&) = default;

  vtkHyperTreeGridLevelEntry(vtkHyperTreeGridLevelEntry* entry)
    : Tree(entry->Tree)
    , Level(entry->Level)
    , Index(entry->Index)
  {
  }

  vtkHyperTreeGridLevelEntry(vtkHyperTree* tree, unsigned int level, vtkIdType index)
    : Tree(tree)
    , Level(level)
    , Index(index)
  {
  }

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

  ~vtkHyperTreeGridLevelEntry() = default;

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

  void Initialize(vtkHyperTree* tree, unsigned int level, vtkIdType index)
  {
    this->Tree = tree;
    this->Level = level;
    this->Index = index;
  }

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

  void Copy(const vtkHyperTreeGridLevelEntry* entry)
  {
    this->Tree = entry->Tree;
    this->Level = entry->Level;
    this->Index = entry->Index;
  }

  vtkSmartPointer<vtkHyperTreeGridNonOrientedCursor> GetHyperTreeGridNonOrientedCursor(
    vtkHyperTreeGrid* grid);

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

  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;

  void SubdivideLeaf(const vtkHyperTreeGrid* grid);

  bool IsTerminalNode(const vtkHyperTreeGrid* grid) const;

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

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

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

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

protected:
  vtkHyperTree* Tree;

  unsigned int Level;

  vtkIdType Index;
};

VTK_ABI_NAMESPACE_END
#endif // vtkHyperTreeGridLevelEntry_h
// VTK-HeaderTest-Exclude: vtkHyperTreeGridLevelEntry.h