PixelLightAPI  .
Public Member Functions | Protected Member Functions
PLEngine::SNLoadScreenBase Class Reference

Abstract load screen base scene node. More...

#include <SNLoadScreenBase.h>

Inheritance diagram for PLEngine::SNLoadScreenBase:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual PL_API void DrawPost (PLRenderer::Renderer &cRenderer, const PLScene::VisNode *pVisNode=nullptr) override
 This function is called after transparent parts of the scene are drawn.

Protected Member Functions

PL_API SNLoadScreenBase ()
 Default constructor.
virtual PL_API ~SNLoadScreenBase ()
 Destructor.
PL_API float GetLoadProgress () const
 Returns the current load progress.

Detailed Description

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.

Constructor & Destructor Documentation

Default constructor.

virtual PL_API PLEngine::SNLoadScreenBase::~SNLoadScreenBase ( ) [protected, virtual]

Destructor.


Member Function Documentation

PL_API float PLEngine::SNLoadScreenBase::GetLoadProgress ( ) const [protected]

Returns the current load progress.

Returns:
The current load progress between 0.0-1.0
virtual PL_API void PLEngine::SNLoadScreenBase::DrawPost ( PLRenderer::Renderer cRenderer,
const PLScene::VisNode pVisNode = nullptr 
) [override, virtual]

This function is called after transparent parts of the scene are drawn.

Parameters:
[in]cRendererThe used renderer
[in]pVisNodeThe current visibility node of this scene node, can be a null pointer
Note:
  • The default implementation only emits the SignalDrawPost signal
See also:

Reimplemented from PLScene::SceneNode.

Reimplemented in PLEngine::SNLoadScreen, and PLEngine::SNLoadScreenPL.


The documentation for this class was generated from the following file:


PixelLight PixelLight 0.9.10-R1
Copyright (C) 2002-2011 by The PixelLight Team
Last modified Fri Dec 23 2011 15:51:17
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported