Ellipsoid.hh
Go to the documentation of this file.
1/*
2 * Copyright 2020 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_ELLIPSOID_HH_
18#define SDF_ELLIPSOID_HH_
19
20#include <optional>
21
22#include <gz/math/Inertial.hh>
23#include <gz/math/Ellipsoid.hh>
24#include <gz/utils/ImplPtr.hh>
25#include <sdf/Error.hh>
26#include <sdf/Element.hh>
27#include <sdf/sdf_config.h>
28
29namespace sdf
30{
31 // Inline bracket to help doxygen filtering.
32 inline namespace SDF_VERSION_NAMESPACE {
36 {
38 public: Ellipsoid();
39
46 public: Errors Load(ElementPtr _sdf);
47
50 public: gz::math::Vector3d Radii() const;
51
54 public: void SetRadii(const gz::math::Vector3d &_radii);
55
60 public: sdf::ElementPtr Element() const;
61
64 public: const gz::math::Ellipsoidd &Shape() const;
65
68 public: gz::math::Ellipsoidd &Shape();
69
75 public: std::optional<gz::math::Inertiald>
76 CalculateInertial(double _density);
77
83 public: sdf::ElementPtr ToElement() const;
84
91 public: sdf::ElementPtr ToElement(sdf::Errors &_errors) const;
92
94 GZ_UTILS_IMPL_PTR(dataPtr)
95 };
96 }
97}
98#endif
Ellipsoid represents a ellipsoid shape, and is usually accessed through a Geometry.
Definition: Ellipsoid.hh:36
sdf::ElementPtr ToElement() const
Create and return an SDF element filled with data from this ellipsoid.
gz::math::Ellipsoidd & Shape()
Get a mutable Gazebo Math representation of this Ellipsoid.
void SetRadii(const gz::math::Vector3d &_radii)
Set the ellipsoid's x, y, and z radii in meters.
gz::math::Vector3d Radii() const
Get the ellipsoid's radii in meters.
std::optional< gz::math::Inertiald > CalculateInertial(double _density)
Calculate and return the Inertial values for the Ellipsoid.
Errors Load(ElementPtr _sdf)
Load the ellipsoid geometry based on a element pointer.
sdf::ElementPtr Element() const
Get a pointer to the SDF element that was used during load.
sdf::ElementPtr ToElement(sdf::Errors &_errors) const
Create and return an SDF element filled with data from this ellipsoid.
const gz::math::Ellipsoidd & Shape() const
Get the Gazebo Math representation of this Ellipsoid.
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