Developer Documentation
BSPImplT.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openflipper.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenFlipper. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41 
42 /*===========================================================================*\
43 * *
44 * $Revision: 10745 $ *
45 * $LastChangedBy: moebius $ *
46 * $Date: 2011-01-26 10:23:50 +0100 (Wed, 26 Jan 2011) $ *
47 * *
48 \*===========================================================================*/
49 
50 
51 
52 
53 //=============================================================================
54 //
55 // CLASS BSPImplT
56 //
57 //=============================================================================
58 
59 #ifndef BSPIMPLT_HH
60 #define BSPIMPLT_HH
61 
62 
63 //== INCLUDES =================================================================
64 
65 
66 #include <OpenMesh/Core/Geometry/VectorT.hh>
67 
68 
69 //== CLASS DEFINITION =========================================================
70 #include <vector>
71 #include <ostream>
72 
73 template <class BSPCore>
74 class BSPImplT : public BSPCore
75 {
76 public: //---------------------------------------------------------------------
77 
78  typedef typename BSPCore::Traits Traits;
79  typedef typename BSPCore::Handle Handle;
80  typedef typename BSPCore::Point Point;
81  typedef typename BSPCore::Scalar Scalar;
82  typedef typename BSPCore::Node Node;
83  typedef typename BSPCore::Handles Handles;
84  typedef typename BSPCore::HandleIter HandleIter;
85 
86 
87 public: //---------------------------------------------------------------------
88 
89  BSPImplT(const Traits& _traits, const Scalar& _infinity = std::numeric_limits<Scalar>::infinity()) :
90  BSPCore(_traits),
91  infinity_(_infinity) {}
92  ~BSPImplT() {}
93 
94 
97  {
98  NearestNeighbor() {}
99  NearestNeighbor(Handle _h, Scalar _d) : handle(_h), dist(_d) {}
100  Handle handle;
101  Scalar dist;
102  };
103 
105  typedef std::vector< std::pair<Handle,Scalar> > RayCollision;
106 
108  NearestNeighbor nearest(const Point& _p) const;
109 
120  RayCollision raycollision (const Point& _p, const Point& _r) const;
121 
133  RayCollision directionalRaycollision (const Point& _p, const Point& _r) const;
134 
147  RayCollision nearestRaycollision(const Point& _p, const Point& _r) const;
148 
149 private: //---------------------------------------------------------------------
150 
151 
154  {
155  Point ref;
156  Scalar dist;
157  Handle nearest;
158 
159  friend std::ostream &operator<< (std::ostream &stream, const NearestNeighborData &data) {
160  stream << "[NearestNeghborData instance. ref: " << data.ref << ", dist: " << data.dist << ", nearest: " << data.nearest.idx() << "]";
161  return stream;
162  }
163  };
164 
167  {
168  Point ref;
169  Point ray;
170  RayCollision hit_handles;
171  };
172 
173 
174  // Recursive part of nearest()
175  void _nearest(Node* _node, NearestNeighborData& _data) const;
176 
182  void _raycollision_non_directional(Node* _node, RayCollisionData& _data) const;
183 
189  void _raycollision_directional(Node* _node, RayCollisionData& _data) const;
190 
191  void _raycollision_nearest_directional(Node* _node, RayCollisionData& _data) const;
192 
193  template<typename T,typename U>
194  struct less_pair_second: public std::binary_function<T,U,bool> {
195  bool operator()(const std::pair<T,U> &left, const std::pair<T,U> &right) {
196  return (fabs(left.second) < fabs(right.second));
197  }
198  };
199 
200  const Scalar infinity_;
201 
202 };
203 
204 //=============================================================================
205 #if defined(OM_INCLUDE_TEMPLATES) && !defined(BSPIMPLT_C)
206 # define BSPIMPLT_TEMPLATES
207 # include "BSPImplT.cc"
208 #endif
209 //=============================================================================
210 #endif // BSPIMPLT_HH defined
211 //=============================================================================
RayCollision directionalRaycollision(const Point &_p, const Point &_r) const
intersect mesh with ray
Definition: BSPImplT.cc:152
std::vector< std::pair< Handle, Scalar > > RayCollision
Store nearest neighbor information.
Definition: BSPImplT.hh:105
RayCollision nearestRaycollision(const Point &_p, const Point &_r) const
intersect mesh with ray
Definition: BSPImplT.cc:170
void _raycollision_non_directional(Node *_node, RayCollisionData &_data) const
recursive part of raycollision()
Definition: BSPImplT.cc:189
void _raycollision_directional(Node *_node, RayCollisionData &_data) const
recursive part of directionalRaycollision()
Definition: BSPImplT.cc:227
Store ray collide information.
Definition: BSPImplT.hh:166
Store nearest neighbor information.
Definition: BSPImplT.hh:96
NearestNeighbor nearest(const Point &_p) const
Return handle of the nearest neighbor face.
Definition: BSPImplT.cc:76
RayCollision raycollision(const Point &_p, const Point &_r) const
intersect mesh with ray
Definition: BSPImplT.cc:135
Store nearest neighbor information.
Definition: BSPImplT.hh:153