Events

Namespaces

 gazebo::event
 Event namespace.
 

Classes

class  Connection
 A class that encapsulates a connection. More...
 
class  Event
 Base class for all events. More...
 
class  Events
 An Event class to get notifications for simulator events. More...
 
class  EventT< T >
 A class for event processing. More...
 

Functions

 EventT ()
 Constructor. More...
 
virtual ~EventT ()
 Destructor. More...
 
ConnectionPtr Connect (const std::function< T > &_subscriber)
 Connect a callback to this event. More...
 
unsigned int ConnectionCount () const
 Get the number of connections. More...
 
virtual void Disconnect (ConnectionPtr _c) GAZEBO_DEPRECATED(8.0)
 Disconnect a callback to this event. More...
 
virtual void Disconnect (int _id)
 Disconnect a callback to this event. More...
 

Detailed Description

Function Documentation

EventT ( )

Constructor.

~EventT ( )
virtual

Destructor.

Destructor. Deletes all the associated connections.

ConnectionPtr Connect ( const std::function< T > &  _subscriber)

Connect a callback to this event.

Adds a connection.

Parameters
[in]_subscriberPointer to a callback function.
Returns
A Connection object, which will automatically call Disconnect when it goes out of scope.
Parameters
[in]_subscriberthe subscriber to connect.

Referenced by Events::ConnectAddBuildingLevel(), Events::ConnectAddEntity(), Events::ConnectAlignMode(), Events::ConnectBeforePhysicsUpdate(), Events::ConnectBuildingNameChanged(), Events::ConnectChangeBuildingEditorZoom(), Events::ConnectChangeBuildingLevel(), Events::ConnectColorSelected(), Events::ConnectCreateBuildingEditorItem(), Events::ConnectCreateEntity(), Events::ConnectCreateScene(), Events::ConnectCreateSensor(), Events::ConnectDeleteBuildingLevel(), Events::ConnectDeleteEntity(), Events::ConnectDiagTimerStart(), Events::ConnectDiagTimerStop(), Events::ConnectEditModel(), Events::ConnectExitBuildingEditor(), Events::ConnectExitModelEditor(), Events::ConnectFinishBuildingModel(), Events::ConnectFinishModel(), Events::ConnectFollow(), Events::ConnectFPS(), Events::ConnectFullScreen(), Events::ConnectInputStepSize(), Events::ConnectJointChanged(), Events::ConnectJointInserted(), Events::ConnectJointNameChanged(), Events::ConnectJointRemoved(), Joint::ConnectJointUpdate(), Events::ConnectKeyPress(), Events::ConnectLeftPaneVisibility(), Events::ConnectLightUpdate(), Events::ConnectLinkInserted(), Events::ConnectLinkRemoved(), Events::ConnectMainWindowReady(), Events::ConnectManipMode(), Events::ConnectModelChanged(), Events::ConnectModelNameChanged(), Events::ConnectModelPluginInserted(), Events::ConnectModelPluginRemoved(), Events::ConnectModelPropertiesChanged(), Events::ConnectModelUpdate(), Events::ConnectMoveEntity(), Events::ConnectMoveMode(), Events::ConnectNestedModelInserted(), Events::ConnectNestedModelRemoved(), Events::ConnectNewBuildingEditor(), Events::ConnectNewBuildingModel(), MultiRayShape::ConnectNewLaserScans(), Events::ConnectNewLayer(), Events::ConnectNewModel(), Events::ConnectNewModelEditor(), Events::ConnectOpenJointInspector(), Events::ConnectOpenLinkInspector(), Events::ConnectOpenModelPluginInspector(), Events::ConnectOrbit(), Events::ConnectPause(), Events::ConnectPostRender(), Events::ConnectPreRender(), Events::ConnectRemoveScene(), Events::ConnectRemoveSensor(), Events::ConnectRender(), Events::ConnectRequestJointInsertion(), Events::ConnectRequestJointRemoval(), Events::ConnectRequestLinkInsertion(), Events::ConnectRequestLinkMove(), Events::ConnectRequestLinkRemoval(), Events::ConnectRequestModelPluginInsertion(), Events::ConnectRequestModelPluginRemoval(), Events::ConnectRequestNestedModelInsertion(), Events::ConnectRequestNestedModelMove(), Events::ConnectRequestNestedModelRemoval(), Events::ConnectSaveAsBuildingEditor(), Events::ConnectSaveAsModelEditor(), Events::ConnectSaveBuildingEditor(), Events::ConnectSaveBuildingModel(), Events::ConnectSaveModel(), Events::ConnectSaveModelEditor(), Events::ConnectScaleEntity(), Events::ConnectSetSelectedEntity(), Events::ConnectSetSelectedJoint(), Events::ConnectSetSelectedModelPlugin(), Events::ConnectShowElements(), Events::ConnectShowFloorplan(), Events::ConnectShowJointContextMenu(), Events::ConnectShowLinkContextMenu(), Events::ConnectShowModelPluginContextMenu(), Events::ConnectShowToolbars(), Events::ConnectSigInt(), Events::ConnectStep(), Events::ConnectStop(), Events::ConnectTextureSelected(), Events::ConnectTimeReset(), Events::ConnectToggleEditMode(), Events::ConnectToggleLayer(), Events::ConnectTriggerShowElements(), Events::ConnectTriggerShowFloorplan(), Events::ConnectUpdateLevelWidget(), Events::ConnectWindowMode(), Events::ConnectWorldCreated(), Events::ConnectWorldReset(), Events::ConnectWorldUpdateBegin(), and Events::ConnectWorldUpdateEnd().

unsigned int ConnectionCount ( ) const

Get the number of connections.

Returns
Number of connection to this Event.
Number of connections.
void Disconnect ( ConnectionPtr  _c)
virtual

Disconnect a callback to this event.

Removes a connection.

Parameters
[in]_cThe connection to disconnect.
Deprecated:
Use event::~Connection to disconnect
Parameters
[in]_cthe connection.

Implements Event.

Referenced by Events::DisconnectAddBuildingLevel(), Events::DisconnectAddEntity(), Events::DisconnectAlignMode(), Events::DisconnectBeforePhysicsUpdate(), Events::DisconnectBuildingNameChanged(), Events::DisconnectChangeBuildingEditorZoom(), Events::DisconnectChangeBuildingLevel(), Events::DisconnectColorSelected(), Events::DisconnectCreateBuildingEditorItem(), Events::DisconnectCreateEntity(), Events::DisconnectCreateScene(), Events::DisconnectCreateSensor(), Events::DisconnectDeleteBuildingLevel(), Events::DisconnectDeleteEntity(), Events::DisconnectDiagTimerStart(), Events::DisconnectDiagTimerStop(), Events::DisconnectEditModel(), Events::DisconnectExitBuildingEditor(), Events::DisconnectExitModelEditor(), Events::DisconnectFinishBuildingModel(), Events::DisconnectFinishModel(), Events::DisconnectFollow(), Events::DisconnectFPS(), Events::DisconnectFullScreen(), Events::DisconnectInputStepSize(), Events::DisconnectJointChanged(), Events::DisconnectJointInserted(), Events::DisconnectJointNameChanged(), Events::DisconnectJointRemoved(), Joint::DisconnectJointUpdate(), Events::DisconnectKeyPress(), Events::DisconnectLeftPaneVisibility(), Events::DisconnectLightUpdate(), Events::DisconnectLinkInserted(), Events::DisconnectLinkRemoved(), Events::DisconnectMainWindowReady(), Events::DisconnectManipMode(), Events::DisconnectModelChanged(), Events::DisconnectModelNameChanged(), Events::DisconnectModelPluginInserted(), Events::DisconnectModelPluginRemoved(), Events::DisconnectModelPropertiesChanged(), Events::DisconnectModelUpdate(), Events::DisconnectMoveEntity(), Events::DisconnectMoveMode(), Events::DisconnectNestedModelInserted(), Events::DisconnectNestedModelRemoved(), Events::DisconnectNewBuildingEditor(), Events::DisconnectNewBuildingModel(), MultiRayShape::DisconnectNewLaserScans(), Events::DisconnectNewLayer(), Events::DisconnectNewModel(), Events::DisconnectNewModelEditor(), Events::DisconnectOpenJointInspector(), Events::DisconnectOpenLinkInspector(), Events::DisconnectOpenModelPluginInspector(), Events::DisconnectOrbit(), Events::DisconnectPause(), Events::DisconnectPostRender(), Events::DisconnectPreRender(), Events::DisconnectRemoveScene(), Events::DisconnectRemoveSensor(), Events::DisconnectRender(), Events::DisconnectRequestJointInsertion(), Events::DisconnectRequestJointRemoval(), Events::DisconnectRequestLinkInsertion(), Events::DisconnectRequestLinkMove(), Events::DisconnectRequestLinkRemoval(), Events::DisconnectRequestModelPluginInsertion(), Events::DisconnectRequestModelPluginRemoval(), Events::DisconnectRequestNestedModelInsertion(), Events::DisconnectRequestNestedModelMove(), Events::DisconnectRequestNestedModelRemoval(), Events::DisconnectSaveAsBuildingEditor(), Events::DisconnectSaveAsModelEditor(), Events::DisconnectSaveBuildingEditor(), Events::DisconnectSaveBuildingModel(), Events::DisconnectSaveModel(), Events::DisconnectSaveModelEditor(), Events::DisconnectScaleEntity(), Events::DisconnectSetSelectedEntity(), Events::DisconnectSetSelectedJoint(), Events::DisconnectSetSelectedModelPlugin(), Events::DisconnectShowElements(), Events::DisconnectShowFloorplan(), Events::DisconnectShowJointContextMenu(), Events::DisconnectShowLinkContextMenu(), Events::DisconnectShowModelPluginContextMenu(), Events::DisconnectShowToolbars(), Events::DisconnectSigInt(), Events::DisconnectStep(), Events::DisconnectStop(), Events::DisconnectTextureSelected(), Events::DisconnectTimeReset(), Events::DisconnectToggleEditMode(), Events::DisconnectToggleLayer(), Events::DisconnectTriggerShowElements(), Events::DisconnectTriggerShowFloorplan(), Events::DisconnectUpdateLevelWidget(), Events::DisconnectWindowMode(), Events::DisconnectWorldCreated(), Events::DisconnectWorldReset(), and Events::DisconnectWorldUpdateEnd().

void Disconnect ( int  _id)
virtual

Disconnect a callback to this event.

Removes a connection.

Parameters
[in]_idThe id of the connection to disconnect.
[in]_idthe connection index.

Implements Event.