sdf::v11::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...

Load the cylinder geometry based on a element pointer. More...

Get the cylinder's radius in meters. More...

void SetLength (const double _length)
Set the cylinder's length in meters. More...

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.

## ◆ Cylinder()

 sdf::v11::Cylinder::Cylinder ( )

Constructor.

## ◆ Element()

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

Get the cylinder's length in meters.

Returns
The length of the cylinder in meters.

 Errors sdf::v11::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] _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.

Get the cylinder's radius in meters.

Returns
The radius of the cylinder in meters.

## ◆ SetLength()

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

Set the cylinder's length in meters.

Parameters
 [in] _length The length of the cylinder in meters.

Set the cylinder's radius in meters.

Parameters

## ◆ Shape() [1/2]

 const ignition::math::Cylinderd& sdf::v11::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::v11::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: