VTK  9.2.5
vtkStaticCellLocator.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkStaticCellLocator.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=========================================================================*/
52#ifndef vtkStaticCellLocator_h
53#define vtkStaticCellLocator_h
54
56#include "vtkCommonDataModelModule.h" // For export macro
57#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
58
59// Forward declarations for PIMPL
60struct vtkCellBinner;
61struct vtkCellProcessor;
62
63class VTKCOMMONDATAMODEL_EXPORT vtkStaticCellLocator : public vtkAbstractCellLocator
64{
65 friend struct vtkCellBinner;
66 friend struct vtkCellProcessor;
67
68public:
70
75 void PrintSelf(ostream& os, vtkIndent indent) override;
77
79
85 vtkSetVector3Macro(Divisions, int);
86 vtkGetVectorMacro(Divisions, int, 3);
88
90
104 vtkSetClampMacro(MaxNumberOfBuckets, vtkIdType, 1000, VTK_ID_MAX);
105 vtkGetMacro(MaxNumberOfBuckets, vtkIdType);
107
115 bool GetLargeIds() { return this->LargeIds; }
116
118
129 VTK_DEPRECATED_IN_9_2_0("This method is no longer used because Tolerance is also not used")
130 vtkSetMacro(UseDiagonalLengthTolerance, bool);
131 VTK_DEPRECATED_IN_9_2_0("This method is no longer used because Tolerance is also not used")
132 vtkGetMacro(UseDiagonalLengthTolerance, bool);
133 VTK_DEPRECATED_IN_9_2_0("This method is no longer used because Tolerance is also not used")
134 virtual void UseDiagonalLengthToleranceOn()
135 {
136 if (this->UseDiagonalLengthTolerance != true)
137 {
138 this->UseDiagonalLengthTolerance = true;
139 this->Modified();
140 }
141 }
142 VTK_DEPRECATED_IN_9_2_0("This method is no longer used because Tolerance is also not used")
143 virtual void UseDiagonalLengthToleranceOff()
144 {
145 if (this->UseDiagonalLengthTolerance != false)
146 {
147 this->UseDiagonalLengthTolerance = false;
148 this->Modified();
149 }
150 }
152
153 // Re-use any superclass signatures that we don't override.
158
165 int IntersectWithLine(const double a0[3], const double a1[3], double tol, double& t, double x[3],
166 double pcoords[3], int& subId, vtkIdType& cellId, vtkGenericCell* cell) override;
167
177 int IntersectWithLine(const double p1[3], const double p2[3], const double tol, vtkPoints* points,
178 vtkIdList* cellIds, vtkGenericCell* cell) override;
179
189 void FindClosestPoint(const double x[3], double closestPoint[3], vtkGenericCell* cell,
190 vtkIdType& cellId, int& subId, double& dist2) override
191 {
192 this->Superclass::FindClosestPoint(x, closestPoint, cell, cellId, subId, dist2);
193 }
194
205 vtkIdType FindClosestPointWithinRadius(double x[3], double radius, double closestPoint[3],
206 vtkGenericCell* cell, vtkIdType& cellId, int& subId, double& dist2, int& inside) override;
207
212 void FindCellsWithinBounds(double* bbox, vtkIdList* cells) override;
213
223 const double p1[3], const double p2[3], double tolerance, vtkIdList* cellsIds) override
224 {
225 this->Superclass::FindCellsAlongLine(p1, p2, tolerance, cellsIds);
226 }
227
235 const double o[3], const double n[3], double tolerance, vtkIdList* cells) override;
236
244 vtkIdType FindCell(double x[3], double vtkNotUsed(tol2), vtkGenericCell* GenCell, int& subId,
245 double pcoords[3], double* weights) override;
246
251 bool InsideCellBounds(double x[3], vtkIdType cellId) override;
252
254
257 void GenerateRepresentation(int level, vtkPolyData* pd) override;
258 void FreeSearchStructure() override;
259 void BuildLocator() override;
260 void ForceBuildLocator() override;
262
266 void ShallowCopy(vtkAbstractCellLocator* locator) override;
267
268protected:
271
272 void BuildLocatorInternal() override;
273
274 double Bounds[6]; // Bounding box of the whole dataset
275 int Divisions[3]; // Number of sub-divisions in x-y-z directions
276 double H[3]; // Width of each bin in x-y-z directions
277
278 vtkIdType MaxNumberOfBuckets; // Maximum number of buckets in locator
279 bool LargeIds; // indicate whether integer ids are small or large
280
281 // VTK_DEPRECATED_IN_9_2_0 This attribute needs to be removed
282 bool UseDiagonalLengthTolerance = false;
283
284 // Support PIMPLd implementation
285 vtkCellBinner* Binner; // Does the binning
286 vtkCellProcessor* Processor; // Invokes methods (templated subclasses)
287
288private:
290 void operator=(const vtkStaticCellLocator&) = delete;
291};
292
293#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 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.
provides thread-safe access to cells
list of point or cell ids
Definition: vtkIdList.h:34
a simple class to control print indentation
Definition: vtkIndent.h:40
virtual void Modified()
Update the modification time for this object.
represent and manipulate 3D points
Definition: vtkPoints.h:40
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:91
perform fast cell location operations
static vtkStaticCellLocator * New()
Standard methods to instantiate, print and obtain type-related information.
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 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 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.
void FindCellsWithinBounds(double *bbox, vtkIdList *cells) override
Return a list of unique cell ids inside of a given bounding box.
void FindCellsAlongPlane(const double o[3], const double n[3], double tolerance, vtkIdList *cells) override
Take the passed line segment and intersect it with the data set.
void ShallowCopy(vtkAbstractCellLocator *locator) override
Shallow copy of a vtkStaticCellLocator.
int IntersectWithLine(const double p1[3], const double p2[3], const double tol, vtkPoints *points, vtkIdList *cellIds, vtkGenericCell *cell) override
Take the passed line segment and intersect it with the data set.
void BuildLocator() override
Satisfy vtkLocator abstract interface.
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.
bool InsideCellBounds(double x[3], vtkIdType cellId) override
Quickly test if a point is inside the bounds of a particular cell.
~vtkStaticCellLocator() override
vtkCellProcessor * Processor
bool GetLargeIds()
Inform the user as to whether large ids are being used.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods to instantiate, print and obtain type-related information.
void BuildLocatorInternal() override
This function is not pure virtual to maintain backwards compatibility.
void GenerateRepresentation(int level, vtkPolyData *pd) override
Satisfy vtkLocator abstract interface.
void FreeSearchStructure() override
Satisfy vtkLocator abstract interface.
void ForceBuildLocator() override
Satisfy vtkLocator abstract interface.
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.
#define VTK_DEPRECATED_IN_9_2_0(reason)
int vtkIdType
Definition: vtkType.h:332
#define VTK_ID_MAX
Definition: vtkType.h:336