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

Abstract life cycle class. More...

#include <AbstractLifecycle.h>

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

List of all members.

Public Member Functions

virtual void OnCreate ()=0
 Called directly after the object has been created.
virtual void OnRestart ()=0
 Called directly before a stopped object is going to start again (always followed by "OnStart()")
virtual bool OnStart ()=0
 Called when the object becoming visible to the user.
virtual void OnResume ()=0
 Called when the object has the focus (keep the implementation lightweight)
virtual void OnPause ()=0
 Called when the object has no longer the focus (keep the implementation lightweight)
virtual void OnStop ()=0
 Called when the object is no longer visible to the user.
virtual void OnDestroy ()=0
 Called before the object is going to be finally destroyed.

Protected Member Functions

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

Detailed Description

Abstract life cycle class.

Remarks:
*    The "Life cycle" is:
*      "OnCreate()"         - Called directly after the object has been created
*        ("OnRestart()")    - Called directly before a stopped object is going to start again (always followed by "OnStart()")
*        "OnStart()"        - Called when the object becoming visible to the user
*          "OnResume()"     - Called when the object has the focus (keep the implementation lightweight)
*          "OnPause()"      - Called when the object has no longer the focus (keep the implementation lightweight)
*        "OnStop()"         - Called when the object is no longer visible to the user
*      "OnDestroy()"        - Called before the object is going to be finally destroyed
*    This life cycle has the same interface as the "Android Activity Life cycle"
*    (http://developer.android.com/reference/android/app/Activity.html#ActivityLifecycle)
*    because this interface looks just the right way to go for this purpose... also there
*    are nice diagrams and documentations explaining the interface so it shouldn't be to
*    hard to understand it.
*  

Constructor & Destructor Documentation

Default constructor.

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

Destructor.


Member Function Documentation

virtual void PLCore::AbstractLifecycle::OnCreate ( ) [pure virtual]

Called directly after the object has been created.

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

virtual void PLCore::AbstractLifecycle::OnRestart ( ) [pure virtual]

Called directly before a stopped object is going to start again (always followed by "OnStart()")

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

virtual bool PLCore::AbstractLifecycle::OnStart ( ) [pure virtual]

Called when the object becoming visible to the user.

Returns:
'true' if all went fine, else 'false' (on failure, no "OnResume()", "OnPause()" or "OnStop()" will be called)

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

virtual void PLCore::AbstractLifecycle::OnResume ( ) [pure virtual]

Called when the object has the focus (keep the implementation lightweight)

Implemented in PLCore::CoreApplication, PLEngine::EngineApplication, PLCore::FrontendPixelLight, PLCore::FrontendImpl, and PLCore::FrontendOpenGL.

virtual void PLCore::AbstractLifecycle::OnPause ( ) [pure virtual]

Called when the object has no longer the focus (keep the implementation lightweight)

Implemented in PLCore::CoreApplication, PLEngine::EngineApplication, PLCore::FrontendPixelLight, PLCore::FrontendImpl, and PLCore::FrontendOpenGL.

virtual void PLCore::AbstractLifecycle::OnStop ( ) [pure virtual]
virtual void PLCore::AbstractLifecycle::OnDestroy ( ) [pure virtual]

Called before the object is going to be finally destroyed.

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


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:14
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported