Cylinder represents a cylinder shape, and is usually accessed through a Geometry.
More...
#include <Cylinder.hh>
Cylinder represents a cylinder shape, and is usually accessed through a Geometry.
◆ Cylinder() [1/3]
sdf::v9::Cylinder::Cylinder |
( |
| ) |
|
◆ Cylinder() [2/3]
sdf::v9::Cylinder::Cylinder |
( |
const Cylinder & |
_cylinder | ) |
|
Copy constructor.
- Parameters
-
◆ Cylinder() [3/3]
sdf::v9::Cylinder::Cylinder |
( |
Cylinder && |
_cylinder | ) |
|
|
noexcept |
Move constructor.
- Parameters
-
◆ ~Cylinder()
virtual sdf::v9::Cylinder::~Cylinder |
( |
| ) |
|
|
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.
◆ Length()
double sdf::v9::Cylinder::Length |
( |
| ) |
const |
Get the cylinder's length in meters.
- Returns
- The length of the cylinder in meters.
◆ Load()
Load the cylinder 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]
Assignment operator.
- Parameters
-
[in] | _cylinder | The cylinder to set values from. |
- Returns
- *this
◆ operator=() [2/2]
Move assignment operator.
- Parameters
-
- Returns
- Reference to this.
◆ Radius()
double sdf::v9::Cylinder::Radius |
( |
| ) |
const |
Get the cylinder's radius in meters.
- Returns
- The radius of the cylinder in meters.
◆ SetLength()
void sdf::v9::Cylinder::SetLength |
( |
const double |
_length | ) |
|
Set the cylinder's length in meters.
- Parameters
-
[in] | _length | The length of the cylinder in meters. |
◆ SetRadius()
void sdf::v9::Cylinder::SetRadius |
( |
const double |
_radius | ) |
|
Set the cylinder's radius in meters.
- Parameters
-
[in] | _radius | The radius of the cylinder in meters. |
◆ Shape() [1/2]
gz::math::Cylinderd& sdf::v9::Cylinder::Shape |
( |
| ) |
|
Get a mutable Gazebo Math representation of this Cylinder.
- Returns
- A reference to a gz::math::Cylinderd object.
◆ Shape() [2/2]
const gz::math::Cylinderd& sdf::v9::Cylinder::Shape |
( |
| ) |
const |
Get the Gazebo Math representation of this Cylinder.
- Returns
- A const reference to a gz::math::Sphered object.
The documentation for this class was generated from the following file: