vtkHyperTreeGridOrientedCursor.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 vtkHyperTreeGridOrientedCursor_h
#define vtkHyperTreeGridOrientedCursor_h
 
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkHyperTreeGridEntry.h"    // Used internally
#include "vtkObject.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkHyperTree;
class vtkHyperTreeGrid;
 
class VTKCOMMONDATAMODEL_EXPORT vtkHyperTreeGridOrientedCursor : public vtkObject
{
public:
  vtkTypeMacro(vtkHyperTreeGridOrientedCursor, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static vtkHyperTreeGridOrientedCursor* New();
 
  vtkHyperTreeGridOrientedCursor* Clone();
 
 
  void Initialize(vtkHyperTreeGrid* grid, vtkIdType treeIndex, bool create = false);
  void Initialize(vtkHyperTreeGrid* grid, vtkHyperTree* tree, unsigned int level, vtkIdType index);
  void Initialize(
    vtkHyperTreeGrid* grid, vtkHyperTree* tree, unsigned int level, vtkHyperTreeGridEntry& entry);
 
 
  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);
 
protected:
  vtkHyperTreeGridOrientedCursor();
 
  ~vtkHyperTreeGridOrientedCursor() override;
 
  vtkHyperTreeGrid* Grid;
 
  vtkHyperTree* Tree;
  unsigned int Level;
 
  // Hyper tree grid to which the cursor is attached
  vtkHyperTreeGridEntry Entry;
 
private:
  vtkHyperTreeGridOrientedCursor(const vtkHyperTreeGridOrientedCursor&) = delete;
  void operator=(const vtkHyperTreeGridOrientedCursor&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif