Events Class Reference

Base class for rendering events. More...

#include <rendering/rendering.hh>

Static Public Member Functions

template<typename T >
static event::ConnectionPtr ConnectCameraPostRender (T _subscriber)
 Connect to a camera post-render update event.
 
template<typename T >
static event::ConnectionPtr ConnectCameraPreRender (T _subscriber)
 Connect to a camera pre-render update event.
 
template<typename T >
static event::ConnectionPtr ConnectCreateScene (T _subscriber)
 Connect to a scene created event.
 
template<typename T >
static event::ConnectionPtr ConnectNewLayer (T _subscriber)
 Connect to a new layer event.
 
template<typename T >
static event::ConnectionPtr ConnectRemoveScene (T _subscriber)
 Connect to a scene removed event.
 
template<typename T >
static event::ConnectionPtr ConnectToggleLayer (T _subscriber)
 Connect to a layer toggle event.
 

Static Public Attributes

static event::EventT< void(const std::string &) cameraPostRender )
 The event used to indicate a camera post-render update event.
 
static event::EventT< void(const std::string &) cameraPreRender )
 The event used to indicate a camera pre-render update event.
 
static event::EventT< void(const std::string &) createScene )
 The event used to trigger a create scene event.
 
static event::EventT< void(const int32_t)> newLayer
 The event used to indicate that a new layer is present.
 
static event::EventT< void(const std::string &) removeScene )
 The event used to trigger a remove scene event.
 
static event::EventT< void(const int32_t)> toggleLayer
 The event used to turn on/off a layer.
 

Detailed Description

Base class for rendering events.

Member Function Documentation

◆ ConnectCameraPostRender()

template<typename T >
static event::ConnectionPtr ConnectCameraPostRender ( T _subscriber)
inlinestatic

Connect to a camera post-render update event.

Parameters
[in]_subscriberCallback to trigger when event occurs.
Returns
Pointer the connection. This must stay in scope.

References Events::cameraPostRender.

◆ ConnectCameraPreRender()

template<typename T >
static event::ConnectionPtr ConnectCameraPreRender ( T _subscriber)
inlinestatic

Connect to a camera pre-render update event.

Parameters
[in]_subscriberCallback to trigger when event occurs.
Returns
Pointer the connection. This must stay in scope.

References Events::cameraPreRender.

◆ ConnectCreateScene()

template<typename T >
static event::ConnectionPtr ConnectCreateScene ( T _subscriber)
inlinestatic

Connect to a scene created event.

Parameters
[in]_subscriberCallback to trigger when event occurs.
Returns
Pointer the connection. This must stay in scope.

References Events::createScene.

◆ ConnectNewLayer()

template<typename T >
static event::ConnectionPtr ConnectNewLayer ( T _subscriber)
inlinestatic

Connect to a new layer event.

Parameters
[in]_subscriberCallback to trigger when event occurs.
Returns
Pointer the connection. This must stay in scope.

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

◆ ConnectRemoveScene()

template<typename T >
static event::ConnectionPtr ConnectRemoveScene ( T _subscriber)
inlinestatic

Connect to a scene removed event.

Parameters
[in]_subscriberCallback to trigger when event occurs.
Returns
Pointer the connection. This must stay in scope.

References Events::removeScene.

◆ ConnectToggleLayer()

template<typename T >
static event::ConnectionPtr ConnectToggleLayer ( T _subscriber)
inlinestatic

Connect to a layer toggle event.

Parameters
[in]_subscriberCallback to trigger when event occurs.
Returns
Pointer the connection. This must stay in scope.

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

Member Data Documentation

◆ cameraPostRender

event::EventT<void (const std::string &) cameraPostRender)
static

The event used to indicate a camera post-render update event.

Referenced by Events::ConnectCameraPostRender().

◆ cameraPreRender

event::EventT<void (const std::string &) cameraPreRender)
static

The event used to indicate a camera pre-render update event.

Referenced by Events::ConnectCameraPreRender().

◆ createScene

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

The event used to trigger a create scene event.

Referenced by Events::ConnectCreateScene().

◆ newLayer

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

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

Referenced by Events::ConnectNewLayer().

◆ removeScene

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

The event used to trigger a remove scene event.

Referenced by Events::ConnectRemoveScene().

◆ toggleLayer

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

The event used to turn on/off a layer.

Referenced by Events::ConnectToggleLayer().


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