unreal.MotionTrackedDeviceFunctionLibrary

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

Bases: unreal.BlueprintFunctionLibrary

Motion Tracked Device Function Library

C++ Source:

  • Module: HeadMountedDisplay
  • File: MotionTrackedDeviceFunctionLibrary.h
classmethod disable_motion_tracking_for_component(motion_controller_component) → None

Disable tracking of the specified controller, by player index and tracked device type.

Parameters:motion_controller_component (MotionControllerComponent) – (in) The motion controller component who’s associated device is targeted.
classmethod disable_motion_tracking_of_all_controllers() → None

Disable tracking for all controllers.

classmethod disable_motion_tracking_of_controllers_for_player(player_index) → None

Disable tracking for all controllers associated with the specified player.

Parameters:player_index (int32) – (in) The index of the player.
classmethod disable_motion_tracking_of_device(player_index, hand) → None

Disable tracking of the specified controller, by player index and tracked device type. deprecated: EControllerHand has been deprecated, please use DisableMotionTrackingOfSource instead.

Parameters:
  • player_index (int32) – (in) The index of the player.
  • hand (ControllerHand) – (in) The tracked device type.
classmethod disable_motion_tracking_of_source(player_index, source_name) → None

Disable tracking of the specified controller, by player index and tracked device type.

Parameters:
  • player_index (int32) – (in) The index of the player.
  • source_name (Name) – (in) The tracked device id.
classmethod enable_motion_tracking_for_component(motion_controller_component) → bool

Enable tracking of the specified controller, by player index and tracked device type.

Parameters:motion_controller_component (MotionControllerComponent) – (in) The motion controller component who’s associated device is targeted.
Returns:(Boolean) true if the specified device is now set to be tracked. This could fail due to tracking limits, or on invalid input.
Return type:bool
classmethod enable_motion_tracking_of_device(player_index, hand) → bool

Enable tracking of the specified controller, by player index and tracked device type. deprecated: EControllerHand has been deprecated, please use EnableMotionTrackingOfSource instead.

Parameters:
  • player_index (int32) – (in) The index of the player.
  • hand (ControllerHand) – (in) The device type.
Returns:

(Boolean) true if the specified device is now set to be tracked. This could fail due to tracking limits, or on invalid input.

Return type:

bool

classmethod enable_motion_tracking_of_source(player_index, source_name) → bool

Enable tracking of the specified controller, by player index and tracked device type.

Parameters:
  • player_index (int32) – (in) The index of the player.
  • source_name (Name) – (in) The device id.
Returns:

(Boolean) true if the specified device is now set to be tracked. This could fail due to tracking limits, or on invalid input.

Return type:

bool

classmethod enumerate_motion_sources() -> Array(Name)

Returns a list of all available motion sources (FNames associated with discrete tracking data that can be used to drive MotionControllerComponents).

Returns:
Return type:Array(Name)
classmethod get_active_tracking_system_name() → Name

Returns the system name used to distinguish the current tracking system. If no XR tracking system is active, then the name ‘None’ is returned.

Returns:
Return type:Name
classmethod get_maximum_motion_tracked_controller_count() → int32

Get the maximum number of controllers that can be tracked.

Returns:(int) number of controllers that can be tracked, or -1 if there is no limit (IsMotionTrackedDeviceCountManagementNecessary() should return false).
Return type:int32
classmethod get_motion_tracking_enabled_controller_count() → int32

Get the number of controllers for which tracking is enabled.

Returns:(int) number of controllers tracked now, or -1 if this query is unsupported (IsMotionTrackedDeviceCountManagementNecessary() should return false).
Return type:int32
classmethod is_motion_source_tracking(player_index, source_name) → bool

Queries the specified source’s tracking status and returns true if it has tracking.

Parameters:
  • player_index (int32) –
  • source_name (Name) –
Returns:

Tracking status of the specified controller.

Return type:

bool

classmethod is_motion_tracked_device_count_management_necessary() → bool

Returns true if it is necessary for the game to manage how many motion tracked devices it is asking to be tracked simultaneously. On some platforms this is unnecessary because all supported devices can be tracked simultaneously.

Returns:(Boolean) true if the game might need to manage which motion tracked devices are actively tracked.
Return type:bool
classmethod is_motion_tracking_enabled_for_component(motion_controller_component) → bool

Returns true if tracking is enabled for the specified device.

Parameters:motion_controller_component (MotionControllerComponent) – (in) The motion controller component who’s associated device is targeted.
Returns:(Boolean) true if the specified device is set to be tracked.
Return type:bool
classmethod is_motion_tracking_enabled_for_device(player_index, hand) → bool

Returns true if tracking is enabled for the specified device. deprecated: EControllerHand has been deprecated, please use IsMotionTrackingEnabledForSource instead.

Parameters:
  • player_index (int32) – (in) The index of the player.
  • hand (ControllerHand) – (in) The tracked device type.
Returns:

(Boolean) true if the specified device is set to be tracked.

Return type:

bool

classmethod is_motion_tracking_enabled_for_source(player_index, source_name) → bool

Returns true if tracking is enabled for the specified device.

Parameters:
  • player_index (int32) – (in) The index of the player.
  • source_name (Name) – (in) The tracked device id.
Returns:

(Boolean) true if the specified device is set to be tracked.

Return type:

bool

classmethod set_is_controller_motion_tracking_enabled_by_default(enable) → None

Set whether motion tracked controllers activate on creation by default, or do not and must be explicitly activated.

Parameters:enable (bool) –