VTK
vtkOBBTree.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkOBBTree.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 =========================================================================*/
56 #ifndef vtkOBBTree_h
57 #define vtkOBBTree_h
58 
59 #include "vtkFiltersGeneralModule.h" // For export macro
60 #include "vtkAbstractCellLocator.h"
61 
62 class vtkMatrix4x4;
63 
64 // Special class defines node for the OBB tree
65 //
66 
67 //
68 class VTKFILTERSGENERAL_EXPORT vtkOBBNode { //;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,
79  int *maxCells );
80 
81 private:
82  vtkOBBNode(const vtkOBBNode& other) = delete;
83  vtkOBBNode& operator=(const vtkOBBNode& rhs) = delete;
84 };
85 
86 //
87 
88 class VTKFILTERSGENERAL_EXPORT vtkOBBTree : public vtkAbstractCellLocator
89 {
90 public:
92  void PrintSelf(ostream& os, vtkIndent indent) override;
93 
98  static vtkOBBTree *New();
99 
100  // Re-use any superclass signatures that we don't override.
102 
114  int IntersectWithLine(const double a0[3], const double a1[3],
115  vtkPoints *points, vtkIdList *cellIds) override;
116 
122  int IntersectWithLine(const double a0[3], const double a1[3], double tol,
123  double& t, double x[3], double pcoords[3],
124  int &subId, vtkIdType &cellId, vtkGenericCell *cell) override;
125 
131  static void ComputeOBB(vtkPoints *pts, double corner[3], double max[3],
132  double mid[3], double min[3], double size[3]);
133 
140  void ComputeOBB(vtkDataSet *input, double corner[3], double max[3],
141  double mid[3], double min[3], double size[3]);
142 
148  int InsideOrOutside(const double point[3]);
149 
155  vtkMatrix4x4 *XformBtoA );
156 
160  int LineIntersectsNode( vtkOBBNode *pA, const double b0[3], const double b1[3] );
161 
166  double p0[3], double p1[3],
167  double p2[3], vtkMatrix4x4 *XformBtoA );
168 
173  int IntersectWithOBBTree( vtkOBBTree *OBBTreeB, vtkMatrix4x4 *XformBtoA,
174  int(*function)( vtkOBBNode *nodeA,
175  vtkOBBNode *nodeB,
176  vtkMatrix4x4 *Xform,
177  void *arg ),
178  void *data_arg );
179 
181 
184  void FreeSearchStructure() override;
185  void BuildLocator() override;
187 
197  void GenerateRepresentation(int level, vtkPolyData *pd) override;
198 
199 protected:
201  ~vtkOBBTree() 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],
207  double mid[3], double min[3], 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(vtkOBBNode *OBBptr, int level, int repLevel,
217  vtkPoints* pts, vtkCellArray *polys);
218 
219 private:
220  vtkOBBTree(const vtkOBBTree&) = delete;
221  void operator=(const vtkOBBTree&) = delete;
222 };
223 
224 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:40
vtkOBBNode::~vtkOBBNode
~vtkOBBNode()
vtkOBBNode::Kids
vtkOBBNode ** Kids
Definition: vtkOBBTree.h:76
vtkOBBTree::DeleteTree
void DeleteTree(vtkOBBNode *OBBptr)
vtkOBBTree::~vtkOBBTree
~vtkOBBTree() override
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkOBBTree::OBBCount
int OBBCount
Definition: vtkOBBTree.h:213
vtkOBBTree::IntersectWithLine
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.
vtkOBBTree::BuildLocator
void BuildLocator() override
Build the locator from the input dataset.
vtkOBBTree::IntersectWithLine
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...
vtkOBBTree
generate oriented bounding box (OBB) tree
Definition: vtkOBBTree.h:89
vtkAbstractCellLocator.h
vtkOBBTree::New
static vtkOBBTree * New()
Construct with automatic computation of divisions, averaging 25 cells per octant.
vtkOBBTree::ComputeOBB
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.
vtkOBBTree::PointsList
vtkPoints * PointsList
Definition: vtkOBBTree.h:211
vtkOBBNode::Parent
vtkOBBNode * Parent
Definition: vtkOBBTree.h:75
max
#define max(a, b)
Definition: vtkX3DExporterFIWriterHelper.h:31
vtkOBBTree::vtkOBBTree
vtkOBBTree()
vtkX3D::level
@ level
Definition: vtkX3D.h:395
vtkX3D::points
@ points
Definition: vtkX3D.h:446
vtkOBBTree::BuildTree
void BuildTree(vtkIdList *cells, vtkOBBNode *parent, int level)
vtkX3D::point
@ point
Definition: vtkX3D.h:236
vtkOBBNode::Cells
vtkIdList * Cells
Definition: vtkOBBTree.h:77
vtkOBBNode
Definition: vtkOBBTree.h:68
vtkOBBTree::GeneratePolygons
void GeneratePolygons(vtkOBBNode *OBBptr, int level, int repLevel, vtkPoints *pts, vtkCellArray *polys)
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkMatrix4x4
represent and manipulate 4x4 transformation matrices
Definition: vtkMatrix4x4.h:42
vtkCellArray
object to represent cell connectivity
Definition: vtkCellArray.h:51
vtkOBBTree::LineIntersectsNode
int LineIntersectsNode(vtkOBBNode *pA, const double b0[3], const double b1[3])
Returns true if line intersects node.
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:37
vtkX3D::size
@ size
Definition: vtkX3D.h:253
vtkOBBTree::IntersectWithOBBTree
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.
vtkAbstractCellLocator
an abstract base class for locators which find cells
Definition: vtkAbstractCellLocator.h:49
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:63
vtkOBBNode::vtkOBBNode
vtkOBBNode()
vtkOBBTree::DisjointOBBNodes
int DisjointOBBNodes(vtkOBBNode *nodeA, vtkOBBNode *nodeB, vtkMatrix4x4 *XformBtoA)
Returns true if nodeB and nodeA are disjoint after optional transformation of nodeB with matrix Xform...
vtkOBBTree::FreeSearchStructure
void FreeSearchStructure() override
Satisfy locator's abstract interface, see vtkLocator.
vtkOBBTree::InsideOrOutside
int InsideOrOutside(const double point[3])
Determine whether a point is inside or outside the data used to build this OBB tree.
vtkAbstractCellLocator::IntersectWithLine
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.
vtkOBBTree::ComputeOBB
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.
vtkOBBTree::ComputeOBB
void ComputeOBB(vtkIdList *cells, double corner[3], double max[3], double mid[3], double min[3], double size[3])
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:86
vtkOBBTree::GenerateRepresentation
void GenerateRepresentation(int level, vtkPolyData *pd) override
Create polygonal representation for OBB tree at specified level.
vtkGenericCell
provides thread-safe access to cells
Definition: vtkGenericCell.h:40
vtkOBBTree::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkOBBNode::DebugPrintTree
void DebugPrintTree(int level, double *leaf_vol, int *minCells, int *maxCells)
vtkOBBTree::InsertedPoints
int * InsertedPoints
Definition: vtkOBBTree.h:212
vtkOBBTree::Tree
vtkOBBNode * Tree
Definition: vtkOBBTree.h:209
vtkOBBTree::TriangleIntersectsNode
int TriangleIntersectsNode(vtkOBBNode *pA, double p0[3], double p1[3], double p2[3], vtkMatrix4x4 *XformBtoA)
Returns true if triangle (optionally transformed) intersects node.