VTK  9.1.20220524
vtkAbstractPointLocator.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkAbstractPointLocator.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
33 #ifndef vtkAbstractPointLocator_h
34 #define vtkAbstractPointLocator_h
35 
36 #include "vtkCommonDataModelModule.h" // For export macro
37 #include "vtkLocator.h"
38 
39 class vtkIdList;
40 
41 class VTKCOMMONDATAMODEL_EXPORT vtkAbstractPointLocator : public vtkLocator
42 {
43 public:
45 
49  void PrintSelf(ostream& os, vtkIndent indent) override;
51 
53 
59  virtual vtkIdType FindClosestPoint(const double x[3]) = 0;
60  vtkIdType FindClosestPoint(double x, double y, double z);
62 
69  double radius, const double x[3], double& dist2) = 0;
70 
72 
80  virtual void FindClosestNPoints(int N, const double x[3], vtkIdList* result) = 0;
81  void FindClosestNPoints(int N, double x, double y, double z, vtkIdList* result);
83 
85 
91  virtual void FindPointsWithinRadius(double R, const double x[3], vtkIdList* result) = 0;
92  void FindPointsWithinRadius(double R, double x, double y, double z, vtkIdList* result);
94 
96 
99  virtual double* GetBounds() { return this->Bounds; }
100  virtual void GetBounds(double*);
102 
104 
108  vtkGetMacro(NumberOfBuckets, vtkIdType);
110 
111 protected:
114 
115  double Bounds[6]; // bounds of points
116  vtkIdType NumberOfBuckets; // total size of locator
117 
118 private:
120  void operator=(const vtkAbstractPointLocator&) = delete;
121 };
122 
123 #endif
abstract class to quickly locate points in 3-space
~vtkAbstractPointLocator() override
virtual void GetBounds(double *)
Provide an accessor to the bounds.
virtual void FindPointsWithinRadius(double R, const double x[3], vtkIdList *result)=0
Find all points within a specified radius R of position x.
virtual vtkIdType FindClosestPoint(const double x[3])=0
Given a position x, return the id of the point closest to it.
virtual double * GetBounds()
Provide an accessor to the bounds.
vtkIdType FindClosestPoint(double x, double y, double z)
Given a position x, return the id of the point closest to it.
virtual void FindClosestNPoints(int N, const double x[3], vtkIdList *result)=0
Find the closest N points to a position.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard type and print methods.
void FindPointsWithinRadius(double R, double x, double y, double z, vtkIdList *result)
Find all points within a specified radius R of position x.
void FindClosestNPoints(int N, double x, double y, double z, vtkIdList *result)
Find the closest N points to a position.
virtual vtkIdType FindClosestPointWithinRadius(double radius, const double x[3], double &dist2)=0
Given a position x and a radius r, return the id of the point closest to the point in that radius.
list of point or cell ids
Definition: vtkIdList.h:143
a simple class to control print indentation
Definition: vtkIndent.h:119
abstract base class for objects that accelerate spatial searches
Definition: vtkLocator.h:89
@ radius
Definition: vtkX3D.h:258
int vtkIdType
Definition: vtkType.h:332