Gazebo Physics

API Reference

9.4.0
GravityEnabled::Implementation< PolicyT > Class Template Referenceabstract

The implementation API for gravity mode. More...

#include <Gravity.hh>

Public Member Functions

virtual bool GetLinkGravityEnabled (const Identity &_id) const =0
 Implementation API for getting the link gravity mode.
 
virtual bool GetModelGravityEnabled (const Identity &_id) const =0
 Implementation API for getting the model gravity mode.
 
virtual void SetLinkGravityEnabled (const Identity &_id, bool _enabled)=0
 Implementation API for setting the link gravity mode.
 
virtual void SetModelGravityEnabled (const Identity &_id, bool _enabled)=0
 Implementation API for setting the model gravity mode.
 
- Public Member Functions inherited from Feature::Implementation< PolicyT >
virtual ~Implementation ()=default
 Virtual destructor.
 
virtual Identity InitiateEngine (std::size_t engineID=0)=0
 Tell the physics plugin to initiate a physics engine.
 

Detailed Description

template<typename PolicyT>
class gz::physics::GravityEnabled::Implementation< PolicyT >

The implementation API for gravity mode.

Member Function Documentation

◆ GetLinkGravityEnabled()

template<typename PolicyT >
virtual bool GetLinkGravityEnabled ( const Identity &  _id) const
pure virtual

Implementation API for getting the link gravity mode.

Parameters
[in]_idIdentity of the link.
Returns
True if gravity is enabled.

◆ GetModelGravityEnabled()

template<typename PolicyT >
virtual bool GetModelGravityEnabled ( const Identity &  _id) const
pure virtual

Implementation API for getting the model gravity mode.

Parameters
[in]_idIdentity of the model.
Returns
True if gravity is enabled.

◆ SetLinkGravityEnabled()

template<typename PolicyT >
virtual void SetLinkGravityEnabled ( const Identity &  _id,
bool  _enabled 
)
pure virtual

Implementation API for setting the link gravity mode.

Parameters
[in]_idIdentity of the link.
[in]_enabledTrue to enable gravity.

◆ SetModelGravityEnabled()

template<typename PolicyT >
virtual void SetModelGravityEnabled ( const Identity &  _id,
bool  _enabled 
)
pure virtual

Implementation API for setting the model gravity mode.

Parameters
[in]_idIdentity of the model.
[in]_enabledTrue to enable gravity.

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