vtkHyperTreeGridEntry.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 vtkHyperTreeGridEntry_h
#define vtkHyperTreeGridEntry_h

#include "vtkObject.h"

VTK_ABI_NAMESPACE_BEGIN
class vtkHyperTree;
class vtkHyperTreeGrid;

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

  void Dump(ostream& os);

  vtkHyperTreeGridEntry() { this->Index = 0; }

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

  vtkHyperTreeGridEntry(vtkIdType index) { this->Index = index; }

  ~vtkHyperTreeGridEntry() = default;

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

  void Initialize(vtkIdType index) { this->Index = index; }

  void Copy(const vtkHyperTreeGridEntry* entry) { this->Index = entry->Index; }

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

  vtkIdType GetGlobalNodeIndex(const vtkHyperTree* tree) const;

  void SetGlobalIndexStart(vtkHyperTree* tree, vtkIdType index);

  void SetGlobalIndexFromLocal(vtkHyperTree* tree, vtkIdType index);

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

  bool IsMasked(const vtkHyperTreeGrid* grid, const vtkHyperTree* tree) const;

  bool IsLeaf(const vtkHyperTreeGrid* grid, const vtkHyperTree* tree, unsigned int level) const;

  void SubdivideLeaf(const vtkHyperTreeGrid* grid, vtkHyperTree* tree, unsigned int level);

  bool IsTerminalNode(
    const vtkHyperTreeGrid* grid, const vtkHyperTree* tree, unsigned int level) const;

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

  void ToChild(const vtkHyperTreeGrid* grid, const vtkHyperTree* tree, unsigned int level,
    unsigned char ichild);

protected:
  vtkIdType Index;
};

VTK_ABI_NAMESPACE_END
#endif // vtkHyperTreeGridEntry_h
// VTK-HeaderTest-Exclude: vtkHyperTreeGridEntry.h