Public Member Functions | List of all members
sdf::v9::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...
 
 Cylinder (const Cylinder &_cylinder)
 Copy constructor. More...
 
 Cylinder (Cylinder &&_cylinder) noexcept
 Move constructor. More...
 
virtual ~Cylinder ()
 Destructor. 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...
 
Cylinderoperator= (Cylinder &&_cylinder)
 Move assignment operator. More...
 
Cylinderoperator= (const Cylinder &_cylinder)
 Assignment operator. 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...
 
const ignition::math::Cylinderd & Shape () const
 Get the Ignition Math representation of this Cylinder. More...
 
ignition::math::Cylinderd & Shape ()
 Get a mutable Ignition Math representation of this Cylinder. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ Cylinder() [1/3]

sdf::v9::Cylinder::Cylinder ( )

Constructor.

◆ Cylinder() [2/3]

sdf::v9::Cylinder::Cylinder ( const Cylinder _cylinder)

Copy constructor.

Parameters
[in]_cylinderCylinder to copy.

◆ Cylinder() [3/3]

sdf::v9::Cylinder::Cylinder ( Cylinder &&  _cylinder)
noexcept

Move constructor.

Parameters
[in]_cylinderCylinder to move.

◆ ~Cylinder()

virtual sdf::v9::Cylinder::~Cylinder ( )
virtual

Destructor.

Member Function Documentation

◆ Element()

sdf::ElementPtr sdf::v9::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::v9::Cylinder::Length ( ) const

Get the cylinder's length in meters.

Returns
The length of the cylinder in meters.

◆ Load()

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

◆ operator=() [1/2]

Cylinder& sdf::v9::Cylinder::operator= ( Cylinder &&  _cylinder)

Move assignment operator.

Parameters
[in]_cylinderCylinder to move.
Returns
Reference to this.

◆ operator=() [2/2]

Cylinder& sdf::v9::Cylinder::operator= ( const Cylinder _cylinder)

Assignment operator.

Parameters
[in]_cylinderThe cylinder to set values from.
Returns
*this

◆ Radius()

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

Get the cylinder's radius in meters.

Returns
The radius of the cylinder in meters.

◆ SetLength()

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

Set the cylinder's length in meters.

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

◆ SetRadius()

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

Set the cylinder's radius in meters.

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

◆ Shape() [1/2]

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

Get the Ignition Math representation of this Cylinder.

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

◆ Shape() [2/2]

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

Get a mutable Ignition Math representation of this Cylinder.

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

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