BVH_model.h 13.2 KB
Newer Older
sachinc's avatar
sachinc committed
1
2
3
/*
 * Software License Agreement (BSD License)
 *
4
5
 *  Copyright (c) 2011-2014, Willow Garage, Inc.
 *  Copyright (c) 2014-2015, Open Source Robotics Foundation
sachinc's avatar
sachinc committed
6
7
8
9
10
11
12
13
14
15
16
17
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
18
 *   * Neither the name of Open Source Robotics Foundation nor the names of its
sachinc's avatar
sachinc committed
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */

/** \author Jia Pan */

Joseph Mirabel's avatar
Joseph Mirabel committed
38
39
#ifndef HPP_FCL_BVH_MODEL_H
#define HPP_FCL_BVH_MODEL_H
sachinc's avatar
sachinc committed
40

41
42
43
#include <hpp/fcl/collision_object.h>
#include <hpp/fcl/BVH/BVH_internal.h>
#include <hpp/fcl/BV/BV_node.h>
sachinc's avatar
sachinc committed
44
45
#include <vector>
#include <boost/shared_ptr.hpp>
Ioan Sucan's avatar
Ioan Sucan committed
46
#include <boost/noncopyable.hpp>
sachinc's avatar
sachinc committed
47

48
49
namespace hpp
{
sachinc's avatar
sachinc committed
50
51
52
namespace fcl
{

53
54
55
/// @addtogroup Construction_Of_BVH
/// @{

56
57
class ConvexBase;

58
59
60
template <typename BV> class BVFitter;
template <typename BV> class BVSplitter;

61
62
/// @brief A base class describing the bounding hierarchy of a mesh model or a point cloud model (which is viewed as a degraded version of mesh)
class BVHModelBase : public CollisionGeometry
sachinc's avatar
sachinc committed
63
64
{
public:
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
  /// @brief Geometry point data
  Vec3f* vertices;

  /// @brief Geometry triangle index data, will be NULL for point clouds
  Triangle* tri_indices;

  /// @brief Geometry point data in previous frame
  Vec3f* prev_vertices;

  /// @brief Number of triangles
  int num_tris;

  /// @brief Number of points
  int num_vertices;

  /// @brief The state of BVH building process
  BVHBuildState build_state;

83
84
  /// @brief Convex<Triangle> representation of this object
  boost::shared_ptr< ConvexBase > convex;
85

jpan's avatar
jpan committed
86
  /// @brief Model type described by the instance
sachinc's avatar
sachinc committed
87
88
89
90
91
92
93
94
95
96
  BVHModelType getModelType() const
  {
    if(num_tris && num_vertices)
      return BVH_MODEL_TRIANGLES;
    else if(num_vertices)
      return BVH_MODEL_POINTCLOUD;
    else
      return BVH_MODEL_UNKNOWN;
  }

jpan's avatar
jpan committed
97
  /// @brief Constructing an empty BVH
98
99
100
101
102
103
104
105
106
  BVHModelBase() : vertices(NULL),
                   tri_indices(NULL),
                   prev_vertices(NULL),
                   num_tris(0),
                   num_vertices(0),
                   build_state(BVH_BUILD_STATE_EMPTY),
                   num_tris_allocated(0),
                   num_vertices_allocated(0),
                   num_vertex_updated(0)
sachinc's avatar
sachinc committed
107
108
109
  {
  }

jpan's avatar
jpan committed
110
  /// @brief copy from another BVH
111
  BVHModelBase(const BVHModelBase& other);
sachinc's avatar
sachinc committed
112

jpan's avatar
jpan committed
113
  /// @brief deconstruction, delete mesh data related.
114
  virtual ~BVHModelBase ()
sachinc's avatar
sachinc committed
115
116
117
118
119
120
  {
    delete [] vertices;
    delete [] tri_indices;
    delete [] prev_vertices;
  }

jpan's avatar
jpan committed
121
  /// @brief Get the object type: it is a BVH
sachinc's avatar
sachinc committed
122
123
  OBJECT_TYPE getObjectType() const { return OT_BVH; }

jpan's avatar
jpan committed
124
  /// @brief Compute the AABB for the BVH, used for broad-phase collision
125
  void computeLocalAABB();
sachinc's avatar
sachinc committed
126

jpan's avatar
jpan committed
127
  /// @brief Begin a new BVH model
sachinc's avatar
sachinc committed
128
129
  int beginModel(int num_tris = 0, int num_vertices = 0);

jpan's avatar
jpan committed
130
  /// @brief Add one point in the new BVH model
sachinc's avatar
sachinc committed
131
132
  int addVertex(const Vec3f& p);

jpan's avatar
jpan committed
133
  /// @brief Add one triangle in the new BVH model
sachinc's avatar
sachinc committed
134
135
  int addTriangle(const Vec3f& p1, const Vec3f& p2, const Vec3f& p3);

jpan's avatar
jpan committed
136
  /// @brief Add a set of triangles in the new BVH model
sachinc's avatar
sachinc committed
137
138
  int addSubModel(const std::vector<Vec3f>& ps, const std::vector<Triangle>& ts);

jpan's avatar
jpan committed
139
  /// @brief Add a set of points in the new BVH model
sachinc's avatar
sachinc committed
140
141
  int addSubModel(const std::vector<Vec3f>& ps);

jpan's avatar
jpan committed
142
  /// @brief End BVH model construction, will build the bounding volume hierarchy
sachinc's avatar
sachinc committed
143
144
  int endModel();

jpan's avatar
jpan committed
145
  /// @brief Replace the geometry information of current frame (i.e. should have the same mesh topology with the previous frame)
sachinc's avatar
sachinc committed
146
147
  int beginReplaceModel();

jpan's avatar
jpan committed
148
  /// @brief Replace one point in the old BVH model
sachinc's avatar
sachinc committed
149
150
  int replaceVertex(const Vec3f& p);

jpan's avatar
jpan committed
151
  /// @brief Replace one triangle in the old BVH model
sachinc's avatar
sachinc committed
152
153
  int replaceTriangle(const Vec3f& p1, const Vec3f& p2, const Vec3f& p3);

jpan's avatar
jpan committed
154
  /// @brief Replace a set of points in the old BVH model
sachinc's avatar
sachinc committed
155
156
  int replaceSubModel(const std::vector<Vec3f>& ps);

jpan's avatar
jpan committed
157
  /// @brief End BVH model replacement, will also refit or rebuild the bounding volume hierarchy
sachinc's avatar
sachinc committed
158
159
  int endReplaceModel(bool refit = true, bool bottomup = true);

jpan's avatar
jpan committed
160
161
  /// @brief Replace the geometry information of current frame (i.e. should have the same mesh topology with the previous frame).
  /// The current frame will be saved as the previous frame in prev_vertices.
sachinc's avatar
sachinc committed
162
163
  int beginUpdateModel();

jpan's avatar
jpan committed
164
  /// @brief Update one point in the old BVH model
sachinc's avatar
sachinc committed
165
166
  int updateVertex(const Vec3f& p);

jpan's avatar
jpan committed
167
  /// @brief Update one triangle in the old BVH model
sachinc's avatar
sachinc committed
168
169
  int updateTriangle(const Vec3f& p1, const Vec3f& p2, const Vec3f& p3);

jpan's avatar
jpan committed
170
  /// @brief Update a set of points in the old BVH model
sachinc's avatar
sachinc committed
171
172
  int updateSubModel(const std::vector<Vec3f>& ps);

jpan's avatar
jpan committed
173
  /// @brief End BVH model update, will also refit or rebuild the bounding volume hierarchy
sachinc's avatar
sachinc committed
174
175
  int endUpdateModel(bool refit = true, bool bottomup = true);

176
177
  /// @brief Build this \ref Convex "Convex<Triangle>" representation of this model.
  /// The result is stored in attribute \ref convex.
178
179
  /// \note this only takes the points of this model. It does not check that the
  ///       object is convex. It does not compute a convex hull.
180
181
  void buildConvexRepresentation(bool share_memory);

182
183
184
185
186
187
188
189
190
191
192
193
194
  /// @brief Build a convex hull
  /// and store it in attribute \ref convex.
  /// \param keepTriangle whether the convex should be triangulated.
  /// \param qhullCommand see \ref ConvexBase::convexHull.
  /// \return \c true if this object is convex, hence the convex hull represents
  ///         the same object.
  /// \sa ConvexBase::convexHull
  /// \warning At the moment, the return value only checks whether there are as
  ///          many points in the convex hull as in the original object. This is
  ///          neither necessary (duplicated vertices get merged) nor sufficient
  ///          (think of a U with 4 vertices and 3 edges).
  bool buildConvexHull(bool keepTriangle, const char* qhullCommand = NULL);

195
  virtual int memUsage(int msg) const = 0;
196
197

  /// @brief This is a special acceleration: BVH_model default stores the BV's transform in world coordinate. However, we can also store each BV's transform related to its parent 
jpan's avatar
jpan committed
198
  /// BV node. When traversing the BVH, this can save one matrix transformation.
199
  virtual void makeParentRelative() = 0;
jpan's avatar
   
jpan committed
200

panjia1983's avatar
panjia1983 committed
201
202
203
  Vec3f computeCOM() const
  {
    FCL_REAL vol = 0;
Joseph Mirabel's avatar
Joseph Mirabel committed
204
    Vec3f com(0,0,0);
panjia1983's avatar
panjia1983 committed
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
    for(int i = 0; i < num_tris; ++i)
    {
      const Triangle& tri = tri_indices[i];
      FCL_REAL d_six_vol = (vertices[tri[0]].cross(vertices[tri[1]])).dot(vertices[tri[2]]);
      vol += d_six_vol;
      com += (vertices[tri[0]] + vertices[tri[1]] + vertices[tri[2]]) * d_six_vol;
    }

    return com / (vol * 4);
  }

  FCL_REAL computeVolume() const
  {
    FCL_REAL vol = 0;
    for(int i = 0; i < num_tris; ++i)
    {
      const Triangle& tri = tri_indices[i];
      FCL_REAL d_six_vol = (vertices[tri[0]].cross(vertices[tri[1]])).dot(vertices[tri[2]]);
      vol += d_six_vol;
    }

    return vol / 6;
  }

  Matrix3f computeMomentofInertia() const
  {
231
    Matrix3f C = Matrix3f::Zero();
panjia1983's avatar
panjia1983 committed
232

233
234
235
236
    Matrix3f C_canonical;
    C_canonical << 1/60.0, 1/120.0, 1/120.0,
                   1/120.0, 1/60.0, 1/120.0,
                   1/120.0, 1/120.0, 1/60.0;
panjia1983's avatar
panjia1983 committed
237
238
239
240
241
242
243

    for(int i = 0; i < num_tris; ++i)
    {
      const Triangle& tri = tri_indices[i];
      const Vec3f& v1 = vertices[tri[0]];
      const Vec3f& v2 = vertices[tri[1]];
      const Vec3f& v3 = vertices[tri[2]];
244
      Matrix3f A; A << v1.transpose(), v2.transpose(), v3.transpose();
245
      C += A.derived().transpose() * C_canonical * A * (v1.cross(v2)).dot(v3);
panjia1983's avatar
panjia1983 committed
246
247
    }

248
    return C.trace() * Matrix3f::Identity() - C;
panjia1983's avatar
panjia1983 committed
249
250
  }

251
252
253
254
255
256
257
258
259
protected:
  virtual void deleteBVs() = 0;
  virtual bool allocateBVs() = 0;

  /// @brief Build the bounding volume hierarchy
  virtual int buildTree() = 0;

  /// @brief Refit the bounding volume hierarchy
  virtual int refitTree(bool bottomup) = 0;
sachinc's avatar
sachinc committed
260

jpan's avatar
jpan committed
261
262
263
  int num_tris_allocated;
  int num_vertices_allocated;
  int num_vertex_updated; /// for ccd vertex update
264
265
266
};

/// @brief A class describing the bounding hierarchy of a mesh model or a point cloud model (which is viewed as a degraded version of mesh)
Joseph Mirabel's avatar
Joseph Mirabel committed
267
/// \tparam BV one of the bounding volume class in \ref Bounding_Volume.
268
269
270
271
272
273
template<typename BV>
class BVHModel : public BVHModelBase
{

public:
  /// @brief Split rule to split one BV node into two children
274
  boost::shared_ptr<BVSplitter<BV> > bv_splitter;
275
276

  /// @brief Fitting rule to fit a BV node to a set of geometry primitives
277
  boost::shared_ptr<BVFitter<BV> > bv_fitter;
278
279

  /// @brief Constructing an empty BVH
280
  BVHModel();
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332

  /// @brief copy from another BVH
  BVHModel(const BVHModel& other);

  /// @brief deconstruction, delete mesh data related.
  ~BVHModel()
  {
    delete [] bvs;
    delete [] primitive_indices;
  }

  /// @brief We provide getBV() and getNumBVs() because BVH may be compressed (in future), so we must provide some flexibility here
  
  /// @brief Access the bv giving the its index
  const BVNode<BV>& getBV(int id) const
  {
    assert (id < num_bvs);
    return bvs[id];
  }

  /// @brief Access the bv giving the its index
  BVNode<BV>& getBV(int id)
  {
    assert (id < num_bvs);
    return bvs[id];
  }

  /// @brief Get the number of bv in the BVH
  int getNumBVs() const
  {
    return num_bvs;
  }

  /// @brief Get the BV type: default is unknown
  NODE_TYPE getNodeType() const { return BV_UNKNOWN; }

  /// @brief Check the number of memory used
  int memUsage(int msg) const;

  /// @brief This is a special acceleration: BVH_model default stores the BV's transform in world coordinate. However, we can also store each BV's transform related to its parent 
  /// BV node. When traversing the BVH, this can save one matrix transformation.
  void makeParentRelative()
  {
    Matrix3f I (Matrix3f::Identity());
    makeParentRelativeRecurse(0, I, Vec3f());
  }

private:
  void deleteBVs();
  bool allocateBVs();

  int num_bvs_allocated;
jpan's avatar
jpan committed
333
334
335
  unsigned int* primitive_indices;

  /// @brief Bounding volume hierarchy
sachinc's avatar
sachinc committed
336
337
  BVNode<BV>* bvs;

jpan's avatar
jpan committed
338
  /// @brief Number of BV nodes in bounding volume hierarchy
sachinc's avatar
sachinc committed
339
340
  int num_bvs;

jpan's avatar
jpan committed
341
  /// @brief Build the bounding volume hierarchy
sachinc's avatar
sachinc committed
342
343
  int buildTree();

jpan's avatar
jpan committed
344
  /// @brief Refit the bounding volume hierarchy
sachinc's avatar
sachinc committed
345
346
  int refitTree(bool bottomup);

jpan's avatar
jpan committed
347
  /// @brief Refit the bounding volume hierarchy in a top-down way (slow but more compact)
sachinc's avatar
sachinc committed
348
349
  int refitTree_topdown();

jpan's avatar
jpan committed
350
  /// @brief Refit the bounding volume hierarchy in a bottom-up way (fast but less compact)
sachinc's avatar
sachinc committed
351
352
  int refitTree_bottomup();

jpan's avatar
jpan committed
353
  /// @brief Recursive kernel for hierarchy construction
sachinc's avatar
sachinc committed
354
355
  int recursiveBuildTree(int bv_id, int first_primitive, int num_primitives);

jpan's avatar
jpan committed
356
  /// @brief Recursive kernel for bottomup refitting 
sachinc's avatar
sachinc committed
357
358
  int recursiveRefitTree_bottomup(int bv_id);

359
  /// @ recursively compute each bv's transform related to its parent. For default BV, only the translation works. 
jpan's avatar
jpan committed
360
  /// For oriented BV (OBB, RSS, OBBRSS), special implementation is provided.
Joseph Mirabel's avatar
Joseph Mirabel committed
361
  void makeParentRelativeRecurse(int bv_id, Matrix3f& parent_axes, const Vec3f& parent_c)
jpan's avatar
   
jpan committed
362
363
364
  {
    if(!bvs[bv_id].isLeaf())
    {
Joseph Mirabel's avatar
Joseph Mirabel committed
365
      makeParentRelativeRecurse(bvs[bv_id].first_child, parent_axes, bvs[bv_id].getCenter());
jpan's avatar
   
jpan committed
366

Joseph Mirabel's avatar
Joseph Mirabel committed
367
      makeParentRelativeRecurse(bvs[bv_id].first_child + 1, parent_axes, bvs[bv_id].getCenter());
jpan's avatar
   
jpan committed
368
369
    }

jpan's avatar
jpan committed
370
    bvs[bv_id].bv = translate(bvs[bv_id].bv, -parent_c);
jpan's avatar
   
jpan committed
371
  }
sachinc's avatar
sachinc committed
372
373
};

374
/// @}
jpan's avatar
   
jpan committed
375

jpan's avatar
jpan committed
376
template<>
Joseph Mirabel's avatar
Joseph Mirabel committed
377
void BVHModel<OBB>::makeParentRelativeRecurse(int bv_id, Matrix3f& parent_axes, const Vec3f& parent_c);
jpan's avatar
jpan committed
378
379

template<>
Joseph Mirabel's avatar
Joseph Mirabel committed
380
void BVHModel<RSS>::makeParentRelativeRecurse(int bv_id, Matrix3f& parent_axes, const Vec3f& parent_c);
jpan's avatar
jpan committed
381
382

template<>
Joseph Mirabel's avatar
Joseph Mirabel committed
383
void BVHModel<OBBRSS>::makeParentRelativeRecurse(int bv_id, Matrix3f& parent_axes, const Vec3f& parent_c);
jpan's avatar
jpan committed
384
385
386


/// @brief Specialization of getNodeType() for BVHModel with different BV types
sachinc's avatar
sachinc committed
387
388
389
390
391
392
393
394
395
template<>
NODE_TYPE BVHModel<AABB>::getNodeType() const;

template<>
NODE_TYPE BVHModel<OBB>::getNodeType() const;

template<>
NODE_TYPE BVHModel<RSS>::getNodeType() const;

396
397
398
template<>
NODE_TYPE BVHModel<kIOS>::getNodeType() const;

jpan's avatar
   
jpan committed
399
400
401
template<>
NODE_TYPE BVHModel<OBBRSS>::getNodeType() const;

sachinc's avatar
sachinc committed
402
403
404
405
406
407
408
409
410
411
412
template<>
NODE_TYPE BVHModel<KDOP<16> >::getNodeType() const;

template<>
NODE_TYPE BVHModel<KDOP<18> >::getNodeType() const;

template<>
NODE_TYPE BVHModel<KDOP<24> >::getNodeType() const;

}

413
414
} // namespace hpp

sachinc's avatar
sachinc committed
415
#endif