unreal.HoloLensARFunctionLibrary

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

Bases: unreal.BlueprintFunctionLibrary

A function library that provides static/Blueprint functions for HoloLensAR.

C++ Source:

  • Plugin: HoloLensAR
  • Module: HoloLensAR
  • File: HoloLensARFunctionLibrary.h
classmethod create_named_ar_pin(name, pin_to_world_transform) → WMRARPin

Create an UARPin with the specified name, which will also be the name used to store it in the Windows Mixed Reality Anchor Store.

Parameters:
  • name (Name) – The name of the anchor. If the Name is already in use creation will fail. A leading “_” is reserved for automatically named anchors. Do not start your names with an underscore.
  • pin_to_world_transform (Transform) – The Pin which the component will be updated by.
Returns:

Return type:

WMRARPin

classmethod is_wmr_anchor_store_ready() → bool

Is the WMRAnchorStore ready to handle calls.

Returns:True if anchor store is ready.
Return type:bool
classmethod load_wmr_anchor_store_ar_pins() -> Array(WMRARPin)

Load all ARPins from the Windows Mixed Reality Anchor Store. Note: Pins of the same name as anchor store pins will be overwritten by the anchor store pin.

Returns:Array of Pins that were loaded.
Return type:Array(WMRARPin)
classmethod pin_component_to_ar_pin(component_to_pin, pin) → bool

Associate a component with an ARPin, so that its transform will be updated by the pin. Any previously associated component will be detached.

Parameters:
  • component_to_pin (SceneComponent) – The Component which will be updated by the Pin.
  • pin (WMRARPin) – The Pin which the component will be updated by.
Returns:

True if Pin successfully created.

Return type:

bool

classmethod remove_all_ar_pins_from_wmr_anchor_store() → None

Remove all ARPins from the the Windows Mixed Reality Anchor Store.

classmethod remove_ar_pin_from_wmr_anchor_store(pin) → None

Remove an ARPin from the the Windows Mixed Reality Anchor Store.

Parameters:pin (ARPin) –
classmethod save_ar_pin_to_wmr_anchor_store(pin) → bool

Save an ARPin to the the Windows Mixed Reality Anchor Store.

Parameters:pin (ARPin) –
Returns:True if saved successfully.
Return type:bool