sdf::v11::Sphere Class Reference

Sphere represents a sphere shape, and is usually accessed through a Geometry. More...

#include <Sphere.hh>

Public Member Functions

Sphere ()
Constructor. More...

sdf::ElementPtr Element () const
Get a pointer to the SDF element that was used during load. More...

Load the sphere geometry based on a element pointer. More...

Get the sphere's radius in meters. More...

Set the sphere's radius in meters. More...

ignition::math::Sphered & Shape ()
Get a mutable Ignition Math representation of this Sphere. More...

const ignition::math::Sphered & Shape () const
Get the Ignition Math representation of this Sphere. More...

Detailed Description

Sphere represents a sphere shape, and is usually accessed through a Geometry.

◆ Sphere()

 sdf::v11::Sphere::Sphere ( )

Constructor.

◆ Element()

 sdf::ElementPtr sdf::v11::Sphere::Element ( ) const

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.

 Errors sdf::v11::Sphere::Load ( ElementPtr _sdf )

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
 [in] _sdf The SDF Element pointer
Returns
Errors, which is a vector of Error objects. Each Error includes an error code and message. An empty vector indicates no error.

Get the sphere's radius in meters.

Returns
The radius of the sphere in meters.

Set the sphere's radius in meters.

Parameters

◆ Shape() [1/2]

 ignition::math::Sphered& sdf::v11::Sphere::Shape ( )

Get a mutable Ignition Math representation of this Sphere.

Returns
A reference to an ignition::math::Sphered object.

◆ Shape() [2/2]

 const ignition::math::Sphered& sdf::v11::Sphere::Shape ( ) const

Get the Ignition Math representation of this Sphere.

Returns
A const reference to an ignition::math::Sphered object.

The documentation for this class was generated from the following file: