unreal.MagicLeapPlanesFunctionLibrary

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

Bases: unreal.BlueprintFunctionLibrary

Magic Leap Planes Function Library

C++ Source:

• Plugin: MagicLeap

• Module: MagicLeapPlanes

• File: MagicLeapPlanesFunctionLibrary.h

classmethod add_persistent_query(persistent_query_type) → Guid

Adds a new plane query.

Parameters

persistent_query_type (MagicLeapPlaneQueryType) –

Returns

Return type

Guid

classmethod create_tracker() → bool

Create a planes tracker.

Returns

Return type

bool

classmethod destroy_tracker() → bool

Destroy a planes tracker.

Returns

Return type

bool

classmethod get_content_scale(content_actor, plane_result) → Transform

Gets the expected scale of the actor to be placed within the bounds of the given plane. Ensure that the actor rotation is 0 (FQuat::Identity) before sending it to this function.

Parameters

• content_actor (Actor) – Actor for which the scale is to be calculated.

• plane_result (MagicLeapPlaneResult) –

Returns

A vector representing the expected scale of the Actor.

Return type

Transform

classmethod is_tracker_valid() → bool

Is a planes tracker already created.

Returns

Return type

bool

classmethod planes_persistent_query_begin_async(query, handle, result_delegate) → bool

Initiates a persistant plane query.

Parameters

• query (MagicLeapPlanesQuery) –

• handle (Guid) –

• result_delegate (MagicLeapPersistentPlanesResultDelegate) –

Returns

Return type

bool

classmethod planes_query_begin_async(query, result_delegate) → bool

Initiates a plane query.

Parameters

• query (MagicLeapPlanesQuery) –

• result_delegate (MagicLeapPlanesResultDelegate) –

Returns

Return type

bool

classmethod remove_flags_not_in_query(query_flags, result_flags)

Removes

Parameters

• query_flags (Array(MagicLeapPlaneQueryFlags)) –

• result_flags (Array(MagicLeapPlaneQueryFlags)) –

Returns

out_flags (Array(MagicLeapPlaneQueryFlags)):

Return type

Array(MagicLeapPlaneQueryFlags)

classmethod remove_persistent_query(handle) → bool

Removes a plane query. Returns a boolean of the operation’s success

Parameters

handle (Guid) –

Returns

Return type

bool

classmethod reorder_plane_flags(priority, flags_to_reorder)

Re-orders an array of plane query flags based on the priority list passed.

Parameters

• priority (Array(MagicLeapPlaneQueryFlags)) – The priority list by which to order the array of plane query flags.

• flags_to_reorder (Array(MagicLeapPlaneQueryFlags)) – The array of plane query flags to be reordered.

Returns

out_reordered_flags (Array(MagicLeapPlaneQueryFlags)): The reordered array of plane query flags.

Return type

Array(MagicLeapPlaneQueryFlags)