Ellipsoid represents a ellipsoid shape, and is usually accessed through a Geometry.
More...
#include <Ellipsoid.hh>
Ellipsoid represents a ellipsoid shape, and is usually accessed through a Geometry.
◆ Ellipsoid()
sdf::v12::Ellipsoid::Ellipsoid 
( 
 ) 

◆ 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 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::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()
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: