VTK
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 
53 #include "vtkCommonDataModelModule.h" // For export macro
55 
56 class vtkIdList;
57 class vtkBucketList;
58 
59 
60 class VTKCOMMONDATAMODEL_EXPORT vtkStaticPointLocator : public vtkAbstractPointLocator
61 {
62 friend class vtkBucketList;
63 public:
68  static vtkStaticPointLocator *New();
69 
71 
75  void PrintSelf(ostream& os, vtkIndent indent) override;
77 
79 
84  vtkSetClampMacro(NumberOfPointsPerBucket,int,1,VTK_INT_MAX);
85  vtkGetMacro(NumberOfPointsPerBucket,int);
87 
89 
95  vtkSetVector3Macro(Divisions,int);
96  vtkGetVectorMacro(Divisions,int,3);
98 
99  // Re-use any superclass signatures that we don't override.
104 
111  vtkIdType FindClosestPoint(const double x[3]) override;
112 
114 
123  double radius, const double x[3], double& dist2) override;
124  virtual vtkIdType FindClosestPointWithinRadius(double radius, const double x[3],
125  double inputDataLength,
126  double& dist2);
128 
137  void FindClosestNPoints(int N, const double x[3], vtkIdList *result) override;
138 
145  void FindPointsWithinRadius(double R, const double x[3],
146  vtkIdList *result) override;
147 
157  int IntersectWithLine(double a0[3], double a1[3], double tol, double& t,
158  double lineX[3], double ptX[3], vtkIdType &ptId);
159 
160 
162 
166  void Initialize() override;
167  void FreeSearchStructure() override;
168  void BuildLocator() override;
170 
176  void GenerateRepresentation(int level, vtkPolyData *pd) override;
177 
182  vtkIdType GetNumberOfPointsInBucket(vtkIdType bNum);
183 
189  void GetBucketIds(vtkIdType bNum, vtkIdList *bList);
190 
192 
206  vtkSetClampMacro(MaxNumberOfBuckets,vtkIdType,1000,VTK_ID_MAX);
207  vtkGetMacro(MaxNumberOfBuckets,vtkIdType);
209 
217  bool GetLargeIds() {return this->LargeIds;}
218 
219 protected:
221  ~vtkStaticPointLocator() override;
222 
223  int NumberOfPointsPerBucket; // Used with AutomaticOn to control subdivide
224  int Divisions[3]; // Number of sub-divisions in x-y-z directions
225  double H[3]; // Width of each bucket in x-y-z directions
226  vtkBucketList *Buckets; // Lists of point ids in each bucket
227  vtkIdType MaxNumberOfBuckets; // Maximum number of buckets in locator
228  bool LargeIds; //indicate whether integer ids are small or large
229 
230 private:
232  void operator=(const vtkStaticPointLocator&) = delete;
233 
234 };
235 
236 #endif
virtual void BuildLocator()=0
Build the locator from the input dataset.
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:157
virtual double * GetBounds()
Provide an accessor to the bounds.
int vtkIdType
Definition: vtkType.h:345
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:79
virtual void FreeSearchStructure()=0
Free the memory required for the spatial data structure.
a simple class to control print indentation
Definition: vtkIndent.h:33
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:30
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.
#define VTK_ID_MAX
Definition: vtkType.h:349
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 GenerateRepresentation(int level, vtkPolyData *pd)=0
Method to build a representation at a particular level.