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

◆ 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.
◆ Length()
double sdf::v12::Cylinder::Length 
( 
 ) 
const 
Get the cylinder's length in meters.
 Returns
 The length of the cylinder in meters.
◆ Load()
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

 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]  _length  The length of the cylinder in meters. 
◆ SetRadius()
void sdf::v12::Cylinder::SetRadius 
( 
const double 
_radius  ) 

Set the cylinder's radius in meters.
 Parameters

[in]  _radius  The 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::Cylinderd object.
◆ ToElement()
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: