Gazebo Physics

API Reference

5.3.2
Gravity::Implementation< PolicyT > Class Template Referenceabstract

The implementation API for the gravity. More...

#include <World.hh>

Public Types

using LinearVectorType = typename FromPolicy< PolicyT >::template Use< LinearVector >
 

Public Member Functions

virtual LinearVectorType GetWorldGravity (const Identity &_id) const =0
 Implementation API for getting the gravity expressed in the world frame. More...
 
virtual void SetWorldGravity (const Identity &_id, const LinearVectorType &_gravity)=0
 Implementation API for setting the gravity vector, which is expressed in the World frame.. More...
 
- Public Member Functions inherited from Feature::Implementation< PolicyT >
virtual ~Implementation ()=default
 Virtual destructor. More...
 
virtual Identity InitiateEngine (std::size_t engineID=0)=0
 Tell the physics plugin to initiate a physics engine. More...
 

Detailed Description

template<typename PolicyT>
class ignition::physics::Gravity::Implementation< PolicyT >

The implementation API for the gravity.

Member Typedef Documentation

◆ LinearVectorType

using LinearVectorType = typename FromPolicy<PolicyT>::template Use<LinearVector>

Member Function Documentation

◆ GetWorldGravity()

virtual LinearVectorType GetWorldGravity ( const Identity &  _id) const
pure virtual

Implementation API for getting the gravity expressed in the world frame.

Parameters
[in]_idIdentity of the world.
Returns
Value of gravity.

◆ SetWorldGravity()

virtual void SetWorldGravity ( const Identity &  _id,
const LinearVectorType _gravity 
)
pure virtual

Implementation API for setting the gravity vector, which is expressed in the World frame..

Parameters
[in]_idIdentity of the world.
[in]_gravityValue of gravity.

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