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

/*
 *   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
 *
 */

/**
    @defgroup Graphics Graphics and GUI
    @ingroup Core
*/

/**
@file
@ingroup Graphics
@brief
    Declaration of GraphicsManager Singleton.
 */

#ifndef _GraphicsManager_H__
#define _GraphicsManager_H__

#include "CorePrereqs.h"

#include <cassert>
#include <string>
#include <memory>

#include <OgreLog.h>

#include "util/DestructionHelper.h"
#include "util/OgreForwardRefs.h"
#include "util/Singleton.h"
#include "config/Configurable.h"

// tolua_begin
namespace orxonox
{
    /**
    @brief
        Graphics engine manager class
    */
    class _CoreExport GraphicsManager
// tolua_end
        : public Singleton<GraphicsManager>, public Configurable, public Ogre::LogListener
    { // tolua_export
        friend class Singleton<GraphicsManager>;
    public:
        GraphicsManager(bool bLoadRenderer = true);

        //! Leave empty and use cleanup() instead
        ~GraphicsManager() = default;
        /// Destructor that also executes when object fails to construct
        void destroy();

        void setConfigValues();

        void postUpdate(const Clock& time);

        Ogre::Viewport* getViewport()           { return this->viewport_; }
        Ogre::RenderWindow* getRenderWindow()   { return this->renderWindow_; }
        Ogre::OverlaySystem* getOverlaySystem() { return this->overlaySystem_; }
        size_t getRenderWindowHandle();

// tolua_begin
        static GraphicsManager& getInstance() { return Singleton<GraphicsManager>::getInstance(); } // tolua_export

        bool isFullScreen() const;
        unsigned int getWindowWidth() const;
        unsigned int getWindowHeight() const;

        bool hasVSyncEnabled() const;
        std::string getFSAAMode() const;
// tolua_end

        void upgradeToGraphics();
        void loadDebugOverlay();
        void unloadDebugOverlay();
        bool rendererLoaded() const { return renderWindow_ != nullptr; }

        void setCamera(Ogre::Camera* camera);

    private:
        // non-copyable:
        GraphicsManager(const GraphicsManager&) = delete;
        GraphicsManager& operator=(const GraphicsManager&) = delete;

        // OGRE initialisation
        void loadOgreRoot();
        void loadOgrePlugins();
        void loadRenderer();

        // event from Ogre::LogListener
#if OGRE_VERSION >= 0x010800
        virtual void messageLogged(const std::string& message, Ogre::LogMessageLevel lml, bool maskDebug, const std::string& logName, bool& skipThisMessage) override;
#else
        virtual void messageLogged(const std::string& message, Ogre::LogMessageLevel lml, bool maskDebug, const std::string& logName) override;
#endif

        // console commands
        void printScreen();
        std::string setScreenResolution(unsigned int width, unsigned int height, bool fullscreen);
        std::string setFSAA(const std::string& mode);
        std::string setVSync(bool vsync);

        OgreWindowEventListener* ogreWindowEventListener_; //!< Pimpl to hide OgreWindowUtilities.h
        Ogre::LogManager*        ogreLogger_;
        Ogre::Root*              ogreRoot_;                //!< Ogre's root
        Ogre::RenderWindow*      renderWindow_;            //!< the one and only render window
        Ogre::Viewport*          viewport_;                //!< default full size viewport
        Ogre::OverlaySystem*     overlaySystem_;
        GlowMaterialListener*    glowMaterialListener_;    //!< Material Listener for the 'Glow' compositor
        float                    lastFrameStartTime_;      //!< Time stamp of the beginning of the last frame
        float                    lastFrameEndTime_;        //!< Time stamp of the end of the last frame

        // XML files for the resources and the debug overlay
        std::shared_ptr<XMLFile> resources_;           //!< XML with resource locations
        std::shared_ptr<XMLFile> extResources_;        //!< XML with resource locations in the external path (only for dev runs)
        std::shared_ptr<XMLFile> debugOverlay_;        //!< XML with various debug overlays

        // config values
        std::string         ogreConfigFile_;           //!< ogre config filename
        std::string         ogrePlugins_;              //!< Comma separated list of all plugins to load
        std::string         ogreLogFile_;              //!< log filename for Ogre log messages

        /// Helper object that executes the surrogate destructor destroy()
        DestructionHelper<GraphicsManager> destructionHelper_;

        static GraphicsManager* singletonPtr_s;        //!< Pointer to the Singleton
// tolua_begin
    };
}
// tolua_end

#endif /* _GraphicsManager_H__ */