PixelLightAPI  .
Public Member Functions | Protected Member Functions
PLCore::AbstractFrontend Class Reference

Abstract frontend class. More...

#include <AbstractFrontend.h>

Inheritance diagram for PLCore::AbstractFrontend:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual void OnSize ()=0
 Called when the window size has been changed.
virtual void OnFullscreenMode ()=0
 Called when the fullscreen mode was changed.
virtual void OnDraw ()=0
 Called to let the frontend draw into it's window.
virtual void OnUpdate ()=0
 Called to let the frontend update it's states.
virtual void OnDrop (const Container< String > &lstFiles)=0
 Called when string data has been dropped onto the frontend window.

Protected Member Functions

 AbstractFrontend ()
 Default constructor.
virtual ~AbstractFrontend ()
 Destructor.

Detailed Description

Abstract frontend class.

Remarks:
Please note that the frontend system is not designed to be a replacement for a decent GUI system. In here, only primitive and commonly used GUI related feature are offered with a limited feature set. For more complex stuff one has to use a real GUI system.

Constructor & Destructor Documentation

Default constructor.

virtual PLCore::AbstractFrontend::~AbstractFrontend ( ) [protected, virtual]

Destructor.


Member Function Documentation

virtual void PLCore::AbstractFrontend::OnSize ( ) [pure virtual]

Called when the window size has been changed.

Implemented in PLCore::FrontendApplication, PLCore::FrontendPixelLight, PLCore::FrontendImpl, and PLCore::FrontendOpenGL.

virtual void PLCore::AbstractFrontend::OnFullscreenMode ( ) [pure virtual]

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.

Implemented in PLRenderer::RendererApplication, PLCore::FrontendApplication, PLCore::FrontendPixelLight, PLCore::FrontendImpl, and PLCore::FrontendOpenGL.

virtual void PLCore::AbstractFrontend::OnDraw ( ) [pure virtual]
virtual void PLCore::AbstractFrontend::OnUpdate ( ) [pure virtual]

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.

Implemented in PLEngine::EngineApplication, PLEngine::ScriptApplication, PLRenderer::RendererApplication, PLCore::FrontendApplication, PLScene::SceneApplication, PLCore::FrontendPixelLight, PLCore::FrontendImpl, and PLCore::FrontendOpenGL.

virtual void PLCore::AbstractFrontend::OnDrop ( const Container< String > &  lstFiles) [pure virtual]

Called when string data has been dropped onto the frontend window.

Parameters:
[in]lstFilesList of file names

Implemented in PLCore::FrontendApplication, PLCore::FrontendPixelLight, PLCore::FrontendImpl, and PLCore::FrontendOpenGL.


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


PixelLight PixelLight 0.9.11-R1
Copyright (C) 2002-2012 by The PixelLight Team
Last modified Thu Feb 23 2012 14:09:25
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported