VTK  9.3.0
vtkOBBTree.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
57 #ifndef vtkOBBTree_h
58 #define vtkOBBTree_h
59 
60 #include "vtkAbstractCellLocator.h"
61 #include "vtkFiltersGeneralModule.h" // For export macro
62 
63 VTK_ABI_NAMESPACE_BEGIN
64 class vtkMatrix4x4;
65 
66 // Special class defines node for the OBB tree
67 class VTKFILTERSGENERAL_EXPORT vtkOBBNode
68 { //;prevent man page generation
69 public:
72 
73  double Corner[3]; // center point of this node
74  double Axes[3][3]; // the axes defining the OBB - ordered from long->short
75  vtkOBBNode* Parent; // parent node; nullptr if root
76  vtkOBBNode** Kids; // two children of this node; nullptr if leaf
77  vtkIdList* Cells; // list of cells in node
78  void DebugPrintTree(int level, double* leaf_vol, int* minCells, int* maxCells);
79 
80 private:
81  vtkOBBNode(const vtkOBBNode& other) = delete;
82  vtkOBBNode& operator=(const vtkOBBNode& rhs) = delete;
83 };
84 
85 class VTKFILTERSGENERAL_EXPORT vtkOBBTree : public vtkAbstractCellLocator
86 {
87 public:
89 
93  void PrintSelf(ostream& os, vtkIndent indent) override;
95 
100  static vtkOBBTree* New();
101 
102  // Re-use any superclass signatures that we don't override.
104 
111  int IntersectWithLine(const double a0[3], const double a1[3], double tol, double& t, double x[3],
112  double pcoords[3], int& subId, vtkIdType& cellId, vtkGenericCell* cell) override;
113 
126  const double a0[3], const double a1[3], vtkPoints* points, vtkIdList* cellIds) override;
127 
133  static void ComputeOBB(
134  vtkPoints* pts, double corner[3], double max[3], double mid[3], double min[3], double size[3]);
135 
142  void ComputeOBB(vtkDataSet* input, double corner[3], double max[3], double mid[3], double min[3],
143  double size[3]);
144 
150  int InsideOrOutside(const double point[3]);
151 
156  int DisjointOBBNodes(vtkOBBNode* nodeA, vtkOBBNode* nodeB, vtkMatrix4x4* XformBtoA);
157 
161  int LineIntersectsNode(vtkOBBNode* pA, const double b0[3], const double b1[3]);
162 
167  vtkOBBNode* pA, double p0[3], double p1[3], double p2[3], vtkMatrix4x4* XformBtoA);
168 
173  int IntersectWithOBBTree(vtkOBBTree* OBBTreeB, vtkMatrix4x4* XformBtoA,
174  int (*function)(vtkOBBNode* nodeA, vtkOBBNode* nodeB, vtkMatrix4x4* Xform, void* arg),
175  void* data_arg);
176 
178 
181  void FreeSearchStructure() override;
182  void BuildLocator() override;
183  void ForceBuildLocator() override;
185 
195  void GenerateRepresentation(int level, vtkPolyData* pd) override;
196 
197 protected:
199  ~vtkOBBTree() override;
200 
201  void BuildLocatorInternal() override;
202 
203  // Compute an OBB from the list of cells given. This used to be
204  // public but should not have been. A public call has been added
205  // so that the functionality can be accessed.
206  void ComputeOBB(vtkIdList* cells, double corner[3], double max[3], double mid[3], double min[3],
207  double size[3]);
208 
210  void BuildTree(vtkIdList* cells, vtkOBBNode* parent, int level);
213  int OBBCount;
214 
215  void DeleteTree(vtkOBBNode* OBBptr);
217  vtkOBBNode* OBBptr, int level, int repLevel, vtkPoints* pts, vtkCellArray* polys);
218 
219 private:
220  vtkOBBTree(const vtkOBBTree&) = delete;
221  void operator=(const vtkOBBTree&) = delete;
222 };
223 
224 VTK_ABI_NAMESPACE_END
225 #endif
an abstract base class for locators which find cells
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:176
abstract class to specify dataset behavior
Definition: vtkDataSet.h:53
provides thread-safe access to cells
list of point or cell ids
Definition: vtkIdList.h:23
a simple class to control print indentation
Definition: vtkIndent.h:29
represent and manipulate 4x4 transformation matrices
Definition: vtkMatrix4x4.h:31
vtkOBBNode * Parent
Definition: vtkOBBTree.h:75
vtkIdList * Cells
Definition: vtkOBBTree.h:77
void DebugPrintTree(int level, double *leaf_vol, int *minCells, int *maxCells)
vtkOBBNode ** Kids
Definition: vtkOBBTree.h:76
generate oriented bounding box (OBB) tree
Definition: vtkOBBTree.h:86
void ComputeOBB(vtkDataSet *input, double corner[3], double max[3], double mid[3], double min[3], double size[3])
Compute an OBB for the input dataset using the cells in the data.
void BuildLocator() override
Satisfy locator's abstract interface, see vtkLocator.
void FreeSearchStructure() override
Satisfy locator's abstract interface, see vtkLocator.
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 the first intersection of the specified line segment with the OBB tree, as well as information...
int DisjointOBBNodes(vtkOBBNode *nodeA, vtkOBBNode *nodeB, vtkMatrix4x4 *XformBtoA)
Returns true if nodeB and nodeA are disjoint after optional transformation of nodeB with matrix Xform...
int InsideOrOutside(const double point[3])
Determine whether a point is inside or outside the data used to build this OBB tree.
void GenerateRepresentation(int level, vtkPolyData *pd) override
Create polygonal representation for OBB tree at specified level.
void GeneratePolygons(vtkOBBNode *OBBptr, int level, int repLevel, vtkPoints *pts, vtkCellArray *polys)
~vtkOBBTree() override
vtkOBBNode * Tree
Definition: vtkOBBTree.h:209
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods to print and obtain type-related information.
void BuildLocatorInternal() override
This function is not pure virtual to maintain backwards compatibility.
static vtkOBBTree * New()
Construct with automatic computation of divisions, averaging 25 cells per octant.
int LineIntersectsNode(vtkOBBNode *pA, const double b0[3], const double b1[3])
Returns true if line intersects node.
void ComputeOBB(vtkIdList *cells, double corner[3], double max[3], double mid[3], double min[3], double size[3])
vtkPoints * PointsList
Definition: vtkOBBTree.h:211
int IntersectWithLine(const double a0[3], const double a1[3], vtkPoints *points, vtkIdList *cellIds) override
Take the passed line segment and intersect it with the data set.
int IntersectWithOBBTree(vtkOBBTree *OBBTreeB, vtkMatrix4x4 *XformBtoA, int(*function)(vtkOBBNode *nodeA, vtkOBBNode *nodeB, vtkMatrix4x4 *Xform, void *arg), void *data_arg)
For each intersecting leaf node pair, call function.
int TriangleIntersectsNode(vtkOBBNode *pA, double p0[3], double p1[3], double p2[3], vtkMatrix4x4 *XformBtoA)
Returns true if triangle (optionally transformed) intersects node.
int OBBCount
Definition: vtkOBBTree.h:213
int * InsertedPoints
Definition: vtkOBBTree.h:212
void ForceBuildLocator() override
Satisfy locator's abstract interface, see vtkLocator.
void DeleteTree(vtkOBBNode *OBBptr)
static void ComputeOBB(vtkPoints *pts, double corner[3], double max[3], double mid[3], double min[3], double size[3])
Compute an OBB from the list of points given.
void BuildTree(vtkIdList *cells, vtkOBBNode *parent, int level)
represent and manipulate 3D points
Definition: vtkPoints.h:29
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:80
@ point
Definition: vtkX3D.h:236
@ points
Definition: vtkX3D.h:446
@ level
Definition: vtkX3D.h:395
@ size
Definition: vtkX3D.h:253
int vtkIdType
Definition: vtkType.h:315
#define max(a, b)