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: WindowsMixedReality

• 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. deprecated: Please transition to use the functions in ARBlueprintLibrary which save pins to the anchor store by a ‘saveId’ rather than using the built in WMR anchorId.

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. The name ‘None’ is illegal.

• pin_to_world_transform (Transform) – The Pin which the component will be updated by.

Returns

Return type

WMRARPin

classmethod get_pv_camera_intrinsics() → (focal_length=Vector2D, width=int32, height=int32, principal_point=Vector2D, radial_distortion=Vector, tangential_distortion=Vector2D) or None

Get the PV Camera intrinsics.

Returns

focal_length (Vector2D):

width (int32):

height (int32):

principal_point (Vector2D):

radial_distortion (Vector):

tangential_distortion (Vector2D):

Return type

tuple or None

classmethod get_pv_camera_to_world_transform() → Transform

Get the transform from PV camera space to Unreal world space.

Returns

Return type

Transform

classmethod get_world_space_ray_from_camera_point(pixel_coordinate) → Vector

Get a ray into the scene from a camera point. X is left/right Y is up/down

Parameters

pixel_coordinate (Vector2D) –

Returns

Return type

Vector

classmethod hide_keyboard() → bool

Hide Keyboard deprecated: The keyboard should be auto-shown and hidden

Returns

Return type

bool

classmethod load_wmr_anchor_store_ar_pins()

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. deprecated: Please use LoadARPinsFromLocalStore

Returns

Array of Pins that were loaded.

Return type

Array(WMRARPin)

classmethod remove_ar_pin_from_wmr_anchor_store(pin) → None

Remove an ARPin from the the Windows Mixed Reality Anchor Store. deprecated: Please use RemoveARPinFromLocalStore

Parameters

pin (ARPin) –

classmethod resize_mixed_reality_camera(size) → IntPoint

Change screen size of Mixed Reality Capture camera. deprecated: Use ResizeXRCamera

Parameters

size (IntPoint) –

Returns

Return type

IntPoint

classmethod save_ar_pin_to_wmr_anchor_store(pin) → bool

Save an ARPin to the the Windows Mixed Reality Anchor Store. deprecated: Please use SaveARPinToLocalStore

Parameters

pin (ARPin) –

Returns

True if saved successfully.

Return type

bool

classmethod set_enabled_mixed_reality_camera(is_enabled) → None

Enable or disable Mixed Reality Capture camera. deprecated: Use SetEnabledXRCamera

Parameters

is_enabled (bool) –

classmethod show_keyboard() → bool

Show Keyboard deprecated: The keyboard should be auto-shown and hidden

Returns

Return type

bool

classmethod start_camera_capture() → None

Turn the camera on. deprecated: Use ToggleARCapture

classmethod start_qr_code_capture() → None

Start looking for QRCodes. deprecated: Use ToggleARCapture

classmethod stop_camera_capture() → None

Turn the camera off. deprecated: Use ToggleARCapture

classmethod stop_qr_code_capture() → None

Stop looking for QRCodes. deprecated: Use ToggleARCapture