SNLoadScreenBase.h

Go to the documentation of this file.

/*********************************************************\
 *  File: SNLoadScreenBase.h                             *
 *
 *  Copyright (C) 2002-2011 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 __PLENGINE_COMPOSITING_LOADSCREENBASE_H__
#define __PLENGINE_COMPOSITING_LOADSCREENBASE_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include <PLScene/Scene/SceneNode.h>
#include "PLEngine/PLEngine.h"


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
namespace PLEngine {


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    Abstract load screen base scene node
*
*  @remarks
*    This scene node listens to the 'load progress'-event of its parent and visualizes it. If
*    the progress is NOT between 0.0-1.0 the load screen will hide itself.
*/
class SNLoadScreenBase : public PLScene::SceneNode {


    //[-------------------------------------------------------]
    //[ RTTI interface                                        ]
    //[-------------------------------------------------------]
    pl_class(PL_RTTI_EXPORT, SNLoadScreenBase, "PLEngine", PLScene::SceneNode, "Abstract load screen base scene node")
        // Attributes
            // Overwritten SceneNode attributes
        pl_attribute(Flags, pl_flag_type(EFlags),   NoCulling,  ReadWrite,  GetSet, "Flags",    "")
    pl_class_end


    //[-------------------------------------------------------]
    //[ Protected functions                                   ]
    //[-------------------------------------------------------]
    protected:
        /**
        *  @brief
        *    Default constructor
        */
        PL_API SNLoadScreenBase();

        /**
        *  @brief
        *    Destructor
        */
        PL_API virtual ~SNLoadScreenBase();

        /**
        *  @brief
        *    Returns the current load progress
        *
        *  @return
        *    The current load progress between 0.0-1.0
        */
        PL_API float GetLoadProgress() const;


    //[-------------------------------------------------------]
    //[ Private functions                                     ]
    //[-------------------------------------------------------]
    private:
        /**
        *  @brief
        *    Called when the scene node container changed
        */
        void OnContainer();

        /**
        *  @brief
        *    Called on load progress
        *
        *  @param[in] fLoadProgress
        *    Load progress (0.0-1.0)
        */
        void OnLoadProgress(float fLoadProgress);


    //[-------------------------------------------------------]
    //[ Private event handlers                                ]
    //[-------------------------------------------------------]
    private:
        PLCore::EventHandler<>      EventHandlerContainer;
        PLCore::EventHandler<float> EventHandlerLoadProgress;


    //[-------------------------------------------------------]
    //[ Private data                                          ]
    //[-------------------------------------------------------]
    private:
        PLScene::SceneContainer *m_pContainer;      /**< Current parent container, can be a null pointer */
        float                    m_fLoadProgress;   /**< Current load progress (0.0-1.0) */


    //[-------------------------------------------------------]
    //[ Public virtual PLScene::SceneNode functions           ]
    //[-------------------------------------------------------]
    public:
        PL_API virtual void DrawPost(PLRenderer::Renderer &cRenderer, const PLScene::VisNode *pVisNode = nullptr) override;


};


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
} // PLEngine


#endif // __PLENGINE_COMPOSITING_LOADSCREENBASE_H__