VTK  9.3.1
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:
70  vtkOBBNode();
71  ~vtkOBBNode();
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 
125  int IntersectWithLine(
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 
166  int TriangleIntersectsNode(
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:
198  vtkOBBTree();
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);
216  void GeneratePolygons(
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
vtkOBBNode * Parent
Definition: vtkOBBTree.h:75
virtual void BuildLocator()=0
Build the locator from the input dataset.
represent and manipulate 4x4 transformation matrices
Definition: vtkMatrix4x4.h:30
vtkOBBNode ** Kids
Definition: vtkOBBTree.h:76
abstract class to specify dataset behavior
Definition: vtkDataSet.h:52
an abstract base class for locators which find cells
int * InsertedPoints
Definition: vtkOBBTree.h:212
int vtkIdType
Definition: vtkType.h:315
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:79
vtkIdList * Cells
Definition: vtkOBBTree.h:77
virtual void FreeSearchStructure()=0
Free the memory required for the spatial data structure.
provides thread-safe access to cells
generate oriented bounding box (OBB) tree
Definition: vtkOBBTree.h:85
vtkOBBNode * Tree
Definition: vtkOBBTree.h:209
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.
a simple class to control print indentation
Definition: vtkIndent.h:28
virtual void BuildLocatorInternal()
This function is not pure virtual to maintain backwards compatibility.
Definition: vtkLocator.h:192
int OBBCount
Definition: vtkOBBTree.h:213
list of point or cell ids
Definition: vtkIdList.h:22
vtkPoints * PointsList
Definition: vtkOBBTree.h:211
object to represent cell connectivity
Definition: vtkCellArray.h:175
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
virtual void GenerateRepresentation(int level, vtkPolyData *pd)=0
Method to build a representation at a particular level.
#define max(a, b)
represent and manipulate 3D points
Definition: vtkPoints.h:28
virtual void ForceBuildLocator()
Build the locator from the input dataset (even if UseExistingSearchStructure is on).
Definition: vtkLocator.h:156