VTK  9.2.6
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 =========================================================================*/
60 #ifndef vtkStaticPointLocator_h
61 #define vtkStaticPointLocator_h
62 
64 #include "vtkCommonDataModelModule.h" // For export macro
65 
66 class vtkIdList;
67 struct vtkBucketList;
68 class vtkDataArray;
69 
70 class VTKCOMMONDATAMODEL_EXPORT vtkStaticPointLocator : public vtkAbstractPointLocator
71 {
72 public:
77  static vtkStaticPointLocator* New();
78 
80 
84  void PrintSelf(ostream& os, vtkIndent indent) override;
86 
88 
93  vtkSetClampMacro(NumberOfPointsPerBucket, int, 1, VTK_INT_MAX);
94  vtkGetMacro(NumberOfPointsPerBucket, int);
96 
98 
104  vtkSetVector3Macro(Divisions, int);
105  vtkGetVectorMacro(Divisions, int, 3);
107 
108  // Re-use any superclass signatures that we don't override.
113 
121  vtkIdType FindClosestPoint(const double x[3]) override;
122 
124 
133  vtkIdType FindClosestPointWithinRadius(double radius, const double x[3], double& dist2) override;
135  double radius, const double x[3], double inputDataLength, double& dist2);
137 
146  void FindClosestNPoints(int N, const double x[3], vtkIdList* result) override;
147 
154  void FindPointsWithinRadius(double R, const double x[3], vtkIdList* result) override;
155 
165  int IntersectWithLine(double a0[3], double a1[3], double tol, double& t, double lineX[3],
166  double ptX[3], vtkIdType& ptId);
167 
178  void MergePoints(double tol, vtkIdType* mergeMap);
179 
190  void MergePointsWithData(vtkDataArray* data, vtkIdType* mergeMap);
191 
193 
197  void Initialize() override;
198  void FreeSearchStructure() override;
199  void BuildLocator() override;
200  void ForceBuildLocator() override;
201  void BuildLocator(const double* inBounds);
203 
209  void GenerateRepresentation(int level, vtkPolyData* pd) override;
210 
215  vtkIdType GetNumberOfPointsInBucket(vtkIdType bNum);
216 
222  void GetBucketIds(vtkIdType bNum, vtkIdList* bList);
223 
225 
239  vtkSetClampMacro(MaxNumberOfBuckets, vtkIdType, 1000, VTK_ID_MAX);
240  vtkGetMacro(MaxNumberOfBuckets, vtkIdType);
242 
250  bool GetLargeIds() { return this->LargeIds; }
251 
253 
257  virtual double* GetSpacing() { return this->H; }
258  virtual void GetSpacing(double spacing[3])
259  {
260  spacing[0] = this->H[0];
261  spacing[1] = this->H[1];
262  spacing[2] = this->H[2];
263  }
265 
278  {
279  POINT_ORDER = 0,
280  BIN_ORDER = 1
281  };
282 
284 
289  vtkSetClampMacro(
291  vtkGetMacro(TraversalOrder, int);
293  {
294  this->SetTraversalOrder(vtkStaticPointLocator::POINT_ORDER);
295  }
298 
299 protected:
301  ~vtkStaticPointLocator() override;
302 
303  void BuildLocatorInternal() override;
304 
305  int NumberOfPointsPerBucket; // Used with AutomaticOn to control subdivide
306  int Divisions[3]; // Number of sub-divisions in x-y-z directions
307  double H[3]; // Width of each bucket in x-y-z directions
308  vtkBucketList* Buckets; // Lists of point ids in each bucket
309  vtkIdType MaxNumberOfBuckets; // Maximum number of buckets in locator
310  bool LargeIds; // indicate whether integer ids are small or large
311  int TraversalOrder; // Control traversal order when threading
312 
313 private:
315  void operator=(const vtkStaticPointLocator&) = delete;
316 };
317 
318 #endif
virtual void BuildLocator()=0
Build the locator from the input dataset.
virtual double * GetSpacing()
Provide an accessor to the bucket spacing.
virtual vtkIdType FindClosestPointWithinRadius(double radius, const double x[3], double &dist2)=0
Given a position x and a radius r, return the id of the point closest to the point in that radius...
#define VTK_INT_MAX
Definition: vtkType.h:155
virtual double * GetBounds()
Provide an accessor to the bounds.
int vtkIdType
Definition: vtkType.h:332
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:90
virtual void FreeSearchStructure()=0
Free the memory required for the spatial data structure.
a simple class to control print indentation
Definition: vtkIndent.h:39
virtual void BuildLocatorInternal()
This function is not pure virtual to maintain backwards compatibility.
Definition: vtkLocator.h:203
void PrintSelf(ostream &os, vtkIndent indent) override
Standard type and print methods.
abstract class to quickly locate points in 3-space
list of point or cell ids
Definition: vtkIdList.h:33
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
virtual void FindPointsWithinRadius(double R, const double x[3], vtkIdList *result)=0
Find all points within a specified radius R of position x.
quickly locate points in 3-space
virtual void FindClosestNPoints(int N, const double x[3], vtkIdList *result)=0
Find the closest N points to a position.
void SetTraversalOrderToBinOrder()
Specify the manner in which points are processed when a non-zero merge tolerance is specified...
void SetTraversalOrderToPointOrder()
Specify the manner in which points are processed when a non-zero merge tolerance is specified...
TraversalOrderType
Point merging is inherently an order-dependent process.
#define VTK_ID_MAX
Definition: vtkType.h:336
bool GetLargeIds()
Inform the user as to whether large ids are being used.
virtual vtkIdType FindClosestPoint(const double x[3])=0
Given a position x, return the id of the point closest to it.
virtual void Initialize()
Initialize locator.
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
virtual void GetSpacing(double spacing[3])
Provide an accessor to the bucket spacing.
virtual void GenerateRepresentation(int level, vtkPolyData *pd)=0
Method to build a representation at a particular level.
virtual void ForceBuildLocator()
Build the locator from the input dataset (even if UseExistingSearchStructure is on).
Definition: vtkLocator.h:167