Public Member Functions | List of all members
sdf::v12::Cylinder Class Reference

Cylinder represents a cylinder shape, and is usually accessed through a Geometry. More...

#include <Cylinder.hh>

Public Member Functions

 Cylinder ()
 Constructor. More...
 
sdf::ElementPtr Element () const
 Get a pointer to the SDF element that was used during load. More...
 
double Length () const
 Get the cylinder's length in meters. More...
 
Errors Load (ElementPtr _sdf)
 Load the cylinder geometry based on a element pointer. More...
 
double Radius () const
 Get the cylinder's radius in meters. More...
 
void SetLength (const double _length)
 Set the cylinder's length in meters. More...
 
void SetRadius (const double _radius)
 Set the cylinder's radius in meters. More...
 
ignition::math::Cylinderd & Shape ()
 Get a mutable Ignition Math representation of this Cylinder. More...
 
const ignition::math::Cylinderd & Shape () const
 Get the Ignition Math representation of this Cylinder. More...
 
sdf::ElementPtr ToElement () const
 Create and return an SDF element filled with data from this cylinder. More...
 

Detailed Description

Cylinder represents a cylinder shape, and is usually accessed through a Geometry.

Constructor & Destructor Documentation

◆ Cylinder()

sdf::v12::Cylinder::Cylinder ( )

Constructor.

Member Function Documentation

◆ Element()

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

◆ Length()

double sdf::v12::Cylinder::Length ( ) const

Get the cylinder's length in meters.

Returns
The length of the cylinder in meters.

◆ Load()

Errors sdf::v12::Cylinder::Load ( ElementPtr  _sdf)

Load the cylinder 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]_sdfThe 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.

◆ Radius()

double sdf::v12::Cylinder::Radius ( ) const

Get the cylinder's radius in meters.

Returns
The radius of the cylinder in meters.

◆ SetLength()

void sdf::v12::Cylinder::SetLength ( const double  _length)

Set the cylinder's length in meters.

Parameters
[in]_lengthThe length of the cylinder in meters.

◆ SetRadius()

void sdf::v12::Cylinder::SetRadius ( const double  _radius)

Set the cylinder's radius in meters.

Parameters
[in]_radiusThe radius of the cylinder in meters.

◆ Shape() [1/2]

ignition::math::Cylinderd& sdf::v12::Cylinder::Shape ( )

Get a mutable Ignition Math representation of this Cylinder.

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

◆ Shape() [2/2]

const ignition::math::Cylinderd& sdf::v12::Cylinder::Shape ( ) const

Get the Ignition Math representation of this Cylinder.

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

◆ ToElement()

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

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

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

Returns
SDF element pointer with updated cylinder values.

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