hpp-fcl  3.0.0
HPP fork of FCL -- The Flexible Collision Library
kIOS.h
Go to the documentation of this file.
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2011-2014, Willow Garage, Inc.
5  * Copyright (c) 2014-2015, Open Source Robotics Foundation
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above
15  * copyright notice, this list of conditions and the following
16  * disclaimer in the documentation and/or other materials provided
17  * with the distribution.
18  * * Neither the name of Open Source Robotics Foundation nor the names of its
19  * contributors may be used to endorse or promote products derived
20  * from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33  * POSSIBILITY OF SUCH DAMAGE.
34  */
35 
38 #ifndef HPP_FCL_KIOS_H
39 #define HPP_FCL_KIOS_H
40 
41 #include "hpp/fcl/BV/OBB.h"
42 
43 namespace hpp {
44 namespace fcl {
45 
46 struct CollisionRequest;
47 
50 
55  struct HPP_FCL_DLLAPI kIOS_Sphere {
56  EIGEN_MAKE_ALIGNED_OPERATOR_NEW
57 
60 
61  bool operator==(const kIOS_Sphere& other) const {
62  return o == other.o && r == other.r;
63  }
64 
65  bool operator!=(const kIOS_Sphere& other) const {
66  return !(*this == other);
67  }
68  };
69 
71  static kIOS_Sphere encloseSphere(const kIOS_Sphere& s0,
72  const kIOS_Sphere& s1) {
73  Vec3f d = s1.o - s0.o;
74  FCL_REAL dist2 = d.squaredNorm();
75  FCL_REAL diff_r = s1.r - s0.r;
76 
78  if (diff_r * diff_r >= dist2) {
79  if (s1.r > s0.r)
80  return s1;
81  else
82  return s0;
83  } else
84  {
85  float dist = (float)std::sqrt(dist2);
86  kIOS_Sphere s;
87  s.r = dist + s0.r + s1.r;
88  if (dist > 0)
89  s.o = s0.o + d * ((s.r - s0.r) / dist);
90  else
91  s.o = s0.o;
92  return s;
93  }
94  }
95 
96  public:
97  EIGEN_MAKE_ALIGNED_OPERATOR_NEW
98 
100  bool operator==(const kIOS& other) const {
101  bool res = obb == other.obb && num_spheres == other.num_spheres;
102  if (!res) return false;
103 
104  for (size_t k = 0; k < num_spheres; ++k) {
105  if (spheres[k] != other.spheres[k]) return false;
106  }
107 
108  return true;
109  }
110 
112  bool operator!=(const kIOS& other) const { return !(*this == other); }
113 
114  static constexpr size_t max_num_spheres = 5;
115 
117  kIOS_Sphere spheres[max_num_spheres];
118 
120  unsigned int num_spheres;
121 
124 
126  bool contain(const Vec3f& p) const;
127 
129  bool overlap(const kIOS& other) const;
130 
132  bool overlap(const kIOS& other, const CollisionRequest&,
133  FCL_REAL& sqrDistLowerBound) const;
134 
136  FCL_REAL distance(const kIOS& other, Vec3f* P = NULL, Vec3f* Q = NULL) const;
137 
139  kIOS& operator+=(const Vec3f& p);
140 
142  kIOS& operator+=(const kIOS& other) {
143  *this = *this + other;
144  return *this;
145  }
146 
148  kIOS operator+(const kIOS& other) const;
149 
151  FCL_REAL size() const;
152 
154  const Vec3f& center() const { return spheres[0].o; }
155 
157  FCL_REAL width() const;
158 
160  FCL_REAL height() const;
161 
163  FCL_REAL depth() const;
164 
166  FCL_REAL volume() const;
167 };
168 
170 HPP_FCL_DLLAPI kIOS translate(const kIOS& bv, const Vec3f& t);
171 
175 HPP_FCL_DLLAPI bool overlap(const Matrix3f& R0, const Vec3f& T0, const kIOS& b1,
176  const kIOS& b2);
177 
181 HPP_FCL_DLLAPI bool overlap(const Matrix3f& R0, const Vec3f& T0, const kIOS& b1,
182  const kIOS& b2, const CollisionRequest& request,
183  FCL_REAL& sqrDistLowerBound);
184 
188  const kIOS& b1, const kIOS& b2,
189  Vec3f* P = NULL, Vec3f* Q = NULL);
190 
191 } // namespace fcl
192 
193 } // namespace hpp
194 
195 #endif
A class describing the kIOS collision structure, which is a set of spheres.
Definition: kIOS.h:53
#define HPP_FCL_DLLAPI
Definition: config.hh:88
bool operator!=(const kIOS &other) const
Difference operator.
Definition: kIOS.h:112
FCL_REAL depth() const
Depth of the kIOS.
kIOS & operator+=(const Vec3f &p)
A simple way to merge the kIOS and a point.
kIOS & operator+=(const kIOS &other)
Merge the kIOS and another kIOS.
Definition: kIOS.h:142
const Vec3f & center() const
Center of the kIOS.
Definition: kIOS.h:154
FCL_REAL distance(const Matrix3f &R0, const Vec3f &T0, const kIOS &b1, const kIOS &b2, Vec3f *P=NULL, Vec3f *Q=NULL)
Approximate distance between two kIOS bounding volumes.
bool operator==(const kIOS_Sphere &other) const
Definition: kIOS.h:61
bool overlap(const kIOS &other) const
Check collision between two kIOS.
FCL_REAL width() const
Width of the kIOS.
EIGEN_MAKE_ALIGNED_OPERATOR_NEW bool operator==(const kIOS &other) const
Equality operator.
Definition: kIOS.h:100
bool overlap(const kIOS &other, const CollisionRequest &, FCL_REAL &sqrDistLowerBound) const
Check collision between two kIOS.
FCL_REAL height() const
Height of the kIOS.
FCL_REAL r
Definition: kIOS.h:59
EIGEN_MAKE_ALIGNED_OPERATOR_NEW Vec3f o
Definition: kIOS.h:58
bool overlap(const Matrix3f &R0, const Vec3f &T0, const AABB &b1, const AABB &b2)
Check collision between two aabbs, b1 is in configuration (R0, T0) and b2 is in identity.
FCL_REAL volume() const
Volume of the kIOS.
bool contain(const Vec3f &p) const
Check whether the kIOS contains a point.
FCL_REAL size() const
size of the kIOS (used in BV_Splitter to order two kIOSs)
kIOS_Sphere spheres[max_num_spheres]
The (at most) five spheres for intersection.
Definition: kIOS.h:117
FCL_REAL distance(const kIOS &other, Vec3f *P=NULL, Vec3f *Q=NULL) const
The distance between two kIOS.
unsigned int num_spheres
The number of spheres, no larger than 5.
Definition: kIOS.h:120
OBB obb
@ OBB related with kIOS
Definition: kIOS.h:123
bool operator!=(const kIOS_Sphere &other) const
Definition: kIOS.h:65
kIOS operator+(const kIOS &other) const
Return the merged kIOS of current kIOS and the other one.
KDOP< N > translate(const KDOP< N > &bv, const Vec3f &t)
translate the KDOP BV
Eigen::Matrix< FCL_REAL, 3, 3 > Matrix3f
Definition: data_types.h:71
Eigen::Matrix< FCL_REAL, 3, 1 > Vec3f
Definition: data_types.h:67
double FCL_REAL
Definition: data_types.h:66
Main namespace.
Definition: broadphase_bruteforce.h:44
request to the collision algorithm
Definition: collision_data.h:312
Oriented bounding box class.
Definition: OBB.h:52