Ellipsoid represents a ellipsoid shape, and is usually accessed through a Geometry. More...

#include <Ellipsoid.hh>

Public Member Functions
	Ellipsoid ()
	Constructor. More...

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

Errors	Load (ElementPtr _sdf)
	Load the ellipsoid geometry based on a element pointer. More...

ignition::math::Vector3d	Radii () const
	Get the ellipsoid's radii in meters. More...

void	SetRadii (const ignition::math::Vector3d &_radii)
	Set the ellipsoid's x, y, and z radii in meters. More...

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

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

sdf::ElementPtr	ToElement () const
	Create and return an SDF element filled with data from this ellipsoid. More...

Detailed Description

Ellipsoid represents a ellipsoid shape, and is usually accessed through a Geometry.

Constructor & Destructor Documentation

◆ Ellipsoid()

sdf::v12::Ellipsoid::Ellipsoid ( )

Constructor.

Member Function Documentation

◆ Element()

sdf::ElementPtr sdf::v12::Ellipsoid::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::v12::Ellipsoid::Load ( ElementPtr _sdf )

Load the ellipsoid 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.

◆ Radii()

ignition::math::Vector3d sdf::v12::Ellipsoid::Radii ( ) const

Get the ellipsoid's radii in meters.

Returns: The radius of the ellipsoid in meters.

◆ SetRadii()

void sdf::v12::Ellipsoid::SetRadii ( const ignition::math::Vector3d & _radii )

Set the ellipsoid's x, y, and z radii in meters.

Parameters

[in] _radius Vector of radii (x, y, z) of the ellipsoid in meters.

◆ Shape() [1/2]

ignition::math::Ellipsoidd& sdf::v12::Ellipsoid::Shape ( )

Get a mutable Ignition Math representation of this Ellipsoid.

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

◆ Shape() [2/2]

const ignition::math::Ellipsoidd& sdf::v12::Ellipsoid::Shape ( ) const

Get the Ignition Math representation of this Ellipsoid.

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

◆ ToElement()

sdf::ElementPtr sdf::v12::Ellipsoid::ToElement ( ) const

Create and return an SDF element filled with data from this ellipsoid.

Note that parameter passing functionality is not captured with this function.

Returns: SDF element pointer with updated ellipsoid values.

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

Ellipsoid.hh

Public Member Functions