Box.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_BOX_HH_
18#define SDF_BOX_HH_
19
20#include <optional>
21
22#include <gz/math/Box.hh>
23#include <gz/math/Vector3.hh>
24#include <gz/math/Inertial.hh>
25#include <gz/utils/ImplPtr.hh>
26#include <sdf/Error.hh>
27#include <sdf/Element.hh>
28#include <sdf/sdf_config.h>
29
30namespace sdf
31{
32 // Inline bracket to help doxygen filtering.
33 inline namespace SDF_VERSION_NAMESPACE {
37 {
39 public: Box();
40
47 public: Errors Load(ElementPtr _sdf);
48
51 public: gz::math::Vector3d Size() const;
52
55 public: void SetSize(const gz::math::Vector3d &_size);
56
61 public: sdf::ElementPtr Element() const;
62
65 public: const gz::math::Boxd &Shape() const;
66
69 public: gz::math::Boxd &Shape();
70
76 public: std::optional<gz::math::Inertiald>
77 CalculateInertial(double _density);
78
84 public: sdf::ElementPtr ToElement() const;
85
92 public: sdf::ElementPtr ToElement(sdf::Errors &_errors) const;
93
95 GZ_UTILS_IMPL_PTR(dataPtr)
96 };
97 }
98}
99
100#endif
Box represents a box shape, and is usually accessed through a Geometry.
Definition: Box.hh:37
std::optional< gz::math::Inertiald > CalculateInertial(double _density)
Calculate and return the Inertial values for the Box.
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 box.
Errors Load(ElementPtr _sdf)
Load the box geometry based on a element pointer.
gz::math::Vector3d Size() const
Get the box size in meters.
const gz::math::Boxd & Shape() const
Get the Gazebo Math representation of this Box.
sdf::ElementPtr ToElement() const
Create and return an SDF element filled with data from this box.
void SetSize(const gz::math::Vector3d &_size)
Set the box size in meters.
gz::math::Boxd & Shape()
Get a mutable Gazebo Math representation of this Box.
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