vtkHyperTreeGridNonOrientedCursor.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 vtkHyperTreeGridNonOrientedCursor_h
#define vtkHyperTreeGridNonOrientedCursor_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkObject.h"

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

VTK_ABI_NAMESPACE_BEGIN
class vtkHyperTree;
class vtkHyperTreeGrid;
class vtkHyperTreeGridEntry;

class VTKCOMMONDATAMODEL_EXPORT vtkHyperTreeGridNonOrientedCursor : public vtkObject
{
public:
  vtkTypeMacro(vtkHyperTreeGridNonOrientedCursor, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static vtkHyperTreeGridNonOrientedCursor* New();

  vtkHyperTreeGridNonOrientedCursor* Clone();

  vtkHyperTreeGridNonOrientedCursor* CloneFromCurrentEntry();

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

  void Initialize(
    vtkHyperTreeGrid* grid, vtkHyperTree* tree, unsigned int level, vtkHyperTreeGridEntry& entry);

  void Initialize(vtkHyperTreeGrid* grid, vtkHyperTree* tree, unsigned int level, vtkIdType index);


  vtkHyperTreeGrid* GetGrid();


  bool HasTree() const;


  vtkHyperTree* GetTree() const;

  vtkIdType GetVertexId();

  vtkIdType GetGlobalNodeIndex();

  unsigned char GetDimension();

  unsigned char GetNumberOfChildren();

  void SetGlobalIndexStart(vtkIdType index);

  void SetGlobalIndexFromLocal(vtkIdType index);

  void SetMask(bool state);

  bool IsMasked();

  bool IsLeaf();

  void SubdivideLeaf();

  bool IsRoot();

  unsigned int GetLevel();

  void ToChild(unsigned char ichild);

  void ToRoot();

  void ToParent();

protected:
  vtkHyperTreeGridNonOrientedCursor();

  ~vtkHyperTreeGridNonOrientedCursor() override;

  vtkHyperTreeGrid* Grid;

  vtkHyperTree* Tree;
  unsigned int Level;
  int LastValidEntry;

  std::vector<vtkHyperTreeGridEntry> Entries;

private:
  vtkHyperTreeGridNonOrientedCursor(const vtkHyperTreeGridNonOrientedCursor&) = delete;
  void operator=(const vtkHyperTreeGridNonOrientedCursor&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif