Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/tutoriallevel/src/libraries/core/GUIManager.h @ 8748

Last change on this file since 8748 was 7894, checked in by dafrick, 14 years ago

Some extension of NotificationQueue, font size and color can now be specified.

  • Property svn:eol-style set to native
File size: 6.9 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 *      Reto Grieder
24 *      Benjamin Knecht
25 *   Co-authors:
26 *      ...
27 *
28 */
29
30/**
31    @file
32    @ingroup Graphics
33*/
34
35#ifndef _GUIManager_H__
36#define _GUIManager_H__
37
38#include "CorePrereqs.h"
39
40#include <map>
41#include <set>
42#include <string>
43#include <CEGUIForwardRefs.h>
44#include <boost/scoped_ptr.hpp>
45#include <boost/shared_ptr.hpp>
46
47#include "util/OgreForwardRefs.h"
48#include "util/TriBool.h"
49#include "util/Singleton.h"
50#include "input/InputHandler.h"
51#include "OrxonoxClass.h"
52
53// Tolua includes (have to be relative to the current directory)
54/*
55$cfile "../util/TriBool.h" // tolua_export
56*/
57
58namespace orxonox // tolua_export
59{ // tolua_export
60    class PlayerInfo; // Forward declaration
61
62    /**
63    @class GUIManager
64    @brief
65        Provides a simple interface to CEGUI with tolua methods and console commands. It also acts as a key and mouse handler.
66
67        The GUIManager is a singleton and can be called anywhere when access on the GUI is needed.
68
69        Since the GUI needs user input, the GUIManager implements the functions needed to act as a key and/or mouse handler.
70        Those input events are then injected into CEGUI in Lua.
71    */
72    class _CoreExport GUIManager // tolua_export
73        : public Singleton<GUIManager>, public InputHandler, public OrxonoxClass
74    { // tolua_export
75        friend class Singleton<GUIManager>;
76    public:
77        GUIManager(const std::pair<int, int>& mousePosition);
78        ~GUIManager();
79
80        void setConfigValues(void);
81        void changedGUIScheme(void);
82
83        void preUpdate(const Clock& time);
84
85        void loadGUI(const std::string& name);
86        static void showGUI(const std::string& name, bool bHidePrevious = false, bool bNoInput = false);
87        void showGUIExtra(const std::string& name, const std::string& ptr, bool bHidePrevious = false, bool bNoInput = false);
88        static void hideGUI(const std::string& name);
89        void keyESC();
90        void setBackgroundImage(const std::string& imageSet, const std::string imageName); // tolua_export
91        void setBackgroundImage(const std::string& image);
92
93        //! Creates a new InputState to be used with a GUI Sheet
94        const std::string& createInputState(const std::string& name, TriBool::Value showCursor = TriBool::True, TriBool::Value useKeyboard = TriBool::True, bool bBlockJoyStick = false); // tolua_export
95        LuaState* getLuaState(void)
96            { return this->luaState_.get(); }
97
98        //! Returns the root window for all menu sheets
99        CEGUI::Window* getMenuRootWindow() { return this->menuRootWindow_; } // tolua_export
100        //! Returns the root window for all HUD sheets
101        CEGUI::Window* getHUDRootWindow() { return this->hudRootWindow_; } // tolua_export
102
103        void setCamera(Ogre::Camera* camera);
104        Ogre::Camera* getCamera() { return this->camera_; }
105
106        inline void setPlayer(const std::string& guiname, PlayerInfo* player)
107            { this->players_[guiname] = player; }
108        inline orxonox::PlayerInfo* getPlayer(const std::string& guiname) const { std::map<std::string, PlayerInfo*>::const_iterator it = this->players_.find(guiname); return (it != this->players_.end()) ? it->second : 0; } // tolua_export
109
110        // TODO: Temporary hack because the tolua exported CEGUI method does not seem to work
111        static void subscribeEventHelper(CEGUI::Window* window, const std::string& event, const std::string& function); // tolua_export
112        static void setTooltipTextHelper(CEGUI::ListboxItem* item, const std::string& toooltip); // tolua_export
113        static void setItemTooltipsEnabledHelper(CEGUI::Listbox* listbox, bool enabled); // tolua_export
114        static void addFontHelper(const std::string& name, int size, const std::string& fontName); // tolua_export
115
116        static GUIManager& getInstance() { return Singleton<GUIManager>::getInstance(); } // tolua_export
117
118    private:
119        GUIManager(const GUIManager& instance); //!< private and undefined copy c'tor (this is a singleton class)
120        void executeCode(const std::string& str);
121
122        template <typename FunctionType>
123        bool protectedCall(FunctionType function);
124
125        // keyHandler functions
126        void buttonPressed (const KeyEvent& evt);
127        void buttonReleased(const KeyEvent& evt);
128
129        // mouseHandler functions
130        void buttonPressed (MouseButtonCode::ByEnum id);
131        void buttonReleased(MouseButtonCode::ByEnum id);
132        void mouseMoved    (IntVector2 abs, IntVector2 rel, IntVector2 clippingSize);
133        void mouseScrolled (int abs, int rel);
134
135        scoped_ptr<CEGUI::OgreCEGUIRenderer> guiRenderer_;      //!< CEGUI's interface to the Ogre Engine
136        scoped_ptr<LuaState>                 luaState_;         //!< LuaState, access point to the Lua engine
137        scoped_ptr<CEGUI::LuaScriptModule>   scriptModule_;     //!< CEGUI's script module to use Lua
138        scoped_ptr<CEGUI::System>            guiSystem_;        //!< CEGUI's main system
139        shared_ptr<ResourceInfo>             rootFileInfo_;     //!< Resource information about the root script
140        CEGUI::ResourceProvider*             resourceProvider_; //!< CEGUI's resource provider
141        CEGUI::Logger*                       ceguiLogger_;      //!< CEGUI's logger to be able to log CEGUI errors in our log
142        CEGUI::Window*                       rootWindow_;       //!< Root node for all windows
143        CEGUI::Window*                       hudRootWindow_;    //!< Root node for the HUD sheets
144        CEGUI::Window*                       menuRootWindow_;   //!< Root node for the menu sheets (used by Lua)
145        std::map<std::string, PlayerInfo*>   players_;          //!< Stores the player (owner) for each GUI
146        Ogre::Camera*                        camera_;           //!< Camera used to render the scene with the GUI
147
148        static GUIManager*                   singletonPtr_s;    //!< Singleton reference to GUIManager
149
150        // The used CEGUI scheme.
151        static const std::string defaultScheme_;
152        std::string guiScheme_;
153
154    }; // tolua_export
155} // tolua_export
156
157#endif /* _GUIManager_H__ */
Note: See TracBrowser for help on using the repository browser.