VTK  9.3.0
vtkModifiedBSPTree.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-FileCopyrightText: Copyright (c) 1997-2009 John Biddiscombe
3// SPDX-License-Identifier: BSD-3-Clause
132#ifndef vtkModifiedBSPTree_h
133#define vtkModifiedBSPTree_h
134
136#include "vtkFiltersFlowPathsModule.h" // For export macro
137#include "vtkSmartPointer.h" // required because it is nice
138
139VTK_ABI_NAMESPACE_BEGIN
140class Sorted_cell_extents_Lists;
141class BSPNode;
142class vtkGenericCell;
143class vtkIdList;
145
146class VTKFILTERSFLOWPATHS_EXPORT vtkModifiedBSPTree : public vtkAbstractCellLocator
147{
148public:
150
154 void PrintSelf(ostream& os, vtkIndent indent) override;
156
161
162 // Re-use any superclass signatures that we don't override.
165
172 int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
173 double pcoords[3], int& subId, vtkIdType& cellId, vtkGenericCell* cell) override;
174
184 int IntersectWithLine(const double p1[3], const double p2[3], double tol, vtkPoints* points,
185 vtkIdList* cellIds, vtkGenericCell* cell) override;
186
196 const double p1[3], const double p2[3], double tolerance, vtkIdList* cellsIds) override
197 {
198 this->Superclass::FindCellsAlongLine(p1, p2, tolerance, cellsIds);
199 }
200
208 vtkIdType FindCell(double x[3], double vtkNotUsed(tol2), vtkGenericCell* GenCell, int& subId,
209 double pcoords[3], double* weights) override;
210
217
222
224
227 void GenerateRepresentation(int level, vtkPolyData* pd) override;
228 void FreeSearchStructure() override;
229 void BuildLocator() override;
230 void ForceBuildLocator() override;
232
236 void ShallowCopy(vtkAbstractCellLocator* locator) override;
237
238protected:
241
242 void BuildLocatorInternal() override;
243 std::shared_ptr<BSPNode> mRoot; // bounding box root node
244 int npn;
245 int nln;
247
248 // The main subdivision routine
249 void Subdivide(BSPNode* node, Sorted_cell_extents_Lists* lists, vtkDataSet* dataSet,
250 vtkIdType nCells, int depth, int maxlevel, vtkIdType maxCells, int& MaxDepth);
251
252private:
253 vtkModifiedBSPTree(const vtkModifiedBSPTree&) = delete;
254 void operator=(const vtkModifiedBSPTree&) = delete;
255};
256
258// BSP Node
259// A BSP Node is a BBox - axis aligned etc etc
261#ifndef DOXYGEN_SHOULD_SKIP_THIS
262
263class BSPNode
264{
265public:
266 // Constructor
267 BSPNode()
268 {
269 mChild[0] = mChild[1] = mChild[2] = nullptr;
270 for (int i = 0; i < 6; i++)
271 sorted_cell_lists[i] = nullptr;
272 for (int i = 0; i < 3; i++)
273 {
274 this->Bounds[i * 2] = VTK_FLOAT_MAX;
275 this->Bounds[i * 2 + 1] = -VTK_FLOAT_MAX;
276 }
277 }
278 // Destructor
279 ~BSPNode()
280 {
281 for (int i = 0; i < 3; i++)
282 delete mChild[i];
283 for (int i = 0; i < 6; i++)
284 delete[] sorted_cell_lists[i];
285 }
286 // Set min box limits
287 void setMin(double minx, double miny, double minz)
288 {
289 this->Bounds[0] = minx;
290 this->Bounds[2] = miny;
291 this->Bounds[4] = minz;
292 }
293 // Set max box limits
294 void setMax(double maxx, double maxy, double maxz)
295 {
296 this->Bounds[1] = maxx;
297 this->Bounds[3] = maxy;
298 this->Bounds[5] = maxz;
299 }
300 //
301 bool Inside(double point[3]) const;
302 // BBox
303 double Bounds[6];
304
305protected:
306 // The child nodes of this one (if present - nullptr otherwise)
307 BSPNode* mChild[3];
308 // The axis we subdivide this voxel along
309 int mAxis;
310 // Just for reference
311 int depth;
312 // the number of cells in this node
313 int num_cells;
314 // 6 lists, sorted after the 6 dominant axes
315 vtkIdType* sorted_cell_lists[6];
316 // Order nodes as near/mid far relative to ray
317 void Classify(const double origin[3], const double dir[3], double& rDist, BSPNode*& Near,
318 BSPNode*& Mid, BSPNode*& Far) const;
319 friend class vtkModifiedBSPTree;
320
321public:
322 static int VTKFILTERSFLOWPATHS_EXPORT getDominantAxis(const double dir[3]);
323};
324
325#endif /* DOXYGEN_SHOULD_SKIP_THIS */
326
327VTK_ABI_NAMESPACE_END
328#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.
abstract class to specify dataset behavior
Definition vtkDataSet.h:53
provides thread-safe access to cells
maintain an ordered list of IdList objects
list of point or cell ids
Definition vtkIdList.h:23
a simple class to control print indentation
Definition vtkIndent.h:29
Generate axis aligned BBox tree for ray-casting and other Locator based searches.
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.
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 ShallowCopy(vtkAbstractCellLocator *locator) override
Shallow copy of a vtkModifiedBSPTree.
std::shared_ptr< BSPNode > mRoot
~vtkModifiedBSPTree() override
void GenerateRepresentation(int level, vtkPolyData *pd) override
Satisfy vtkLocator abstract interface.
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.
vtkIdListCollection * GetLeafNodeCellInformation()
After subdivision has completed, one may wish to query the tree to find which cells are in which leaf...
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.
void BuildLocatorInternal() override
This function is not pure virtual to maintain backwards compatibility.
void ForceBuildLocator() override
Satisfy vtkLocator abstract interface.
virtual void GenerateRepresentationLeafs(vtkPolyData *pd)
Generate BBox representation of all leaf nodes.
void Subdivide(BSPNode *node, Sorted_cell_extents_Lists *lists, vtkDataSet *dataSet, vtkIdType nCells, int depth, int maxlevel, vtkIdType maxCells, int &MaxDepth)
void FreeSearchStructure() override
Satisfy vtkLocator abstract interface.
void BuildLocator() override
Satisfy vtkLocator abstract interface.
static vtkModifiedBSPTree * New()
Construct with maximum 32 cells per node.
represent and manipulate 3D points
Definition vtkPoints.h:29
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition vtkPolyData.h:80
int vtkIdType
Definition vtkType.h:315
#define VTK_FLOAT_MAX
Definition vtkType.h:152