##

Events Class Reference
Events

An Event class to get notifications for simulator events. More...

`#include <common/common.hh>`

## Static Public Member Functions

template<typename T >
static ConnectionPtr | ConnectAddEntity (T _subscriber)
| Connect a callback to the add entity signal. More...
template<typename T >
static ConnectionPtr | ConnectBeforePhysicsUpdate (T _subscriber)
| Connect a callback to the before physics update signal. More...
template<typename T >
static ConnectionPtr | ConnectCreateEntity (T _subscriber)
| Connect a callback to the add entity signal. More...
template<typename T >
static ConnectionPtr | ConnectCreateSensor (T _subscriber)
| Connect to the create sensor signal. More...
template<typename T >
static ConnectionPtr | ConnectDeleteEntity (T _subscriber)
| Connect a callback to the delete entity signal. More...
template<typename T >
static ConnectionPtr | ConnectDiagTimerStart (T _subscriber)
| Connect a callback to the diagnostic timer start signal. More...
template<typename T >
static ConnectionPtr | ConnectDiagTimerStop (T _subscriber)
| Connect a callback to the diagnostic timer stop signal. More...
template<typename T >
static ConnectionPtr | ConnectPause (T _subscriber)
| Connect a callback to the pause signal. More...
template<typename T >
static ConnectionPtr | ConnectPostRender (T _subscriber)
| Connect a callback to the post render update signal. More...
template<typename T >
static ConnectionPtr | ConnectPreRender (T _subscriber)
| Render start signal. More...
template<typename T >
static ConnectionPtr | ConnectRemoveSensor (T _subscriber)
| Connect to the remove sensor signal. More...
template<typename T >
static ConnectionPtr | ConnectRender (T _subscriber)
| Connect a callback to the render update signal. More...
template<typename T >
static ConnectionPtr | ConnectSetSelectedEntity (T _subscriber)
| Connect a callback to the set selected entity signal. More...
template<typename T >
static ConnectionPtr | ConnectSigInt (T _subscriber)
| Connect a callback to the sigint event. More...
template<typename T >
static ConnectionPtr | ConnectStep (T _subscriber)
| Connect a callback to the step signal. More...
template<typename T >
static ConnectionPtr | ConnectStop (T _subscriber)
| Connect a callback to the stop signal. More...
template<typename T >
static ConnectionPtr | ConnectTimeReset (T _subscriber)
| Connect to the time reset signal. More...
template<typename T >
static ConnectionPtr | ConnectWorldCreated (T _subscriber)
| Connect a callback to the world created signal. More...
template<typename T >
static ConnectionPtr | ConnectWorldReset (T _subscriber)
| Connect to the world reset signal. More...
template<typename T >
static ConnectionPtr | ConnectWorldUpdateBegin (T _subscriber)
| Connect a callback to the world update start signal. More...
template<typename T >
static ConnectionPtr | ConnectWorldUpdateEnd (T _subscriber)
| Connect a callback to the world update end signal. More...

## Static Public Attributes

static EventT< void(std::string)> | addEntity
| An entity has been added. More...
static EventT< void(const common::UpdateInfo &)> | beforePhysicsUpdate
| Collision detection has been done, physics update not yet. More...
static EventT< void(sdf::ElementPtr, const std::string &, const std::string &, const uint32_t)> | createSensor
| Create a sensor. More...
static EventT< void(std::string)> | deleteEntity
| An entity has been deleted. More...
static EventT< void(std::string)> | diagTimerStart
| Diagnostic timer start. More...
static EventT< void(std::string)> | diagTimerStop
| Diagnostic timer stop. More...
static EventT< void(std::string)> | entityCreated
| An entity has been created. More...
static EventT< void(bool)> | pause
| Pause signal. More...
static EventT< void()> | postRender
| Post-Render. More...
static EventT< void()> | preRender
| Pre-render. More...
static EventT< void(std::string)> | removeSensor
| Remove a sensor. More...
static EventT< void()> | render
| Render. More...
static EventT< void(std::string, std::string)> | setSelectedEntity
| An entity has been selected. More...
static EventT< void()> | sigInt
| Simulation SIGINT/SIGTERM signal. More...
static EventT< void()> | step
| Step the simulation once signal. More...
static EventT< void()> | stop
| Simulation stop signal. More...
static EventT< void()> | timeReset
| Time reset signal. More...
static EventT< void(std::string)> | worldCreated
| A world has been created. More...
static EventT< void()> | worldReset
| World reset signal. More...
static EventT< void(const common::UpdateInfo &)> | worldUpdateBegin
| World update has started. More...
static EventT< void()> | worldUpdateEnd
| World update has ended. More...

## Detailed Description

An Event class to get notifications for simulator events.

## Member Function Documentation

## ConnectAddEntity()

static ConnectionPtr ConnectAddEntity | ( | T | _subscriber | ) |

inline static

Connect a callback to the add entity signal.

Parameters

  [in] | _subscriber | the subscriber to this event

Returns
  a connection

References Events::addEntity, and EventT< T >::Connect().

## ConnectBeforePhysicsUpdate()

static ConnectionPtr ConnectBeforePhysicsUpdate | ( | T | _subscriber | ) |

inline static

Connect a callback to the before physics update signal.

Parameters

  [in] | _subscriber | the subscriber to this event

Returns
  a connection

The signal is called after collision detection has finished and before the physics update step. So you can e.g. change some forces depending on the collisions that have occured.

References Events::beforePhysicsUpdate.

## ConnectCreateEntity()

static ConnectionPtr ConnectCreateEntity | ( | T | _subscriber | ) |

inline static

Connect a callback to the add entity signal.

Parameters

  [in] | _subscriber | the subscriber to this event

Returns
  a connection

References EventT< T >::Connect(), and Events::entityCreated.

## ConnectCreateSensor()

static ConnectionPtr ConnectCreateSensor | ( | T | _subscriber | ) |

inline static

Connect to the create sensor signal.

Parameters

  [in] | _subscriber | the subscriber to this event

Returns
  a connection

References EventT< T >::Connect(), and Events::createSensor.

## ConnectDeleteEntity()

static ConnectionPtr ConnectDeleteEntity | ( | T | _subscriber | ) |

inline static

Connect a callback to the delete entity signal.

Parameters

  [in] | _subscriber | the subscriber to this event

Returns
  a connection

References EventT< T >::Connect(), and Events::deleteEntity.

## ConnectDiagTimerStart()

static ConnectionPtr ConnectDiagTimerStart | ( | T | _subscriber | ) |

inline static

Connect a callback to the diagnostic timer start signal.

Parameters

  [in] | _subscriber | the subscriber to this event

Returns
  a connection

References EventT< T >::Connect(), and Events::diagTimerStart.

## ConnectDiagTimerStop()

static ConnectionPtr ConnectDiagTimerStop | ( | T | _subscriber | ) |

inline static

Connect a callback to the diagnostic timer stop signal.

Parameters

  [in] | _subscriber | the subscriber to this event

Returns
  a connection

References EventT< T >::Connect(), and Events::diagTimerStop.

## ConnectPause()

static ConnectionPtr ConnectPause | ( | T | _subscriber | ) |

inline static

Connect a callback to the pause signal.

Parameters

  [in] | _subscriber | the subscriber to this event

Returns
  a connection

References EventT< T >::Connect(), and Events::pause.

## ConnectPostRender()

static ConnectionPtr ConnectPostRender | ( | T | _subscriber | ) |

inline static

Connect a callback to the post render update signal.

Parameters

  [in] | _subscriber | the subscriber to this event

Returns
  a connection

References EventT< T >::Connect(), and Events::postRender.

## ConnectPreRender()

static ConnectionPtr ConnectPreRender | ( | T | _subscriber | ) |

inline static

Render start signal.

Parameters

  [in] | _subscriber | the subscriber to this event

Returns
  a connection

References EventT< T >::Connect(), and Events::preRender.

## ConnectRemoveSensor()

static ConnectionPtr ConnectRemoveSensor | ( | T | _subscriber | ) |

inline static

Connect to the remove sensor signal.

Parameters

  [in] | _subscriber | the subscriber to this event

Returns
  a connection

References EventT< T >::Connect(), and Events::removeSensor.

## ConnectRender()

static ConnectionPtr ConnectRender | ( | T | _subscriber | ) |

inline static

Connect a callback to the render update signal.

Parameters

  [in] | _subscriber | the subscriber to this event

Returns
  a connection

References EventT< T >::Connect(), and Events::render.

## ConnectSetSelectedEntity()

static ConnectionPtr ConnectSetSelectedEntity | ( | T | _subscriber | ) |

inline static

Connect a callback to the set selected entity signal.

Parameters

  [in] | _subscriber | the subscriber to this event

Returns
  a connection

References EventT< T >::Connect(), and Events::setSelectedEntity.

## ConnectSigInt()

static ConnectionPtr ConnectSigInt | ( | T | _subscriber | ) |

inline static

Connect a callback to the sigint event.

Parameters

  [in] | _subscriber | the subscriber to this event

Returns
  a connection

References EventT< T >::Connect(), and Events::sigInt.

## ConnectStep()

static ConnectionPtr ConnectStep | ( | T | _subscriber | ) |

inline static

Connect a callback to the step signal.

Parameters

  [in] | _subscriber | the subscriber to this event

Returns
  a connection

References EventT< T >::Connect(), and Events::step.

## ConnectStop()

static ConnectionPtr ConnectStop | ( | T | _subscriber | ) |

inline static

Connect a callback to the stop signal.

Parameters

  [in] | _subscriber | the subscriber to this event

Returns
  a connection

References EventT< T >::Connect(), and Events::stop.

## ConnectTimeReset()

static ConnectionPtr ConnectTimeReset | ( | T | _subscriber | ) |

inline static

Connect to the time reset signal.

Parameters

  [in] | _subscriber | the subscriber to this event

Returns
  a connection

References EventT< T >::Connect(), and Events::timeReset.

## ConnectWorldCreated()

static ConnectionPtr ConnectWorldCreated | ( | T | _subscriber | ) |

inline static

Connect a callback to the world created signal.

Parameters

  [in] | _subscriber | the subscriber to this event

Returns
  a connection

References EventT< T >::Connect(), and Events::worldCreated.

## ConnectWorldReset()

static ConnectionPtr ConnectWorldReset | ( | T | _subscriber | ) |

inline static

Connect to the world reset signal.

Parameters

  [in] | _subscriber | the subscriber to this event

Returns
  a connection

References EventT< T >::Connect(), and Events::worldReset.

## ConnectWorldUpdateBegin()

static ConnectionPtr ConnectWorldUpdateBegin | ( | T | _subscriber | ) |

inline static

Connect a callback to the world update start signal.

Parameters

  [in] | _subscriber | the subscriber to this event

Returns
  a connection

References Events::worldUpdateBegin.

## ConnectWorldUpdateEnd()

static ConnectionPtr ConnectWorldUpdateEnd | ( | T | _subscriber | ) |

inline static

Connect a callback to the world update end signal.

Parameters

  [in] | _subscriber | the subscriber to this event

Returns
  a connection

References EventT< T >::Connect(), and Events::worldUpdateEnd.

## Member Data Documentation

## addEntity

EventT<void (std::string)> addEntity

static

An entity has been added.

Referenced by Events::ConnectAddEntity().

## beforePhysicsUpdate

EventT<void (const common::UpdateInfo &)> beforePhysicsUpdate

static

Collision detection has been done, physics update not yet.

Referenced by Events::ConnectBeforePhysicsUpdate().

## createSensor

EventT<void (sdf::ElementPtr, const std::string &, const std::string &, const uint32_t)> createSensor

static

Create a sensor.

- Parameter 1 (sdf::ElementPtr): The SDF element that describes the sensor.
- Parameter 2 (std::string): Name of the world in which to create the sensor.
- Parameter 3 (std::string): The scoped parent name (model::link).
- Parameter 4 (uint32_t): ID of the sensor

Referenced by Events::ConnectCreateSensor().

## deleteEntity

EventT<void (std::string)> deleteEntity

static

An entity has been deleted.

Referenced by Events::ConnectDeleteEntity().

## diagTimerStart

EventT<void (std::string)> diagTimerStart

static

Diagnostic timer start.

Referenced by Events::ConnectDiagTimerStart().

## diagTimerStop

EventT<void (std::string)> diagTimerStop

static

Diagnostic timer stop.

Referenced by Events::ConnectDiagTimerStop().

## entityCreated

EventT<void (std::string)> entityCreated

static

An entity has been created.

Referenced by Events::ConnectCreateEntity().

## pause

EventT<void (bool)> pause

static

Pause signal.

Referenced by Events::ConnectPause().

## postRender

EventT<void ()> postRender

static

Post-Render.

Referenced by Events::ConnectPostRender().

## preRender

EventT<void ()> preRender

static

Pre-render.

Referenced by Events::ConnectPreRender().

## removeSensor

EventT<void (std::string)> removeSensor

static

Remove a sensor.

- Parameter 1 (string): Name of the sensor to remove.

Referenced by Events::ConnectRemoveSensor().

## render

EventT<void ()> render

static

Render.

Referenced by Events::ConnectRender().

## setSelectedEntity

EventT<void (std::string, std::string)> setSelectedEntity

static

An entity has been selected.

Referenced by Events::ConnectSetSelectedEntity().

## sigInt

EventT<void ()> sigInt

static

Simulation SIGINT/SIGTERM signal.

Referenced by Events::ConnectSigInt().

## step

EventT<void ()> step

static

Step the simulation once signal.

Referenced by Events::ConnectStep().

## stop

EventT<void ()> stop

static

Simulation stop signal.

Referenced by Events::ConnectStop().

## timeReset

EventT<void ()> timeReset

static

Time reset signal.

Referenced by Events::ConnectTimeReset().

## worldCreated

EventT<void (std::string)> worldCreated

static

A world has been created.

Referenced by Events::ConnectWorldCreated().

## worldReset

EventT<void ()> worldReset

static

World reset signal.

Referenced by Events::ConnectWorldReset().

## worldUpdateBegin

EventT<void (const common::UpdateInfo &)> worldUpdateBegin

static

World update has started.

Referenced by Events::ConnectWorldUpdateBegin().

## worldUpdateEnd

EventT<void ()> worldUpdateEnd

static

World update has ended.

Referenced by Events::ConnectWorldUpdateEnd().

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

- Events.hh