VTK  9.2.5
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 =========================================================================*/
89 #ifndef vtkStaticPointLocator_h
90 #define vtkStaticPointLocator_h
91 
93 #include "vtkCommonDataModelModule.h" // For export macro
94 
95 class vtkIdList;
96 struct vtkBucketList;
97 class vtkDataArray;
98 
99 class VTKCOMMONDATAMODEL_EXPORT vtkStaticPointLocator : public vtkAbstractPointLocator
100 {
101 public:
107 
109 
113  void PrintSelf(ostream& os, vtkIndent indent) override;
115 
117 
122  vtkSetClampMacro(NumberOfPointsPerBucket, int, 1, VTK_INT_MAX);
123  vtkGetMacro(NumberOfPointsPerBucket, int);
125 
127 
133  vtkSetVector3Macro(Divisions, int);
134  vtkGetVectorMacro(Divisions, int, 3);
136 
137  // Re-use any superclass signatures that we don't override.
142 
150  vtkIdType FindClosestPoint(const double x[3]) override;
151 
153 
162  vtkIdType FindClosestPointWithinRadius(double radius, const double x[3], double& dist2) override;
164  double radius, const double x[3], double inputDataLength, double& dist2);
166 
175  void FindClosestNPoints(int N, const double x[3], vtkIdList* result) override;
176 
183  void FindPointsWithinRadius(double R, const double x[3], vtkIdList* result) override;
184 
194  int IntersectWithLine(double a0[3], double a1[3], double tol, double& t, double lineX[3],
195  double ptX[3], vtkIdType& ptId);
196 
207  void MergePoints(double tol, vtkIdType* mergeMap);
208 
220 
222 
226  void Initialize() override;
227  void FreeSearchStructure() override;
228  void BuildLocator() override;
229  void ForceBuildLocator() override;
230  void BuildLocator(const double* inBounds);
232 
238  void GenerateRepresentation(int level, vtkPolyData* pd) override;
239 
245 
251  void GetBucketIds(vtkIdType bNum, vtkIdList* bList);
252 
254 
268  vtkSetClampMacro(MaxNumberOfBuckets, vtkIdType, 1000, VTK_ID_MAX);
269  vtkGetMacro(MaxNumberOfBuckets, vtkIdType);
271 
279  bool GetLargeIds() { return this->LargeIds; }
280 
282 
286  virtual double* GetSpacing() { return this->H; }
287  virtual void GetSpacing(double spacing[3])
288  {
289  spacing[0] = this->H[0];
290  spacing[1] = this->H[1];
291  spacing[2] = this->H[2];
292  }
294 
307  {
308  POINT_ORDER = 0,
309  BIN_ORDER = 1
310  };
311 
313 
318  vtkSetClampMacro(
320  vtkGetMacro(TraversalOrder, int);
322  {
323  this->SetTraversalOrder(vtkStaticPointLocator::POINT_ORDER);
324  }
327 
328 protected:
331 
332  void BuildLocatorInternal() override;
333 
334  int NumberOfPointsPerBucket; // Used with AutomaticOn to control subdivide
335  int Divisions[3]; // Number of sub-divisions in x-y-z directions
336  double H[3]; // Width of each bucket in x-y-z directions
337  vtkBucketList* Buckets; // Lists of point ids in each bucket
338  vtkIdType MaxNumberOfBuckets; // Maximum number of buckets in locator
339  bool LargeIds; // indicate whether integer ids are small or large
340  int TraversalOrder; // Control traversal order when threading
341 
342 private:
344  void operator=(const vtkStaticPointLocator&) = delete;
345 };
346 
347 #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.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:165
list of point or cell ids
Definition: vtkIdList.h:143
a simple class to control print indentation
Definition: vtkIndent.h:119
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:200
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 SetTraversalOrderToBinOrder()
Specify the manner in which points are processed when a non-zero merge tolerance is specified.
static vtkStaticPointLocator * New()
Construct with automatic computation of divisions, averaging 5 points per bucket.
void MergePointsWithData(vtkDataArray *data, vtkIdType *mergeMap)
Merge points and associated data in the locator.
void FindClosestNPoints(int N, const double x[3], vtkIdList *result) override
Find the closest N points to a position.
TraversalOrderType
Point merging is inherently an order-dependent process.
bool GetLargeIds()
Inform the user as to whether large ids are being used.
~vtkStaticPointLocator() override
void BuildLocatorInternal() override
This function is not pure virtual to maintain backwards compatibility.
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.
void SetTraversalOrderToPointOrder()
Specify the manner in which points are processed when a non-zero merge tolerance is specified.
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 ForceBuildLocator() override
See vtkLocator and vtkAbstractPointLocator interface documentation.
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.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard type and print methods.
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.
virtual double * GetSpacing()
Provide an accessor to the bucket spacing.
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.
@ level
Definition: vtkX3D.h:401
@ spacing
Definition: vtkX3D.h:487
@ radius
Definition: vtkX3D.h:258
@ data
Definition: vtkX3D.h:321
int vtkIdType
Definition: vtkType.h:332
#define VTK_ID_MAX
Definition: vtkType.h:336
#define VTK_INT_MAX
Definition: vtkType.h:155