Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/presentationHS15/src/libraries/core/singleton/ScopeManager.h @ 10970

Last change on this file since 10970 was 10542, checked in by landauf, 10 years ago

clean and explicit setup/shutdown of singletons that are used by statically initialized instances

  • Property svn:eol-style set to native
File size: 3.1 KB
Line 
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
29/**
30@file
31@ingroup SingletonScope
32@brief Declaration of orxonox::ScopeManager.
33*/
34
35#ifndef __ScopeManager_H__
36#define __ScopeManager_H__
37
38#include "core/CorePrereqs.h"
39
40#include <map>
41#include <set>
42
43#include "util/Singleton.h"
44
45namespace orxonox
46{
47    /**
48        @brief The ScopeManager stores the variables of the Scope templates in a statically linked context.
49
50        If all Scope objects are managed by this class, they are statically linked in the core library.
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.
55    */
56    class _CoreExport ScopeManager : public Singleton<ScopeManager>
57    {
58        friend class Singleton<ScopeManager>;
59
60        public:
61            /** Adds a scope and activates all listeners which are registered for this scope */
62            void addScope(ScopeID::Value scope);
63            /** Removes a scope and deactivates all listeners which are registered for this scope */
64            void removeScope(ScopeID::Value scope);
65            /** Returns true if this scope is active */
66            bool isActive(ScopeID::Value scope);
67
68            /** Registers a listener for the given scope. If the scope is already active, the listener is activate immediately. */
69            void addListener(ScopeListener* listener, ScopeID::Value scope);
70            /** Unregisters a listener for the given scope. If the scope is still active, the listener is deactivated before removal. */
71            void removeListener(ScopeListener* listener, ScopeID::Value scope);
72
73        private:
74            void activateListenersForScope(ScopeID::Value scope);
75            void deactivateListenersForScope(ScopeID::Value scope);
76
77            void activateListener(ScopeListener* listener);
78            void deactivateListener(ScopeListener* listener);
79
80            std::set<ScopeID::Value> activeScopes_;
81            std::map<ScopeID::Value, std::set<ScopeListener*> > listeners_; //!< Stores all listeners for a scope
82
83            static ScopeManager* singletonPtr_s;
84    };
85}
86
87#endif /* __ScopeManager_H__ */
Note: See TracBrowser for help on using the repository browser.