vtkAbstractPointLocator.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 vtkAbstractPointLocator_h
#define vtkAbstractPointLocator_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkLocator.h"

VTK_ABI_NAMESPACE_BEGIN
class vtkIdList;

class VTKCOMMONDATAMODEL_EXPORT vtkAbstractPointLocator : public vtkLocator
{
public:

  vtkTypeMacro(vtkAbstractPointLocator, vtkLocator);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetClampMacro(Tolerance, double, 0.0, VTK_DOUBLE_MAX);
  vtkGetMacro(Tolerance, double);


  virtual vtkIdType FindClosestPoint(const double x[3]) = 0;
  vtkIdType FindClosestPoint(double x, double y, double z);

  virtual vtkIdType FindClosestPointWithinRadius(
    double radius, const double x[3], double& dist2) = 0;


  virtual void FindClosestNPoints(int N, const double x[3], vtkIdList* result) = 0;
  void FindClosestNPoints(int N, double x, double y, double z, vtkIdList* result);


  virtual void FindPointsWithinRadius(double R, const double x[3], vtkIdList* result) = 0;
  void FindPointsWithinRadius(double R, double x, double y, double z, vtkIdList* result);


  virtual double* GetBounds() { return this->Bounds; }
  virtual void GetBounds(double*);


  vtkGetMacro(NumberOfBuckets, vtkIdType);

protected:
  vtkAbstractPointLocator();
  ~vtkAbstractPointLocator() override;

  double Bounds[6];          // bounds of points
  double Tolerance;          // for performing merging
  vtkIdType NumberOfBuckets; // total size of locator

private:
  vtkAbstractPointLocator(const vtkAbstractPointLocator&) = delete;
  void operator=(const vtkAbstractPointLocator&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif