BVH_model.h 11.4 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
44
45
#include <hpp/fcl/collision_object.h>
#include <hpp/fcl/BVH/BVH_internal.h>
#include <hpp/fcl/BV/BV_node.h>
#include <hpp/fcl/BVH/BV_splitter.h>
#include <hpp/fcl/BVH/BV_fitter.h>
sachinc's avatar
sachinc committed
46
47
#include <vector>
#include <boost/shared_ptr.hpp>
Ioan Sucan's avatar
Ioan Sucan committed
48
#include <boost/noncopyable.hpp>
sachinc's avatar
sachinc committed
49

50
51
namespace hpp
{
sachinc's avatar
sachinc committed
52
53
54
namespace fcl
{

55
56
class ConvexBase;

jpan's avatar
jpan committed
57
/// @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)
sachinc's avatar
sachinc committed
58
template<typename BV>
59
class BVHModel : public CollisionGeometry
sachinc's avatar
sachinc committed
60
61
62
{

public:
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
  /// @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;

  /// @brief Split rule to split one BV node into two children
  boost::shared_ptr<BVSplitterBase<BV> > bv_splitter;

  /// @brief Fitting rule to fit a BV node to a set of geometry primitives
  boost::shared_ptr<BVFitterBase<BV> > bv_fitter;
86
87
88

  /// @brief Convex<Triangle> representation of this object
  boost::shared_ptr< ConvexBase > convex;
89
  
jpan's avatar
jpan committed
90
  /// @brief Model type described by the instance
sachinc's avatar
sachinc committed
91
92
93
94
95
96
97
98
99
100
  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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
  /// @brief Constructing an empty BVH
  BVHModel() : vertices(NULL),
               tri_indices(NULL),
               prev_vertices(NULL),
               num_tris(0),
               num_vertices(0),
               build_state(BVH_BUILD_STATE_EMPTY),
               bv_splitter(new BVSplitter<BV>(SPLIT_METHOD_MEAN)),
               bv_fitter(new BVFitter<BV>()),
               num_tris_allocated(0),
               num_vertices_allocated(0),
               num_bvs_allocated(0),
               num_vertex_updated(0),
               primitive_indices(NULL),
               bvs(NULL),
               num_bvs(0)
sachinc's avatar
sachinc committed
117
118
119
  {
  }

jpan's avatar
jpan committed
120
121
  /// @brief copy from another BVH
  BVHModel(const BVHModel& other);
sachinc's avatar
sachinc committed
122

jpan's avatar
jpan committed
123
  /// @brief deconstruction, delete mesh data related.
sachinc's avatar
sachinc committed
124
125
126
127
128
129
130
131
132
133
  ~BVHModel()
  {
    delete [] vertices;
    delete [] tri_indices;
    delete [] bvs;

    delete [] prev_vertices;
    delete [] primitive_indices;
  }

jpan's avatar
jpan committed
134
  /// @brief We provide getBV() and getNumBVs() because BVH may be compressed (in future), so we must provide some flexibility here
jpan's avatar
   
jpan committed
135
  
jpan's avatar
jpan committed
136
  /// @brief Access the bv giving the its index
sachinc's avatar
sachinc committed
137
138
  const BVNode<BV>& getBV(int id) const
  {
Joseph Mirabel's avatar
Joseph Mirabel committed
139
    assert (id < num_bvs);
sachinc's avatar
sachinc committed
140
141
142
    return bvs[id];
  }

jpan's avatar
jpan committed
143
  /// @brief Access the bv giving the its index
sachinc's avatar
sachinc committed
144
145
  BVNode<BV>& getBV(int id)
  {
Joseph Mirabel's avatar
Joseph Mirabel committed
146
    assert (id < num_bvs);
sachinc's avatar
sachinc committed
147
148
149
    return bvs[id];
  }

jpan's avatar
jpan committed
150
  /// @brief Get the number of bv in the BVH
sachinc's avatar
sachinc committed
151
152
153
154
155
  int getNumBVs() const
  {
    return num_bvs;
  }

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

jpan's avatar
jpan committed
159
  /// @brief Get the BV type: default is unknown
sachinc's avatar
sachinc committed
160
161
  NODE_TYPE getNodeType() const { return BV_UNKNOWN; }

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

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

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

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

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

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

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

jpan's avatar
jpan committed
183
  /// @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
184
185
  int beginReplaceModel();

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

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

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

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

jpan's avatar
jpan committed
198
199
  /// @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
200
201
  int beginUpdateModel();

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

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

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

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

jpan's avatar
jpan committed
214
  /// @brief Check the number of memory used
sachinc's avatar
sachinc committed
215
216
  int memUsage(int msg) const;

217
218
219
220
221
222
  /// @brief Build this Convex<Triangle> representation of this model.
  /// \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.
  void buildConvexRepresentation();

  /// @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
223
  /// BV node. When traversing the BVH, this can save one matrix transformation.
jpan's avatar
   
jpan committed
224
225
  void makeParentRelative()
  {
Joseph Mirabel's avatar
Joseph Mirabel committed
226
    Matrix3f I (Matrix3f::Identity());
jpan's avatar
jpan committed
227
    makeParentRelativeRecurse(0, I, Vec3f());
jpan's avatar
   
jpan committed
228
229
  }

panjia1983's avatar
panjia1983 committed
230
231
232
  Vec3f computeCOM() const
  {
    FCL_REAL vol = 0;
Joseph Mirabel's avatar
Joseph Mirabel committed
233
    Vec3f com(0,0,0);
panjia1983's avatar
panjia1983 committed
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
    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
  {
260
    Matrix3f C = Matrix3f::Zero();
panjia1983's avatar
panjia1983 committed
261

262
263
264
265
    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
266
267
268
269
270
271
272

    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]];
273
      Matrix3f A; A << v1.transpose(), v2.transpose(), v3.transpose();
274
      C += A.derived().transpose() * C_canonical * A * (v1.cross(v2)).dot(v3);
panjia1983's avatar
panjia1983 committed
275
276
    }

277
    return C.trace() * Matrix3f::Identity() - C;
panjia1983's avatar
panjia1983 committed
278
279
  }

sachinc's avatar
sachinc committed
280
281
private:

jpan's avatar
jpan committed
282
283
284
285
286
287
288
  int num_tris_allocated;
  int num_vertices_allocated;
  int num_bvs_allocated;
  int num_vertex_updated; /// for ccd vertex update
  unsigned int* primitive_indices;

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

jpan's avatar
jpan committed
291
  /// @brief Number of BV nodes in bounding volume hierarchy
sachinc's avatar
sachinc committed
292
293
  int num_bvs;

jpan's avatar
jpan committed
294
  /// @brief Build the bounding volume hierarchy
sachinc's avatar
sachinc committed
295
296
  int buildTree();

jpan's avatar
jpan committed
297
  /// @brief Refit the bounding volume hierarchy
sachinc's avatar
sachinc committed
298
299
  int refitTree(bool bottomup);

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

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

jpan's avatar
jpan committed
306
  /// @brief Recursive kernel for hierarchy construction
sachinc's avatar
sachinc committed
307
308
  int recursiveBuildTree(int bv_id, int first_primitive, int num_primitives);

jpan's avatar
jpan committed
309
  /// @brief Recursive kernel for bottomup refitting 
sachinc's avatar
sachinc committed
310
311
  int recursiveRefitTree_bottomup(int bv_id);

jpan's avatar
jpan committed
312
313
  /// @recursively compute each bv's transform related to its parent. For default BV, only the translation works. 
  /// For oriented BV (OBB, RSS, OBBRSS), special implementation is provided.
Joseph Mirabel's avatar
Joseph Mirabel committed
314
  void makeParentRelativeRecurse(int bv_id, Matrix3f& parent_axes, const Vec3f& parent_c)
jpan's avatar
   
jpan committed
315
316
317
  {
    if(!bvs[bv_id].isLeaf())
    {
Joseph Mirabel's avatar
Joseph Mirabel committed
318
      makeParentRelativeRecurse(bvs[bv_id].first_child, parent_axes, bvs[bv_id].getCenter());
jpan's avatar
   
jpan committed
319

Joseph Mirabel's avatar
Joseph Mirabel committed
320
      makeParentRelativeRecurse(bvs[bv_id].first_child + 1, parent_axes, bvs[bv_id].getCenter());
jpan's avatar
   
jpan committed
321
322
    }

jpan's avatar
jpan committed
323
    bvs[bv_id].bv = translate(bvs[bv_id].bv, -parent_c);
jpan's avatar
   
jpan committed
324
  }
sachinc's avatar
sachinc committed
325
326
};

jpan's avatar
   
jpan committed
327

jpan's avatar
jpan committed
328
template<>
Joseph Mirabel's avatar
Joseph Mirabel committed
329
void BVHModel<OBB>::makeParentRelativeRecurse(int bv_id, Matrix3f& parent_axes, const Vec3f& parent_c);
jpan's avatar
jpan committed
330
331

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

template<>
Joseph Mirabel's avatar
Joseph Mirabel committed
335
void BVHModel<OBBRSS>::makeParentRelativeRecurse(int bv_id, Matrix3f& parent_axes, const Vec3f& parent_c);
jpan's avatar
jpan committed
336
337
338


/// @brief Specialization of getNodeType() for BVHModel with different BV types
sachinc's avatar
sachinc committed
339
340
341
342
343
344
345
346
347
template<>
NODE_TYPE BVHModel<AABB>::getNodeType() const;

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

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

348
349
350
template<>
NODE_TYPE BVHModel<kIOS>::getNodeType() const;

jpan's avatar
   
jpan committed
351
352
353
template<>
NODE_TYPE BVHModel<OBBRSS>::getNodeType() const;

sachinc's avatar
sachinc committed
354
355
356
357
358
359
360
361
362
363
364
template<>
NODE_TYPE BVHModel<KDOP<16> >::getNodeType() const;

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

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

}

365
366
} // namespace hpp

sachinc's avatar
sachinc committed
367
#endif