Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/gui/src/orxonox/gamestates/GSGraphics.h @ 2968

Last change on this file since 2968 was 2875, checked in by bknecht, 16 years ago

(Doxygen) Documentation added for GUIManager and some GameState classes.

  • Property svn:eol-style set to native
File size: 2.5 KB
RevLine 
[1661]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 *   Co-authors:
[2875]25 *      Benjamin Knecht (documentation)
[1661]26 *
27 */
28
[2875]29 /**
30    @file
31    @brief Declaration of the Graphics GameState class.
32  */
33
[1661]34#ifndef _GSGraphics_H__
35#define _GSGraphics_H__
36
37#include "OrxonoxPrereqs.h"
38#include "core/GameState.h"
[2801]39#include "tools/WindowEventListener.h"
[1661]40
41namespace orxonox
42{
[2875]43    /**
44    @class GSGraphics
45    @brief
46        Game state used when displaying graphics of any kind
47
48        This game state is only left out if we start a dedicated server where no graphics are present.
49    */
[2817]50    class _OrxonoxExport GSGraphics : public GameState, public WindowEventListener
[1661]51    {
52    public:
[2844]53        GSGraphics(const std::string& name);
[1661]54        ~GSGraphics();
[2844]55        void setConfigValues();
[1661]56
[2844]57        void activate();
58        void deactivate();
59        void update(const Clock& time);
[1661]60
[2869]61        void toggleGUI();
62
[2844]63    private:
[2801]64        // Window events from WindowEventListener
65        void windowResized(unsigned int newWidth, unsigned int newHeight);
66        void windowFocusChanged();
[1686]67
68        // managed singletons
[2875]69        InputManager*         inputManager_;        //!< Reference to input management
[1661]70        InGameConsole*        console_;
[2875]71        GUIManager*           guiManager_;          //!< Interface to GUI
72        GraphicsManager*      graphicsManager_;     //!< Interface to Ogre
[1672]73
[2875]74        KeyBinder*            masterKeyBinder_;     //!< Key binder for master key bindings
75        SimpleInputState*     masterInputState_;    //!< Special input state for master input
[2087]76        XMLFile*              debugOverlay_;
[2875]77        ConsoleCommand*       ccToggleGUI_;         //!< Console command to toggle GUI
[1661]78    };
79}
80
81#endif /* _GSGraphics_H__ */
Note: See TracBrowser for help on using the repository browser.