vtkLocator.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkLocator.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 vtkLocator_h
#define vtkLocator_h
 
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkObject.h"
 
class vtkDataSet;
class vtkPolyData;
 
class VTKCOMMONDATAMODEL_EXPORT vtkLocator : public vtkObject
{
public:
 
  vtkTypeMacro(vtkLocator, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  virtual void SetDataSet(vtkDataSet*);
  vtkGetObjectMacro(DataSet, vtkDataSet);
 
 
  vtkSetClampMacro(MaxLevel, int, 0, VTK_INT_MAX);
  vtkGetMacro(MaxLevel, int);
 
 
  vtkGetMacro(Level, int);
 
 
  vtkSetMacro(Automatic, vtkTypeBool);
  vtkGetMacro(Automatic, vtkTypeBool);
  vtkBooleanMacro(Automatic, vtkTypeBool);
 
 
  vtkSetClampMacro(Tolerance, double, 0.0, VTK_DOUBLE_MAX);
  vtkGetMacro(Tolerance, double);
 
 
  vtkSetMacro(UseExistingSearchStructure, vtkTypeBool);
  vtkGetMacro(UseExistingSearchStructure, vtkTypeBool);
  vtkBooleanMacro(UseExistingSearchStructure, vtkTypeBool);
 
  virtual void Update();
 
  virtual void Initialize();
 
  virtual void BuildLocator() = 0;
 
  virtual void ForceBuildLocator() {}
 
  virtual void FreeSearchStructure() = 0;
 
  virtual void GenerateRepresentation(int level, vtkPolyData* pd) = 0;
 
 
  vtkGetMacro(BuildTime, vtkMTimeType);
 
 
  bool UsesGarbageCollector() const override { return true; }
 
protected:
  vtkLocator();
  ~vtkLocator() override;
 
  virtual void BuildLocatorInternal(){};
 
  vtkDataSet* DataSet;
  vtkTypeBool UseExistingSearchStructure;
  vtkTypeBool Automatic; // boolean controls automatic subdivision (or uses user spec.)
  double Tolerance;      // for performing merging
  int MaxLevel;
  int Level;
 
  vtkTimeStamp BuildTime; // time at which locator was built
 
  void ReportReferences(vtkGarbageCollector*) override;
 
private:
  vtkLocator(const vtkLocator&) = delete;
  void operator=(const vtkLocator&) = delete;
};
 
#endif