unreal.MagicLeapARPinFunctionLibrary

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

Bases: unreal.BlueprintFunctionLibrary

Direct API interface for the Magic Leap Persistent AR Pin tracker system.

C++ Source:

  • Plugin: MagicLeap
  • Module: MagicLeap
  • File: MagicLeapARPinComponent.h
classmethod get_ar_pin_position_and_orientation(pin_id) → (position=Vector, orientation=Rotator, pin_found_in_environment=bool) or None

Returns the world position & orientation of the requested Pin.

Parameters:pin_id (Guid) – ID of the Pin to get the position and orientation for.
Returns:true if the PinID was valid and the position & orientation were successfully retrieved.

position (Vector): Output param for the world position of the Pin. Valid only if return value is true.

orientation (Rotator): Output param for the world orientation of the Pin. Valid only if return value is true.

pin_found_in_environment (bool): Output param for indicating ig the requested Pin was found user’s current environment or not.

Return type:tuple or None
classmethod get_available_ar_pins(num_requested) -> (PassableWorldError, pins=Array(Guid))

Returns all the AR Pins currently available.

Parameters:num_requested (int32) – Max number of AR Pins to query. Pass in a negative integer to get all available Pins.
Returns:Error code representing specific success or failure cases.

pins (Array(Guid)): Output array containing IDs of the found Pins. Valid only if return value is EPassableWorldError::None.

Return type:Array(Guid)
classmethod get_closest_ar_pin(search_point) -> (PassableWorldError, pin_id=Guid)

Returns the Pin closest to the target point passed in.

Parameters:search_point (Vector) – Position, in world space, to search the closest Pin to.
Returns:Error code representing specific success or failure cases.

pin_id (Guid): Output param for the ID of the closest Pin. Valid only if return value is EPassableWorldError::None.

Return type:Guid
classmethod get_num_available_ar_pins() -> (PassableWorldError, count=int32)

Returns the count of currently available AR Pins.

Returns:Error code representing specific success or failure cases.

count (int32): Output param for number of currently available AR Pins. Valid only if return value is EPassableWorldError::None.

Return type:int32