sdf::v10::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...
	Sphere (const Sphere &_sphere)
	Copy constructor. More...
	Sphere (Sphere &&_sphere) noexcept
	Move constructor. More...
virtual	~Sphere ()
	Destructor. More...
sdf::ElementPtr	Element () const
	Get a pointer to the SDF element that was used during load. More...
Errors	Load (ElementPtr _sdf)
	Load the sphere geometry based on a element pointer. More...
Sphere &	operator= (const Sphere &_sphere)
	Assignment operator. More...
Sphere &	operator= (Sphere &&_sphere)
	Move assignment operator. More...
double	Radius () const
	Get the sphere's radius in meters. More...
void	SetRadius (const double _radius)
	Set the sphere's radius in meters. More...
const ignition::math::Sphered &	Shape () const
	Get the Ignition Math representation of this Sphere. More...
ignition::math::Sphered &	Shape ()
	Get a mutable Ignition Math representation of this Sphere. More...

Detailed Description

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

Constructor & Destructor Documentation

Sphere() [1/3]

sdf::v10::Sphere::Sphere

(

)

Constructor.

Sphere() [2/3]

sdf::v10::Sphere::Sphere

(

const Sphere &

_sphere

)

Copy constructor.

Parameters

[in]

_sphere

Sphere to copy.

Sphere() [3/3]

sdf::v10::Sphere::Sphere ( Sphere &&  _sphere )

noexcept

Move constructor.

Parameters

[in]

_sphere

Sphere to move.

~Sphere()

virtual sdf::v10::Sphere::~Sphere ( )

virtual

Destructor.

Member Function Documentation

Element()

sdf::ElementPtr sdf::v10::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.

Load()

Errors sdf::v10::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.

operator=() [1/2]

Sphere& sdf::v10::Sphere::operator=

(

const Sphere &

_sphere

)

Assignment operator.

Parameters

[in]

_sphere

The sphere to set values from.

Returns

*this

operator=() [2/2]

Sphere& sdf::v10::Sphere::operator=

(

Sphere &&

_sphere

)

Move assignment operator.

Parameters

[in]

_sphere

Sphere to move.

Returns

Reference to this.

Radius()

double sdf::v10::Sphere::Radius

(

)

const

Get the sphere's radius in meters.

Returns

The radius of the sphere in meters.

SetRadius()

void sdf::v10::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]

const ignition::math::Sphered& sdf::v10::Sphere::Shape

(

)

const

Get the Ignition Math representation of this Sphere.

Returns

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

Shape() [2/2]

ignition::math::Sphered& sdf::v10::Sphere::Shape

(

)

Get a mutable Ignition Math representation of this Sphere.

Returns

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

---

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

• Sphere.hh