Berserk
EventDispatcher.hpp
Go to the documentation of this file.
1 /**********************************************************************************/
2 /* This file is part of Berserk Engine project */
3 /* https://github.com/EgorOrachyov/Berserk */
4 /**********************************************************************************/
5 /* MIT License */
6 /* */
7 /* Copyright (c) 2018 - 2021 Egor Orachyov */
8 /* */
9 /* Permission is hereby granted, free of charge, to any person obtaining a copy */
10 /* of this software and associated documentation files (the "Software"), to deal */
11 /* in the Software without restriction, including without limitation the rights */
12 /* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell */
13 /* copies of the Software, and to permit persons to whom the Software is */
14 /* furnished to do so, subject to the following conditions: */
15 /* */
16 /* The above copyright notice and this permission notice shall be included in all */
17 /* copies or substantial portions of the Software. */
18 /* */
19 /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR */
20 /* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, */
21 /* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE */
22 /* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER */
23 /* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, */
24 /* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE */
25 /* SOFTWARE. */
26 /**********************************************************************************/
27 
28 #ifndef BERSERK_EVENTDISPATCHER_HPP
29 #define BERSERK_EVENTDISPATCHER_HPP
30 
31 #include <core/Config.hpp>
32 #include <core/Typedefs.hpp>
33 #include <core/event/Event.hpp>
34 
35 #include <functional>
36 #include <unordered_map>
37 #include <vector>
38 
40 
58 class EventDispatcher final {
59 public:
61  using ListenerFunc = std::function<bool(const Event &)>;
63  using Handle = size_t;
64 
77  BRK_API void Dispatch(const Ref<Event> &event);
78 
95  BRK_API Handle Subscribe(const EventType &eventType, ListenerFunc func, bool paused = false);
96 
104  BRK_API void Unsubscribe(Handle handle);
105 
113  BRK_API void Pause(Handle handle);
114 
122  BRK_API void Resume(Handle handle);
123 
124 private:
125  friend class Engine;
126 
128  struct Listener {
129  ListenerFunc callback;
130  Handle handle;
131  bool paused = false;
132  };
133 
134  void Update();
135  Handle GetNext();
136 
137 private:
139  std::unordered_map<EventType, std::vector<Listener>> mListeners;
141  std::unordered_map<Handle, EventType> mListenersTypes;
142 
144  std::vector<Listener> mPendingAdd;
146  std::vector<Handle> mPendingRemove;
148  std::vector<std::pair<Handle, bool>> mPendingPause;
149 
151  std::vector<Ref<Event>> mQueuedEvents;
152  std::vector<Ref<Event>> mQueuedEventsExec;
153 
155  Handle mNextHandle = 0;
156 };
157 
163 
164 
165 #endif//BERSERK_EVENTDISPATCHER_HPP
#define BRK_NS_END
Definition: Config.hpp:48
#define BRK_API
Definition: Config.hpp:32
std::size_t size_t
Definition: Typedefs.hpp:49
Root manager class.
Definition: Engine.hpp:72
Event dispatcher is responsible for managing engine events.
Definition: EventDispatcher.hpp:58
BRK_API void Dispatch(const Ref< Event > &event)
Dispatch new event to listeners.
Definition: EventDispatcher.cpp:53
BRK_API void Unsubscribe(Handle handle)
Unsubscribe listener associated with specified handle.
Definition: EventDispatcher.cpp:76
BRK_API void Resume(Handle handle)
Resume listening for events of specified listener by handle.
Definition: EventDispatcher.cpp:84
BRK_API void Pause(Handle handle)
Pause listening for events of specified listener by handle.
Definition: EventDispatcher.cpp:80
BRK_API Handle Subscribe(const EventType &eventType, ListenerFunc func, bool paused=false)
Subscribe listener function to specified event type.
Definition: EventDispatcher.cpp:62
size_t Handle
Definition: EventDispatcher.hpp:63
std::function< bool(const Event &)> ListenerFunc
Definition: EventDispatcher.hpp:61
StringName based event type.
Base class for any engine event.
Definition: Event.hpp:56
Automates reference counting and behaves as shared smart pointer.
Definition: Ref.hpp:46
Definition: GLDevice.cpp:46