Loading...
Searching...
No Matches
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 <sdf/Error.hh>
21#include <sdf/Element.hh>
22#include <sdf/sdf_config.h>
23
24namespace sdf
25{
26 // Inline bracket to help doxygen filtering.
27 inline namespace SDF_VERSION_NAMESPACE {
28 //
29
30 // Forward declare private data class.
31 class GeometryPrivate;
32 class Box;
33 class Cylinder;
34 class Heightmap;
35 class Mesh;
36 class Plane;
37 class Sphere;
38
41 enum class GeometryType
42 {
44 EMPTY = 0,
45
47 BOX = 1,
48
50 CYLINDER = 2,
51
53 PLANE = 3,
54
56 SPHERE = 4,
57
59 MESH = 5,
60
62 HEIGHTMAP = 6,
63 };
64
70 {
72 public: Geometry();
73
76 public: Geometry(const Geometry &_geometry);
77
80 public: Geometry(Geometry &&_geometry) noexcept;
81
83 public: virtual ~Geometry();
84
88 public: Geometry &operator=(const Geometry &_geometry);
89
93 public: Geometry &operator=(Geometry &&_geometry);
94
101 public: Errors Load(ElementPtr _sdf);
102
105 public: GeometryType Type() const;
106
109 public: void SetType(const GeometryType _type);
110
116 public: const Box *BoxShape() const;
117
120 public: void SetBoxShape(const Box &_box);
121
127 public: const Cylinder *CylinderShape() const;
128
131 public: void SetCylinderShape(const Cylinder &_cylinder);
132
138 public: const Sphere *SphereShape() const;
139
142 public: void SetSphereShape(const Sphere &_sphere);
143
149 public: const Plane *PlaneShape() const;
150
153 public: void SetPlaneShape(const Plane &_plane);
154
160 public: const Mesh *MeshShape() const;
161
164 public: void SetMeshShape(const Mesh &_mesh);
165
171 public: const Heightmap *HeightmapShape() const;
172
175 public: void SetHeightmapShape(const Heightmap &_heightmap);
176
181 public: sdf::ElementPtr Element() const;
182
184 private: GeometryPrivate *dataPtr;
185 };
186 }
187}
188#endif
Box represents a box shape, and is usually accessed through a Geometry.
Definition Box.hh:37
Cylinder represents a cylinder shape, and is usually accessed through a Geometry.
Definition Cylinder.hh:37
Geometry provides access to a shape, such as a Box.
Definition Geometry.hh:70
GeometryType Type() const
Get the type of geometry.
Geometry(const Geometry &_geometry)
Copy constructor.
void SetBoxShape(const Box &_box)
Set the box shape.
const Sphere * SphereShape() const
Get the sphere geometry, or nullptr if the contained geometry is not a sphere.
void SetMeshShape(const Mesh &_mesh)
Set the mesh shape.
Geometry & operator=(const Geometry &_geometry)
Assignment operator.
const Plane * PlaneShape() const
Get the plane geometry, or nullptr if the contained geometry is not a plane.
void SetSphereShape(const Sphere &_sphere)
Set the sphere shape.
sdf::ElementPtr Element() const
Get a pointer to the SDF element that was used during load.
void SetPlaneShape(const Plane &_plane)
Set the plane shape.
void SetCylinderShape(const Cylinder &_cylinder)
Set the cylinder shape.
Errors Load(ElementPtr _sdf)
Load the geometry based on a element pointer.
const Heightmap * HeightmapShape() const
Get the heightmap geometry, or nullptr if the contained geometry is not a heightmap.
const Box * BoxShape() const
Get the box geometry, or nullptr if the contained geometry is not a box.
Geometry(Geometry &&_geometry) noexcept
Move constructor.
void SetType(const GeometryType _type)
Set the type of geometry.
Geometry()
Default constructor.
Geometry & operator=(Geometry &&_geometry)
Move assignment operator.
const Cylinder * CylinderShape() const
Get the cylinder geometry, or nullptr if the contained geometry is not a cylinder.
void SetHeightmapShape(const Heightmap &_heightmap)
Set the heightmap shape.
virtual ~Geometry()
Destructor.
const Mesh * MeshShape() const
Get the mesh geometry, or nullptr if the contained geometry is not a mesh.
Heightmap represents a shape defined by a 2D field, and is usually accessed through a Geometry.
Definition Heightmap.hh:168
Mesh represents a mesh shape, and is usually accessed through a Geometry.
Definition Mesh.hh:38
Plane represents a plane shape, and is usually accessed through a Geometry.
Definition Plane.hh:39
Sphere represents a sphere shape, and is usually accessed through a Geometry.
Definition Sphere.hh:38
GeometryType
The set of geometry types.
Definition Geometry.hh:42
std::vector< Error > Errors
A vector of Error.
Definition Types.hh:89
std::shared_ptr< Element > ElementPtr
Definition Element.hh:53
namespace for Simulation Description Format parser
Definition Actor.hh:33
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition system_util.hh:48