Events

Namespaces
namespace	gazebo::event
	Event namespace.

Classes
class	gazebo::event::Connection
	A class that encapsulates a connection. More...
class	gazebo::event::Event
	Base class for all events. More...
class	gazebo::event::EventT< T >
	A class for event processing. More...

Functions
virtual	gazebo::event::EventT< T >::~EventT ()
	Destructor.
ConnectionPtr	gazebo::event::EventT< T >::Connect (const boost::function< T > &_subscriber)
	Connect a callback to this event.
template<typename T >
static ConnectionPtr	gazebo::event::Events::ConnectAddEntity (T _subscriber)
	Connect a boost::slot the the add entity signal.
template<typename T >
static ConnectionPtr	gazebo::event::Events::ConnectCreateEntity (T _subscriber)
	Connect a boost::slot the the add entity signal.
template<typename T >
static ConnectionPtr	gazebo::event::Events::ConnectDeleteEntity (T _subscriber)
	Connect a boost::slot the delete entity.
template<typename T >
static ConnectionPtr	gazebo::event::Events::ConnectDiagTimerStart (T _subscriber)
	Connect a boost::slot the diagnostic timer start signal.
template<typename T >
static ConnectionPtr	gazebo::event::Events::ConnectDiagTimerStop (T _subscriber)
	Connect a boost::slot the diagnostic timer stop signal.
template<typename T >
static ConnectionPtr	gazebo::event::Events::ConnectPause (T _subscriber)
	Connect a boost::slot the the pause signal.
template<typename T >
static ConnectionPtr	gazebo::event::Events::ConnectPostRender (T _subscriber)
	Connect a boost::slot the post render update signal.
template<typename T >
static ConnectionPtr	gazebo::event::Events::ConnectPreRender (T _subscriber)
	Render start signal.
template<typename T >
static ConnectionPtr	gazebo::event::Events::ConnectRender (T _subscriber)
	Connect a boost::slot the render update signal.
template<typename T >
static ConnectionPtr	gazebo::event::Events::ConnectSetSelectedEntity (T _subscriber)
	Connect a boost::slot the set selected entity.
template<typename T >
static ConnectionPtr	gazebo::event::Events::ConnectStep (T _subscriber)
	Connect a boost::slot the the step signal.
template<typename T >
static ConnectionPtr	gazebo::event::Events::ConnectStop (T _subscriber)
	Connect a boost::slot the the stop signal.
template<typename T >
static ConnectionPtr	gazebo::event::Events::ConnectWorldCreated (T _subscriber)
	Connect a boost::slot the the world created signal.
template<typename T >
static ConnectionPtr	gazebo::event::Events::ConnectWorldUpdateEnd (T _subscriber)
	Connect a boost::slot the the world update end signal.
template<typename T >
static ConnectionPtr	gazebo::event::Events::ConnectWorldUpdateStart (T _subscriber)
	Connect a boost::slot the the world update start signal.
virtual void	gazebo::event::EventT< T >::Disconnect (ConnectionPtr _c)
	Disconnect a callback to this event.
virtual void	gazebo::event::EventT< T >::Disconnect (int _id)
	Disconnect a callback to this event.
static void	gazebo::event::Events::DisconnectAddEntity (ConnectionPtr _subscriber)
	Disconnect a boost::slot the the add entity signal.
static void	gazebo::event::Events::DisconnectCreateEntity (ConnectionPtr _subscriber)
	Disconnect a boost::slot the the add entity signal.
static void	gazebo::event::Events::DisconnectDeleteEntity (ConnectionPtr _subscriber)
	Disconnect a boost::slot the delete entity.
static void	gazebo::event::Events::DisconnectDiagTimerStart (ConnectionPtr _subscriber)
	Disconnect a boost::slot the diagnostic timer start signal.
static void	gazebo::event::Events::DisconnectDiagTimerStop (ConnectionPtr _subscriber)
	Disconnect a boost::slot the diagnostic timer stop signal.
static void	gazebo::event::Events::DisconnectPause (ConnectionPtr _subscriber)
	Disconnect a boost::slot the the pause signal.
static void	gazebo::event::Events::DisconnectPostRender (ConnectionPtr _subscriber)
	Disconnect a boost::slot the post render update signal.
static void	gazebo::event::Events::DisconnectPreRender (ConnectionPtr _subscriber)
	Disconnect a render start signal.
static void	gazebo::event::Events::DisconnectRender (ConnectionPtr _subscriber)
	Disconnect a boost::slot the render update signal.
static void	gazebo::event::Events::DisconnectSetSelectedEntity (ConnectionPtr _subscriber)
	Disconnect a boost::slot the set selected entity.
static void	gazebo::event::Events::DisconnectStep (ConnectionPtr _subscriber)
	Disconnect a boost::slot the the step signal.
static void	gazebo::event::Events::DisconnectStop (ConnectionPtr _subscriber)
	Disconnect a boost::slot the the stop signal.
static void	gazebo::event::Events::DisconnectWorldCreated (ConnectionPtr _subscriber)
	Disconnect a boost::slot the the world created signal.
static void	gazebo::event::Events::DisconnectWorldUpdateEnd (ConnectionPtr _subscriber)
	Disconnect a boost::slot the the world update end signal.
static void	gazebo::event::Events::DisconnectWorldUpdateStart (ConnectionPtr _subscriber)
	Disconnect a boost::slot the the world update start signal.

Variables
static EventT< void(std::string)>	gazebo::event::Events::addEntity
	An entity has been added.
static EventT< void(std::string)>	gazebo::event::Events::deleteEntity
	An entity has been deleted.
static EventT< void(std::string)>	gazebo::event::Events::diagTimerStart
	Diagnostic timer start.
static EventT< void(std::string)>	gazebo::event::Events::diagTimerStop
	Diagnostic timer stop.
static EventT< void(std::string)>	gazebo::event::Events::entityCreated
	An entity has been created.
static EventT< void(bool)>	gazebo::event::Events::pause
	Pause signal.
static EventT< void()>	gazebo::event::Events::postRender
	Post-Render.
static EventT< void()>	gazebo::event::Events::preRender
	Pre-render.
static EventT< void()>	gazebo::event::Events::render
	Render.
static EventT< void(std::string, std::string)>	gazebo::event::Events::setSelectedEntity
	An entity has been selected.
static EventT< void()>	gazebo::event::Events::step
	Step the simulation once signal.
static EventT< void()>	gazebo::event::Events::stop
	Simulation stop signal.
static EventT< void(std::string)>	gazebo::event::Events::worldCreated
	A world has been created.
static EventT< void()>	gazebo::event::Events::worldUpdateEnd
	World update has ended.
static EventT< void()>	gazebo::event::Events::worldUpdateStart
	World update has started.

Detailed Description

Function Documentation

template<typename T >

gazebo::event::EventT< T >::~EventT ( )

virtual

Destructor.

Destructor. Deletes all the associated connections.

template<typename T>

ConnectionPtr gazebo::event::EventT< T >::Connect

(

const boost::function< T > &

_subscriber

)

Connect a callback to this event.

Adds a connection.

Parameters

[in]

_subscriber

Pointer to a callback function

Returns

A Connection object, which will automatically call Disconnect when it goes out of scope

Parameters

[in]

_subscriber

the subscriber to connect

Referenced by gazebo::event::Events::ConnectAddEntity(), gazebo::physics::Collision::ConnectContact(), gazebo::event::Events::ConnectCreateEntity(), gazebo::rendering::Events::ConnectCreateScene(), gazebo::event::Events::ConnectDeleteEntity(), gazebo::event::Events::ConnectDiagTimerStart(), gazebo::event::Events::ConnectDiagTimerStop(), gazebo::physics::Link::ConnectEnabled(), gazebo::physics::Joint::ConnectJointUpdate(), gazebo::rendering::DepthCamera::ConnectNewDepthFrame(), gazebo::rendering::Camera::ConnectNewImageFrame(), gazebo::rendering::GpuLaser::ConnectNewLaserFrame(), gazebo::physics::MultiRayShape::ConnectNewLaserScans(), gazebo::rendering::DepthCamera::ConnectNewRGBPointCloud(), gazebo::event::Events::ConnectPause(), gazebo::event::Events::ConnectPostRender(), gazebo::event::Events::ConnectPreRender(), gazebo::rendering::Events::ConnectRemoveScene(), gazebo::event::Events::ConnectRender(), gazebo::event::Events::ConnectSetSelectedEntity(), gazebo::event::Events::ConnectStep(), gazebo::event::Events::ConnectStop(), gazebo::transport::Connection::ConnectToShutdown(), gazebo::event::Events::ConnectWorldCreated(), gazebo::event::Events::ConnectWorldUpdateEnd(), and gazebo::event::Events::ConnectWorldUpdateStart().

template<typename T >

static ConnectionPtr gazebo::event::Events::ConnectAddEntity ( T  _subscriber )

inlinestatic

Connect a boost::slot the the add entity signal.

Parameters

[in]

_subscriber

the subscriber to this event

Returns

a connection

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

template<typename T >

static ConnectionPtr gazebo::event::Events::ConnectCreateEntity ( T  _subscriber )

inlinestatic

Connect a boost::slot the the add entity signal.

Parameters

[in]

_subscriber

the subscriber to this event

Returns

a connection

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

template<typename T >

static ConnectionPtr gazebo::event::Events::ConnectDeleteEntity ( T  _subscriber )

inlinestatic

Connect a boost::slot the delete entity.

Parameters

[in]

_subscriber

the subscriber to this event

Returns

a connection

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

template<typename T >

static ConnectionPtr gazebo::event::Events::ConnectDiagTimerStart ( T  _subscriber )

inlinestatic

Connect a boost::slot the diagnostic timer start signal.

Parameters

[in]

_subscriber

the subscriber to this event

Returns

a connection

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

template<typename T >

static ConnectionPtr gazebo::event::Events::ConnectDiagTimerStop ( T  _subscriber )

inlinestatic

Connect a boost::slot the diagnostic timer stop signal.

Parameters

[in]

_subscriber

the subscriber to this event

Returns

a connection

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

template<typename T >

static ConnectionPtr gazebo::event::Events::ConnectPause ( T  _subscriber )

inlinestatic

Connect a boost::slot the the pause signal.

Parameters

[in]

_subscriber

the subscriber to this event

Returns

a connection

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

template<typename T >

static ConnectionPtr gazebo::event::Events::ConnectPostRender ( T  _subscriber )

inlinestatic

Connect a boost::slot the post render update signal.

Parameters

[in]

_subscriber

the subscriber to this event

Returns

a connection

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

template<typename T >

static ConnectionPtr gazebo::event::Events::ConnectPreRender ( T  _subscriber )

inlinestatic

Render start signal.

Parameters

[in]

_subscriber

the subscriber to this event

Returns

a connection

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

template<typename T >

static ConnectionPtr gazebo::event::Events::ConnectRender ( T  _subscriber )

inlinestatic

Connect a boost::slot the render update signal.

Parameters

[in]

_subscriber

the subscriber to this event

Returns

a connection

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

template<typename T >

static ConnectionPtr gazebo::event::Events::ConnectSetSelectedEntity ( T  _subscriber )

inlinestatic

Connect a boost::slot the set selected entity.

Parameters

[in]

_subscriber

the subscriber to this event

Returns

a connection

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

template<typename T >

static ConnectionPtr gazebo::event::Events::ConnectStep ( T  _subscriber )

inlinestatic

Connect a boost::slot the the step signal.

Parameters

[in]

_subscriber

the subscriber to this event

Returns

a connection

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

template<typename T >

static ConnectionPtr gazebo::event::Events::ConnectStop ( T  _subscriber )

inlinestatic

Connect a boost::slot the the stop signal.

Parameters

[in]

_subscriber

the subscriber to this event

Returns

a connection

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

template<typename T >

static ConnectionPtr gazebo::event::Events::ConnectWorldCreated ( T  _subscriber )

inlinestatic

Connect a boost::slot the the world created signal.

Parameters

[in]

_subscriber

the subscriber to this event

Returns

a connection

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

template<typename T >

static ConnectionPtr gazebo::event::Events::ConnectWorldUpdateEnd ( T  _subscriber )

inlinestatic

Connect a boost::slot the the world update end signal.

Parameters

[in]

_subscriber

the subscriber to this event

Returns

a connection

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

template<typename T >

static ConnectionPtr gazebo::event::Events::ConnectWorldUpdateStart ( T  _subscriber )

inlinestatic

Connect a boost::slot the the world update start signal.

Parameters

[in]

_subscriber

the subscriber to this event

Returns

a connection

References gazebo::event::EventT< T >::Connect(), and gazebo::event::Events::worldUpdateStart.

template<typename T >

void gazebo::event::EventT< T >::Disconnect ( ConnectionPtr  _c )

virtual

Disconnect a callback to this event.

Removes a connection.

Parameters

[in]	_c	The connection to disconnect
[in]	_c	the connection

Implements gazebo::event::Event.

References gazebo::event::Connection::GetId(), and NULL.

Referenced by gazebo::event::Events::DisconnectAddEntity(), gazebo::physics::Collision::DisconnectContact(), gazebo::event::Events::DisconnectCreateEntity(), gazebo::rendering::Events::DisconnectCreateScene(), gazebo::event::Events::DisconnectDeleteEntity(), gazebo::event::Events::DisconnectDiagTimerStart(), gazebo::event::Events::DisconnectDiagTimerStop(), gazebo::physics::Link::DisconnectEnabled(), gazebo::physics::Joint::DisconnectJointUpdate(), gazebo::rendering::DepthCamera::DisconnectNewDepthFrame(), gazebo::rendering::Camera::DisconnectNewImageFrame(), gazebo::rendering::GpuLaser::DisconnectNewLaserFrame(), gazebo::physics::MultiRayShape::DisconnectNewLaserScans(), gazebo::rendering::DepthCamera::DisconnectNewRGBPointCloud(), gazebo::event::Events::DisconnectPause(), gazebo::event::Events::DisconnectPostRender(), gazebo::event::Events::DisconnectPreRender(), gazebo::rendering::Events::DisconnectRemoveScene(), gazebo::event::Events::DisconnectRender(), gazebo::event::Events::DisconnectSetSelectedEntity(), gazebo::transport::Connection::DisconnectShutdown(), gazebo::event::Events::DisconnectStep(), gazebo::event::Events::DisconnectStop(), gazebo::event::Events::DisconnectWorldCreated(), gazebo::event::Events::DisconnectWorldUpdateEnd(), and gazebo::event::Events::DisconnectWorldUpdateStart().

template<typename T >

void gazebo::event::EventT< T >::Disconnect ( int  _id )

virtual

Disconnect a callback to this event.

Removes a connection.

Parameters

[in]	_id	The id of the connection to disconnect
	_id]	the connection index

Implements gazebo::event::Event.

static void gazebo::event::Events::DisconnectAddEntity ( ConnectionPtr  _subscriber )

inlinestatic

Disconnect a boost::slot the the add entity signal.

Parameters

[in]

_subscriber

the subscriber to this event

References gazebo::event::Events::addEntity, and gazebo::event::EventT< T >::Disconnect().

static void gazebo::event::Events::DisconnectCreateEntity ( ConnectionPtr  _subscriber )

inlinestatic

Disconnect a boost::slot the the add entity signal.

Parameters

[in]

_subscriber

the subscriber to this event

References gazebo::event::EventT< T >::Disconnect(), and gazebo::event::Events::entityCreated.

static void gazebo::event::Events::DisconnectDeleteEntity ( ConnectionPtr  _subscriber )

inlinestatic

Disconnect a boost::slot the delete entity.

Parameters

[in]

_subscriber

the subscriber to this event

References gazebo::event::Events::deleteEntity, and gazebo::event::EventT< T >::Disconnect().

static void gazebo::event::Events::DisconnectDiagTimerStart ( ConnectionPtr  _subscriber )

inlinestatic

Disconnect a boost::slot the diagnostic timer start signal.

Parameters

[in]

_subscriber

the subscriber to this event

References gazebo::event::Events::diagTimerStart, and gazebo::event::EventT< T >::Disconnect().

static void gazebo::event::Events::DisconnectDiagTimerStop ( ConnectionPtr  _subscriber )

inlinestatic

Disconnect a boost::slot the diagnostic timer stop signal.

Parameters

[in]

_subscriber

the subscriber to this event

References gazebo::event::Events::diagTimerStop, and gazebo::event::EventT< T >::Disconnect().

static void gazebo::event::Events::DisconnectPause ( ConnectionPtr  _subscriber )

inlinestatic

Disconnect a boost::slot the the pause signal.

Parameters

[in]

_subscriber

the subscriber to this event

References gazebo::event::EventT< T >::Disconnect(), and gazebo::event::Events::pause.

static void gazebo::event::Events::DisconnectPostRender ( ConnectionPtr  _subscriber )

inlinestatic

Disconnect a boost::slot the post render update signal.

Parameters

[in]

_subscriber

the subscriber to this event

References gazebo::event::EventT< T >::Disconnect(), and gazebo::event::Events::postRender.

static void gazebo::event::Events::DisconnectPreRender ( ConnectionPtr  _subscriber )

inlinestatic

Disconnect a render start signal.

Parameters

[in]

_subscriber

the subscriber to this event

References gazebo::event::EventT< T >::Disconnect(), and gazebo::event::Events::preRender.

static void gazebo::event::Events::DisconnectRender ( ConnectionPtr  _subscriber )

inlinestatic

Disconnect a boost::slot the render update signal.

Parameters

[in]

_subscriber

the subscriber to this event

References gazebo::event::EventT< T >::Disconnect(), and gazebo::event::Events::render.

static void gazebo::event::Events::DisconnectSetSelectedEntity ( ConnectionPtr  _subscriber )

inlinestatic

Disconnect a boost::slot the set selected entity.

Parameters

[in]

_subscriber

the subscriber to this event

References gazebo::event::EventT< T >::Disconnect(), and gazebo::event::Events::setSelectedEntity.

static void gazebo::event::Events::DisconnectStep ( ConnectionPtr  _subscriber )

inlinestatic

Disconnect a boost::slot the the step signal.

Parameters

[in]

_subscriber

the subscriber to this event

References gazebo::event::EventT< T >::Disconnect(), and gazebo::event::Events::step.

static void gazebo::event::Events::DisconnectStop ( ConnectionPtr  _subscriber )

inlinestatic

Disconnect a boost::slot the the stop signal.

Parameters

[in]

_subscriber

the subscriber to this event

References gazebo::event::EventT< T >::Disconnect(), and gazebo::event::Events::stop.

static void gazebo::event::Events::DisconnectWorldCreated ( ConnectionPtr  _subscriber )

inlinestatic

Disconnect a boost::slot the the world created signal.

References gazebo::event::EventT< T >::Disconnect(), and gazebo::event::Events::worldCreated.

static void gazebo::event::Events::DisconnectWorldUpdateEnd ( ConnectionPtr  _subscriber )

inlinestatic

Disconnect a boost::slot the the world update end signal.

Parameters

[in]

_subscriber

the subscriber to this event

References gazebo::event::EventT< T >::Disconnect(), and gazebo::event::Events::worldUpdateEnd.

static void gazebo::event::Events::DisconnectWorldUpdateStart ( ConnectionPtr  _subscriber )

inlinestatic

Disconnect a boost::slot the the world update start signal.

Parameters

[in]

_subscriber

the subscriber to this event

References gazebo::event::EventT< T >::Disconnect(), and gazebo::event::Events::worldUpdateStart.

Variable Documentation

EventT<void (std::string)> gazebo::event::Events::addEntity

static

An entity has been added.

Referenced by gazebo::event::Events::ConnectAddEntity(), and gazebo::event::Events::DisconnectAddEntity().

EventT<void (std::string)> gazebo::event::Events::deleteEntity

static

An entity has been deleted.

Referenced by gazebo::event::Events::ConnectDeleteEntity(), and gazebo::event::Events::DisconnectDeleteEntity().

EventT<void (std::string)> gazebo::event::Events::diagTimerStart

static

Diagnostic timer start.

Referenced by gazebo::event::Events::ConnectDiagTimerStart(), and gazebo::event::Events::DisconnectDiagTimerStart().

EventT<void (std::string)> gazebo::event::Events::diagTimerStop

static

Diagnostic timer stop.

Referenced by gazebo::event::Events::ConnectDiagTimerStop(), and gazebo::event::Events::DisconnectDiagTimerStop().

EventT<void (std::string)> gazebo::event::Events::entityCreated

static

An entity has been created.

Referenced by gazebo::event::Events::ConnectCreateEntity(), and gazebo::event::Events::DisconnectCreateEntity().

EventT<void (bool)> gazebo::event::Events::pause

static

Pause signal.

Referenced by gazebo::event::Events::ConnectPause(), and gazebo::event::Events::DisconnectPause().

EventT<void ()> gazebo::event::Events::postRender

static

Post-Render.

Referenced by gazebo::event::Events::ConnectPostRender(), and gazebo::event::Events::DisconnectPostRender().

EventT<void ()> gazebo::event::Events::preRender

static

Pre-render.

Referenced by gazebo::event::Events::ConnectPreRender(), and gazebo::event::Events::DisconnectPreRender().

EventT<void ()> gazebo::event::Events::render

static

Render.

Referenced by gazebo::event::Events::ConnectRender(), and gazebo::event::Events::DisconnectRender().

EventT<void (std::string, std::string)> gazebo::event::Events::setSelectedEntity

static

An entity has been selected.

Referenced by gazebo::event::Events::ConnectSetSelectedEntity(), and gazebo::event::Events::DisconnectSetSelectedEntity().

EventT<void ()> gazebo::event::Events::step

static

Step the simulation once signal.

Referenced by gazebo::event::Events::ConnectStep(), and gazebo::event::Events::DisconnectStep().

EventT<void ()> gazebo::event::Events::stop

static

Simulation stop signal.

Referenced by gazebo::event::Events::ConnectStop(), and gazebo::event::Events::DisconnectStop().

EventT<void (std::string)> gazebo::event::Events::worldCreated

static

A world has been created.

Referenced by gazebo::event::Events::ConnectWorldCreated(), and gazebo::event::Events::DisconnectWorldCreated().

EventT<void ()> gazebo::event::Events::worldUpdateEnd

static

World update has ended.

Referenced by gazebo::event::Events::ConnectWorldUpdateEnd(), and gazebo::event::Events::DisconnectWorldUpdateEnd().

EventT<void ()> gazebo::event::Events::worldUpdateStart

static

World update has started.

Referenced by gazebo::event::Events::ConnectWorldUpdateStart(), and gazebo::event::Events::DisconnectWorldUpdateStart().