RSS.h 5.33 KB
Newer Older
sachinc's avatar
sachinc committed
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
sachinc's avatar
sachinc committed
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
sachinc's avatar
sachinc committed
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_RSS_H
#define HPP_FCL_RSS_H
sachinc's avatar
sachinc committed
40

41
#include <stdexcept>
42
#include <hpp/fcl/math/types.h>
43
#include <boost/math/constants/constants.hpp>
sachinc's avatar
sachinc committed
44

45
46
namespace hpp
{
sachinc's avatar
sachinc committed
47
48
49
namespace fcl
{

50
  class CollisionRequest;
51
/// @brief A class for rectangle sphere-swept bounding volume
sachinc's avatar
sachinc committed
52
53
54
class RSS
{
public:
55
56
  /// @brief Orientation of RSS. axis[i] is the ith column of the orientation matrix for the RSS; it is also the i-th principle direction of the RSS.
  /// We assume that axis[0] corresponds to the axis with the longest length, axis[1] corresponds to the shorter one and axis[2] corresponds to the shortest one.
Joseph Mirabel's avatar
Joseph Mirabel committed
57
  Matrix3f axes;
sachinc's avatar
sachinc committed
58

59
  /// @brief Origin of the rectangle in RSS
sachinc's avatar
sachinc committed
60
61
  Vec3f Tr;

62
  /// @brief Side lengths of rectangle
63
  FCL_REAL l[2];
sachinc's avatar
sachinc committed
64

65
  /// @brief Radius of sphere summed with rectangle to form RSS
66
  FCL_REAL r;
sachinc's avatar
sachinc committed
67

68
  /// @brief Check collision between two RSS
sachinc's avatar
sachinc committed
69
70
  bool overlap(const RSS& other) const;

71
  /// Not implemented
72
73
  bool overlap(const RSS& other, const CollisionRequest&,
               FCL_REAL& sqrDistLowerBound) const
74
  {
75
76
    sqrDistLowerBound = sqrt (-1);
    return overlap (other);
77
78
  }

79
80
  /// @brief Check collision between two RSS and return the overlap part.
  /// For RSS, we return nothing, as the overlap part of two RSSs usually is not a RSS.
Joseph Mirabel's avatar
Joseph Mirabel committed
81
  bool overlap(const RSS& other, RSS& /*overlap_part*/) const
sachinc's avatar
sachinc committed
82
83
84
85
  {
    return overlap(other);
  }

86
  /// @brief Check whether the RSS contains a point
sachinc's avatar
sachinc committed
87
88
  inline bool contain(const Vec3f& p) const;

89
90
  /// @brief A simple way to merge the RSS and a point, not compact.
  /// @todo This function may have some bug.
sachinc's avatar
sachinc committed
91
92
  RSS& operator += (const Vec3f& p);

93
  /// @brief Merge the RSS and another RSS
sachinc's avatar
sachinc committed
94
95
96
97
98
99
  inline RSS& operator += (const RSS& other)
  {
    *this = *this + other;
    return *this;
  }

100
  /// @brief Return the merged RSS of current RSS and the other one
sachinc's avatar
sachinc committed
101
102
  RSS operator + (const RSS& other) const;

103
  /// @brief Width of the RSS
104
  inline FCL_REAL width() const
sachinc's avatar
sachinc committed
105
106
107
108
  {
    return l[0] + 2 * r;
  }

109
  /// @brief Height of the RSS
110
  inline FCL_REAL height() const
sachinc's avatar
sachinc committed
111
112
113
114
  {
    return l[1] + 2 * r;
  }

115
  /// @brief Depth of the RSS
116
  inline FCL_REAL depth() const
sachinc's avatar
sachinc committed
117
118
119
120
  {
    return 2 * r;
  }

121
  /// @brief Volume of the RSS
122
  inline FCL_REAL volume() const
sachinc's avatar
sachinc committed
123
  {
124
    return (l[0] * l[1] * 2 * r + 4 * boost::math::constants::pi<FCL_REAL>() * r * r * r);
sachinc's avatar
sachinc committed
125
126
  }

127
  /// @brief Size of the RSS (used in BV_Splitter to order two RSSs)
128
  inline FCL_REAL size() const
sachinc's avatar
sachinc committed
129
  {
130
    return (std::sqrt(l[0] * l[0] + l[1] * l[1]) + 2 * r);
sachinc's avatar
sachinc committed
131
132
  }

133
  /// @brief The RSS center
134
  inline const Vec3f& center() const
sachinc's avatar
sachinc committed
135
136
137
138
  {
    return Tr;
  }

139
  /// @brief the distance between two RSS; P and Q, if not NULL, return the nearest points
140
  FCL_REAL distance(const RSS& other, Vec3f* P = NULL, Vec3f* Q = NULL) const;
sachinc's avatar
sachinc committed
141
142
143

};

144
145
146
/// @brief distance between two RSS bounding volumes
/// P and Q (optional return values) are the closest points in the rectangles, not the RSS. But the direction P - Q is the correct direction for cloest points
/// Notice that P and Q are both in the local frame of the first RSS (not global frame and not even the local frame of object 1)
147
FCL_REAL distance(const Matrix3f& R0, const Vec3f& T0, const RSS& b1, const RSS& b2, Vec3f* P = NULL, Vec3f* Q = NULL);
sachinc's avatar
sachinc committed
148

149
150

/// @brief Check collision between two RSSs, b1 is in configuration (R0, T0) and b2 is in identity.
151
bool overlap(const Matrix3f& R0, const Vec3f& T0, const RSS& b1, const RSS& b2);
sachinc's avatar
sachinc committed
152

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

}


161
162
} // namespace hpp

sachinc's avatar
sachinc committed
163
#endif