vtkHyperTreeGridOrientedCursor.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkHyperTreeGridOrientedCursor.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkHyperTreeGridOrientedCursor_h
#define vtkHyperTreeGridOrientedCursor_h
 
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkHyperTreeGridEntry.h"    // Used internally
#include "vtkObject.h"
 
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;
};
#endif