PLScene::SceneApplication Class Reference

Scene application class. More...

#include <SceneApplication.h>

Inheritance diagram for PLScene::SceneApplication:

List of all members.

Protected Member Functions
PLS_API void	SetRootScene (PLScene::SceneContainer *pSceneContainer)
	Set root scene.
virtual PLS_API bool	OnStart () override
	Initialization function that is called prior to OnInit()
virtual PLS_API void	OnStop () override
	De-initialization function that is called after OnDeInit()
virtual PLS_API void	OnUpdate () override
	Called to let the frontend update it's states.
virtual PLS_API void	OnCreateRootScene ()
	Function that is called to create the application's root scene.
Protected Attributes
PLScene::SceneContext *	m_pSceneContext
PLScene::SceneContainer *	m_pRootScene

---

Detailed Description

Scene application class.

Remarks:

An application class that provides a scene graph for rendering

Note:

• The 'OnCreatePainter()'-implementation creates a 'SPScene' surface painter

---

Member Function Documentation

PLS_API void PLScene::SceneApplication::SetRootScene

(

PLScene::SceneContainer *

pSceneContainer

)

[protected]

Set root scene.

Parameters:

[in]

pSceneContainer

Pointer to root scene container, can be a null pointer

virtual PLS_API bool PLScene::SceneApplication::OnStart

(

)

[override, protected, virtual]

Initialization function that is called prior to OnInit()

Returns:

'true' if all went fine, else 'false' which will stop the application

Remarks:

The default implementation does the following tasks:

• Everything that PLRenderer::RendererApplication::OnStart() does
• Create scene context
• Call OnCreateRootScene()
• Return and go on with OnInit()

Reimplemented from PLRenderer::RendererApplication.

Reimplemented in PLEngine::EngineApplication, and PLEngine::ScriptApplication.

virtual PLS_API void PLScene::SceneApplication::OnStop

(

)

[override, protected, virtual]

De-initialization function that is called after OnDeInit()

Remarks:

The default implementation does the following tasks:

• Destroy scene context
• Everything that PLRenderer::RendererApplication::OnStop() does

Reimplemented from PLRenderer::RendererApplication.

Reimplemented in PLEngine::EngineApplication, and PLEngine::ScriptApplication.

virtual PLS_API void PLScene::SceneApplication::OnUpdate

(

)

[override, protected, virtual]

Called to let the frontend update it's states.

Remarks:

The default implementation does the following tasks:

• Everything that PLRenderer::RendererApplication::OnUpdate() does
• Update the scene context

Reimplemented from PLRenderer::RendererApplication.

Reimplemented in PLEngine::EngineApplication, and PLEngine::ScriptApplication.

virtual PLS_API void PLScene::SceneApplication::OnCreateRootScene

(

)

[protected, virtual]

Function that is called to create the application's root scene.

Note:

• Part of the application framework initialization function "OnStart()"
• The default implementation creates a standard root scene

Reimplemented in PLEngine::EngineApplication.

---

Member Data Documentation

PLScene::SceneContext* PLScene::SceneApplication::m_pSceneContext [protected]

The scene context, can be a null pointer

PLScene::SceneContainer* PLScene::SceneApplication::m_pRootScene [protected]

Root scene (can be a null pointer)

---

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

• SceneApplication.h