Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/kicklib/src/libraries/core/GUIManager.h @ 8166

Last change on this file since 8166 was 7971, checked in by rgrieder, 14 years ago

Fixed GUITools.lua for good: both CECGUI 0.6 and 0.7 seem to work. At least I haven't noticed any bogus behaviour in the Credits or in the Quest sheet.

  • Property svn:eol-style set to native
File size: 7.6 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 <CEGUIVersion.h>
45#include <boost/shared_ptr.hpp>
46#include <loki/ScopeGuard.h>
47
48#include "util/OgreForwardRefs.h"
49#include "util/TriBool.h"
50#include "util/Singleton.h"
51#include "input/InputHandler.h"
52#include "OrxonoxClass.h"
53#include "WindowEventListener.h"
54
55// Tolua includes (have to be relative to the current directory)
56/*
57$cfile "../util/TriBool.h" // tolua_export
58*/
59
60#if CEGUI_VERSION_MAJOR < 1 && CEGUI_VERSION_MINOR < 7
61#  define ORXONOX_OLD_CEGUI
62#endif
63
64namespace orxonox // tolua_export
65{ // tolua_export
66    class PlayerInfo; // Forward declaration
67
68    /**
69    @class GUIManager
70    @brief
71        Provides a simple interface to CEGUI with tolua methods and console commands. It also acts as a key and mouse handler.
72
73        The GUIManager is a singleton and can be called anywhere when access on the GUI is needed.
74
75        Since the GUI needs user input, the GUIManager implements the functions needed to act as a key and/or mouse handler.
76        Those input events are then injected into CEGUI in Lua.
77    */
78    class _CoreExport GUIManager // tolua_export
79        : public Singleton<GUIManager>, public InputHandler, public WindowEventListener
80    { // tolua_export
81        friend class Singleton<GUIManager>;
82    public:
83        GUIManager(const std::pair<int, int>& mousePosition);
84        //! Leave empty and use cleanup() instead
85        ~GUIManager() {}
86
87        void setConfigValues(void);
88        void changedGUIScheme(void);
89
90        void preUpdate(const Clock& time);
91
92        void loadGUI(const std::string& name);
93        static void showGUI(const std::string& name, bool bHidePrevious = false, bool bNoInput = false);
94        void showGUIExtra(const std::string& name, const std::string& ptr, bool bHidePrevious = false, bool bNoInput = false);
95        static void hideGUI(const std::string& name);
96        void keyESC();
97        void setBackgroundImage(const std::string& imageSet, const std::string imageName); // tolua_export
98        void setBackgroundImage(const std::string& image);
99
100        //! Creates a new InputState to be used with a GUI Sheet
101        const std::string& createInputState(const std::string& name, TriBool::Value showCursor = TriBool::True, TriBool::Value useKeyboard = TriBool::True, bool bBlockJoyStick = false); // tolua_export
102        LuaState* getLuaState(void)
103            { return this->luaState_; }
104
105        //! Returns the root window for all menu sheets
106        CEGUI::Window* getMenuRootWindow() { return this->menuRootWindow_; } // tolua_export
107        //! Returns the root window for all HUD sheets
108        CEGUI::Window* getHUDRootWindow() { return this->hudRootWindow_; } // tolua_export
109
110        void setCamera(Ogre::Camera* camera);
111        Ogre::Camera* getCamera() { return this->camera_; }
112
113        inline void setPlayer(const std::string& guiname, PlayerInfo* player)
114            { this->players_[guiname] = player; }
115        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
116
117        // TODO: Temporary hack because the tolua exported CEGUI method does not seem to work
118        static void subscribeEventHelper(CEGUI::Window* window, const std::string& event, const std::string& function); //tolua_export
119        static void setTooltipTextHelper(CEGUI::ListboxItem* item, const std::string& toooltip); //tolua_export
120        static void setItemTooltipsEnabledHelper(CEGUI::Listbox* listbox, bool enabled); //tolua_export
121
122        static GUIManager& getInstance() { return Singleton<GUIManager>::getInstance(); } // tolua_export
123
124    private:
125        GUIManager(const GUIManager& instance); //!< private and undefined copy c'tor (this is a singleton class)
126
127        /// Destructor that also executes when object fails to construct
128        void cleanup();
129
130        void executeCode(const std::string& str);
131
132        template <typename FunctionType>
133        bool protectedCall(FunctionType function);
134
135        // keyHandler functions
136        void buttonPressed (const KeyEvent& evt);
137        void buttonReleased(const KeyEvent& evt);
138
139        // mouseHandler functions
140        void buttonPressed (MouseButtonCode::ByEnum id);
141        void buttonReleased(MouseButtonCode::ByEnum id);
142        void mouseMoved    (IntVector2 abs, IntVector2 rel, IntVector2 clippingSize);
143        void mouseScrolled (int abs, int rel);
144        void mouseLeft     ();
145
146        // window event handler
147        virtual void windowResized(unsigned int newWidth, unsigned int newHeight);
148        virtual void windowFocusChanged(bool bFocus);
149
150        /// Surrogate for the destructor
151        Loki::ObjScopeGuardImpl0<GUIManager, void (GUIManager::*)()> destroyer_;
152
153#ifdef ORXONOX_OLD_CEGUI
154        CEGUI::OgreCEGUIRenderer*            guiRenderer_;      //!< CEGUI's interface to the Ogre Engine
155        CEGUI::ResourceProvider*             resourceProvider_; //!< CEGUI's resource provider
156#else
157        CEGUI::OgreRenderer*                 guiRenderer_;      //!< CEGUI's interface to the Ogre Engine
158        CEGUI::OgreResourceProvider*         resourceProvider_; //!< CEGUI's resource provider
159        CEGUI::OgreImageCodec*               imageCodec_;
160#endif
161        LuaState*                            luaState_;         //!< LuaState, access point to the Lua engine
162        CEGUI::LuaScriptModule*              scriptModule_;     //!< CEGUI's script module to use Lua
163        CEGUI::System*                       guiSystem_;        //!< CEGUI's main system
164        shared_ptr<ResourceInfo>             rootFileInfo_;     //!< Resource information about the root script
165        CEGUI::Logger*                       ceguiLogger_;      //!< CEGUI's logger to be able to log CEGUI errors in our log
166        CEGUI::Window*                       rootWindow_;       //!< Root node for all windows
167        CEGUI::Window*                       hudRootWindow_;    //!< Root node for the HUD sheets
168        CEGUI::Window*                       menuRootWindow_;   //!< Root node for the menu sheets (used by Lua)
169        std::map<std::string, PlayerInfo*>   players_;          //!< Stores the player (owner) for each GUI
170        Ogre::Camera*                        camera_;           //!< Camera used to render the scene with the GUI
171
172        static GUIManager*                   singletonPtr_s;    //!< Singleton reference to GUIManager
173
174        // The used CEGUI scheme.
175        static const std::string defaultScheme_;
176        std::string guiScheme_;
177
178    }; // tolua_export
179} // tolua_export
180
181#endif /* _GUIManager_H__ */
Note: See TracBrowser for help on using the repository browser.