GCC Code Coverage Report
Directory: ./ Exec Total Coverage
File: include/hpp/fcl/distance.h Lines: 8 14 57.1 %
Date: 2024-02-09 12:57:42 Branches: 0 0 - %

Line Branch Exec Source
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
36
/** @author Jia Pan */
37
38
#ifndef HPP_FCL_DISTANCE_H
39
#define HPP_FCL_DISTANCE_H
40
41
#include <hpp/fcl/collision_object.h>
42
#include <hpp/fcl/collision_data.h>
43
#include <hpp/fcl/distance_func_matrix.h>
44
#include <hpp/fcl/timings.h>
45
46
namespace hpp {
47
namespace fcl {
48
49
/// @brief Main distance interface: given two collision objects, and the
50
/// requirements for contacts, including whether return the nearest points, this
51
/// function performs the distance between them. Return value is the minimum
52
/// distance generated between the two objects.
53
HPP_FCL_DLLAPI FCL_REAL distance(const CollisionObject* o1,
54
                                 const CollisionObject* o2,
55
                                 const DistanceRequest& request,
56
                                 DistanceResult& result);
57
58
/// @copydoc distance(const CollisionObject*, const CollisionObject*, const
59
/// DistanceRequest&, DistanceResult&)
60
HPP_FCL_DLLAPI FCL_REAL distance(const CollisionGeometry* o1,
61
                                 const Transform3f& tf1,
62
                                 const CollisionGeometry* o2,
63
                                 const Transform3f& tf2,
64
                                 const DistanceRequest& request,
65
                                 DistanceResult& result);
66
67
/// @copydoc distance(const CollisionObject*, const CollisionObject*, const
68
/// DistanceRequest&, DistanceResult&) \note this function update the initial
69
/// guess of \c request if requested.
70
///       See QueryRequest::updateGuess
71
2214
inline FCL_REAL distance(const CollisionObject* o1, const CollisionObject* o2,
72
                         DistanceRequest& request, DistanceResult& result) {
73
2214
  FCL_REAL res = distance(o1, o2, (const DistanceRequest&)request, result);
74
2214
  request.updateGuess(result);
75
2214
  return res;
76
}
77
78
/// @copydoc distance(const CollisionObject*, const CollisionObject*, const
79
/// DistanceRequest&, DistanceResult&) \note this function update the initial
80
/// guess of \c request if requested.
81
///       See QueryRequest::updateGuess
82
2009
inline FCL_REAL distance(const CollisionGeometry* o1, const Transform3f& tf1,
83
                         const CollisionGeometry* o2, const Transform3f& tf2,
84
                         DistanceRequest& request, DistanceResult& result) {
85
  FCL_REAL res =
86
2009
      distance(o1, tf1, o2, tf2, (const DistanceRequest&)request, result);
87
2009
  request.updateGuess(result);
88
2009
  return res;
89
}
90
91
/// This class reduces the cost of identifying the geometry pair.
92
/// This is mostly useful for repeated shape-shape queries.
93
///
94
/// \code
95
///   ComputeDistance calc_distance (o1, o2);
96
///   FCL_REAL distance = calc_distance(tf1, tf2, request, result);
97
/// \endcode
98
class HPP_FCL_DLLAPI ComputeDistance {
99
 public:
100
  ComputeDistance(const CollisionGeometry* o1, const CollisionGeometry* o2);
101
102
  FCL_REAL operator()(const Transform3f& tf1, const Transform3f& tf2,
103
                      const DistanceRequest& request,
104
                      DistanceResult& result) const;
105
106
  inline FCL_REAL operator()(const Transform3f& tf1, const Transform3f& tf2,
107
                             DistanceRequest& request,
108
                             DistanceResult& result) const {
109
    FCL_REAL res = operator()(tf1, tf2, (const DistanceRequest&)request,
110
                              result);
111
    request.updateGuess(result);
112
    return res;
113
  }
114
115
  bool operator==(const ComputeDistance& other) const {
116
    return o1 == other.o1 && o2 == other.o2 && swap_geoms == other.swap_geoms &&
117
           solver == other.solver && func == other.func;
118
  }
119
120
  bool operator!=(const ComputeDistance& other) const {
121
    return !(*this == other);
122
  }
123
124
  virtual ~ComputeDistance(){};
125
126
 protected:
127
  // These pointers are made mutable to let the derived classes to update
128
  // their values when updating the collision geometry (e.g. creating a new
129
  // one). This feature should be used carefully to avoid any mis usage (e.g,
130
  // changing the type of the collision geometry should be avoided).
131
  mutable const CollisionGeometry* o1;
132
  mutable const CollisionGeometry* o2;
133
134
  mutable GJKSolver solver;
135
136
  DistanceFunctionMatrix::DistanceFunc func;
137
  bool swap_geoms;
138
139
  virtual FCL_REAL run(const Transform3f& tf1, const Transform3f& tf2,
140
                       const DistanceRequest& request,
141
                       DistanceResult& result) const;
142
143
 public:
144
  EIGEN_MAKE_ALIGNED_OPERATOR_NEW
145
};
146
147
}  // namespace fcl
148
}  // namespace hpp
149
150
#endif