Gazebo Gazebo

API Reference

6.16.0
Physics Class Reference

Base class for a System. Includes optional parameter : <include_entity_names>. When set to false, the name of colliding entities is not populated in the contacts. Remains true by default. Usage : More...

#include <ignition/gazebo/systems/Physics.hh>

Public Member Functions

 Physics ()
 Constructor. More...
 
 ~Physics () override
 Destructor. More...
 
void Configure (const Entity &_entity, const std::shared_ptr< const sdf::Element > &_sdf, EntityComponentManager &_ecm, EventManager &_eventMgr) final
 Configure the system. More...
 
void Update (const UpdateInfo &_info, EntityComponentManager &_ecm) final
 Documentation inherited. More...
 
- Public Member Functions inherited from System
 System ()=default
 Constructor. More...
 
virtual ~System ()=default
 Destructor. More...
 

Detailed Description

Base class for a System. Includes optional parameter : <include_entity_names>. When set to false, the name of colliding entities is not populated in the contacts. Remains true by default. Usage :

<plugin
filename="ignition-gazebo-physics-system"
name="ignition::gazebo::systems::Physics">
<contacts>
<include_entity_names>false</include_entity_names>
</contacts>
</plugin>

Constructor & Destructor Documentation

◆ Physics()

Physics ( )
explicit

Constructor.

◆ ~Physics()

~Physics ( )
override

Destructor.

Member Function Documentation

◆ Configure()

void Configure ( const Entity _entity,
const std::shared_ptr< const sdf::Element > &  _sdf,
EntityComponentManager _ecm,
EventManager _eventMgr 
)
finalvirtual

Configure the system.

Parameters
[in]_entityThe entity this plugin is attached to.
[in]_sdfThe SDF Element associated with this system plugin.
[in]_ecmThe EntityComponentManager of the given simulation instance.
[in]_eventMgrThe EventManager of the given simulation instance.

Implements ISystemConfigure.

◆ Update()

void Update ( const UpdateInfo _info,
EntityComponentManager _ecm 
)
finalvirtual

Documentation inherited.

Implements ISystemUpdate.


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