Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/usability/src/orxonox/LevelManager.h @ 8365

Last change on this file since 8365 was 8037, checked in by dafrick, 14 years ago

Making LevelInfoCompare a strictly weak ordering (compared to just a weak ordering, which is not a good idea for sets), which leads to no more warnings because of levels that have the same name. Which is ok, imo, als long as the LevelManager can distinguish them, which it can as long as they don't have the sime filenames as well.

  • Property svn:eol-style set to native
File size: 4.4 KB
RevLine 
[2072]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:
[7802]25 *      Damian 'Mozork' Frick
[2072]26 *
27 */
28
[7804]29/**
30    @file LevelManager.h
31    @brief Definition of the LevelManager singleton.
32    @ingroup Orxonox
33*/
34
[2072]35#ifndef _LevelManager_H__
36#define _LevelManager_H__
37
38#include "OrxonoxPrereqs.h"
39
[3196]40#include <cassert>
[2072]41#include <list>
[7648]42#include <map>
[3304]43#include <string>
[3370]44
[7802]45#include "LevelInfo.h"
46
[3370]47#include "util/Singleton.h"
[3280]48#include "core/OrxonoxClass.h"
[2072]49
[3280]50// tolua_begin
[2072]51namespace orxonox
52{
[7802]53
54    /**
55    @brief
[7803]56        The LevelManager keeps track of @ref orxonox::Level "Levels" whose activity has been requested and activates the @ref orxonox::Level "Levels" in the list in a FIFO manner with exactly one Level (the first in the list) being active at all times (unless the list is empty).
57        It also serves as an access point to get a list of all available @ref orxonox::Level "Levels" (or rather their respective @ref orxonox::LevelInfoItem "LevelInfoItems").
[7802]58
59    @author
60        Fabian 'x3n' Landau
61
62    @author
63        Damian 'Mozork' Frick
[7804]64
65    @ingroup Orxonox
[7802]66    */
[2171]67    class _OrxonoxExport LevelManager
[3280]68    // tolua_end
[3370]69        : public Singleton<LevelManager>, public OrxonoxClass
[3280]70    { // tolua_export
[3370]71            friend class Singleton<LevelManager>;
[2072]72        public:
73            LevelManager();
74            virtual ~LevelManager();
75
[7802]76            void setConfigValues(); //!< Set the config values for this object.
[3280]77
[7802]78            void requestActivity(Level* level); //!< Request activity for the input Level.
79            void releaseActivity(Level* level); //!< Release activity for the input Level.
80            Level* getActiveLevel(); //!< Get the currently active Level.
[2072]81
[7802]82            // tolua_begin
83            void setDefaultLevel(const std::string& levelName); //!< Set the default Level.
84            /**
85            @brief Get the default level.
86            @return Returns the filename of the default level.
87            */
88            const std::string& getDefaultLevel() const
89                { return defaultLevelName_; }
90            unsigned int getNumberOfLevels(void);
91            LevelInfoItem* getAvailableLevelListItem(unsigned int index); //!< Get the LevelInfoItem at the given index in the list of available Levels.
[3280]92
[7802]93            /**
94            @brief Get the instance of the LevelManager.
95            @return Returns the instance of the LevelManager.
96            */
97            static LevelManager& getInstance()
98                { return Singleton<LevelManager>::getInstance(); }
99            // tolua_end
[2072]100
101        private:
102            LevelManager(const LevelManager&);
103
[7802]104            void activateNextLevel(); //!< Activate the next level.
[2072]105
[7802]106            void compileAvailableLevelList(void); //!< Compile the list of available Levels.
107            void updateAvailableLevelList(void); //!< Update the list of available Levels.
[7648]108
[7802]109            std::list<Level*> levels_; //!< A list of all the Levels whose activity has been requested, in the order in which they will become active.
110            std::set<LevelInfoItem*, LevelInfoCompare> availableLevels_; //!< The set of available Levels sorted alphabetically according to the name of the Level.
[3196]111
[7802]112            // Helpers to allow fast access to the availableLevels list.
113            unsigned int nextIndex_; //! The next expected index to be accessed.
[8037]114            std::set<LevelInfoItem*, LevelInfoCompare>::iterator nextLevel_; //! The next expected Level to be accessed.
[7802]115
[3280]116            // config values
117            std::string defaultLevelName_;
118
[3370]119            static LevelManager* singletonPtr_s;
[3280]120    }; // tolua_export
121} // tolua_export
[2072]122
123#endif /* _LevelManager_H__ */
Note: See TracBrowser for help on using the repository browser.