hpp-fcl  1.4.4
HPP fork of FCL -- The Flexible Collision Library
OBB.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_OBB_H
39 #define HPP_FCL_OBB_H
40 
41 #include <hpp/fcl/data_types.h>
42 
43 namespace hpp
44 {
45 namespace fcl
46 {
47 
48 struct CollisionRequest;
49 
52 
54 class OBB
55 {
56 public:
60 
63 
66 
68  bool contain(const Vec3f& p) const;
69 
72  bool overlap(const OBB& other) const;
73 
78  bool overlap(const OBB& other, const CollisionRequest& request,
79  FCL_REAL& sqrDistLowerBound) const;
80 
82  FCL_REAL distance(const OBB& other, Vec3f* P = NULL, Vec3f* Q = NULL) const;
83 
85  OBB& operator += (const Vec3f& p);
86 
88  OBB& operator += (const OBB& other)
89  {
90  *this = *this + other;
91  return *this;
92  }
93 
95  OBB operator + (const OBB& other) const;
96 
98  inline FCL_REAL size() const
99  {
100  return extent.squaredNorm();
101  }
102 
104  inline const Vec3f& center() const
105  {
106  return To;
107  }
108 
110  inline FCL_REAL width() const
111  {
112  return 2 * extent[0];
113  }
114 
116  inline FCL_REAL height() const
117  {
118  return 2 * extent[1];
119  }
120 
122  inline FCL_REAL depth() const
123  {
124  return 2 * extent[2];
125  }
126 
128  inline FCL_REAL volume() const
129  {
130  return width() * height() * depth();
131  }
132 };
133 
134 
136 OBB translate(const OBB& bv, const Vec3f& t);
137 
139 bool overlap(const Matrix3f& R0, const Vec3f& T0, const OBB& b1, const OBB& b2);
140 
142 bool overlap(const Matrix3f& R0, const Vec3f& T0, const OBB& b1,
143  const OBB& b2, const CollisionRequest& request,
144  FCL_REAL& sqrDistLowerBound);
145 
146 
152 bool obbDisjoint(const Matrix3f& B, const Vec3f& T, const Vec3f& a, const Vec3f& b);
153 }
154 
155 } // namespace hpp
156 
157 #endif
FCL_REAL volume() const
Volume of the OBB.
Definition: OBB.h:128
Main namespace.
Definition: AABB.h:43
FCL_REAL distance(const OBB &other, Vec3f *P=NULL, Vec3f *Q=NULL) const
Distance between two OBBs, not implemented.
Oriented bounding box class.
Definition: OBB.h:54
FCL_REAL height() const
Height of the OBB.
Definition: OBB.h:116
Eigen::Matrix< FCL_REAL, 3, 3 > Matrix3f
Definition: data_types.h:74
KDOP< N > translate(const KDOP< N > &bv, const Vec3f &t)
translate the KDOP BV
bool overlap(const OBB &other) const
bool obbDisjoint(const Matrix3f &B, const Vec3f &T, const Vec3f &a, const Vec3f &b)
request to the collision algorithm
Definition: collision_data.h:150
double FCL_REAL
Definition: data_types.h:68
FCL_REAL depth() const
Depth of the OBB.
Definition: OBB.h:122
OBB operator+(const OBB &other) const
Return the merged OBB of current OBB and the other one (the result is not compact).
FCL_REAL size() const
Size of the OBB (used in BV_Splitter to order two OBBs)
Definition: OBB.h:98
bool contain(const Vec3f &p) const
Check whether the OBB contains a point.
Vec3f To
Center of OBB.
Definition: OBB.h:62
Eigen::Matrix< FCL_REAL, 3, 1 > Vec3f
Definition: data_types.h:73
const Vec3f & center() const
Center of the OBB.
Definition: OBB.h:104
FCL_REAL width() const
Width of the OBB.
Definition: OBB.h:110
Matrix3f axes
Orientation of OBB. axis[i] is the ith column of the orientation matrix for the box; it is also the i...
Definition: OBB.h:59
OBB & operator+=(const Vec3f &p)
A simple way to merge the OBB and a point (the result is not compact).
Vec3f extent
Half dimensions of OBB.
Definition: OBB.h:65