Public Member Functions | List of all members
sdf::SDF_VERSION_NAMESPACE::Box Class Reference

Box represents a box shape, and is usually accessed through a Geometry. More...

#include <Box.hh>

Public Member Functions

 Box ()
 Constructor. More...
 
std::optional< gz::math::Inertiald > CalculateInertial (double _density)
 Calculate and return the Inertial values for the Box. More...
 
sdf::ElementPtr Element () const
 Get a pointer to the SDF element that was used during load. More...
 
Errors Load (ElementPtr _sdf)
 Load the box geometry based on a element pointer. More...
 
void SetSize (const gz::math::Vector3d &_size)
 Set the box size in meters. More...
 
gz::math::Boxd & Shape ()
 Get a mutable Gazebo Math representation of this Box. More...
 
const gz::math::Boxd & Shape () const
 Get the Gazebo Math representation of this Box. More...
 
gz::math::Vector3d Size () const
 Get the box size in meters. More...
 
sdf::ElementPtr ToElement () const
 Create and return an SDF element filled with data from this box. More...
 
sdf::ElementPtr ToElement (sdf::Errors &_errors) const
 Create and return an SDF element filled with data from this box. More...
 

Detailed Description

Box represents a box shape, and is usually accessed through a Geometry.

Constructor & Destructor Documentation

◆ Box()

sdf::SDF_VERSION_NAMESPACE::Box::Box ( )

Constructor.

Member Function Documentation

◆ CalculateInertial()

std::optional<gz::math::Inertiald> sdf::SDF_VERSION_NAMESPACE::Box::CalculateInertial ( double  _density)

Calculate and return the Inertial values for the Box.

In order to calculate the inertial properties, the function mutates the object by updating its material properties.

Parameters
[in]_densityDensity of the box in kg/m^3
Returns
A std::optional with gz::math::Inertiald object or std::nullopt

◆ Element()

sdf::ElementPtr sdf::SDF_VERSION_NAMESPACE::Box::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.

◆ Load()

Errors sdf::SDF_VERSION_NAMESPACE::Box::Load ( ElementPtr  _sdf)

Load the box 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.

◆ SetSize()

void sdf::SDF_VERSION_NAMESPACE::Box::SetSize ( const gz::math::Vector3d &  _size)

Set the box size in meters.

Parameters
[in]_sizeSize of the box in meters.

◆ Shape() [1/2]

gz::math::Boxd& sdf::SDF_VERSION_NAMESPACE::Box::Shape ( )

Get a mutable Gazebo Math representation of this Box.

Returns
A reference to a gz::math::Boxd object.

◆ Shape() [2/2]

const gz::math::Boxd& sdf::SDF_VERSION_NAMESPACE::Box::Shape ( ) const

Get the Gazebo Math representation of this Box.

Returns
A const reference to a gz::math::Boxd object.

◆ Size()

gz::math::Vector3d sdf::SDF_VERSION_NAMESPACE::Box::Size ( ) const

Get the box size in meters.

Returns
Size of the box in meters.

◆ ToElement() [1/2]

sdf::ElementPtr sdf::SDF_VERSION_NAMESPACE::Box::ToElement ( ) const

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

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

Returns
SDF element pointer with updated box values.

◆ ToElement() [2/2]

sdf::ElementPtr sdf::SDF_VERSION_NAMESPACE::Box::ToElement ( sdf::Errors _errors) const

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

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

Parameters
[out]_errorsVector of errors.
Returns
SDF element pointer with updated box values.

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