Ellipsoid represents a ellipsoid shape, and is usually accessed through a Geometry.
More...
#include <Ellipsoid.hh>

 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...


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


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


Ellipsoid represents a ellipsoid shape, and is usually accessed through a Geometry.
◆ Ellipsoid()
sdf::v11::Ellipsoid::Ellipsoid 
( 
 ) 

◆ Element()
sdf::ElementPtr sdf::v11::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()
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

 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::v11::Ellipsoid::Radii 
( 
 ) 
const 
Get the ellipsoid's radii in meters.
 Returns
 The radius of the ellipsoid in meters.
◆ SetRadii()
void sdf::v11::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]
const ignition::math::Ellipsoidd& sdf::v11::Ellipsoid::Shape 
( 
 ) 
const 
Get the Ignition Math representation of this Ellipsoid.
 Returns
 A const reference to an ignition::math::Ellipsoidd object.
◆ Shape() [2/2]
ignition::math::Ellipsoidd& sdf::v11::Ellipsoid::Shape 
( 
 ) 

Get a mutable Ignition Math representation of this Ellipsoid.
 Returns
 A reference to an ignition::math::Ellipsoidd object.
The documentation for this class was generated from the following file: