Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/sound5/src/orxonox/MoodManager.h @ 7687

Last change on this file since 7687 was 6767, checked in by youngk, 15 years ago

Added descriptions and missing documentation to the classes I edited last semester. Thanks!

  • Property svn:eol-style set to native
File size: 2.7 KB
RevLine 
[6119]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 *      Kevin 'youngk' Young
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29#ifndef _MoodManager_H__
30#define _MoodManager_H__
31
32#include "OrxonoxPrereqs.h"
33
34#include <string>
35#include "util/Singleton.h"
36#include "core/OrxonoxClass.h"
37
38namespace orxonox
39{
[6767]40    /**
41     * The MoodManager class enables the game to set different themes, i.e. audio themes, each
42     * with a set of different audio files. A theme (called mood) is set by the server and applies to
43     * all clients. Existing moods are currently hard-coded in function checkMoodValidity(). Each mood
44     * needs to have a folder with its name in "data_extern/audo/ambient/" containing sound files named like
45     * the ones in mood "default".
46     */
[6406]47    class _OrxonoxExport MoodListener : virtual public OrxonoxClass
48    {
49        friend class MoodManager;
50
51        protected:
52            MoodListener();
53            virtual ~MoodListener() {}
54
55            const std::string& getMood() const { return mood_s; }
56
57        private:
58            virtual void moodChanged(const std::string& mood) = 0;
59
60            static void changedMood(const std::string& mood);
61            static std::string mood_s;
62    };
63
64    class _OrxonoxExport MoodManager : public Singleton<MoodManager>, public OrxonoxClass
65    {
[6119]66            friend class Singleton<MoodManager>;
67        public:
68            MoodManager();
69
70            void setConfigValues();
71
72            void setMood(const std::string& mood);
[6406]73            inline const std::string& getMood() const { return this->mood_; }
[6119]74
[6406]75            static MoodManager& getInstance() { return Singleton<MoodManager>::getInstance(); }
[6119]76
77        private:
[6406]78            ~MoodManager() {}
[6370]79            void checkMoodValidity();
[6119]80
81            // config values
82            std::string mood_;
83
84            static MoodManager* singletonPtr_s;
[6406]85    };
86}
[6119]87
88#endif /* _MoodManager_H__ */
Note: See TracBrowser for help on using the repository browser.