VTK  9.3.0
vtkCellLocator.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
45 #ifndef vtkCellLocator_h
46 #define vtkCellLocator_h
47 
48 #include "vtkAbstractCellLocator.h"
49 #include "vtkCommonDataModelModule.h" // For export macro
50 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
51 #include "vtkNew.h" // For vtkNew
52 
53 VTK_ABI_NAMESPACE_BEGIN
54 class vtkIntArray;
55 
56 class VTKCOMMONDATAMODEL_EXPORT vtkCellLocator : public vtkAbstractCellLocator
57 {
58 public:
60 
64  void PrintSelf(ostream& os, vtkIndent indent) override;
66 
71  static vtkCellLocator* New();
72 
78 
79  // Re-use any superclass signatures that we don't override.
84 
91  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
92  double pcoords[3], int& subId, vtkIdType& cellId, vtkGenericCell* cell) override;
93 
103  int IntersectWithLine(const double p1[3], const double p2[3], double tol, vtkPoints* points,
104  vtkIdList* cellIds, vtkGenericCell* cell) override;
105 
115  void FindClosestPoint(const double x[3], double closestPoint[3], vtkGenericCell* cell,
116  vtkIdType& cellId, int& subId, double& dist2) override
117  {
118  this->Superclass::FindClosestPoint(x, closestPoint, cell, cellId, subId, dist2);
119  }
120 
133  vtkIdType FindClosestPointWithinRadius(double x[3], double radius, double closestPoint[3],
134  vtkGenericCell* cell, vtkIdType& cellId, int& subId, double& dist2, int& inside) override;
135 
143  vtkIdType FindCell(double x[3], double vtkNotUsed(tol2), vtkGenericCell* GenCell, int& subId,
144  double pcoords[3], double* weights) override;
145 
150  void FindCellsWithinBounds(double* bbox, vtkIdList* cells) override;
151 
161  const double p1[3], const double p2[3], double tolerance, vtkIdList* cellsIds) override
162  {
163  this->Superclass::FindCellsAlongLine(p1, p2, tolerance, cellsIds);
164  }
165 
167 
170  void FreeSearchStructure() override;
171  void BuildLocator() override;
172  void ForceBuildLocator() override;
173  void GenerateRepresentation(int level, vtkPolyData* pd) override;
175 
176  VTK_DEPRECATED_IN_9_2_0("This method is deprecated because LazyEvaluation has been deprecated")
177  virtual void BuildLocatorIfNeeded() {}
178 
182  virtual vtkIdList* GetCells(int bucket);
183 
188  virtual int GetNumberOfBuckets();
189 
193  void ShallowCopy(vtkAbstractCellLocator* locator) override;
194 
195 protected:
197  ~vtkCellLocator() override;
198 
199  void BuildLocatorInternal() override;
200 
201  //------------------------------------------------------------------------------
203  {
204  public:
206 
207  inline int GetNumberOfNeighbors();
208 
209  inline void Reset();
210 
211  inline int* GetPoint(int i);
212 
213  inline int InsertNextPoint(int* x);
214 
215  protected:
217  };
218 
219  void GetOverlappingBuckets(vtkNeighborCells& buckets, const double x[3], double dist,
220  int prevMinLevel[3], int prevMaxLevel[3]);
221 
222  inline void GetBucketIndices(const double x[3], int ijk[3]);
223 
224  double Distance2ToBucket(const double x[3], int nei[3]);
225  double Distance2ToBounds(const double x[3], double bounds[6]);
226 
227  int NumberOfOctants; // number of octants in tree
228  double Bounds[6]; // bounding box root octant
229  double H[3]; // width of leaf octant in x-y-z directions
230  int NumberOfDivisions; // number of "leaf" octant sub-divisions
231  std::shared_ptr<std::vector<vtkSmartPointer<vtkIdList>>> TreeSharedPtr;
233 
234  void MarkParents(const vtkSmartPointer<vtkIdList>&, int, int, int, int, int);
235  int GenerateIndex(int offset, int numDivs, int i, int j, int k, vtkIdType& idx);
237  int face, int numDivs, int i, int j, int k, vtkPoints* pts, vtkCellArray* polys);
238  void ComputeOctantBounds(double octantBounds[6], int i, int j, int k);
239 
240 private:
241  vtkCellLocator(const vtkCellLocator&) = delete;
242  void operator=(const vtkCellLocator&) = delete;
243 };
244 
245 VTK_ABI_NAMESPACE_END
246 #endif
an abstract base class for locators which find cells
virtual vtkIdType FindCell(double x[3])
Returns the Id of the cell containing the point, returns -1 if no cell found.
virtual void SetNumberOfCellsPerNode(int)
Specify the preferred/maximum number of cells in each node/bucket.
virtual void FindClosestPoint(const double x[3], double closestPoint[3], vtkIdType &cellId, int &subId, double &dist2)
Return the closest point and the cell which is closest to the point x.
virtual vtkIdType FindClosestPointWithinRadius(double x[3], double radius, double closestPoint[3], vtkIdType &cellId, int &subId, double &dist2)
Return the closest point within a specified radius and the cell which is closest to the point x.
virtual int IntersectWithLine(const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)
Return intersection point (if any) of finite line with cells contained in cell locator.
object to represent cell connectivity
Definition: vtkCellArray.h:185
vtkNew< vtkIntArray > Points
octree-based spatial search object to quickly locate cells
void MarkParents(const vtkSmartPointer< vtkIdList > &, int, int, int, int, int)
void FreeSearchStructure() override
Satisfy vtkLocator abstract interface.
~vtkCellLocator() override
double Distance2ToBounds(const double x[3], double bounds[6])
int GenerateIndex(int offset, int numDivs, int i, int j, int k, vtkIdType &idx)
int GetNumberOfCellsPerBucket()
void GetBucketIndices(const double x[3], int ijk[3])
void GenerateRepresentation(int level, vtkPolyData *pd) override
Satisfy vtkLocator abstract interface.
void GetOverlappingBuckets(vtkNeighborCells &buckets, const double x[3], double dist, int prevMinLevel[3], int prevMaxLevel[3])
virtual int GetNumberOfBuckets()
Return number of buckets available.
void SetNumberOfCellsPerBucket(int N)
Specify the average number of cells in each octant.
void FindCellsWithinBounds(double *bbox, vtkIdList *cells) override
Return a list of unique cell ids inside of a given bounding box.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods to print and obtain type-related information.
void ComputeOctantBounds(double octantBounds[6], int i, int j, int k)
double Distance2ToBucket(const double x[3], int nei[3])
int IntersectWithLine(const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId, vtkIdType &cellId, vtkGenericCell *cell) override
Return intersection point (if any) AND the cell which was intersected by the finite line.
std::shared_ptr< std::vector< vtkSmartPointer< vtkIdList > > > TreeSharedPtr
static vtkCellLocator * New()
Construct with automatic computation of divisions, averaging 25 cells per bucket.
void GenerateFace(int face, int numDivs, int i, int j, int k, vtkPoints *pts, vtkCellArray *polys)
int IntersectWithLine(const double p1[3], const double p2[3], double tol, vtkPoints *points, vtkIdList *cellIds, vtkGenericCell *cell) override
Take the passed line segment and intersect it with the data set.
virtual vtkIdList * GetCells(int bucket)
Get the cells in a particular bucket.
void BuildLocatorInternal() override
This function is not pure virtual to maintain backwards compatibility.
void FindCellsAlongLine(const double p1[3], const double p2[3], double tolerance, vtkIdList *cellsIds) override
Take the passed line segment and intersect it with the data set.
void ForceBuildLocator() override
Satisfy vtkLocator abstract interface.
void ShallowCopy(vtkAbstractCellLocator *locator) override
Shallow copy of a vtkCellLocator.
vtkSmartPointer< vtkIdList > * Tree
vtkIdType FindClosestPointWithinRadius(double x[3], double radius, double closestPoint[3], vtkGenericCell *cell, vtkIdType &cellId, int &subId, double &dist2, int &inside) override
Return the closest point within a specified radius and the cell which is closest to the point x.
void BuildLocator() override
Satisfy vtkLocator abstract interface.
void FindClosestPoint(const double x[3], double closestPoint[3], vtkGenericCell *cell, vtkIdType &cellId, int &subId, double &dist2) override
Return the closest point and the cell which is closest to the point x.
vtkIdType FindCell(double x[3], double vtkNotUsed(tol2), vtkGenericCell *GenCell, int &subId, double pcoords[3], double *weights) override
Find the cell containing a given point.
provides thread-safe access to cells
list of point or cell ids
Definition: vtkIdList.h:32
a simple class to control print indentation
Definition: vtkIndent.h:38
dynamic, self-adjusting array of int
Definition: vtkIntArray.h:44
represent and manipulate 3D points
Definition: vtkPoints.h:38
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:89
@ points
Definition: vtkX3D.h:446
@ level
Definition: vtkX3D.h:395
@ radius
Definition: vtkX3D.h:252
@ size
Definition: vtkX3D.h:253
@ offset
Definition: vtkX3D.h:438
#define VTK_DEPRECATED_IN_9_2_0(reason)
int vtkIdType
Definition: vtkType.h:315