vtkScalarTree.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkScalarTree.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 vtkScalarTree_h
#define vtkScalarTree_h
 
#include "vtkCommonExecutionModelModule.h" // For export macro
#include "vtkObject.h"
 
class vtkCell;
class vtkDataArray;
class vtkDataSet;
class vtkIdList;
class vtkTimeStamp;
 
class VTKCOMMONEXECUTIONMODEL_EXPORT vtkScalarTree : public vtkObject
{
public:
 
  vtkTypeMacro(vtkScalarTree, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  virtual void ShallowCopy(vtkScalarTree* stree);
 
 
  virtual void SetDataSet(vtkDataSet*);
  vtkGetObjectMacro(DataSet, vtkDataSet);
 
 
  virtual void SetScalars(vtkDataArray*);
  vtkGetObjectMacro(Scalars, vtkDataArray);
 
  virtual void BuildTree() = 0;
 
  virtual void Initialize() = 0;
 
  virtual void InitTraversal(double scalarValue) = 0;
 
  virtual vtkCell* GetNextCell(vtkIdType& cellId, vtkIdList*& ptIds, vtkDataArray* cellScalars) = 0;
 
  double GetScalarValue() { return this->ScalarValue; }
 
  // 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.
 
  virtual vtkIdType GetNumberOfCellBatches(double scalarValue) = 0;
 
  virtual const vtkIdType* GetCellBatch(vtkIdType batchNum, vtkIdType& numCells) = 0;
 
protected:
  vtkScalarTree();
  ~vtkScalarTree() override;
 
  vtkDataSet* DataSet;   // the dataset over which the scalar tree is built
  vtkDataArray* Scalars; // the scalars of the DataSet
  double ScalarValue;    // current scalar value for traversal
 
  vtkTimeStamp BuildTime; // time at which tree was built
 
private:
  vtkScalarTree(const vtkScalarTree&) = delete;
  void operator=(const vtkScalarTree&) = delete;
};
 
#endif