vtkSimpleScalarTree.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 vtkSimpleScalarTree_h
#define vtkSimpleScalarTree_h
 
#include "vtkCommonExecutionModelModule.h" // For export macro
#include "vtkScalarTree.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkScalarNode;
class vtkSimpleScalarTree;
 
class VTKCOMMONEXECUTIONMODEL_EXPORT vtkSimpleScalarTree : public vtkScalarTree
{
public:
  static vtkSimpleScalarTree* New();


  vtkTypeMacro(vtkSimpleScalarTree, vtkScalarTree);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void ShallowCopy(vtkScalarTree* stree) override;


  vtkSetClampMacro(BranchingFactor, int, 2, VTK_INT_MAX);
  vtkGetMacro(BranchingFactor, int);


  vtkGetMacro(Level, int);


  vtkSetClampMacro(MaxLevel, int, 1, VTK_INT_MAX);
  vtkGetMacro(MaxLevel, int);

  void BuildTree() override;

  void Initialize() override;

  void InitTraversal(double scalarValue) override;

  vtkCell* GetNextCell(vtkIdType& cellId, vtkIdList*& ptIds, vtkDataArray* cellScalars) override;
 
  // The following methods supports parallel (threaded) traversal. Basically
  // batches of cells (which are a portion of the whole dataset) are available for
  // processing in a parallel For() operation.

  vtkIdType GetNumberOfCellBatches(double scalarValue) override;

  const vtkIdType* GetCellBatch(vtkIdType batchNum, vtkIdType& numCells) override;
 
protected:
  vtkSimpleScalarTree();
  ~vtkSimpleScalarTree() override;
 
  int MaxLevel;
  int Level;
  int BranchingFactor;  // number of children per node
  vtkScalarNode* Tree;  // pointerless scalar range tree
  int TreeSize;         // allocated size of tree
  vtkIdType LeafOffset; // offset to leaf nodes of tree
 
private:
  vtkIdType NumCells;  // the number of cells in this dataset
  vtkIdType TreeIndex; // traversal location within tree
  int ChildNumber;     // current child in traversal
  vtkIdType CellId;    // current cell id being examined
  int FindStartLeaf(vtkIdType index, int level);
  int FindNextLeaf(vtkIdType index, int level);
 
  vtkIdType* CandidateCells; // to support parallel computing
  vtkIdType NumCandidates;
 
  vtkSimpleScalarTree(const vtkSimpleScalarTree&) = delete;
  void operator=(const vtkSimpleScalarTree&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif