IAppEventHandler

Provides an interface between the AppFramework and any system that needs to be notified of application events (such as pause/resume).

Windows
MacOS
Linux

References

Module

MagicLeap

Header

/Engine/Plugins/Lumin/MagicLeap/Source/MagicLeap/Public/AppEventHandler.h

Include

#include "AppEventHandler.h"

Syntax

class IAppEventHandler

Remarks

Provides an interface between the AppFramework and any system that needs to be notified of application events (such as pause/resume).

Variables

Name Description

Protected variable

bool

 

bAllPrivilegesInSync

Protected variable

bool

 

bWasSystemEnabledOnPause

Protected variable

FCriticalSectio...

 

CriticalSection

Protected variable

FEventHandler

 

OnAppPauseHandler

Protected variable

FEventHandler

 

OnAppResumeHandler

Protected variable

FEventHandler

 

OnAppShutDownHandler

Protected variable

FEventHandler

 

OnAppStartHandler

Protected variable

FEventHandler

 

OnAppTickHandler

Protected variable

TMap< EMagicLea...

 

RequiredPrivileges

Constructors

Name Description

Public function

IAppEventHandler()

Public function

IAppEventHandler

(
    const TArray< EMagicLeapPrivilege >...
)

Adds the IAppEventHandler instance to the application's list of IAppEventHandler instances.

Destructors

Name Description

Public function Virtual

~IAppEventHandler()

Removes the IAppEventHandler instance from the application's list of IAppEventHandler instances.

Functions

Name Description

Public function

bool

 

AddPrivilegeEventHandler

(
    EMagicLeapPrivilege PrivilegeID,
    FRequiredPrivilege::FPrivilegeEvent...
)

Triggered when a privilege request changes state.

Public function

EPrivilegeSt...

 

GetPrivilegeStatus

(
    EMagicLeapPrivilege PrivilegeID,
    bool bBlocking
)

Returns the status of the specified privilege.

Public function Virtual

void

 

OnAppPause()

Can be overridden by inheriting class in order to pause its system.

Public function Virtual

void

 

OnAppResume()

Can be overridden by inheriting class in order to resume its system.

Public function Virtual

void

 

OnAppShutDown()

Can be overridden by inheriting class that needs to destroy certain api interfaces before the perception stack is closed down.

Public function Virtual

void

 

OnAppStart()

Perform any operations that must occur when an application begins

Public function Virtual

void

 

OnAppTick()

Use to check status of privilege requests.

Public function

const TCHAR ...

 

PrivilegeStateToString

(
    EPrivilegeState PrivilegeState
)

Converts the EPrivilegeState enum value to it's corresponding string representation.

Public function

FString

 

PrivilegeToString

(
    EMagicLeapPrivilege PrivilegeID
)

Converts the EMagicLeapPrivilege enum value to it's corresponding string representation.

Public function

void

 

SetOnAppPauseHandler

(
    FEventHandler&& InOnAppPauseHandle...
)

Use this as an alternative to overriding the OnAppPause function.

Public function

void

 

SetOnAppResumeHandler

(
    FEventHandler&& InOnAppResumeHandl...
)

Use this as an alternative to overriding the OnAppResume function.

Public function

void

 

SetOnAppShutDownHandler

(
    FEventHandler&& InOnAppShutDownHan...
)

Use this as an alternative to overriding the OnAppShutDown function.

Public function

void

 

SetOnAppStartHandler

(
    FEventHandler&& InOnAppStartHandle...
)

Use this as an alternative to overriding the OnAppStart function.

Public function

void

 

SetOnAppTickHandler

(
    FEventHandler&& InOnAppTickHandler
)

Use this as an alternative to overriding the OnAppTick function.

Public function

void

 

SetWasSystemEnabledOnPause

(
    bool bInWasSystemEnabledOnPause
)

Public function Const

bool

 

WasSystemEnabledOnPause()

Typedefs

Name

Description

FEventHandler
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss