[5640] | 1 | /* |
---|
| 2 | * ORXONOX - the hottest 3D action shooter ever to exist |
---|
| 3 | * > www.orxonox.net < |
---|
| 4 | * |
---|
| 5 | * |
---|
| 6 | * License notice: |
---|
| 7 | * |
---|
| 8 | * This program is free software; you can redistribute it and/or |
---|
| 9 | * modify it under the terms of the GNU General Public License |
---|
| 10 | * as published by the Free Software Foundation; either version 2 |
---|
| 11 | * of the License, or (at your option) any later version. |
---|
| 12 | * |
---|
| 13 | * This program is distributed in the hope that it will be useful, |
---|
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 16 | * GNU General Public License for more details. |
---|
| 17 | * |
---|
| 18 | * You should have received a copy of the GNU General Public License |
---|
| 19 | * along with this program; if not, write to the Free Software |
---|
| 20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
---|
| 21 | * |
---|
| 22 | * Author: |
---|
| 23 | * Fabian 'x3n' Landau |
---|
| 24 | * Co-authors: |
---|
| 25 | * ... |
---|
| 26 | * |
---|
| 27 | */ |
---|
| 28 | |
---|
[7401] | 29 | /** |
---|
| 30 | @file |
---|
| 31 | @ingroup SingletonScope |
---|
[10461] | 32 | @brief Declaration of orxonox::ScopeManager. |
---|
[7401] | 33 | */ |
---|
| 34 | |
---|
[10461] | 35 | #ifndef __ScopeManager_H__ |
---|
| 36 | #define __ScopeManager_H__ |
---|
[5640] | 37 | |
---|
[10407] | 38 | #include "core/CorePrereqs.h" |
---|
[5929] | 39 | |
---|
| 40 | #include <map> |
---|
[5640] | 41 | #include <set> |
---|
[5929] | 42 | |
---|
[10542] | 43 | #include "util/Singleton.h" |
---|
| 44 | |
---|
[5640] | 45 | namespace orxonox |
---|
| 46 | { |
---|
| 47 | /** |
---|
[7401] | 48 | @brief The ScopeManager stores the variables of the Scope templates in a statically linked context. |
---|
| 49 | |
---|
[10407] | 50 | If all Scope objects are managed by this class, they are statically linked in the core library. |
---|
[7401] | 51 | Without this, a new instance of Scope<T> for each T would be created in every library of Orxonox, |
---|
| 52 | which is of course not the desired behavior. |
---|
| 53 | |
---|
| 54 | @see See @ref Scope "this description" for details about the interrelationship of Scope, ScopeListener, and ScopeManager. |
---|
[5640] | 55 | */ |
---|
[10542] | 56 | class _CoreExport ScopeManager : public Singleton<ScopeManager> |
---|
[5640] | 57 | { |
---|
[10542] | 58 | friend class Singleton<ScopeManager>; |
---|
| 59 | |
---|
[10462] | 60 | public: |
---|
[10513] | 61 | /** Adds a scope and activates all listeners which are registered for this scope */ |
---|
[10463] | 62 | void addScope(ScopeID::Value scope); |
---|
[10513] | 63 | /** Removes a scope and deactivates all listeners which are registered for this scope */ |
---|
[10463] | 64 | void removeScope(ScopeID::Value scope); |
---|
[10513] | 65 | /** Returns true if this scope is active */ |
---|
[10463] | 66 | bool isActive(ScopeID::Value scope); |
---|
| 67 | |
---|
[10538] | 68 | /** Registers a listener for the given scope. If the scope is already active, the listener is activate immediately. */ |
---|
[10514] | 69 | void addListener(ScopeListener* listener, ScopeID::Value scope); |
---|
[10538] | 70 | /** Unregisters a listener for the given scope. If the scope is still active, the listener is deactivated before removal. */ |
---|
[10514] | 71 | void removeListener(ScopeListener* listener, ScopeID::Value scope); |
---|
[10462] | 72 | |
---|
[11012] | 73 | /** Returns all registered listeners for a given scope. */ |
---|
| 74 | const std::set<ScopeListener*>& getListeners(ScopeID::Value scope) |
---|
| 75 | { return this->listeners_[scope]; } |
---|
| 76 | |
---|
[10513] | 77 | private: |
---|
| 78 | void activateListenersForScope(ScopeID::Value scope); |
---|
| 79 | void deactivateListenersForScope(ScopeID::Value scope); |
---|
[10462] | 80 | |
---|
[10513] | 81 | void activateListener(ScopeListener* listener); |
---|
| 82 | void deactivateListener(ScopeListener* listener); |
---|
| 83 | |
---|
[10463] | 84 | std::set<ScopeID::Value> activeScopes_; |
---|
[11071] | 85 | std::map<ScopeID::Value, std::set<ScopeListener*>> listeners_; //!< Stores all listeners for a scope |
---|
[10542] | 86 | |
---|
| 87 | static ScopeManager* singletonPtr_s; |
---|
[5640] | 88 | }; |
---|
| 89 | } |
---|
| 90 | |
---|
[10461] | 91 | #endif /* __ScopeManager_H__ */ |
---|