kIOS.h 5.05 KB
Newer Older
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
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
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_KIOS_H
#define HPP_FCL_KIOS_H
40

41
#include <hpp/fcl/BV/OBB.h>
42

43

44
45
namespace hpp
{
46
47
namespace fcl
{
48
  class CollisionRequest;
49
50
51
52

/// @addtogroup Bounding_Volume
/// @{

53
/// @brief A class describing the kIOS collision structure, which is a set of spheres.
54
55
class kIOS
{
56
  /// @brief One sphere in kIOS
57
58
59
  struct kIOS_Sphere
  {
    Vec3f o;
60
    FCL_REAL r;
61
62
  };

63
  /// @brief generate one sphere enclosing two spheres
64
65
66
  static kIOS_Sphere encloseSphere(const kIOS_Sphere& s0, const kIOS_Sphere& s1)
  {
    Vec3f d = s1.o - s0.o;
67
    FCL_REAL dist2 = d.squaredNorm();
68
    FCL_REAL diff_r = s1.r - s0.r;
69
70
71
72
73
74
75
76
77
      
    /** The sphere with the larger radius encloses the other */
    if(diff_r * diff_r >= dist2)
    {
      if(s1.r > s0.r) return s1;
      else return s0;
    }
    else /** spheres partially overlapping or disjoint */
    {
Joseph Mirabel's avatar
Joseph Mirabel committed
78
      float dist = (float)std::sqrt(dist2);
79
80
81
      kIOS_Sphere s;
      s.r = dist + s0.r + s1.r;
      if(dist > 0)
jpan's avatar
   
jpan committed
82
83
84
        s.o = s0.o + d * ((s.r - s0.r) / dist);
      else
        s.o = s0.o;
85
86
87
88
89
      return s;
    }
  }
public:
    
90
  /// @brief The (at most) five spheres for intersection
91
92
  kIOS_Sphere spheres[5];

93
94
  /// @brief The number of spheres, no larger than 5
  unsigned int num_spheres;
jpan's avatar
   
jpan committed
95

96
97
  /// @ OBB related with kIOS
  OBB obb;
98

99
100
101
  /// @brief Check whether the kIOS contains a point
  inline bool contain(const Vec3f& p) const;

102
  /// @brief Check collision between two kIOS
103
104
  bool overlap(const kIOS& other) const;

105
  /// @brief Check collision between two kIOS
106
107
  bool overlap(const kIOS& other, const CollisionRequest&,
               FCL_REAL& sqrDistLowerBound) const;
108

109
110
  /// @brief The distance between two kIOS
  FCL_REAL distance(const kIOS& other, Vec3f* P = NULL, Vec3f* Q = NULL) const;
111

112
  /// @brief A simple way to merge the kIOS and a point
113
114
  kIOS& operator += (const Vec3f& p);

115
  /// @brief Merge the kIOS and another kIOS
116
117
118
119
120
121
  kIOS& operator += (const kIOS& other)
  {
    *this = *this + other;
    return *this;
  }

122
  /// @brief Return the merged kIOS of current kIOS and the other one
123
124
  kIOS operator + (const kIOS& other) const;

125
126
127
  /// @brief size of the kIOS (used in BV_Splitter to order two kIOSs)
  FCL_REAL size() const;

128
  /// @brief Center of the kIOS
129
130
131
132
133
  const Vec3f& center() const
  {
    return spheres[0].o;
  }

134
  /// @brief Width of the kIOS
135
  FCL_REAL width() const;
136

137
  /// @brief Height of the kIOS
138
  FCL_REAL height() const;
139

140
  /// @brief Depth of the kIOS
141
  FCL_REAL depth() const;
142

143
  /// @brief Volume of the kIOS
144
  FCL_REAL volume() const;
145
146
};

jpan's avatar
jpan committed
147
148
149
150

/// @brief Translate the kIOS BV
kIOS translate(const kIOS& bv, const Vec3f& t);

151
152
/// @brief Check collision between two kIOSs, b1 is in configuration (R0, T0) and b2 is in identity.
/// @todo Not efficient
153
154
bool overlap(const Matrix3f& R0, const Vec3f& T0, const kIOS& b1, const kIOS& b2);

Joseph Mirabel's avatar
Joseph Mirabel committed
155
156
157
158
159
160
/// @brief Check collision between two kIOSs, b1 is in configuration (R0, T0) and b2 is in identity.
/// @todo Not efficient
bool overlap(const Matrix3f& R0, const Vec3f& T0, const kIOS& b1, const kIOS& b2,
             const CollisionRequest& request,
             FCL_REAL& sqrDistLowerBound);

161
162
/// @brief Approximate distance between two kIOS bounding volumes
/// @todo P and Q is not returned, need implementation
163
FCL_REAL distance(const Matrix3f& R0, const Vec3f& T0, const kIOS& b1, const kIOS& b2, Vec3f* P = NULL, Vec3f* Q = NULL);
164
165
166

}

167
168
} // namespace hpp

169
#endif