Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/spaceboundaries2/src/libraries/core/GUIManager.h @ 8526

Last change on this file since 8526 was 8423, checked in by rgrieder, 14 years ago

Added and incorporated new class DestructionHelper: instead of doing the destruction of certain singletons implicitly via scoped_ptrs and ScopeGuards, use a method named destroy() that essentially achieves the same, but makes the destruction sequence obvious.

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