vtkLocator.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 vtkLocator_h
#define vtkLocator_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkDeprecation.h"           // For VTK_DEPRECATED_IN_9_7_0
#include "vtkObject.h"

VTK_ABI_NAMESPACE_BEGIN
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);


  VTK_DEPRECATED_IN_9_7_0("Tolerance is only used by vtkAbstractPointLocator subclasses")
  void SetTolerance(double vtkNotUsed(tol)) {}
  VTK_DEPRECATED_IN_9_7_0("Tolerance is only used by vtkAbstractPointLocator subclasses")
  double GetToleranceMinValue() VTK_FUTURE_CONST { return 0.0; }
  VTK_DEPRECATED_IN_9_7_0("Tolerance is only used by vtkAbstractPointLocator subclasses")
  double GetToleranceMaxValue() VTK_FUTURE_CONST { return VTK_DOUBLE_MAX; }
  VTK_DEPRECATED_IN_9_7_0("Tolerance is only used by vtkAbstractPointLocator subclasses")
  double GetToleranceDefaultValue() VTK_FUTURE_CONST { return 0.001; }


  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.)
  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;
};

VTK_ABI_NAMESPACE_END
#endif