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. More...
template<typename T >
static event::ConnectionPtr	ConnectNewLayer (T _subscriber)
	Connect to a new layer event. More...
template<typename T >
static event::ConnectionPtr	ConnectRemoveScene (T _subscriber)
	Connect to a scene removed event. More...
template<typename T >
static event::ConnectionPtr	ConnectToggleLayer (T _subscriber)
	Connect to a layer toggle event. More...
static void	DisconnectCreateScene (event::ConnectionPtr _connection) GAZEBO_DEPRECATED(8.0)
	Disconnect from a scene created event. More...
static void	DisconnectNewLayer (event::ConnectionPtr _connection) GAZEBO_DEPRECATED(8.0)
	Disconnect from a new layer event. More...
static void	DisconnectRemoveScene (event::ConnectionPtr _connection) GAZEBO_DEPRECATED(8.0)
	Disconnect from a scene removed event. More...
static void	DisconnectToggleLayer (event::ConnectionPtr _connection) GAZEBO_DEPRECATED(8.0)
	Disconnect from a layer toggle event. More...

Static Public Attributes
static event::EventT< void(const std::string &)>	createScene
	The event used to trigger a create scene event. More...
static event::EventT< void(const int32_t)>	newLayer
	The event used to indicate that a new layer is present. More...
static event::EventT< void(const std::string &)>	removeScene
	The event used to trigger a remove scene event. More...
static event::EventT< void(const int32_t)>	toggleLayer
	The event used to turn on/off a layer. More...

Detailed Description

Base class for rendering events.

Member Function Documentation

static event::ConnectionPtr 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 EventT< T >::Connect(), and Events::createScene.

static event::ConnectionPtr ConnectNewLayer ( T  _subscriber )

inlinestatic

Connect to a new layer event.

Parameters

[in]

_subscriber

Callback to trigger when event occurs.

Returns

Pointer the connection. This must stay in scope.

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

static event::ConnectionPtr 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 EventT< T >::Connect(), and Events::removeScene.

static event::ConnectionPtr ConnectToggleLayer ( T  _subscriber )

inlinestatic

Connect to a layer toggle event.

Parameters

[in]

_subscriber

Callback to trigger when event occurs.

Returns

Pointer the connection. This must stay in scope.

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

static void DisconnectCreateScene ( event::ConnectionPtr  _connection )

inlinestatic

Disconnect from a scene created event.

Parameters

[in]

_connection

The connection to disconnect.

Deprecated:

Use event::~Connection to disconnect

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

static void DisconnectNewLayer ( event::ConnectionPtr  _connection )

inlinestatic

Disconnect from a new layer event.

Parameters

[in]

_connection

The connection to disconnect.

Deprecated:

Use event::~Connection to disconnect

References EventT< T >::Disconnect(), and Events::newLayer.

static void DisconnectRemoveScene ( event::ConnectionPtr  _connection )

inlinestatic

Disconnect from a scene removed event.

Parameters

[in]

_connection

The connection to disconnect.

Deprecated:

Use event::~Connection to disconnect

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

static void DisconnectToggleLayer ( event::ConnectionPtr  _connection )

inlinestatic

Disconnect from a layer toggle event.

Parameters

[in]

_connection

The connection to disconnect.

Deprecated:

Use event::~Connection to disconnect

References EventT< T >::Disconnect(), and Events::toggleLayer.

Member Data Documentation

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

static

The event used to trigger a create scene event.

Referenced by Events::ConnectCreateScene(), and Events::DisconnectCreateScene().

event::EventT<void (const int32_t)> newLayer

static

The event used to indicate that a new layer is present.

Referenced by Events::ConnectNewLayer(), and Events::DisconnectNewLayer().

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

static

The event used to trigger a remove scene event.

Referenced by Events::ConnectRemoveScene(), and Events::DisconnectRemoveScene().

event::EventT<void (const int32_t)> toggleLayer

static

The event used to turn on/off a layer.

Referenced by Events::ConnectToggleLayer(), and Events::DisconnectToggleLayer().

---

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

• RenderEvents.hh