Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/core/GraphicsManager.h @ 7401

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

merged doc branch back to trunk

  • Property svn:eol-style set to native
File size: 4.4 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 <beni_at_orxonox.net>, (C) 2007
25 *   Co-authors:
26 *      Felix Schulthess
27 *
28 */
29
30/**
31    @defgroup Graphics Graphics and GUI
32    @ingroup Core
33*/
34
35/**
36@file
37@ingroup Graphics
38@brief
39    Declaration of GraphicsManager Singleton.
40 */
41
42#ifndef _GraphicsManager_H__
43#define _GraphicsManager_H__
44
45#include "CorePrereqs.h"
46
47#include <cassert>
48#include <string>
49#include <OgreLog.h>
50#include <boost/scoped_ptr.hpp>
51#include <boost/shared_ptr.hpp>
52
53#include "util/Singleton.h"
54#include "OrxonoxClass.h"
55
56namespace orxonox
57{
58    /**
59    @brief
60        Graphics engine manager class
61    */
62    class _CoreExport GraphicsManager : public Singleton<GraphicsManager>, public OrxonoxClass, public Ogre::LogListener
63    {
64        friend class Singleton<GraphicsManager>;
65    public:
66        GraphicsManager(bool bLoadRenderer = true);
67        ~GraphicsManager();
68
69        void setConfigValues();
70
71        void postUpdate(const Clock& time);
72
73        Ogre::Viewport* getViewport()         { return this->viewport_; }
74        Ogre::RenderWindow* getRenderWindow() { return this->renderWindow_; }
75        size_t getRenderWindowHandle();
76        bool isFullScreen() const;
77
78        void upgradeToGraphics();
79        void loadDebugOverlay();
80        bool rendererLoaded() const { return renderWindow_ != NULL; }
81
82        void setCamera(Ogre::Camera* camera);
83
84    private:
85        GraphicsManager(GraphicsManager&); // don't mess with singletons
86
87        // OGRE initialisation
88        void loadOgreRoot();
89        void loadOgrePlugins();
90        void loadRenderer();
91
92        // event from Ogre::LogListener
93        void messageLogged(const std::string& message, Ogre::LogMessageLevel lml,
94            bool maskDebug, const std::string& logName);
95
96        // console commands
97        void printScreen();
98
99        scoped_ptr<OgreWindowEventListener> ogreWindowEventListener_; //!< Pimpl to hide OgreWindowUtilities.h
100#if OGRE_VERSION < 0x010600
101        scoped_ptr<MemoryArchiveFactory>    memoryArchiveFactory_;    //!< Stores the modified particle scripts
102#endif
103        scoped_ptr<Ogre::LogManager>        ogreLogger_;
104        scoped_ptr<Ogre::Root>              ogreRoot_;                //!< Ogre's root
105        Ogre::RenderWindow* renderWindow_;             //!< the one and only render window
106        Ogre::Viewport*     viewport_;                 //!< default full size viewport
107
108        // XML files for the resources and the debug overlay
109        shared_ptr<XMLFile> resources_;                //!< XML with resource locations
110        shared_ptr<XMLFile> extResources_;             //!< XML with resource locations in the external path (only for dev runs)
111        shared_ptr<XMLFile> debugOverlay_;             //!< XML with various debug overlays
112
113        // config values
114        std::string         ogreConfigFile_;           //!< ogre config filename
115        std::string         ogrePluginsDirectory_;     //!< Directory where the Ogre plugins are located
116        std::string         ogrePlugins_;              //!< Comma separated list of all plugins to load
117        std::string         ogreLogFile_;              //!< log filename for Ogre log messages
118        int                 ogreLogLevelTrivial_;      //!< Corresponding Orxonox debug level for LL_TRIVIAL
119        int                 ogreLogLevelNormal_;       //!< Corresponding Orxonox debug level for LL_NORMAL
120        int                 ogreLogLevelCritical_;     //!< Corresponding Orxonox debug level for LL_CRITICAL
121
122        static GraphicsManager* singletonPtr_s;        //!< Pointer to the Singleton
123    };
124}
125
126#endif /* _GraphicsManager_H__ */
Note: See TracBrowser for help on using the repository browser.