-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Expand file tree
/
Copy pathvtkAbstractPointLocator.h
More file actions
122 lines (107 loc) · 3.84 KB
/
Copy pathvtkAbstractPointLocator.h
File metadata and controls
122 lines (107 loc) · 3.84 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkAbstractPointLocator
* @brief abstract class to quickly locate points in 3-space
*
* vtkAbstractPointLocator is an abstract spatial search object to quickly locate points
* in 3D. vtkAbstractPointLocator works by dividing a specified region of space into
* "rectangular" buckets, and then keeping a list of points that
* lie in each bucket. Typical operation involves giving a position in 3D
* and finding the closest point. The points are provided from the specified
* dataset input.
*
* @sa
* vtkPointLocator vtkStaticPointLocator vtkMergePoints
*/
#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:
///@{
/**
* Standard type and print methods.
*/
vtkTypeMacro(vtkAbstractPointLocator, vtkLocator);
void PrintSelf(ostream& os, vtkIndent indent) override;
///@}
///@{
/**
* Specify absolute tolerance (in world coordinates) for performing
* geometric operations.
*
* The default is 0.001.
*/
vtkSetClampMacro(Tolerance, double, 0.0, VTK_DOUBLE_MAX);
vtkGetMacro(Tolerance, double);
///@}
///@{
/**
* Given a position x, return the id of the point closest to it. Alternative
* method requires separate x-y-z values.
* These methods are thread safe if BuildLocator() is directly or
* indirectly called from a single thread first.
*/
virtual vtkIdType FindClosestPoint(const double x[3]) = 0;
vtkIdType FindClosestPoint(double x, double y, double z);
///@}
/**
* Given a position x and a radius r, return the id of the point
* closest to the point in that radius.
* dist2 returns the squared distance to the point.
*/
virtual vtkIdType FindClosestPointWithinRadius(
double radius, const double x[3], double& dist2) = 0;
///@{
/**
* Find the closest N points to a position. This returns the closest
* N points to a position. A faster method could be created that returned
* N close points to a position, but necessarily the exact N closest.
* The returned points are sorted from closest to farthest.
* These methods are thread safe if BuildLocator() is directly or
* indirectly called from a single thread first.
*/
virtual void FindClosestNPoints(int N, const double x[3], vtkIdList* result) = 0;
void FindClosestNPoints(int N, double x, double y, double z, vtkIdList* result);
///@}
///@{
/**
* Find all points within a specified radius R of position x.
* The result is not sorted in any specific manner.
* These methods are thread safe if BuildLocator() is directly or
* indirectly called from a single thread first.
*/
virtual void FindPointsWithinRadius(double R, const double x[3], vtkIdList* result) = 0;
void FindPointsWithinRadius(double R, double x, double y, double z, vtkIdList* result);
///@}
///@{
/**
* Provide an accessor to the bounds. Valid after the locator is built.
*/
virtual double* GetBounds() { return this->Bounds; }
virtual void GetBounds(double*);
///@}
///@{
/**
* Return the total number of buckets in the locator. This has meaning only
* after the locator is constructed.
*/
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