Events Class Reference

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 stop 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

static ConnectionPtr ConnectAddEntity ( _subscriber)
inlinestatic

Connect a callback to the add entity signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

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

static ConnectionPtr ConnectBeforePhysicsUpdate ( _subscriber)
inlinestatic

Connect a callback to the before physics update signal.

Parameters
[in]_subscriberthe 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, and EventT< T >::Connect().

static ConnectionPtr ConnectCreateEntity ( _subscriber)
inlinestatic

Connect a callback to the add entity signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

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

static ConnectionPtr ConnectCreateSensor ( _subscriber)
inlinestatic

Connect to the create sensor signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

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

static ConnectionPtr ConnectDeleteEntity ( _subscriber)
inlinestatic

Connect a callback to the delete entity signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

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

static ConnectionPtr ConnectDiagTimerStart ( _subscriber)
inlinestatic

Connect a callback to the diagnostic timer start signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

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

static ConnectionPtr ConnectDiagTimerStop ( _subscriber)
inlinestatic

Connect a callback to the diagnostic timer stop signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

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

static ConnectionPtr ConnectPause ( _subscriber)
inlinestatic

Connect a callback to the pause signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

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

static ConnectionPtr ConnectPostRender ( _subscriber)
inlinestatic

Connect a callback to the post render update signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

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

static ConnectionPtr ConnectPreRender ( _subscriber)
inlinestatic

Render start signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

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

static ConnectionPtr ConnectRemoveSensor ( _subscriber)
inlinestatic

Connect to the remove sensor signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

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

static ConnectionPtr ConnectRender ( _subscriber)
inlinestatic

Connect a callback to the render update signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

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

static ConnectionPtr ConnectSetSelectedEntity ( _subscriber)
inlinestatic

Connect a callback to the set selected entity signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

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

static ConnectionPtr ConnectSigInt ( _subscriber)
inlinestatic

Connect a callback to the sigint event.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

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

static ConnectionPtr ConnectStep ( _subscriber)
inlinestatic

Connect a callback to the step signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

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

static ConnectionPtr ConnectStop ( _subscriber)
inlinestatic

Connect a callback to the stop signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

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

static ConnectionPtr ConnectTimeReset ( _subscriber)
inlinestatic

Connect to the time reset signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

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

static ConnectionPtr ConnectWorldCreated ( _subscriber)
inlinestatic

Connect a callback to the world created signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

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

static ConnectionPtr ConnectWorldReset ( _subscriber)
inlinestatic

Connect to the world reset signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

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

static ConnectionPtr ConnectWorldUpdateBegin ( _subscriber)
inlinestatic

Connect a callback to the world update start signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

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

static ConnectionPtr ConnectWorldUpdateEnd ( _subscriber)
inlinestatic

Connect a callback to the world update end signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

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

Member Data Documentation

EventT<void (std::string)> addEntity
static

An entity has been added.

Referenced by Events::ConnectAddEntity().

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

Collision detection has been done, physics update not yet.

Referenced by Events::ConnectBeforePhysicsUpdate().

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().

EventT<void (std::string)> deleteEntity
static

An entity has been deleted.

Referenced by Events::ConnectDeleteEntity().

EventT<void (std::string)> diagTimerStart
static

Diagnostic timer start.

Referenced by Events::ConnectDiagTimerStart().

EventT<void (std::string)> diagTimerStop
static

Diagnostic timer stop.

Referenced by Events::ConnectDiagTimerStop().

EventT<void (std::string)> entityCreated
static

An entity has been created.

Referenced by Events::ConnectCreateEntity().

EventT<void (bool)> pause
static

Pause signal.

Referenced by Events::ConnectPause().

EventT<void ()> postRender
static

Post-Render.

Referenced by Events::ConnectPostRender().

EventT<void ()> preRender
static

Pre-render.

Referenced by Events::ConnectPreRender().

EventT<void (std::string)> removeSensor
static

Remove a sensor.

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

Referenced by Events::ConnectRemoveSensor().

EventT<void ()> render
static

Render.

Referenced by Events::ConnectRender().

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

An entity has been selected.

Referenced by Events::ConnectSetSelectedEntity().

EventT<void ()> sigInt
static

Simulation stop signal.

Referenced by Events::ConnectSigInt().

EventT<void ()> step
static

Step the simulation once signal.

Referenced by Events::ConnectStep().

EventT<void ()> stop
static

Simulation stop signal.

Referenced by Events::ConnectStop().

EventT<void ()> timeReset
static

Time reset signal.

Referenced by Events::ConnectTimeReset().

EventT<void (std::string)> worldCreated
static

A world has been created.

Referenced by Events::ConnectWorldCreated().

EventT<void ()> worldReset
static

World reset signal.

Referenced by Events::ConnectWorldReset().

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

World update has started.

Referenced by Events::ConnectWorldUpdateBegin().

EventT<void ()> worldUpdateEnd
static

World update has ended.

Referenced by Events::ConnectWorldUpdateEnd().


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