GCC Code Coverage Report


Directory: ./
File: include/coal/shape/convex.h
Date: 2025-04-01 09:23:31
Exec Total Coverage
Lines: 1 1 100.0%
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 COAL_SHAPE_CONVEX_H
39 #define COAL_SHAPE_CONVEX_H
40
41 #include "coal/shape/geometric_shapes.h"
42
43 namespace coal {
44
45 /// @brief Convex polytope
46 /// @tparam PolygonT the polygon class. It must have method \c size() and
47 /// \c operator[](int i)
48 template <typename PolygonT>
49 class Convex : public ConvexBase {
50 public:
51 /// @brief Construct an uninitialized convex object
52 61184 Convex() : ConvexBase(), num_polygons(0) {}
53
54 /// @brief Constructing a convex, providing normal and offset of each polytype
55 /// surface, and the points and shape topology information \param ownStorage
56 /// whether this class owns the pointers of points and
57 /// polygons. If owned, they are deleted upon destruction.
58 /// \param points_ list of 3D points
59 /// \param num_points_ number of 3D points
60 /// \param polygons_ \copydoc Convex::polygons
61 /// \param num_polygons_ the number of polygons.
62 /// \note num_polygons_ is not the allocated size of polygons_.
63 Convex(std::shared_ptr<std::vector<Vec3s>> points_, unsigned int num_points_,
64 std::shared_ptr<std::vector<PolygonT>> polygons_,
65 unsigned int num_polygons_);
66
67 /// @brief Copy constructor
68 /// Only the list of neighbors is copied.
69 Convex(const Convex& other);
70
71 ~Convex();
72
73 /// based on http://number-none.com/blow/inertia/bb_inertia.doc
74 Matrix3s computeMomentofInertia() const;
75
76 Vec3s computeCOM() const;
77
78 Scalar computeVolume() const;
79
80 ///
81 /// @brief Set the current Convex from a list of points and polygons.
82 ///
83 /// \param ownStorage whether this class owns the pointers of points and
84 /// polygons. If owned, they are deleted upon destruction.
85 /// \param points list of 3D points
86 /// \param num_points number of 3D points
87 /// \param polygons \copydoc Convex::polygons
88 /// \param num_polygons the number of polygons.
89 /// \note num_polygons is not the allocated size of polygons.
90 ///
91 void set(std::shared_ptr<std::vector<Vec3s>> points, unsigned int num_points,
92 std::shared_ptr<std::vector<PolygonT>> polygons,
93 unsigned int num_polygons);
94
95 /// @brief Clone (deep copy)
96 virtual Convex<PolygonT>* clone() const;
97
98 /// @brief An array of PolygonT object.
99 /// PolygonT should contains a list of vertices for each polygon,
100 /// in counter clockwise order.
101 std::shared_ptr<std::vector<PolygonT>> polygons;
102 unsigned int num_polygons;
103
104 protected:
105 void fillNeighbors();
106 };
107
108 } // namespace coal
109
110 #include "coal/shape/details/convex.hxx"
111
112 #endif
113