VTK  9.2.6
vtkPointLocator.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkPointLocator.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=========================================================================*/
46#ifndef vtkPointLocator_h
47#define vtkPointLocator_h
48
49#include "vtkCommonDataModelModule.h" // For export macro
51
52class vtkCellArray;
53class vtkIdList;
54class vtkNeighborPoints;
55class vtkPoints;
56
57class VTKCOMMONDATAMODEL_EXPORT vtkPointLocator : public vtkIncrementalPointLocator
58{
59public:
65
67
71 void PrintSelf(ostream& os, vtkIndent indent) override;
73
75
78 vtkSetVector3Macro(Divisions, int);
79 vtkGetVectorMacro(Divisions, int, 3);
81
83
86 vtkSetClampMacro(NumberOfPointsPerBucket, int, 1, VTK_INT_MAX);
87 vtkGetMacro(NumberOfPointsPerBucket, int);
89
90 // Re-use any superclass signatures that we don't override.
92
99 vtkIdType FindClosestPoint(const double x[3]) override;
100
102
109 vtkIdType FindClosestPointWithinRadius(double radius, const double x[3], double& dist2) override;
111 double radius, const double x[3], double inputDataLength, double& dist2);
113
120 int InitPointInsertion(vtkPoints* newPts, const double bounds[6]) override;
121
128 int InitPointInsertion(vtkPoints* newPts, const double bounds[6], vtkIdType estNumPts) override;
129
139 void InsertPoint(vtkIdType ptId, const double x[3]) override;
140
151 vtkIdType InsertNextPoint(const double x[3]) override;
152
154
159 vtkIdType IsInsertedPoint(double x, double y, double z) override
160 {
161 double xyz[3];
162 xyz[0] = x;
163 xyz[1] = y;
164 xyz[2] = z;
165 return this->IsInsertedPoint(xyz);
166 };
167 vtkIdType IsInsertedPoint(const double x[3]) override;
169
179 int InsertUniquePoint(const double x[3], vtkIdType& ptId) override;
180
188 vtkIdType FindClosestInsertedPoint(const double x[3]) override;
189
198 void FindClosestNPoints(int N, const double x[3], vtkIdList* result) override;
199
201
208 virtual void FindDistributedPoints(int N, const double x[3], vtkIdList* result, int M);
209 virtual void FindDistributedPoints(int N, double x, double y, double z, vtkIdList* result, int M);
211
218 void FindPointsWithinRadius(double R, const double x[3], vtkIdList* result) override;
219
226 virtual vtkIdList* GetPointsInBucket(const double x[3], int ijk[3]);
227
229
232 vtkGetObjectMacro(Points, vtkPoints);
234
236
240 void Initialize() override;
241 void FreeSearchStructure() override;
242 void BuildLocator() override;
243 void ForceBuildLocator() override;
244 void GenerateRepresentation(int level, vtkPolyData* pd) override;
246
247protected:
250
251 void BuildLocatorInternal() override;
252
253 // place points in appropriate buckets
255 vtkNeighborPoints* buckets, const int ijk[3], const int ndivs[3], int level);
257 vtkNeighborPoints* buckets, const double x[3], const int ijk[3], double dist, int level);
258 void GetOverlappingBuckets(vtkNeighborPoints* buckets, const double x[3], double dist,
259 int prevMinLevel[3], int prevMaxLevel[3]);
260 void GenerateFace(int face, int i, int j, int k, vtkPoints* pts, vtkCellArray* polys);
261 double Distance2ToBucket(const double x[3], const int nei[3]);
262 double Distance2ToBounds(const double x[3], const double bounds[6]);
263
264 vtkPoints* Points; // Used for merging points
265 int Divisions[3]; // Number of sub-divisions in x-y-z directions
266 int NumberOfPointsPerBucket; // Used with previous boolean to control subdivide
267 vtkIdList** HashTable; // lists of point ids in buckets
268 double H[3]; // width of each bucket in x-y-z directions
269
273
274 // These are inlined methods and data members for performance reasons
275 double HX, HY, HZ;
276 double FX, FY, FZ, BX, BY, BZ;
277 vtkIdType XD, YD, ZD, SliceSize;
278
279 void GetBucketIndices(const double* x, int ijk[3]) const
280 {
281 // Compute point index. Make sure it lies within range of locator.
282 vtkIdType tmp0 = static_cast<vtkIdType>(((x[0] - this->BX) * this->FX));
283 vtkIdType tmp1 = static_cast<vtkIdType>(((x[1] - this->BY) * this->FY));
284 vtkIdType tmp2 = static_cast<vtkIdType>(((x[2] - this->BZ) * this->FZ));
285
286 ijk[0] = tmp0 < 0 ? 0 : (tmp0 >= this->XD ? this->XD - 1 : tmp0);
287 ijk[1] = tmp1 < 0 ? 0 : (tmp1 >= this->YD ? this->YD - 1 : tmp1);
288 ijk[2] = tmp2 < 0 ? 0 : (tmp2 >= this->ZD ? this->ZD - 1 : tmp2);
289 }
290
291 vtkIdType GetBucketIndex(const double* x) const
292 {
293 int ijk[3];
294 this->GetBucketIndices(x, ijk);
295 return ijk[0] + ijk[1] * this->XD + ijk[2] * this->SliceSize;
296 }
297
299
300private:
301 vtkPointLocator(const vtkPointLocator&) = delete;
302 void operator=(const vtkPointLocator&) = delete;
303};
304
305#endif
virtual vtkIdType FindClosestPoint(const double x[3])=0
Given a position x, return the id of the point closest to it.
object to represent cell connectivity
list of point or cell ids
Definition vtkIdList.h:31
Abstract class in support of both point location and point insertion.
virtual vtkIdType IsInsertedPoint(double x, double y, double z)=0
Determine whether or not a given point has been inserted.
a simple class to control print indentation
Definition vtkIndent.h:34
quickly locate points in 3-space
void InsertPoint(vtkIdType ptId, const double x[3]) override
Incrementally insert a point into search structure with a particular index value.
int InitPointInsertion(vtkPoints *newPts, const double bounds[6]) override
Initialize the point insertion process.
vtkIdType FindClosestPointWithinRadius(double radius, const double x[3], double &dist2) override
Given a position x and a radius r, return the id of the point closest to the point in that radius.
vtkIdType IsInsertedPoint(double x, double y, double z) override
Determine whether point given by x[3] has been inserted into points list.
void BuildLocator() override
See vtkLocator interface documentation.
void FindClosestNPoints(int N, const double x[3], vtkIdList *result) override
Find the closest N points to a position.
virtual void FindDistributedPoints(int N, double x, double y, double z, vtkIdList *result, int M)
Find the closest points to a position such that each octant of space around the position contains at ...
virtual vtkIdList * GetPointsInBucket(const double x[3], int ijk[3])
Given a position x, return the list of points in the bucket that contains the point.
static vtkPointLocator * New()
Construct with automatic computation of divisions, averaging 25 points per bucket.
void GetBucketIndices(const double *x, int ijk[3]) const
void GetBucketNeighbors(vtkNeighborPoints *buckets, const int ijk[3], const int ndivs[3], int level)
virtual void FindDistributedPoints(int N, const double x[3], vtkIdList *result, int M)
Find the closest points to a position such that each octant of space around the position contains at ...
void FreeSearchStructure() override
See vtkLocator interface documentation.
vtkIdList ** HashTable
void BuildLocatorInternal() override
This function is not pure virtual to maintain backwards compatibility.
void ForceBuildLocator() override
See vtkLocator interface documentation.
void Initialize() override
See vtkLocator interface documentation.
vtkIdType FindClosestPoint(const double x[3]) override
Given a position x, return the id of the point closest to it.
double Distance2ToBucket(const double x[3], const int nei[3])
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for type management and printing.
virtual vtkIdType FindClosestPointWithinRadius(double radius, const double x[3], double inputDataLength, double &dist2)
Given a position x and a radius r, return the id of the point closest to the point in that radius.
void ComputePerformanceFactors()
vtkIdType IsInsertedPoint(const double x[3]) override
Determine whether point given by x[3] has been inserted into points list.
~vtkPointLocator() override
void GenerateRepresentation(int level, vtkPolyData *pd) override
See vtkLocator interface documentation.
void GenerateFace(int face, int i, int j, int k, vtkPoints *pts, vtkCellArray *polys)
vtkIdType InsertionPointId
void GetOverlappingBuckets(vtkNeighborPoints *buckets, const double x[3], double dist, int prevMinLevel[3], int prevMaxLevel[3])
void GetOverlappingBuckets(vtkNeighborPoints *buckets, const double x[3], const int ijk[3], double dist, int level)
vtkIdType GetBucketIndex(const double *x) const
vtkIdType InsertNextPoint(const double x[3]) override
Incrementally insert a point into search structure.
int InsertUniquePoint(const double x[3], vtkIdType &ptId) override
Determine whether point given by x[3] has been inserted into points list.
void FindPointsWithinRadius(double R, const double x[3], vtkIdList *result) override
Find all points within a specified radius R of position x.
double Distance2ToBounds(const double x[3], const double bounds[6])
int InitPointInsertion(vtkPoints *newPts, const double bounds[6], vtkIdType estNumPts) override
Initialize the point insertion process.
vtkIdType FindClosestInsertedPoint(const double x[3]) override
Given a position x, return the id of the point closest to it.
represent and manipulate 3D points
Definition vtkPoints.h:34
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition vtkPolyData.h:85
int vtkIdType
Definition vtkType.h:332
#define VTK_INT_MAX
Definition vtkType.h:155