FrontendOpenGL.h

Go to the documentation of this file.

/*********************************************************\
 *  File: FrontendOpenGL.h                               *
 *
 *  Copyright (C) 2002-2012 The PixelLight Team (http://www.pixellight.org/)
 *
 *  This file is part of PixelLight.
 *
 *  PixelLight is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  PixelLight 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 Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with PixelLight. If not, see <http://www.gnu.org/licenses/>.
\*********************************************************/


#ifndef __PLCORE_FRONTEND_OPENGL_H__
#define __PLCORE_FRONTEND_OPENGL_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include "PLCore/Frontend/Frontend.h"
#ifdef WIN32
    #include <windows.h>
#endif
#include <GL/gl.h>
#include <GL/glu.h>


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
namespace PLCore {


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    Simple test frontend that uses OpenGL
*
*  @remarks
*    This is a test frontend which uses OpenGL to display a spinning colored
*    rectangle. It can be used easily to test the frontend integration when
*    developing a new backend.
*/
class FrontendOpenGL : public Frontend {


    //[-------------------------------------------------------]
    //[ RTTI interface                                        ]
    //[-------------------------------------------------------]
    pl_class(PLCORE_RTTI_EXPORT, FrontendOpenGL, "PLCore", PLCore::Frontend, "Simple test frontend that uses OpenGL")
        #ifdef PLCORE_EXPORTS   // The following is only required when compiling PLCore
            // Constructors
            pl_constructor_2(ParameterConstructor,  const FrontendContext&, FrontendImpl&,  "Parameter constructor. Frontend context this frontend is using as first parameter, frontend implementation this frontend is using as second parameter.",   "")
        #endif
    pl_class_end


    //[-------------------------------------------------------]
    //[ Public functions                                      ]
    //[-------------------------------------------------------]
    public:
        /**
        *  @brief
        *    Constructor
        *
        *  @param[in] cFrontendContext
        *    Frontend context to use (just shared, the given instance must stay valid as long as this frontend lives)
        *  @param[in] cFrontendImpl
        *    Frontend implementation instance
        */
        PLCORE_API FrontendOpenGL(const FrontendContext &cFrontendContext, FrontendImpl &cFrontendImpl);

        /**
        *  @brief
        *    Destructor
        */
        PLCORE_API virtual ~FrontendOpenGL();


    //[-------------------------------------------------------]
    //[ Public virtual Frontend functions                     ]
    //[-------------------------------------------------------]
    public:
        PLCORE_API virtual bool IsRunning() const override;


    //[-------------------------------------------------------]
    //[ Protected virtual AbstractLifecycle functions         ]
    //[-------------------------------------------------------]
    protected:
        PLCORE_API virtual void OnCreate() override;
        PLCORE_API virtual void OnRestart() override;
        PLCORE_API virtual bool OnStart() override;
        PLCORE_API virtual void OnResume() override;
        PLCORE_API virtual void OnPause() override;
        PLCORE_API virtual void OnStop() override;
        PLCORE_API virtual void OnDestroy() override;


    //[-------------------------------------------------------]
    //[ Protected virtual AbstractFrontend functions          ]
    //[-------------------------------------------------------]
    protected:
        PLCORE_API virtual void OnSize() override;
        PLCORE_API virtual void OnFullscreenMode() override;
        PLCORE_API virtual void OnDraw() override;
        PLCORE_API virtual void OnUpdate() override;
        PLCORE_API virtual void OnDrop(const Container<String> &lstFiles) override;


    //[-------------------------------------------------------]
    //[ Private functions                                     ]
    //[-------------------------------------------------------]
    private:
        /**
        *  @brief
        *    Initialize OpenGL
        */
        void InitGL();

        /**
        *  @brief
        *    Resize GL scene to fit the current window size
        */
        void ResizeGL();

        /**
        *  @brief
        *    Draw scene
        */
        void DrawGL();


    //[-------------------------------------------------------]
    //[ Private data                                          ]
    //[-------------------------------------------------------]
    private:
        // Platform specific
        #ifdef WIN32
            HDC   m_hDC;    /**< Device context, can be a null pointer */
            HGLRC m_hRC;    /**< OpenGL rendering context, can be a null pointer */
        #endif

        // Platform independent
        float m_fAngle; /**< Current rotation angle of the rectangle */


};


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
} // PLCore


#endif // __PLCORE_FRONTEND_OPENGL_H__