source: code/branches/gui/src/orxonox/GraphicsEngine.h @ 1642

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   This program is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU General Public License
 *   as published by the Free Software Foundation; either version 2
 *   of the License, or (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Reto Grieder
 *      Benjamin Knecht <beni_at_orxonox.net>, (C) 2007
 *   Co-authors:
 *      Felix Schulthess
 *
 */

/**
  @file
  @brief Declaration of GraphicsEngine Singleton.
  @author Benjamin Knecht <beni_at_orxonox.net>
 */

#ifndef _GraphicsEngine_H__
#define _GraphicsEngine_H__

#include "OrxonoxPrereqs.h"

#include <string>

#include <OgrePrerequisites.h>
#include <OgreLog.h>
#include <OgreRenderWindow.h>
#include <OgreWindowEventUtilities.h>
#include "core/OrxonoxClass.h"


namespace orxonox
{
    /**
    @brief Graphics engine manager class
    */
    class _OrxonoxExport GraphicsEngine : public Ogre::WindowEventListener, public Ogre::LogListener, public OrxonoxClass
    {
    public:
        GraphicsEngine();
        ~GraphicsEngine();

        void setConfigValues();
        void setup();
        void declareRessourceLocations();
        bool loadRenderer();
        bool initialiseResources();
        bool createNewScene();

        void setLevelSceneManager(Ogre::SceneManager* sceneMgr) { this->levelSceneManager_ = sceneMgr; }
        Ogre::SceneManager* getLevelSceneManager() { return levelSceneManager_; }

        Ogre::Viewport* getViewport() { return this->viewport_; }

        // several window properties
        Ogre::RenderWindow* getRenderWindow() { return this->renderWindow_; }
        size_t getWindowHandle();
        int getWindowWidth() const;
        int getWindowHeight() const;
        float getWindowAspectRatio() const;
        float getAverageFramesPerSecond() const   { return this->avgFramesPerSecond_; }
        float getAverageTickTime() const          { return this->avgTickTime_; }
        void setAverageTickTime(float tickTime)   { this->avgTickTime_ = tickTime; }
        void setAverageFramesPerSecond(float fps) { this->avgFramesPerSecond_ = fps; }

        void setWindowActivity(bool activity)
        { if (this->renderWindow_) this->renderWindow_->setActive(activity); }

        inline unsigned int getDetailLevelParticle() const
        { return this->detailLevelParticle_; }

        static GraphicsEngine& getSingleton();
        static GraphicsEngine* getSingletonPtr() { return singletonRef_s; }

    private:
        // don't mess with singletons
        GraphicsEngine(GraphicsEngine&) { }

        //! Method called by the LogListener from Ogre
        void messageLogged(const std::string&, Ogre::LogMessageLevel,
            bool, const std::string&);

        // window events from Ogre::WindowEventListener
        void windowMoved       (Ogre::RenderWindow* rw);
        void windowResized     (Ogre::RenderWindow* rw);
        void windowFocusChanged(Ogre::RenderWindow* rw);
        void windowClosed      (Ogre::RenderWindow* rw);

        Ogre::Root*         root_;                  //!< Ogre's root
        Ogre::RenderWindow* renderWindow_;          //!< the current render window
        Ogre::SceneManager* levelSceneManager_;     //!< scene manager of the game
        Ogre::Viewport*     viewport_;              //!< default full size viewport

        // stats
        float               avgTickTime_;           //!< time in ms to tick() one frame
        float               avgFramesPerSecond_;    //!< number of frames processed in one second

        // config values
        std::string         resourceFile_;          //!< resources file name
        std::string         ogreConfigFile_;        //!< ogre config file name
        std::string         ogrePluginsFile_;       //!< ogre plugins file name
        std::string         ogreLogFile_;           //!< log file name for Ogre log messages
        int                 ogreLogLevelTrivial_;   //!< Corresponding Orxonx debug level for LL_TRIVIAL
        int                 ogreLogLevelNormal_;    //!< Corresponding Orxonx debug level for LL_NORMAL
        int                 ogreLogLevelCritical_;  //!< Corresponding Orxonx debug level for LL_CRITICAL
        unsigned int        detailLevelParticle_;   //!< Detail level of particle effects (0: off, 1: low, 2: normal, 3: high)

        static GraphicsEngine* singletonRef_s;      //!< Pointer to the Singleton
    };
}

#endif /* _GraphicsEngine_H__ */