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 | @brief |
---|
33 | Declaration of the GUIManager class. |
---|
34 | */ |
---|
35 | |
---|
36 | #ifndef _GUIManager_H__ |
---|
37 | #define _GUIManager_H__ |
---|
38 | |
---|
39 | #include "CorePrereqs.h" |
---|
40 | |
---|
41 | #include <map> |
---|
42 | #include <string> |
---|
43 | #include <CEGUIForwardRefs.h> |
---|
44 | #include <boost/scoped_ptr.hpp> |
---|
45 | |
---|
46 | #include "util/OgreForwardRefs.h" |
---|
47 | #include "input/InputHandler.h" |
---|
48 | |
---|
49 | namespace orxonox |
---|
50 | { |
---|
51 | /** |
---|
52 | @class GUIManager |
---|
53 | @brief |
---|
54 | Provides a simple interface to CEGUI with tolua methods and console commands. It also acts as a key and mouse handler. |
---|
55 | |
---|
56 | The GUIManager is a singleton and can be called anywhere when access on the GUI is needed. |
---|
57 | Creation of the GUIManager is therefore not possible and the cunstructor is private. |
---|
58 | |
---|
59 | Since the GUI needs user input, the GUIManager implements the functions needed to act as a key and/or mouse handler. |
---|
60 | Those input events are then injected into CEGUI in Lua. |
---|
61 | */ |
---|
62 | class _CoreExport GUIManager : public InputHandler |
---|
63 | { |
---|
64 | public: |
---|
65 | GUIManager(Ogre::RenderWindow* renderWindow); |
---|
66 | ~GUIManager(); |
---|
67 | |
---|
68 | void update(const Clock& time); |
---|
69 | |
---|
70 | void showGUI(const std::string& name); |
---|
71 | void executeCode(const std::string& str); |
---|
72 | |
---|
73 | void setCamera(Ogre::Camera* camera); |
---|
74 | |
---|
75 | static GUIManager& getInstance() { assert(singletonRef_s); return *singletonRef_s; } |
---|
76 | static GUIManager* getInstancePtr() { return singletonRef_s; } |
---|
77 | |
---|
78 | private: |
---|
79 | GUIManager(const GUIManager& instance); //!< private and undefined copy c'tor (this is a singleton class) |
---|
80 | |
---|
81 | void loadLuaCode(); |
---|
82 | |
---|
83 | // keyHandler functions |
---|
84 | void keyPressed (const KeyEvent& evt); |
---|
85 | void keyReleased(const KeyEvent& evt); |
---|
86 | |
---|
87 | // mouseHandler functions |
---|
88 | void buttonPressed (MouseButtonCode::ByEnum id); |
---|
89 | void buttonReleased(MouseButtonCode::ByEnum id); |
---|
90 | void mouseMoved (IntVector2 abs, IntVector2 rel, IntVector2 clippingSize); |
---|
91 | void mouseScrolled (int abs, int rel); |
---|
92 | |
---|
93 | boost::scoped_ptr<CEGUI::OgreCEGUIRenderer> guiRenderer_; //!< CEGUI's interface to the Ogre Engine |
---|
94 | boost::scoped_ptr<CEGUI::LuaScriptModule> scriptModule_; //!< CEGUI's script module to use Lua |
---|
95 | boost::scoped_ptr<CEGUI::System> guiSystem_; //!< CEGUI's main system |
---|
96 | Ogre::RenderWindow* renderWindow_; //!< Ogre's render window to give CEGUI access to it |
---|
97 | CEGUI::ResourceProvider* resourceProvider_; //!< CEGUI's resource provider |
---|
98 | CEGUI::Logger* ceguiLogger_; //!< CEGUI's logger to be able to log CEGUI errors in our log |
---|
99 | lua_State* luaState_; //!< Lua state, access point to the Lua engine |
---|
100 | |
---|
101 | static GUIManager* singletonRef_s; //!< Singleton reference to GUIManager |
---|
102 | |
---|
103 | }; |
---|
104 | } |
---|
105 | |
---|
106 | #endif /* _GUIManager_H__ */ |
---|