hpp-fcl  3.0.0
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 namespace fcl {
45 
46 struct CollisionRequest;
47 
50 
53  EIGEN_MAKE_ALIGNED_OPERATOR_NEW
54 
61 
64 
67 
68  OBB() : axes(Matrix3f::Zero()), To(Vec3f::Zero()), extent(Vec3f::Zero()) {}
69 
71  bool operator==(const OBB& other) const {
72  return axes == other.axes && To == other.To && extent == other.extent;
73  }
74 
76  bool operator!=(const OBB& other) const { return !(*this == other); }
77 
79  bool contain(const Vec3f& p) const;
80 
83  bool overlap(const OBB& other) const;
84 
89  bool overlap(const OBB& other, const CollisionRequest& request,
90  FCL_REAL& sqrDistLowerBound) const;
91 
93  FCL_REAL distance(const OBB& other, Vec3f* P = NULL, Vec3f* Q = NULL) const;
94 
97  OBB& operator+=(const Vec3f& p);
98 
100  OBB& operator+=(const OBB& other) {
101  *this = *this + other;
102  return *this;
103  }
104 
107  OBB operator+(const OBB& other) const;
108 
110  inline FCL_REAL size() const { return extent.squaredNorm(); }
111 
113  inline const Vec3f& center() const { return To; }
114 
116  inline FCL_REAL width() const { return 2 * extent[0]; }
117 
119  inline FCL_REAL height() const { return 2 * extent[1]; }
120 
122  inline FCL_REAL depth() const { return 2 * extent[2]; }
123 
125  inline FCL_REAL volume() const { return width() * height() * depth(); }
126 };
127 
129 HPP_FCL_DLLAPI OBB translate(const OBB& bv, const Vec3f& t);
130 
133 HPP_FCL_DLLAPI bool overlap(const Matrix3f& R0, const Vec3f& T0, const OBB& b1,
134  const OBB& b2);
135 
138 HPP_FCL_DLLAPI bool overlap(const Matrix3f& R0, const Vec3f& T0, const OBB& b1,
139  const OBB& b2, const CollisionRequest& request,
140  FCL_REAL& sqrDistLowerBound);
141 
147 HPP_FCL_DLLAPI bool obbDisjoint(const Matrix3f& B, const Vec3f& T,
148  const Vec3f& a, const Vec3f& b);
149 } // namespace fcl
150 
151 } // namespace hpp
152 
153 #endif
#define HPP_FCL_DLLAPI
Definition: config.hh:88
FCL_REAL height() const
Height of the OBB.
Definition: OBB.h:119
FCL_REAL distance(const OBB &other, Vec3f *P=NULL, Vec3f *Q=NULL) const
Distance between two OBBs, not implemented.
OBB & operator+=(const Vec3f &p)
A simple way to merge the OBB and a point (the result is not compact).
OBB()
Definition: OBB.h:68
OBB & operator+=(const OBB &other)
Merge the OBB and another OBB (the result is not compact).
Definition: OBB.h:100
bool overlap(const OBB &other) const
Vec3f extent
Half dimensions of OBB.
Definition: OBB.h:66
FCL_REAL depth() const
Depth of the OBB.
Definition: OBB.h:122
bool operator!=(const OBB &other) const
Difference operator.
Definition: OBB.h:76
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 OBB.
Definition: OBB.h:125
EIGEN_MAKE_ALIGNED_OPERATOR_NEW 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:60
FCL_REAL width() const
Width of the OBB.
Definition: OBB.h:116
bool contain(const Vec3f &p) const
Check whether the OBB contains a point.
bool operator==(const OBB &other) const
Equality operator.
Definition: OBB.h:71
const Vec3f & center() const
Center of the OBB.
Definition: OBB.h:113
OBB operator+(const OBB &other) const
Return the merged OBB of current OBB and the other one (the result is not compact).
bool overlap(const OBB &other, const CollisionRequest &request, FCL_REAL &sqrDistLowerBound) const
bool obbDisjoint(const Matrix3f &B, const Vec3f &T, const Vec3f &a, const Vec3f &b)
FCL_REAL size() const
Size of the OBB (used in BV_Splitter to order two OBBs)
Definition: OBB.h:110
Vec3f To
Center of OBB.
Definition: OBB.h:63
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