Box represents a box shape, and is usually accessed through a Geometry.
More...
#include <Box.hh>
Box represents a box shape, and is usually accessed through a Geometry.
◆ Box() [1/3]
◆ Box() [2/3]
sdf::v9::Box::Box |
( |
const Box & |
_box | ) |
|
Copy constructor.
- Parameters
-
◆ Box() [3/3]
sdf::v9::Box::Box |
( |
Box && |
_box | ) |
|
|
noexcept |
Move constructor.
- Parameters
-
◆ ~Box()
virtual sdf::v9::Box::~Box |
( |
| ) |
|
|
virtual |
◆ Element()
Get a pointer to the SDF element that was used during load.
- Returns
- SDF element pointer. The value will be nullptr if Load has not been called.
◆ Load()
Load the box geometry based on a element pointer.
This is not the usual entry point. Typical usage of the SDF DOM is through the Root object.
- Parameters
-
- Returns
- Errors, which is a vector of Error objects. Each Error includes an error code and message. An empty vector indicates no error.
◆ operator=() [1/2]
Box& sdf::v9::Box::operator= |
( |
Box && |
_box | ) |
|
Move assignment operator.
- Parameters
-
- Returns
- Reference to this.
◆ operator=() [2/2]
Box& sdf::v9::Box::operator= |
( |
const Box & |
_box | ) |
|
Assignment operator.
- Parameters
-
[in] | _box | The box to set values from. |
- Returns
- *this
◆ SetSize()
void sdf::v9::Box::SetSize |
( |
const gz::math::Vector3d & |
_size | ) |
|
Set the box size in meters.
- Parameters
-
[in] | _size | Size of the box in meters. |
◆ Shape() [1/2]
gz::math::Boxd& sdf::v9::Box::Shape |
( |
| ) |
|
Get a mutable Gazebo Math representation of this Box.
- Returns
- A reference to a gz::math::Boxd object.
◆ Shape() [2/2]
const gz::math::Boxd& sdf::v9::Box::Shape |
( |
| ) |
const |
Get the Gazebo Math representation of this Box.
- Returns
- A const reference to a gz::math::Boxd object.
◆ Size()
gz::math::Vector3d sdf::v9::Box::Size |
( |
| ) |
const |
Get the box size in meters.
- Returns
- Size of the box in meters.
The documentation for this class was generated from the following file: