VTK  9.3.0
vtkCellTreeLocator.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
51 #ifndef vtkCellTreeLocator_h
52 #define vtkCellTreeLocator_h
53 
54 #include "vtkAbstractCellLocator.h"
55 #include "vtkCommonDataModelModule.h" // For export macro
56 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
57 
58 namespace detail
59 {
60 VTK_ABI_NAMESPACE_BEGIN
61 // Forward declarations for PIMPL
62 struct vtkCellTree;
63 template <typename T>
64 struct CellTree;
65 template <typename T>
67 VTK_ABI_NAMESPACE_END
68 }
69 
70 VTK_ABI_NAMESPACE_BEGIN
71 class VTKCOMMONDATAMODEL_EXPORT vtkCellTreeLocator : public vtkAbstractCellLocator
72 {
73  template <typename>
74  friend struct detail::CellTree;
75  template <typename>
76  friend struct detail::CellTreeBuilder;
77 
78 public:
80 
84  void PrintSelf(ostream& os, vtkIndent indent) override;
86 
92 
94 
99  vtkSetMacro(NumberOfBuckets, int);
100  vtkGetMacro(NumberOfBuckets, int);
102 
110  bool GetLargeIds() { return this->LargeIds; }
111 
112  // Re-use any superclass signatures that we don't override.
115 
120  int IntersectWithLine(const double a0[3], const double a1[3], double tol, double& t, double x[3],
121  double pcoords[3], int& subId, vtkIdType& cellId, vtkGenericCell* cell) override;
122 
132  int IntersectWithLine(const double p1[3], const double p2[3], double tol, vtkPoints* points,
133  vtkIdList* cellIds, vtkGenericCell* cell) override;
134 
139  void FindCellsWithinBounds(double* bbox, vtkIdList* cells) override;
140 
150  const double p1[3], const double p2[3], double tolerance, vtkIdList* cellsIds) override
151  {
152  this->Superclass::FindCellsAlongLine(p1, p2, tolerance, cellsIds);
153  }
154 
160  vtkIdType FindCell(double pos[3], double vtkNotUsed(tol2), vtkGenericCell* cell, int& subId,
161  double pcoords[3], double* weights) override;
162 
164 
167  void FreeSearchStructure() override;
168  void BuildLocator() override;
169  void ForceBuildLocator() override;
170  void GenerateRepresentation(int level, vtkPolyData* pd) override;
172 
173  VTK_DEPRECATED_IN_9_2_0("This method is deprecated because LazyEvaluation has been deprecated")
174  virtual void BuildLocatorIfNeeded() {}
175 
179  void ShallowCopy(vtkAbstractCellLocator* locator) override;
180 
181 protected:
184 
185  void BuildLocatorInternal() override;
186 
188  bool LargeIds = false;
189 
190  detail::vtkCellTree* Tree;
191 
192 private:
193  vtkCellTreeLocator(const vtkCellTreeLocator&) = delete;
194  void operator=(const vtkCellTreeLocator&) = delete;
195 };
196 VTK_ABI_NAMESPACE_END
197 
198 #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 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.
This class implements the data structures, construction algorithms for fast cell location.
void FindCellsWithinBounds(double *bbox, vtkIdList *cells) override
Return a list of unique cell ids inside of a given bounding box.
int IntersectWithLine(const double a0[3], const double a1[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.
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.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods to print and obtain type-related information.
static vtkCellTreeLocator * New()
Constructor sets the maximum number of cells in a leaf to 8 and number of buckets to 6.
void BuildLocatorInternal() override
This function is not pure virtual to maintain backwards compatibility.
void ForceBuildLocator() override
Satisfy vtkLocator abstract interface.
vtkIdType FindCell(double pos[3], double vtkNotUsed(tol2), vtkGenericCell *cell, int &subId, double pcoords[3], double *weights) override
Find the cell containing a given point.
bool GetLargeIds()
Inform the user as to whether large ids are being used.
~vtkCellTreeLocator() override
detail::vtkCellTree * Tree
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 FreeSearchStructure() override
Satisfy vtkLocator abstract interface.
void ShallowCopy(vtkAbstractCellLocator *locator) override
Shallow copy of a vtkCellTreeLocator.
void GenerateRepresentation(int level, vtkPolyData *pd) override
Satisfy vtkLocator abstract interface.
void BuildLocator() override
Satisfy vtkLocator abstract interface.
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
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
#define VTK_DEPRECATED_IN_9_2_0(reason)
int vtkIdType
Definition: vtkType.h:315