Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/resource2/src/core/GUIManager.h @ 3594

Last change on this file since 3594 was 3370, checked in by rgrieder, 15 years ago

Merged resource branch back to the trunk. Changes:

  • Automated graphics loading by evaluating whether a GameState requires it
  • Using native Tcl library (x3n)

Windows users: Update your dependency package!

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