VTK  9.2.6
vtkOctreePointLocator.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkOctreePointLocator.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 =========================================================================*/
15 /*----------------------------------------------------------------------------
16  Copyright (c) Sandia Corporation
17  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
18 ----------------------------------------------------------------------------*/
19 
40 #ifndef vtkOctreePointLocator_h
41 #define vtkOctreePointLocator_h
42 
44 #include "vtkCommonDataModelModule.h" // For export macro
45 
46 class vtkCellArray;
47 class vtkIdTypeArray;
49 class vtkPoints;
50 class vtkPolyData;
51 
52 class VTKCOMMONDATAMODEL_EXPORT vtkOctreePointLocator : public vtkAbstractPointLocator
53 {
54 public:
56  void PrintSelf(ostream& os, vtkIndent indent) override;
57 
58  static vtkOctreePointLocator* New();
59 
61 
64  vtkSetMacro(MaximumPointsPerRegion, int);
65  vtkGetMacro(MaximumPointsPerRegion, int);
67 
69 
72  vtkSetMacro(CreateCubicOctants, int);
73  vtkGetMacro(CreateCubicOctants, int);
75 
77 
83  vtkGetMacro(FudgeFactor, double);
84  vtkSetMacro(FudgeFactor, double);
86 
88 
92  double* GetBounds() override;
93  void GetBounds(double* bounds) override;
95 
97 
100  vtkGetMacro(NumberOfLeafNodes, int);
102 
106  void GetRegionBounds(int regionID, double bounds[6]);
107 
111  void GetRegionDataBounds(int leafNodeID, double bounds[6]);
112 
116  int GetRegionContainingPoint(double x, double y, double z);
117 
125  void BuildLocator() override;
126 
130  void ForceBuildLocator() override;
131 
133 
137  vtkIdType FindClosestPoint(const double x[3]) override;
138  vtkIdType FindClosestPoint(double x, double y, double z, double& dist2);
140 
146  vtkIdType FindClosestPointWithinRadius(double radius, const double x[3], double& dist2) override;
147 
149 
154  vtkIdType FindClosestPointInRegion(int regionId, double* x, double& dist2);
155  vtkIdType FindClosestPointInRegion(int regionId, double x, double y, double z, double& dist2);
157 
162  void FindPointsWithinRadius(double radius, const double x[3], vtkIdList* result) override;
163 
172  void FindClosestNPoints(int N, const double x[3], vtkIdList* result) override;
173 
177  VTK_NEWINSTANCE vtkIdTypeArray* GetPointsInRegion(int leafNodeId);
178 
182  void FreeSearchStructure() override;
183 
188  void GenerateRepresentation(int level, vtkPolyData* pd) override;
189 
196  void FindPointsInArea(double* area, vtkIdTypeArray* ids, bool clearArray = true);
197 
198 protected:
200  ~vtkOctreePointLocator() override;
201 
202  void BuildLocatorInternal() override;
203 
205  vtkOctreePointLocatorNode** LeafNodeList; // indexed by region/node ID
206 
207  void BuildLeafNodeList(vtkOctreePointLocatorNode* node, int& index);
208 
210 
214  int FindRegion(vtkOctreePointLocatorNode* node, float x, float y, float z);
215  int FindRegion(vtkOctreePointLocatorNode* node, double x, double y, double z);
217 
218  static void SetDataBoundsToSpatialBounds(vtkOctreePointLocatorNode* node);
219 
220  static void DeleteAllDescendants(vtkOctreePointLocatorNode* octant);
221 
228  vtkOctreePointLocatorNode* node, double radiusSquared, const double x[3], vtkIdList* ids);
229 
230  // Recursive helper for public FindPointsWithinRadius
231  void AddAllPointsInRegion(vtkOctreePointLocatorNode* node, vtkIdList* ids);
232 
233  // Recursive helper for public FindPointsInArea
234  void FindPointsInArea(vtkOctreePointLocatorNode* node, double* area, vtkIdTypeArray* ids);
235 
236  // Recursive helper for public FindPointsInArea
237  void AddAllPointsInRegion(vtkOctreePointLocatorNode* node, vtkIdTypeArray* ids);
238 
239  void DivideRegion(vtkOctreePointLocatorNode* node, int* ordering, int level);
240 
241  int DivideTest(int size, int level);
242 
243  void AddPolys(vtkOctreePointLocatorNode* node, vtkPoints* pts, vtkCellArray* polys);
244 
249  int FindClosestPointInRegion_(int leafNodeId, double x, double y, double z, double& dist2);
250 
258  int FindClosestPointInSphere(
259  double x, double y, double z, double radius, int skipRegion, double& dist2);
260 
262 
268 
269  double FudgeFactor; // a very small distance, relative to the dataset's size
273 
274  float MaxWidth;
275 
284 
286  void operator=(const vtkOctreePointLocator&) = delete;
287 };
288 #endif
virtual void BuildLocator()=0
Build the locator from the input dataset.
an octree spatial decomposition of a set of points
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...
int CreateCubicOctants
If CreateCubicOctants is non-zero, the bounding box of the points will be expanded such that all octa...
virtual double * GetBounds()
Provide an accessor to the bounds.
int MaximumPointsPerRegion
The maximum number of points in a region/octant before it is subdivided.
dynamic, self-adjusting array of vtkIdType
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.
int NumberOfLeafNodes
The maximum number of points in a region/octant before it is subdivided.
vtkOctreePointLocatorNode ** LeafNodeList
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
virtual void FindPointsWithinRadius(double R, const double x[3], vtkIdList *result)=0
Find all points within a specified radius R of position x.
virtual void FindClosestNPoints(int N, const double x[3], vtkIdList *result)=0
Find the closest N points to a position.
#define VTK_NEWINSTANCE
object to represent cell connectivity
Definition: vtkCellArray.h:186
Octree node that has 8 children each of equal size.
vtkOctreePointLocatorNode * Top
virtual vtkIdType FindClosestPoint(const double x[3])=0
Given a position x, return the id of the point closest to it.
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.
represent and manipulate 3D points
Definition: vtkPoints.h:39
virtual void ForceBuildLocator()
Build the locator from the input dataset (even if UseExistingSearchStructure is on).
Definition: vtkLocator.h:167