VTK  9.1.0
vtkStaticPointLocator.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkStaticPointLocator.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=========================================================================*/
79#ifndef vtkStaticPointLocator_h
80#define vtkStaticPointLocator_h
81
83#include "vtkCommonDataModelModule.h" // For export macro
84
85class vtkIdList;
86struct vtkBucketList;
87
88class VTKCOMMONDATAMODEL_EXPORT vtkStaticPointLocator : public vtkAbstractPointLocator
89{
90public:
96
98
102 void PrintSelf(ostream& os, vtkIndent indent) override;
104
106
111 vtkSetClampMacro(NumberOfPointsPerBucket, int, 1, VTK_INT_MAX);
112 vtkGetMacro(NumberOfPointsPerBucket, int);
114
116
122 vtkSetVector3Macro(Divisions, int);
123 vtkGetVectorMacro(Divisions, int, 3);
125
126 // Re-use any superclass signatures that we don't override.
131
139 vtkIdType FindClosestPoint(const double x[3]) override;
140
142
151 vtkIdType FindClosestPointWithinRadius(double radius, const double x[3], double& dist2) override;
153 double radius, const double x[3], double inputDataLength, double& dist2);
155
164 void FindClosestNPoints(int N, const double x[3], vtkIdList* result) override;
165
172 void FindPointsWithinRadius(double R, const double x[3], vtkIdList* result) override;
173
183 int IntersectWithLine(double a0[3], double a1[3], double tol, double& t, double lineX[3],
184 double ptX[3], vtkIdType& ptId);
185
193 void MergePoints(double tol, vtkIdType* mergeMap);
194
196
200 void Initialize() override;
201 void FreeSearchStructure() override;
202 void BuildLocator() override;
203 void BuildLocator(const double* inBounds);
205
211 void GenerateRepresentation(int level, vtkPolyData* pd) override;
212
218
224 void GetBucketIds(vtkIdType bNum, vtkIdList* bList);
225
227
241 vtkSetClampMacro(MaxNumberOfBuckets, vtkIdType, 1000, VTK_ID_MAX);
242 vtkGetMacro(MaxNumberOfBuckets, vtkIdType);
244
252 bool GetLargeIds() { return this->LargeIds; }
253
255
259 virtual double* GetSpacing() { return this->H; }
260 virtual void GetSpacing(double spacing[3])
261 {
262 spacing[0] = this->H[0];
263 spacing[1] = this->H[1];
264 spacing[2] = this->H[2];
265 }
267
268protected:
271
272 int NumberOfPointsPerBucket; // Used with AutomaticOn to control subdivide
273 int Divisions[3]; // Number of sub-divisions in x-y-z directions
274 double H[3]; // Width of each bucket in x-y-z directions
275 vtkBucketList* Buckets; // Lists of point ids in each bucket
276 vtkIdType MaxNumberOfBuckets; // Maximum number of buckets in locator
277 bool LargeIds; // indicate whether integer ids are small or large
278
279private:
281 void operator=(const vtkStaticPointLocator&) = delete;
282};
283
284#endif
abstract class to quickly locate points in 3-space
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.
virtual void FindClosestNPoints(int N, const double x[3], vtkIdList *result)=0
Find the closest N points to a position.
list of point or cell ids
Definition: vtkIdList.h:140
a simple class to control print indentation
Definition: vtkIndent.h:113
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:195
quickly locate points in 3-space
void MergePoints(double tol, vtkIdType *mergeMap)
Merge points in the locator given a tolerance.
vtkIdType GetNumberOfPointsInBucket(vtkIdType bNum)
Given a bucket number bNum between 0 <= bNum < this->GetNumberOfBuckets(), return the number of point...
void Initialize() override
See vtkLocator and vtkAbstractPointLocator interface documentation.
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,...
void FindClosestNPoints(int N, const double x[3], vtkIdList *result) override
Find the closest N points to a position.
bool GetLargeIds()
Inform the user as to whether large ids are being used.
~vtkStaticPointLocator() override
int IntersectWithLine(double a0[3], double a1[3], double tol, double &t, double lineX[3], double ptX[3], vtkIdType &ptId)
Intersect the points contained in the locator with the line defined by (a0,a1).
void FreeSearchStructure() override
See vtkLocator and vtkAbstractPointLocator interface documentation.
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 GetBucketIds(vtkIdType bNum, vtkIdList *bList)
Given a bucket number bNum between 0 <= bNum < this->GetNumberOfBuckets(), return a list of point ids...
void GenerateRepresentation(int level, vtkPolyData *pd) override
Populate a polydata with the faces of the bins that potentially contain cells.
void FindPointsWithinRadius(double R, const double x[3], vtkIdList *result) override
Find all points within a specified radius R of position x.
static vtkStaticPointLocator * New()
Construct with automatic computation of divisions, averaging 5 points per bucket.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard type and print methods.
virtual double * GetSpacing()
Provide an accessor to the bucket spacing.
vtkIdType FindClosestPoint(const double x[3]) override
Given a position x, return the id of the point closest to it, or (-1) if no point found.
void BuildLocator(const double *inBounds)
See vtkLocator and vtkAbstractPointLocator interface documentation.
void BuildLocator() override
See vtkLocator and vtkAbstractPointLocator interface documentation.
virtual void GetSpacing(double spacing[3])
Provide an accessor to the bucket spacing.
int vtkIdType
Definition: vtkType.h:332
#define VTK_ID_MAX
Definition: vtkType.h:336
#define VTK_INT_MAX
Definition: vtkType.h:155