PLEngine::EngineApplication Class Reference

Basic scene application class. More...

#include <EngineApplication.h>

Inheritance diagram for PLEngine::EngineApplication:

List of all members.

Public Member Functions
PL_API	EngineApplication (PLCore::Frontend &cFrontend, const PLCore::String &sSceneFilename="")
	Constructor.
virtual PL_API	~EngineApplication ()
	Destructor.
PL_API PLScene::SceneContainer *	GetScene () const
	Returns the scene container (the 'concrete scene')
PL_API void	SetScene (PLScene::SceneContainer *pContainer)
	Sets the scene container (the 'concrete scene')
PL_API void	ClearScene ()
	Clears the scene, after calling this method the scene is empty.
PL_API PLScene::SNCamera *	GetCamera () const
	Get scene camera.
PL_API PLInput::VirtualController *	GetInputController () const
	Get virtual input controller.
PL_API void	SetInputController (PLInput::VirtualController *pInputController)
	Set virtual input controller.
PL_API SceneRendererTool &	GetSceneRendererTool ()
	Get scene renderer tool.
PL_API const SceneRendererTool &	GetSceneRendererTool () const
	Get scene renderer tool.
PL_API Screenshot &	GetScreenshotTool ()
	Get screenshot tool.
PL_API bool	IsEditModeEnabled () const
	Returns whether or not edit mode is enabled.
PL_API void	SetEditModeEnabled (bool bEnabled=true)
	Sets whether or not edit mode is enabled.
PL_API void	ConsoleCommandQuit (ConsoleCommand &cCommand)
	Quit the engine.
virtual PL_API void	SetCamera (PLScene::SNCamera *pCamera)
	Sets the scene camera.
virtual PL_API bool	LoadScene (const PLCore::String &sFilename)
	Loads a scene.
Protected Member Functions
virtual PL_API bool	OnStart () override
	Initialization function that is called prior to OnInit()
virtual PL_API void	OnResume () override
	Called when the object has the focus (keep the implementation lightweight)
virtual PL_API void	OnPause () override
	Called when the object has no longer the focus (keep the implementation lightweight)
virtual PL_API void	OnStop () override
	De-initialization function that is called after OnDeInit()
virtual PL_API void	OnUpdate () override
	Called to let the frontend update it's states.
virtual PL_API void	OnCreateRootScene () override
	Function that is called to create the application's root scene.
virtual PL_API void	OnCreateScene (PLScene::SceneContainer &cContainer)
	Function that is called to create the application's scene container.
virtual PL_API void	OnCreateInputController ()
	Function that is called to initialize the application's virtual input controller.
virtual PL_API void	OnInputControllerFound (PLInput::Controller *pInputController, PLCore::String sInputSemantic)
	Function that is called when an input controller has been found.
virtual PL_API void	OnLoadProgress (float fLoadProgress)
	Called on load progress.
Protected Attributes
PLScene::SceneNodeHandler	m_cSceneContainerHandler
PLScene::SceneNodeHandler	m_cCameraHandler
PLCore::String	m_sDefaultSceneRenderer
PLCore::String	m_sSceneRendererVariables
PLCore::String	m_sClearColor
PLCore::String	m_sStartCamera
PLScene::SceneNode *	m_pFirstFoundCamera
bool	m_bHasLoadScreen
PLInput::VirtualController *	m_pInputController
SceneRendererTool	m_cSceneRendererTool
Screenshot	m_cScreenshot
bool	m_bEditModeEnabled

---

Detailed Description

Basic scene application class.

Remarks:

An application class that provides a standard scene graph for usual 3D applications and offers functionality to load in whole scenes at once as well as load screen handling and screenshot capturing.

---

Constructor & Destructor Documentation

PL_API PLEngine::EngineApplication::EngineApplication	(	PLCore::Frontend &	cFrontend,
		const PLCore::String &	sSceneFilename = ""
	)

Constructor.

< The used default (and very basic) scene renderer

Parameters:

[in]	cFrontend	Frontend this application instance is running in
[in]	sSceneFilename	Filename of the scene to load

virtual PL_API PLEngine::EngineApplication::~EngineApplication

(

)

[virtual]

Destructor.

---

Member Function Documentation

PL_API PLScene::SceneContainer* PLEngine::EngineApplication::GetScene

(

)

const

Returns the scene container (the 'concrete scene')

Returns:

Scene container, can be a null pointer

PL_API void PLEngine::EngineApplication::SetScene

(

PLScene::SceneContainer *

pContainer

)

Sets the scene container (the 'concrete scene')

Parameters:

[in]

pContainer

New scene container, can be a null pointer

PL_API void PLEngine::EngineApplication::ClearScene

(

)

Clears the scene, after calling this method the scene is empty.

PL_API PLScene::SNCamera* PLEngine::EngineApplication::GetCamera

(

)

const

Get scene camera.

Returns:

Scene camera, can be a null pointer

PL_API PLInput::VirtualController* PLEngine::EngineApplication::GetInputController

(

)

const

Get virtual input controller.

Returns:

Virtual input controller (can be a null pointer)

PL_API void PLEngine::EngineApplication::SetInputController

(

PLInput::VirtualController *

pInputController

)

Set virtual input controller.

Parameters:

[in]

pInputController

Virtual input controller (can be a null pointer)

PL_API SceneRendererTool& PLEngine::EngineApplication::GetSceneRendererTool

(

)

Get scene renderer tool.

Returns:

Scene renderer tool instance

Remarks:

Use "GetSceneRendererTool()" for a simplified interface to the scene renderer. By writing for example "GetSceneRendererTool().SetPassAttribute("BackgroundBitmap", "Material", "Data/Textures/Background.dds");" one can usually (on standard scene renderer configurations) set directly a background bitmap.

This component is initialized within the application framework initialization function "OnStart()" that is called prior to "Main()". As a result, using the returned component instance prior to the application-specific initialization routine "OnInit()" will not work.

PL_API const SceneRendererTool& PLEngine::EngineApplication::GetSceneRendererTool

(

)

const

Get scene renderer tool.

Returns:

Scene renderer tool instance

See also:

• Non-constant GetSceneRendererTool()

PL_API Screenshot& PLEngine::EngineApplication::GetScreenshotTool

(

)

Get screenshot tool.

Returns:

Screenshot tool instance

Remarks:

This component is initialized within the application framework initialization function "OnStart()" that is called prior to "Main()". As a result, using the returned component instance prior to the application-specific initialization routine "OnInit()" will not work.

PL_API bool PLEngine::EngineApplication::IsEditModeEnabled

(

)

const

Returns whether or not edit mode is enabled.

Returns:

'true' if edit mode is enabled, else 'false'

Remarks:

This class introduces some generic edit features which are enabled by default. For public release versions you may disable the edit mode so users can't for example use edit features to chat.

PL_API void PLEngine::EngineApplication::SetEditModeEnabled

(

bool

bEnabled = true

)

Sets whether or not edit mode is enabled.

Parameters:

[in]

bEnabled

'true' if edit mode is enabled, else 'false'

Remarks:

Also the scene nodes 'SNEngineInformation0' and 'SNConsole0' from the root scene are enabled/disabled. By default, edit mode is enabled.

See also:

• IsEditModeEnabled()

PL_API void PLEngine::EngineApplication::ConsoleCommandQuit

(

ConsoleCommand &

cCommand

)

Quit the engine.

Parameters:

[in]

cCommand

Calling command

virtual PL_API void PLEngine::EngineApplication::SetCamera

(

PLScene::SNCamera *

pCamera

)

[virtual]

Sets the scene camera.

Parameters:

[in]

pCamera

New scene camera, can be a null pointer

Note:

• Deactivates automatically the current set camera and activates the new camera
• Sets this camera also within the 'SPScene' surface painter instance
• Emits the "SignalCameraSet"-signal

virtual PL_API bool PLEngine::EngineApplication::LoadScene

(

const PLCore::String &

sFilename

)

[virtual]

Loads a scene.

Parameters:

[in]

sFilename

Filename of the scene to load

Returns:

'true' if all went fine, else 'false'

Remarks:

This function will use the current set scene container (the 'concrete scene') to load in given scene data. It will temporarily add a new base path so all scene data can be found even if the scene to load is not within the application directory. Supported 'SNKeyValue' information: Key Value 'SceneRenderer' 'Class name of the scene renderer to use' 'SceneRendererVariables' '<Variable>=

' 'ClearColor' '<red> <green> <blue> <alpha>' (all floating point values from 0-1) 'StartCamera' '<name of="" the="" start="" camera="" scene="" node>="">' (name is relative to the loaded scene container)

Note:

• If currently the edit dialog is opened, it will be closed automatically to avoid update problems
• Emits the "SignalSceneLoadingFinished"-signal when the scene loading has been finished successfully

virtual PL_API bool PLEngine::EngineApplication::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 (we reimplement the PLScene::SceneApplication::OnStart() order)
• Initialize input system
• Call OnCreateInputController()
• Initialize scene renderer tool
• Initialize screenshot tool
• Create scene context
• Call OnCreateRootScene()
• Return and go on with OnInit()

Reimplemented from PLScene::SceneApplication.

virtual PL_API void PLEngine::EngineApplication::OnResume

(

)

[override, protected, virtual]

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

Remarks:

The default implementation does the following tasks:

• Everything that PLScene::SceneApplication::OnResume() does
• Activate the input controller

Reimplemented from PLCore::CoreApplication.

virtual PL_API void PLEngine::EngineApplication::OnPause

(

)

[override, protected, virtual]

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

Remarks:

The default implementation does the following tasks:

• Everything that PLScene::SceneApplication::OnPause() does
• Deactivate the input controller

Reimplemented from PLCore::CoreApplication.

virtual PL_API void PLEngine::EngineApplication::OnStop

(

)

[override, protected, virtual]

De-initialization function that is called after OnDeInit()

Remarks:

The default implementation does the following tasks:

• Destroy input controller
• Everything that PLScene::SceneApplication::OnStop() does

Reimplemented from PLScene::SceneApplication.

virtual PL_API void PLEngine::EngineApplication::OnUpdate

(

)

[override, protected, virtual]

Called to let the frontend update it's states.

Remarks:

The default implementation does the following tasks:

• Everything that PLScene::SceneApplication::OnUpdate() does
• Update input manager

Reimplemented from PLScene::SceneApplication.

Reimplemented in PLEngine::ScriptApplication.

virtual PL_API void PLEngine::EngineApplication::OnCreateRootScene

(

)

[override, 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 from PLScene::SceneApplication.

virtual PL_API void PLEngine::EngineApplication::OnCreateScene

(

PLScene::SceneContainer &

cContainer

)

[protected, virtual]

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

Parameters:

[in]

cContainer

Scene container where the 'concrete scene' should be created in

Note:

• Part of the application framework initialization function "OnStart()"
• The default implementation creates an controllable camera and a simple mesh scene node
• Called from within "PLScene::SceneApplication::OnCreateRootScene()"

virtual PL_API void PLEngine::EngineApplication::OnCreateInputController

(

)

[protected, virtual]

Function that is called to initialize the application's virtual input controller.

Note:

• Part of the application framework initialization function "OnStart()"
• In the default implementation, an instance of VirtualStandardController is created

virtual PL_API void PLEngine::EngineApplication::OnInputControllerFound	(	PLInput::Controller *	pInputController,
		PLCore::String	sInputSemantic
	)		[protected, virtual]

Function that is called when an input controller has been found.

Parameters:

[in]	pInputController	Found input controller, always valid
[in]	sInputSemantic	Purpose of this input controller

Remarks:

Use this virtual method for instance to connect the input controller to real input devices.

Note:

• Connected to the "PLInput::InputManager::EventInputControllerFound"-event
• The default implementation tries to connect all controls automatically with the virtual standard controller

virtual PL_API void PLEngine::EngineApplication::OnLoadProgress

(

float

fLoadProgress

)

[protected, virtual]

Called on load progress.

Parameters:

[in]

fLoadProgress

Load progress (0.0-1.0)

Note:

• Calls "GetFrontend().RedrawAndPing()", but only if there's a load screen

---

Member Data Documentation

PLScene::SceneNodeHandler PLEngine::EngineApplication::m_cSceneContainerHandler [protected]

Scene node handler for the scene container

PLScene::SceneNodeHandler PLEngine::EngineApplication::m_cCameraHandler [protected]

Scene node handler for the camera

PLCore::String PLEngine::EngineApplication::m_sDefaultSceneRenderer [protected]

Default scene renderer

PLCore::String PLEngine::EngineApplication::m_sSceneRendererVariables [protected]

Scene renderer variables

PLCore::String PLEngine::EngineApplication::m_sClearColor [protected]

Clear color

PLCore::String PLEngine::EngineApplication::m_sStartCamera [protected]

Name of the given start camera

PLScene::SceneNode* PLEngine::EngineApplication::m_pFirstFoundCamera [protected]

First found camera, can be a null pointer

bool PLEngine::EngineApplication::m_bHasLoadScreen [protected]

Is there a load screen?

PLInput::VirtualController* PLEngine::EngineApplication::m_pInputController [protected]

Virtual input controller, can be a null pointer

SceneRendererTool PLEngine::EngineApplication::m_cSceneRendererTool [protected]

Scene renderer tool

Screenshot PLEngine::EngineApplication::m_cScreenshot [protected]

Screenshot tool

bool PLEngine::EngineApplication::m_bEditModeEnabled [protected]

Edit mode enabled?

---

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

• EngineApplication.h