Radium Engine  1.5.0
Ra::Engine::Scene::SignalManager Class Reference

#include <Engine/Scene/SignalManager.hpp>

+ Collaboration diagram for Ra::Engine::Scene::SignalManager:

Public Types

using ItemObservable = Ra::Core::Utils::Observable< const ItemEntry & >
 Type for item (entity, component or render object) observable.
 
using FrameObservable = Ra::Core::Utils::Observable<>
 Type for frame observable.
 

Public Member Functions

void fireEntityCreated (const ItemEntry &entity) const
 Notifies all observers of an entity creation.
 
void fireEntityDestroyed (const ItemEntry &entity) const
 Notifies all observers of an entity removal.
 
void fireComponentAdded (const ItemEntry &component) const
 Notifies all observers of a component creation.
 
void fireComponentRemoved (const ItemEntry &component) const
 Notifies all observers of a component removal.
 
void fireRenderObjectAdded (const ItemEntry &ro) const
 Notifies all observers of a render object creation.
 
void fireRenderObjectRemoved (const ItemEntry &ro) const
 Notifies all observers of a render object removal.
 
void fireFrameEnded () const
 Notifies all observers of a end of frame event.
 
void setOn (bool on)
 Enable/disable the notification of observers.
 
ItemObservablegetEntityCreatedNotifier ()
 
ItemObservablegetEntityDestroyedNotifier ()
 
ItemObservablegetComponentCreatedNotifier ()
 
ItemObservablegetComponentDestroyedNotifier ()
 
ItemObservablegetRenderObjectCreatedNotifier ()
 
ItemObservablegetRenderObjectDestroyedNotifier ()
 
FrameObservablegetEndFrameNotifier ()
 

Detailed Description

This class is used to inform the external world of events happening in the engine. You can register a callback function which will be called any time the event happens. Signals are fired when an object of the engine (entity, component or render object) is either added or removed. Signals on entities, components and render objects send the item entry indicating the object that was added or removed.

Signals for new objects are fired just after they have been initialized and acquired by the object owning them. Signals for destroyed objects are fired just before they are removed from the object owning them and destroyed

Signals of end of frame send no parameters.

Definition at line 29 of file SignalManager.hpp.

Member Function Documentation

◆ getEntityCreatedNotifier()

SignalManager::ItemObservable & Ra::Engine::Scene::SignalManager::getEntityCreatedNotifier ( )

Access to the observable members

Definition at line 7 of file SignalManager.cpp.


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