unreal.MagicLeapHMDFunctionLibrary

class unreal.MagicLeapHMDFunctionLibrary(outer=None, name='None')

Bases: unreal.BlueprintFunctionLibrary

Magic Leap HMDFunction Library

C++ Source:

• Plugin: MagicLeap

• Module: MagicLeap

• File: MagicLeapHMDFunctionLibrary.h

classmethod get_graphics_client_performance_info() → MagicLeapGraphicsClientPerformanceInfo or None

Get Graphics Client Performance Info

Returns

performance_info (MagicLeapGraphicsClientPerformanceInfo):

Return type

MagicLeapGraphicsClientPerformanceInfo or None

classmethod get_head_tracking_map_events() → Set(MagicLeapHeadTrackingMapEvent) or None

Get map events. A developer must be aware of certain events that can occur under degenerative conditions in order to cleanly handle it. The most important event to be aware of is when a map changes. In the case that a new map session begins, or recovery fails, all formerly cached transform and world reconstruction data (raycast, planes, mesh) is invalidated and must be updated.

Returns

true if call get map events from the platform succeeded, false otherwise.

map_events (Set(MagicLeapHeadTrackingMapEvent)): Set of map events occured since the last frame. Valid only if function returns true.

Return type

Set(MagicLeapHeadTrackingMapEvent) or None

classmethod get_head_tracking_state() → MagicLeapHeadTrackingState or None

Get Head Tracking State

Returns

state (MagicLeapHeadTrackingState):

Return type

MagicLeapHeadTrackingState or None

classmethod get_minimum_api_level() → int32

Get Minimum APILevel

Returns

Return type

int32

classmethod get_mlsdk_version() → str

Get MLSDKVersion

Returns

Return type

str

classmethod get_mlsdk_version_major() → int32

Get MLSDKVersion Major

Returns

Return type

int32

classmethod get_mlsdk_version_minor() → int32

Get MLSDKVersion Minor

Returns

Return type

int32

classmethod get_mlsdk_version_revision() → int32

Get MLSDKVersion Revision

Returns

Return type

int32

classmethod get_platform_api_level() → int32

Get Platform APILevel

Returns

Return type

int32

classmethod is_running_on_magic_leap_hmd() → bool

Returns true if this code is executing on the ML HMD, false otherwise (e.g. it’s executing on PC)

Returns

Return type

bool

classmethod set_app_ready() → bool

Notifies lifecycle that the app is ready to run (dismisses the loading logo). note: This MUST be called if you have checked bManualCallToAppReady in LuminRuntimeSettings. Failure to do so will cause the application to remain in the loading state.

Returns

Return type

bool

classmethod set_base_orientation(base_orientation) → None

Set Base Orientation deprecated: Use XRPawn setup for coordinate space calibration

Parameters

base_orientation (Quat) –

classmethod set_base_position(base_position) → None

Set Base Position deprecated: Use XRPawn setup for coordinate space calibration

Parameters

base_position (Vector) –

classmethod set_base_rotation(base_rotation) → None

Set Base Rotation deprecated: Use XRPawn setup for coordinate space calibration

Parameters

base_rotation (Rotator) –

classmethod set_focus_actor(focus_actor, set_stabilization_actor=True) → None

Set the actor whose location is used as the focus point. The focus distance is the distance from the HMD to the focus point.

Parameters

• focus_actor (Actor) – The actor that will be set as the new focus actor.

• set_stabilization_actor (bool) – True if the function should set the stabilization depth actor to match the passed in focus actor. (RECOMMENDED TO STAY CHECKED)

classmethod set_stabilization_depth_actor(stabilization_depth_actor, set_focus_actor=True) → None

Set the actor whose location is used as the depth for timewarp stabilization.

Parameters

• stabilization_depth_actor (Actor) – The actor that will be set as the new stabilization depth actor.

• set_focus_actor (bool) – True if the function should set the focus actor to match the passed in stabilization depth actor. (RECOMMENDED TO STAY CHECKED)