##

Events Class Reference
Rendering

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. More...
template<typename T >
static event::ConnectionPtr | ConnectCameraPreRender (T _subscriber)
| Connect to a camera pre-render update event. More...
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 Public Attributes

static event::EventT< void(const std::string &)> | cameraPostRender
| The event used to indicate a camera post-render update event. More...
static event::EventT< void(const std::string &)> | cameraPreRender
| The event used to indicate a camera pre-render update event. More...
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

## ConnectCameraPostRender()

static event::ConnectionPtr ConnectCameraPostRender | ( | T | _subscriber | ) |

inline static

Connect to a camera post-render update event.

Parameters

  [in] | _subscriber | Callback to trigger when event occurs.

Returns
  Pointer the connection. This must stay in scope.

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

## ConnectCameraPreRender()

static event::ConnectionPtr ConnectCameraPreRender | ( | T | _subscriber | ) |

inline static

Connect to a camera pre-render update event.

Parameters

  [in] | _subscriber | Callback to trigger when event occurs.

Returns
  Pointer the connection. This must stay in scope.

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

## ConnectCreateScene()

static event::ConnectionPtr ConnectCreateScene | ( | T | _subscriber | ) |

inline static

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.

## ConnectNewLayer()

static event::ConnectionPtr ConnectNewLayer | ( | T | _subscriber | ) |

inline static

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.

## ConnectRemoveScene()

static event::ConnectionPtr ConnectRemoveScene | ( | T | _subscriber | ) |

inline static

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.

## ConnectToggleLayer()

static event::ConnectionPtr ConnectToggleLayer | ( | T | _subscriber | ) |

inline static

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.

## 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:

- RenderEvents.hh