FrontendApplication.h

Go to the documentation of this file.

/*********************************************************\
 *  File: FrontendApplication.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_APPLICATION_H__
#define __PLCORE_APPLICATION_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include "PLCore/Frontend/Frontend.h"
#include "PLCore/Application/CoreApplication.h"


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


//[-------------------------------------------------------]
//[ Forward declarations                                  ]
//[-------------------------------------------------------]
class Frontend;


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    Frontend application class
*
*  @remarks
*    As the name of this class indicates, this is the base class for applications running
*    within a frontend (the application host). The main loop as well as other logic is handed
*    over to a host in order to become passive. Although a frontend application is always
*    running within a frontend, it shouldn't care about the frontend. Just write our application
*    as if there wouldn't be any "outer world". By following this philosophy as close as possible
*    and only accessing frontend features when really necessary, you enhance the chance that your
*    application can be embedded within other applications like browsers such as MS Internet Explorer
*    or Mozilla Firefox without problems.
*/
class FrontendApplication : public CoreApplication, protected AbstractFrontend {


    //[-------------------------------------------------------]
    //[ Friends                                               ]
    //[-------------------------------------------------------]
    friend class FrontendPixelLight;


    //[-------------------------------------------------------]
    //[ RTTI interface                                        ]
    //[-------------------------------------------------------]
    pl_class(PLCORE_RTTI_EXPORT, FrontendApplication, "PLCore", PLCore::CoreApplication, "Frontend application class")
        #ifdef PLCORE_EXPORTS   // The following is only required when compiling PLCore
            // Methods
            pl_method_0(GetFrontend,    pl_ret_type(Frontend&), "Returns the frontend this application is running in.", "")
        #endif
    pl_class_end


    //[-------------------------------------------------------]
    //[ Public functions                                      ]
    //[-------------------------------------------------------]
    public:
        /**
        *  @brief
        *    Returns the frontend this application is running in
        *
        *  @return
        *    Frontend this application instance is running in
        *
        *  @note
        *    - Try to avoid to access the frontend whenever possible (Hollywood Principle: "Don't call us, we'll call you")
        */
        inline Frontend &GetFrontend() const;


    //[-------------------------------------------------------]
    //[ Protected functions                                   ]
    //[-------------------------------------------------------]
    protected:
        /**
        *  @brief
        *    Constructor
        *
        *  @param[in] cFrontend
        *    Frontend this application instance is running in
        *
        *  @note
        *    - This constructor sets the default application name and title by using the name of the frontend executable ("GetFrontend().GetContext().GetName()")
        */
        PLCORE_API FrontendApplication(Frontend &cFrontend);

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


    //[-------------------------------------------------------]
    //[ Protected virtual AbstractLifecycle functions         ]
    //[-------------------------------------------------------]
    protected:
        /**
        *  @brief
        *    De-initialization function that is called after OnDeInit()
        *
        *  @remarks
        *    The default implementation does the following tasks:
        *    - Get frontend position and size of the current session and write frontend configuration
        *    - Everything that CoreApplication::OnStop() does
        */
        PLCORE_API virtual void OnStop() override;


    //[-------------------------------------------------------]
    //[ Protected virtual AbstractFrontend functions          ]
    //[-------------------------------------------------------]
    protected:
        /**
        *  @brief
        *    Called when the window size has been changed
        *
        *  @note
        *    - The default implementation is empty
        */
        PLCORE_API virtual void OnSize() override;

        /**
        *  @brief
        *    Called when the fullscreen mode was changed
        *
        *  @remarks
        *    This method just says "something related to fullscreen mode has been changed". Whether we
        *    changed from window mode into fullscreen mode or changed e.g. the resolution used in
        *    fullscreen mode is not really interesting in here.
        *
        *  @note
        *    - The default implementation is empty
        */
        PLCORE_API virtual void OnFullscreenMode() override;

        /**
        *  @brief
        *    Called to let the frontend draw into it's window
        *
        *  @note
        *    - The default implementation is empty
        */
        PLCORE_API virtual void OnDraw() override;

        /**
        *  @brief
        *    Called to let the frontend update it's states
        *
        *  @remarks
        *    You can use this method to do work you have to perform on a regular basis. It's
        *    recommended to keep the work done within the implementation as compact as possible.
        *    Don't use this function to perform 'polling'-everything, use events or if required
        *    for example timers or threads instead.
        *
        *  @note
        *    - The default implementation is empty
        */
        PLCORE_API virtual void OnUpdate() override;

        /**
        *  @brief
        *    Called when string data has been dropped onto the frontend window
        *
        *  @param[in] lstFiles
        *    List of file names
        *
        *  @note
        *    - The default implementation is empty
        */
        PLCORE_API virtual void OnDrop(const Container<String> &lstFiles) override;


    //[-------------------------------------------------------]
    //[ Protected virtual CoreApplication functions           ]
    //[-------------------------------------------------------]
    protected:
        /**
        *  @brief
        *    Called when application should initialize it's configuration
        *
        *  @remarks
        *    The default implementation does the following tasks:
        *    - Everything that CoreApplication::OnInitConfig() does
        *    - Read frontend configuration and set frontend position and size of the previous session
        *
        *  @note
        *    - Part of the application framework initialization function "OnStart()"
        */
        PLCORE_API virtual void OnInitConfig() override;

        /**
        *  @brief
        *    Called when application should load it's plugins
        *
        *  @remarks
        *    The default implementation does the following tasks:
        *    - Scan for plugins in application executable directory non-recursively
        *    - If the application executable directory is not the same as the application startup directory, scan for plugins in application startup directory non-recursively
        *
        *  @note
        *    - Part of the application framework initialization function "OnStart()"
        */
        PLCORE_API virtual void OnInitPlugins() override;

        /**
        *  @brief
        *    Called when application should set it's data paths
        *
        *  @remarks
        *    The default implementation does the following tasks:
        *    - Set '.' as base path in LoadableManager
        *    - Scan for packages in "Data/" directory
        *    - Set application directory as base path in LoadableManager
        *    - Scan for packages in application directory "Data/" directory
        *    - Get current language and load PixelLight localization file, if no language is defined, English is used as default
        *
        *  @note
        *    - Part of the application framework initialization function "OnStart()"
        */
        PLCORE_API virtual void OnInitData() override;


    //[-------------------------------------------------------]
    //[ Private data                                          ]
    //[-------------------------------------------------------]
    private:
        Frontend *m_pFrontend;  /**< Frontend the application is running in, always valid! */


};


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


//[-------------------------------------------------------]
//[ Implementation                                        ]
//[-------------------------------------------------------]
#include "PLCore/Frontend/FrontendApplication.inl"


#endif // __PLCORE_APPLICATION_H__