FCL  0.6.0
Flexible Collision Library
AABB.h
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2011-2014, Willow Garage, Inc.
5  * Copyright (c) 2014-2016, 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 FCL_BV_AABB_H
39 #define FCL_BV_AABB_H
40 
41 #include "fcl/common/types.h"
42 
43 namespace fcl
44 {
45 
48 template <typename S_>
49 class AABB
50 {
51 public:
52 
53  using S = S_;
54 
56  Vector3<S> min_;
57 
59  Vector3<S> max_;
60 
62  AABB();
63 
65  AABB(const Vector3<S>& v);
66 
68  AABB(const Vector3<S>& a, const Vector3<S>&b);
69 
71  AABB(const AABB<S>& core, const Vector3<S>& delta);
72 
74  AABB(const Vector3<S>& a, const Vector3<S>& b, const Vector3<S>& c);
75 
77  bool overlap(const AABB<S>& other) const;
78 
80  bool contain(const AABB<S>& other) const;
81 
83  bool axisOverlap(const AABB<S>& other, int axis_id) const;
84 
86  bool overlap(const AABB<S>& other, AABB<S>& overlap_part) const;
87 
89  bool contain(const Vector3<S>& p) const;
90 
92  AABB<S>& operator += (const Vector3<S>& p);
93 
95  AABB<S>& operator += (const AABB<S>& other);
96 
98  AABB<S> operator + (const AABB<S>& other) const;
99 
101  S width() const;
102 
104  S height() const;
105 
107  S depth() const;
108 
110  S volume() const;
111 
113  S size() const;
114 
116  S radius() const;
117 
119  Vector3<S> center() const;
120 
123  S distance(const AABB<S>& other, Vector3<S>* P, Vector3<S>* Q) const;
124 
126  S distance(const AABB<S>& other) const;
127 
129  bool equal(const AABB<S>& other) const;
130 
133  AABB<S>& expand(const Vector3<S>& delta);
134 
136  AABB<S>& expand(const AABB<S>& core, S ratio);
137 };
138 
139 using AABBf = AABB<float>;
140 using AABBd = AABB<double>;
141 
143 template <typename S, typename Derived>
145  const AABB<S>& aabb, const Eigen::MatrixBase<Derived>& t);
146 
147 } // namespace fcl
148 
149 #include "fcl/math/bv/AABB-inl.h"
150 
151 #endif
Main namespace.
Definition: broadphase_bruteforce-inl.h:45
S size() const
Size of the AABB (used in BV_Splitter to order two AABBs)
Definition: AABB-inl.h:216
bool axisOverlap(const AABB< S > &other, int axis_id) const
Check whether two AABB are overlapped along specific axis.
Definition: AABB-inl.h:124
AABB< S > & operator+=(const Vector3< S > &p)
Merge the AABB and a point.
Definition: AABB-inl.h:162
S height() const
Height of the AABB.
Definition: AABB-inl.h:195
AABB< S > translate(const AABB< S > &aabb, const Eigen::MatrixBase< Derived > &t)
translate the center of AABB by t
Definition: AABB-inl.h:345
A class describing the AABB collision structure, which is a box in 3D space determined by two diagona...
Definition: AABB.h:49
bool equal(const AABB< S > &other) const
whether two AABB are equal
Definition: AABB-inl.h:319
bool overlap(const AABB< S > &other) const
Check whether two AABB are overlap.
Definition: AABB-inl.h:98
Vector3< S > max_
The max point in the AABB.
Definition: AABB.h:59
Vector3< S > center() const
Center of the AABB.
Definition: AABB-inl.h:230
AABB< S > operator+(const AABB< S > &other) const
Return the merged AABB of current AABB and the other one.
Definition: AABB-inl.h:180
Vector3< S > min_
The min point in the AABB.
Definition: AABB.h:56
S depth() const
Depth of the AABB.
Definition: AABB-inl.h:202
S volume() const
Volume of the AABB.
Definition: AABB-inl.h:209
S radius() const
Radius of the AABB.
Definition: AABB-inl.h:223
AABB()
Creating an AABB with zero size (low bound +inf, upper bound -inf)
Definition: AABB-inl.h:52
AABB< S > & expand(const Vector3< S > &delta)
expand the half size of the AABB by delta, and keep the center unchanged.
Definition: AABB-inl.h:327
S distance(const AABB< S > &other, Vector3< S > *P, Vector3< S > *Q) const
Distance between two AABBs; P and Q, should not be nullptr, return the nearest points.
Definition: AABB-inl.h:237
S width() const
Width of the AABB.
Definition: AABB-inl.h:188
bool contain(const AABB< S > &other) const
Check whether the AABB contains another AABB.
Definition: AABB-inl.h:111