Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/core/GUIManager.h @ 7940

Last change on this file since 7940 was 7874, checked in by landauf, 14 years ago

WindowEventListener now declares if the window's focus is active or not.
CEGUI stops highlighting menu items if the window's focus is lost, i.e. after pressing alt+tab

  • Property svn:eol-style set to native
File size: 7.0 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#include "WindowEventListener.h"
53
54// Tolua includes (have to be relative to the current directory)
55/*
56$cfile "../util/TriBool.h" // tolua_export
57*/
58
59namespace orxonox // tolua_export
60{ // tolua_export
61    class PlayerInfo; // Forward declaration
62
63    /**
64    @class GUIManager
65    @brief
66        Provides a simple interface to CEGUI with tolua methods and console commands. It also acts as a key and mouse handler.
67
68        The GUIManager is a singleton and can be called anywhere when access on the GUI is needed.
69
70        Since the GUI needs user input, the GUIManager implements the functions needed to act as a key and/or mouse handler.
71        Those input events are then injected into CEGUI in Lua.
72    */
73    class _CoreExport GUIManager // tolua_export
74        : public Singleton<GUIManager>, public InputHandler, public WindowEventListener
75    { // tolua_export
76        friend class Singleton<GUIManager>;
77    public:
78        GUIManager(const std::pair<int, int>& mousePosition);
79        ~GUIManager();
80
81        void setConfigValues(void);
82        void changedGUIScheme(void);
83
84        void preUpdate(const Clock& time);
85
86        void loadGUI(const std::string& name);
87        static void showGUI(const std::string& name, bool bHidePrevious = false, bool bNoInput = false);
88        void showGUIExtra(const std::string& name, const std::string& ptr, bool bHidePrevious = false, bool bNoInput = false);
89        static void hideGUI(const std::string& name);
90        void keyESC();
91        void setBackgroundImage(const std::string& imageSet, const std::string imageName); // tolua_export
92        void setBackgroundImage(const std::string& image);
93
94        //! Creates a new InputState to be used with a GUI Sheet
95        const std::string& createInputState(const std::string& name, TriBool::Value showCursor = TriBool::True, TriBool::Value useKeyboard = TriBool::True, bool bBlockJoyStick = false); // tolua_export
96        LuaState* getLuaState(void)
97            { return this->luaState_.get(); }
98
99        //! Returns the root window for all menu sheets
100        CEGUI::Window* getMenuRootWindow() { return this->menuRootWindow_; } // tolua_export
101        //! Returns the root window for all HUD sheets
102        CEGUI::Window* getHUDRootWindow() { return this->hudRootWindow_; } // tolua_export
103
104        void setCamera(Ogre::Camera* camera);
105        Ogre::Camera* getCamera() { return this->camera_; }
106
107        inline void setPlayer(const std::string& guiname, PlayerInfo* player)
108            { this->players_[guiname] = player; }
109        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
110
111        // TODO: Temporary hack because the tolua exported CEGUI method does not seem to work
112        static void subscribeEventHelper(CEGUI::Window* window, const std::string& event, const std::string& function); //tolua_export
113        static void setTooltipTextHelper(CEGUI::ListboxItem* item, const std::string& toooltip); //tolua_export
114        static void setItemTooltipsEnabledHelper(CEGUI::Listbox* listbox, bool enabled); //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        void mouseLeft     ();
135
136        // window event handler
137        virtual void windowResized(unsigned int newWidth, unsigned int newHeight);
138        virtual void windowFocusChanged(bool bFocus);
139
140        scoped_ptr<CEGUI::OgreCEGUIRenderer> guiRenderer_;      //!< CEGUI's interface to the Ogre Engine
141        scoped_ptr<LuaState>                 luaState_;         //!< LuaState, access point to the Lua engine
142        scoped_ptr<CEGUI::LuaScriptModule>   scriptModule_;     //!< CEGUI's script module to use Lua
143        scoped_ptr<CEGUI::System>            guiSystem_;        //!< CEGUI's main system
144        shared_ptr<ResourceInfo>             rootFileInfo_;     //!< Resource information about the root script
145        CEGUI::ResourceProvider*             resourceProvider_; //!< CEGUI's resource provider
146        CEGUI::Logger*                       ceguiLogger_;      //!< CEGUI's logger to be able to log CEGUI errors in our log
147        CEGUI::Window*                       rootWindow_;       //!< Root node for all windows
148        CEGUI::Window*                       hudRootWindow_;    //!< Root node for the HUD sheets
149        CEGUI::Window*                       menuRootWindow_;   //!< Root node for the menu sheets (used by Lua)
150        std::map<std::string, PlayerInfo*>   players_;          //!< Stores the player (owner) for each GUI
151        Ogre::Camera*                        camera_;           //!< Camera used to render the scene with the GUI
152
153        static GUIManager*                   singletonPtr_s;    //!< Singleton reference to GUIManager
154
155        // The used CEGUI scheme.
156        static const std::string defaultScheme_;
157        std::string guiScheme_;
158
159    }; // tolua_export
160} // tolua_export
161
162#endif /* _GUIManager_H__ */
Note: See TracBrowser for help on using the repository browser.