RSS.h 5.07 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
38
39
40
 *     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 */

#ifndef FCL_RSS_H
#define FCL_RSS_H

41
#include <stdexcept>
42
43
#include "fcl/math/vec_3f.h"
#include "fcl/math/matrix_3f.h"
44
#include <boost/math/constants/constants.hpp>
sachinc's avatar
sachinc committed
45
46
47
48

namespace fcl
{

49
/// @brief A class for rectangle sphere-swept bounding volume
sachinc's avatar
sachinc committed
50
51
52
class RSS
{
public:
53
54
  /// @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.
sachinc's avatar
sachinc committed
55
56
  Vec3f axis[3];

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

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

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

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

69
70
71
72
73
74
75
  /// Not implemented
  bool overlap(const RSS& other, FCL_REAL& sqrDistLowerBound) const
  {
    throw std::runtime_error ("Not implemented.");
    return false;
  }

76
77
  /// @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.
sachinc's avatar
sachinc committed
78
79
80
81
82
  bool overlap(const RSS& other, RSS& overlap_part) const
  {
    return overlap(other);
  }

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

86
87
  /// @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
88
89
  RSS& operator += (const Vec3f& p);

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

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

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

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

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

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

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

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

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

};

jpan's avatar
jpan committed
141
142
143
144

/// @brief Translate the RSS bv
RSS translate(const RSS& bv, const Vec3f& t);

145
146
147
/// @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)
148
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
149

150
151

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


}


#endif