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 =========================================================================*/
50 #ifndef vtkStaticPointLocator_h
51 #define vtkStaticPointLocator_h
52 
54 #include "vtkCommonDataModelModule.h" // For export macro
55 
56 class vtkIdList;
57 struct vtkBucketList;
58 
59 class VTKCOMMONDATAMODEL_EXPORT vtkStaticPointLocator : public vtkAbstractPointLocator
60 {
61 public:
67 
69 
73  void PrintSelf(ostream& os, vtkIndent indent) override;
75 
77 
82  vtkSetClampMacro(NumberOfPointsPerBucket, int, 1, VTK_INT_MAX);
83  vtkGetMacro(NumberOfPointsPerBucket, int);
85 
87 
93  vtkSetVector3Macro(Divisions, int);
94  vtkGetVectorMacro(Divisions, int, 3);
96 
97  // Re-use any superclass signatures that we don't override.
102 
110  vtkIdType FindClosestPoint(const double x[3]) override;
111 
113 
122  vtkIdType FindClosestPointWithinRadius(double radius, const double x[3], double& dist2) override;
124  double radius, const double x[3], double inputDataLength, double& dist2);
126 
135  void FindClosestNPoints(int N, const double x[3], vtkIdList* result) override;
136 
143  void FindPointsWithinRadius(double R, const double x[3], vtkIdList* result) override;
144 
154  int IntersectWithLine(double a0[3], double a1[3], double tol, double& t, double lineX[3],
155  double ptX[3], vtkIdType& ptId);
156 
164  void MergePoints(double tol, vtkIdType* mergeMap);
165 
167 
171  void Initialize() override;
172  void FreeSearchStructure() override;
173  void BuildLocator() override;
174  void BuildLocator(const double* inBounds);
176 
182  void GenerateRepresentation(int level, vtkPolyData* pd) override;
183 
189 
195  void GetBucketIds(vtkIdType bNum, vtkIdList* bList);
196 
198 
212  vtkSetClampMacro(MaxNumberOfBuckets, vtkIdType, 1000, VTK_ID_MAX);
213  vtkGetMacro(MaxNumberOfBuckets, vtkIdType);
215 
223  bool GetLargeIds() { return this->LargeIds; }
224 
226 
230  virtual double* GetSpacing() { return this->H; }
231  virtual void GetSpacing(double spacing[3])
232  {
233  spacing[0] = this->H[0];
234  spacing[1] = this->H[1];
235  spacing[2] = this->H[2];
236  }
238 
239 protected:
242 
243  int NumberOfPointsPerBucket; // Used with AutomaticOn to control subdivide
244  int Divisions[3]; // Number of sub-divisions in x-y-z directions
245  double H[3]; // Width of each bucket in x-y-z directions
246  vtkBucketList* Buckets; // Lists of point ids in each bucket
247  vtkIdType MaxNumberOfBuckets; // Maximum number of buckets in locator
248  bool LargeIds; // indicate whether integer ids are small or large
249 
250 private:
252  void operator=(const vtkStaticPointLocator&) = delete;
253 };
254 
255 #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:31
a simple class to control print indentation
Definition: vtkIndent.h:34
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:86
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,...
static vtkStaticPointLocator * New()
Construct with automatic computation of divisions, averaging 5 points per bucket.
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.
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
int vtkIdType
Definition: vtkType.h:332
#define VTK_ID_MAX
Definition: vtkType.h:336
#define VTK_INT_MAX
Definition: vtkType.h:155