unreal.WindowsMixedRealityFunctionLibrary

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

Bases: unreal.BlueprintFunctionLibrary

Windows Mixed Reality Extensions Function Library

C++ Source:

• Plugin: WindowsMixedReality

• Module: WindowsMixedRealityHMD

• File: WindowsMixedRealityFunctionLibrary.h

classmethod get_controller_tracking_status(hand) → HMDTrackingStatus

Returns tracking state for the controller deprecated: Use GetMotionControllerData TrackingStatus

Parameters

hand (ControllerHand) –

Returns

Return type

HMDTrackingStatus

classmethod get_pointer_pose_info(hand) → PointerPoseInfo

Returns the pose information to determine what a WMR device is pointing at. deprecated: Use GetMotionControllerData Aim members

Parameters

hand (ControllerHand) –

Returns

Return type

PointerPoseInfo

classmethod get_version_string() → str

Returns name of WindowsMR device type. deprecated: Use Generic HMD library version

Returns

Return type

str

classmethod is_button_clicked(hand, button) → bool

Returns true if the button was clicked. deprecated: Use Input Action Mappings to get events

Parameters

• hand (ControllerHand) –

• button (HMDInputControllerButtons) –

Returns

Return type

bool

classmethod is_button_down(hand, button) → bool

Returns true if the button is held down. deprecated: Use Input Action Mappings to gets events

Parameters

• hand (ControllerHand) –

• button (HMDInputControllerButtons) –

Returns

Return type

bool

classmethod is_currently_immersive() → bool

Returns true if currently rendering immersive, or false if rendering as a slate.

Returns

Return type

bool

classmethod is_display_opaque() → bool

Returns true if running on a WMR VR device, false if running on HoloLens. deprecated: Use GetXRSystemFlags and check for bIsAR

Returns

Return type

bool

classmethod is_grasped(hand) → bool

Returns true if an input device detects a grasp/grab action. deprecated: Use Input Action Mappings to get left or right grip events. Also available in GetMotionControllerData

Parameters

hand (ControllerHand) –

Returns

Return type

bool

classmethod is_select_pressed(hand) → bool

Returns true if a hand or motion controller is experiencing a primary Select press. deprecated: Use Input Action Mappings to get left or right trigger events

Parameters

hand (ControllerHand) –

Returns

Return type

bool

classmethod is_tracking_available() → bool

Returns true if a WMR VR device or HoloLens are tracking the environment. deprecated: Use GetHMDData TrackingStatus member

Returns

Return type

bool

classmethod lock_mouse_to_center(locked) → None

Lock Mouse to Center deprecated: No longer needed

Parameters

locked (bool) –

classmethod set_focus_point_for_frame(position) → None

Set Focus Point for Frame deprecated: No longer needed

Parameters

position (Vector) –

classmethod toggle_immersive(immersive) → None

Sets game context to immersive or slate. immersive: true for immersive context, false for slate.

Parameters

immersive (bool) –