gazebo::rendering::Events Class Reference

Base class for rendering events. More...

#include <rendering/rendering.hh>

Static Public Member Functions
template<typename T >
static event::ConnectionPtr	ConnectCreateScene (T _subscriber)
	Connect to a scene created event.
template<typename T >
static event::ConnectionPtr	ConnectRemoveScene (T _subscriber)
	Connect to a scene removed event.
static void	DisconnectCreateScene (event::ConnectionPtr _connection)
	Disconnect from a scene created event.
static void	DisconnectRemoveScene (event::ConnectionPtr _connection)
	Disconnect from a scene removed event.

Static Public Attributes
static event::EventT< void(const std::string &)>	createScene
	The event used to trigger a create scene event.
static event::EventT< void(const std::string &)>	removeScene
	The event used to trigger a remve scene event.

Detailed Description

Base class for rendering events.

Member Function Documentation

template<typename T >

static event::ConnectionPtr gazebo::rendering::Events::ConnectCreateScene ( T  _subscriber )

inlinestatic

Connect to a scene created event.

Parameters

[in]

_subscriber

Callback to trigger when event occurs.

Returns

Pointer the connection. This must stay in scope.

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

template<typename T >

static event::ConnectionPtr gazebo::rendering::Events::ConnectRemoveScene ( T  _subscriber )

inlinestatic

Connect to a scene removed event.

Parameters

[in]

_subscriber

Callback to trigger when event occurs.

Returns

Pointer the connection. This must stay in scope.

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

static void gazebo::rendering::Events::DisconnectCreateScene ( event::ConnectionPtr  _connection )

inlinestatic

Disconnect from a scene created event.

Parameters

[in]

_connection

The connection to disconnect.

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

static void gazebo::rendering::Events::DisconnectRemoveScene ( event::ConnectionPtr  _connection )

inlinestatic

Disconnect from a scene removed event.

Parameters

[in]

_connection

The connection to disconnect.

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

Member Data Documentation

event::EventT<void (const std::string &)> gazebo::rendering::Events::createScene

static

The event used to trigger a create scene event.

Referenced by ConnectCreateScene(), and DisconnectCreateScene().

event::EventT<void (const std::string &)> gazebo::rendering::Events::removeScene

static

The event used to trigger a remve scene event.

Referenced by ConnectRemoveScene(), and DisconnectRemoveScene().

---

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

• RenderEvents.hh