Geometry.hh
Go to the documentation of this file.
1 /*
2  * Copyright 2018 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 #ifndef SDF_GEOMETRY_HH_
18 #define SDF_GEOMETRY_HH_
19 
20 #include <vector>
21 #include <optional>
22 
23 #include <gz/utils/ImplPtr.hh>
24 #include <gz/math/Inertial.hh>
25 #include <sdf/Error.hh>
26 #include <sdf/Element.hh>
27 #include <sdf/sdf_config.h>
28 #include <sdf/ParserConfig.hh>
29 #include <sdf/Types.hh>
30 
31 namespace sdf
32 {
33  // Inline bracket to help doxygen filtering.
34  inline namespace SDF_VERSION_NAMESPACE {
35  //
36 
37  // Forward declare private data class.
38  class Box;
39  class Capsule;
40  class Cone;
41  class Cylinder;
42  class Ellipsoid;
43  class Heightmap;
44  class Mesh;
45  class ParserConfig;
46  class Plane;
47  class Polyline;
48  class Sphere;
49 
52  enum class GeometryType
53  {
55  EMPTY = 0,
56 
58  BOX = 1,
59 
61  CYLINDER = 2,
62 
64  PLANE = 3,
65 
67  SPHERE = 4,
68 
70  MESH = 5,
71 
73  HEIGHTMAP = 6,
74 
76  CAPSULE = 7,
77 
79  ELLIPSOID = 8,
80 
82  POLYLINE = 9,
83 
85  CONE = 10,
86  };
87 
93  {
95  public: Geometry();
96 
103  public: Errors Load(ElementPtr _sdf);
104 
112  public: Errors Load(sdf::ElementPtr _sdf, const ParserConfig &_config);
113 
116  public: GeometryType Type() const;
117 
120  public: void SetType(const GeometryType _type);
121 
127  public: const Box *BoxShape() const;
128 
131  public: void SetBoxShape(const Box &_box);
132 
138  public: const Capsule *CapsuleShape() const;
139 
142  public: void SetCapsuleShape(const Capsule &_capsule);
143 
149  public: const Cone *ConeShape() const;
150 
153  public: void SetConeShape(const Cone &_cone);
154 
160  public: const Cylinder *CylinderShape() const;
161 
164  public: void SetCylinderShape(const Cylinder &_cylinder);
165 
171  public: const Ellipsoid *EllipsoidShape() const;
172 
175  public: void SetEllipsoidShape(const Ellipsoid &_ellipsoid);
176 
182  public: const Sphere *SphereShape() const;
183 
186  public: void SetSphereShape(const Sphere &_sphere);
187 
192  public: const std::vector<Polyline> &PolylineShape() const;
193 
196  public: void SetPolylineShape(const std::vector<Polyline> &_polyline);
197 
203  public: const Plane *PlaneShape() const;
204 
207  public: void SetPlaneShape(const Plane &_plane);
208 
214  public: const Mesh *MeshShape() const;
215 
218  public: void SetMeshShape(const Mesh &_mesh);
219 
225  public: const Heightmap *HeightmapShape() const;
226 
229  public: void SetHeightmapShape(const Heightmap &_heightmap);
230 
238  public: std::optional<gz::math::Inertiald> CalculateInertial(
239  sdf::Errors &_errors, const ParserConfig &_config,
240  double _density, sdf::ElementPtr _autoInertiaParams);
241 
246  public: sdf::ElementPtr Element() const;
247 
253  public: sdf::ElementPtr ToElement() const;
254 
261  public: sdf::ElementPtr ToElement(sdf::Errors &_errors) const;
262 
264  GZ_UTILS_IMPL_PTR(dataPtr)
265  };
266  }
267 }
268 #endif
Box represents a box shape, and is usually accessed through a Geometry.
Definition: Box.hh:37
Capsule represents a capsule shape, and is usually accessed through a Geometry.
Definition: Capsule.hh:36
Cone represents a cone shape, and is usually accessed through a Geometry.
Definition: Cone.hh:38
Cylinder represents a cylinder shape, and is usually accessed through a Geometry.
Definition: Cylinder.hh:36
Ellipsoid represents a ellipsoid shape, and is usually accessed through a Geometry.
Definition: Ellipsoid.hh:36
Geometry provides access to a shape, such as a Box.
Definition: Geometry.hh:93
void SetConeShape(const Cone &_cone)
Set the cone shape.
const Sphere * SphereShape() const
Get the sphere geometry, or nullptr if the contained geometry is not a sphere.
const Cone * ConeShape() const
Get the cone geometry, or nullptr if the contained geometry is not a cone.
sdf::ElementPtr Element() const
Get a pointer to the SDF element that was used during load.
const Ellipsoid * EllipsoidShape() const
Get the ellipsoid geometry, or nullptr if the contained geometry is not an ellipsoid.
std::optional< gz::math::Inertiald > CalculateInertial(sdf::Errors &_errors, const ParserConfig &_config, double _density, sdf::ElementPtr _autoInertiaParams)
Calculate and return the Inertial values for the Geometry.
const Plane * PlaneShape() const
Get the plane geometry, or nullptr if the contained geometry is not a plane.
sdf::ElementPtr ToElement() const
Create and return an SDF element filled with data from this geometry.
void SetEllipsoidShape(const Ellipsoid &_ellipsoid)
Set the ellipsoid shape.
sdf::ElementPtr ToElement(sdf::Errors &_errors) const
Create and return an SDF element filled with data from this geometry.
GeometryType Type() const
Get the type of geometry.
const std::vector< Polyline > & PolylineShape() const
Get the polyline geometry.
void SetPolylineShape(const std::vector< Polyline > &_polyline)
Set the polyline shape.
const Box * BoxShape() const
Get the box geometry, or nullptr if the contained geometry is not a box.
const Cylinder * CylinderShape() const
Get the cylinder geometry, or nullptr if the contained geometry is not a cylinder.
void SetSphereShape(const Sphere &_sphere)
Set the sphere shape.
const Capsule * CapsuleShape() const
Get the capsule geometry, or nullptr if the contained geometry is not a capsule.
const Mesh * MeshShape() const
Get the mesh geometry, or nullptr if the contained geometry is not a mesh.
void SetCapsuleShape(const Capsule &_capsule)
Set the capsule shape.
Errors Load(ElementPtr _sdf)
Load the geometry based on a element pointer.
void SetHeightmapShape(const Heightmap &_heightmap)
Set the heightmap shape.
const Heightmap * HeightmapShape() const
Get the heightmap geometry, or nullptr if the contained geometry is not a heightmap.
Errors Load(sdf::ElementPtr _sdf, const ParserConfig &_config)
Load the geometry based on a element pointer.
void SetPlaneShape(const Plane &_plane)
Set the plane shape.
void SetCylinderShape(const Cylinder &_cylinder)
Set the cylinder shape.
void SetMeshShape(const Mesh &_mesh)
Set the mesh shape.
void SetType(const GeometryType _type)
Set the type of geometry.
void SetBoxShape(const Box &_box)
Set the box shape.
Heightmap represents a shape defined by a 2D field, and is usually accessed through a Geometry.
Definition: Heightmap.hh:134
Mesh represents a mesh shape, and is usually accessed through a Geometry.
Definition: Mesh.hh:96
This class contains configuration options for the libsdformat parser.
Definition: ParserConfig.hh:100
Plane represents a plane shape, and is usually accessed through a Geometry.
Definition: Plane.hh:37
Sphere represents a sphere shape, and is usually accessed through a Geometry.
Definition: Sphere.hh:37
GeometryType
The set of geometry types.
Definition: Geometry.hh:53
@ EMPTY
Empty geometry. This means no shape has been defined.
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:95
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:55
namespace for Simulation Description Format parser
Definition: Actor.hh:35
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system_util.hh:25