Murl::IAppControl Interface Reference

The IAppControl interface. More...

#include "murl_i_app_control.h"

Inheritance diagram for Murl::IAppControl:

Public Member Functions
virtual Bool	TerminateApp ()=0
	Terminate (exit) the entire application within the next frame tick. More...
virtual Bool	IsTerminatingApp () const =0
	Check if the application is going to be terminated within the next frame tick. More...
virtual Bool	SuspendApp ()=0
	Suspend the application within the next frame tick. More...
virtual Bool	IsSuspendingApp () const =0
	Check if the application is going to be suspended within the next frame tick. More...
virtual Bool	SetLoadingProgress (Real progress)=0
	Set the current loading progress. More...
virtual Real	GetLoadingProgress () const =0
	Get the current loading progress. More...
Public Member Functions inherited from Murl::IControlable
virtual const String &	GetName () const =0
	Get the controlable's name. More...
virtual void	FrameUpdate ()=0
	Is executed in the platform thread context each frame tick.
virtual void	LogicUpdate ()=0
	Is executed in the logic thread context each logic tick.
virtual void	ConfigChanged (const IAppConfiguration *appConfig)=0
	Notification of changed configuration. More...

Detailed Description

The IAppControl interface.

Member Function Documentation

TerminateApp()

virtual Bool Murl::IAppControl::TerminateApp ( )

pure virtual

Terminate (exit) the entire application within the next frame tick.

Terminating the application is not supported on all devices.

Returns

true if successful.

IsTerminatingApp()

virtual Bool Murl::IAppControl::IsTerminatingApp ( ) const

pure virtual

Check if the application is going to be terminated within the next frame tick.

Returns

true if termination is pending

SuspendApp()

virtual Bool Murl::IAppControl::SuspendApp ( )

pure virtual

Suspend the application within the next frame tick.

Suspending the application is not supported on all devices.

Returns

true if successful.

IsSuspendingApp()

virtual Bool Murl::IAppControl::IsSuspendingApp ( ) const

pure virtual

Check if the application is going to be suspended within the next frame tick.

Returns

true if suspension is pending

SetLoadingProgress()

virtual Bool Murl::IAppControl::SetLoadingProgress ( Real  progress )

pure virtual

Set the current loading progress.

Setting the loading progress is an optional feature to communicate the app's current loading state to the platform handler. By default, the loading progress is set to 0.0 (unloaded).

Parameters

progress

The loading progress, between 0.0 and 1.0

Returns

true if successful.

GetLoadingProgress()

virtual Real Murl::IAppControl::GetLoadingProgress ( ) const

pure virtual

Get the current loading progress.

Returns

The current loading progress, between 0.0 and 1.0

---

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

• murl_i_app_control.h