ignition::gazebo::events Namespace Reference
Namespace for all events. Refer to the EventManager class for more information about events. More...
Typedefs | |
using | LoadPlugins = common::EventT< void(Entity, sdf::ElementPtr), struct LoadPluginsTag > |
Event used to load plugins for an entity into simulation. Pass in the entity which will own the plugins, and an SDF element for the entity, which may contain multiple <plugin> tags. More... | |
using | Pause = ignition::common::EventT< void(bool), struct PauseTag > |
The pause event can be used to pause or unpause simulation. Emit a value of true to pause simulation, and emit a value of false to unpause simulation. More... | |
using | Stop = ignition::common::EventT< void(void), struct StopTag > |
The stop event can be used to terminate simulation. Emit this signal to terminate an active simulation. More... | |
Detailed Description
Namespace for all events. Refer to the EventManager class for more information about events.
Typedef Documentation
◆ LoadPlugins
using LoadPlugins = common::EventT<void(Entity, sdf::ElementPtr), struct LoadPluginsTag> |
Event used to load plugins for an entity into simulation. Pass in the entity which will own the plugins, and an SDF element for the entity, which may contain multiple <plugin> tags.
◆ Pause
using Pause = ignition::common::EventT<void(bool), struct PauseTag> |
The pause event can be used to pause or unpause simulation. Emit a value of true to pause simulation, and emit a value of false to unpause simulation.
For example, to pause simulation use:
eventManager.Emit<events::Pause>(true);
◆ Stop
using Stop = ignition::common::EventT<void(void), struct StopTag> |
The stop event can be used to terminate simulation. Emit this signal to terminate an active simulation.
For example:
eventManager.Emit<events::Stop>();