Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

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

Merged presentation3 branch into trunk.

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