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