unreal.MagicLeapMovementSettings

class unreal.MagicLeapMovementSettings(movement_type=MagicLeapMovementType.CONTROLLER6DOF, sway_history_size=30, max_delta_angle=28.647888, control_dampening_factor=3.5, max_sway_angle=30.0, maximum_headpose_rotation_speed=300.0, maximum_headpose_movement_speed=75.0, maximum_depth_delta_for_sway=10.0, minimum_distance=50.0, maximum_distance=1500.0, maximum_sway_time_s=0.4, end_resolve_timeout_s=10.0, max_penetration_percentage=0.3)

Bases: unreal.StructBase

Settings for a movement session.

C++ Source:

  • Plugin: MagicLeapMovement
  • Module: MagicLeapMovement
  • File: MagicLeapMovementTypes.h

Editor Properties: (see get_editor_property/set_editor_property)

  • control_dampening_factor (float): [Read-Write] A unitless number that governs the smoothing of Control input. Larger values will make the movement more twitchy, smaller values will make it smoother by increasing latency between Control input and object movement response by averaging multiple frames of input values. Must be greater than zero. Typical values would be between 0.5 and 10.0. This is defaulted to 7.0.
  • end_resolve_timeout_s (float): [Read-Write] Maximum length of time, in seconds, to allow DetatchObject() to resolve before forcefully aborting. This serves as a fail-safe for instances where the object is in a bad position and can’t resolve to a safe position.
  • max_delta_angle (float): [Read-Write] Maximum angle, in degrees, between the oldest and newest headpose to object vector. Increasing this will increase the maximum speed of movement. Must be greater than zero.
  • max_penetration_percentage (float): [Read-Write] The percentage (0 to 1) of the moved object’s radius that can penetrate a colliding object.
  • max_sway_angle (float): [Read-Write] The maximum angle, in degrees, that the object will be tilted left/right and front/back. Cannot be a negative value, but may be zero.
  • maximum_depth_delta_for_sway (float): [Read-Write] Distance object must move in depth since the last frame to cause maximum push/pull sway. Must be greater than zero.
  • maximum_distance (float): [Read-Write] The maximum distance in cm the object can be moved in depth relative to the headpose. This must be greater than zero and MinimumDistance.
  • maximum_headpose_movement_speed (float): [Read-Write] The maximum speed that headpose can move, in cm per second, that will stop implicit depth translation. If the headpose is moving faster than this speed (meters per second) implicit depth translation doesn’t happen. Must be greater than zero.
  • maximum_headpose_rotation_speed (float): [Read-Write] The speed of rotation that will stop implicit depth translation from happening. The speed of rotation about the headpose Y-axis, in degrees per second, that if exceeded, stops implicit depth translation from happening. Must be greater than zero.
  • maximum_sway_time_s (float): [Read-Write] Maximum length of time, in seconds, lateral sway should take to decay. Maximum length of time (in seconds) lateral sway should take to decay back to an upright orientation once lateral movement stops. Defaults to 0.15, must be greater than zero.
  • minimum_distance (float): [Read-Write] The minimum distance in cm the object can be moved in depth relative to the headpose. This must be greater than zero and less than MaximumDistance.
  • movement_type (MagicLeapMovementType): [Read-Write] The movement type to use when updating the transform of the set controller.
  • sway_history_size (int32): [Read-Write] Number of frames of sway history to track. Increase to improve smoothing. Minimum value of 3.
control_dampening_factor

(float) – [Read-Write] A unitless number that governs the smoothing of Control input. Larger values will make the movement more twitchy, smaller values will make it smoother by increasing latency between Control input and object movement response by averaging multiple frames of input values. Must be greater than zero. Typical values would be between 0.5 and 10.0. This is defaulted to 7.0.

end_resolve_timeout_s

(float) – [Read-Write] Maximum length of time, in seconds, to allow DetatchObject() to resolve before forcefully aborting. This serves as a fail-safe for instances where the object is in a bad position and can’t resolve to a safe position.

max_delta_angle

(float) – [Read-Write] Maximum angle, in degrees, between the oldest and newest headpose to object vector. Increasing this will increase the maximum speed of movement. Must be greater than zero.

max_penetration_percentage

(float) – [Read-Write] The percentage (0 to 1) of the moved object’s radius that can penetrate a colliding object.

max_sway_angle

(float) – [Read-Write] The maximum angle, in degrees, that the object will be tilted left/right and front/back. Cannot be a negative value, but may be zero.

maximum_depth_delta_for_sway

(float) – [Read-Write] Distance object must move in depth since the last frame to cause maximum push/pull sway. Must be greater than zero.

maximum_distance

(float) – [Read-Write] The maximum distance in cm the object can be moved in depth relative to the headpose. This must be greater than zero and MinimumDistance.

maximum_headpose_movement_speed

(float) – [Read-Write] The maximum speed that headpose can move, in cm per second, that will stop implicit depth translation. If the headpose is moving faster than this speed (meters per second) implicit depth translation doesn’t happen. Must be greater than zero.

maximum_headpose_rotation_speed

(float) – [Read-Write] The speed of rotation that will stop implicit depth translation from happening. The speed of rotation about the headpose Y-axis, in degrees per second, that if exceeded, stops implicit depth translation from happening. Must be greater than zero.

maximum_sway_time_s

(float) – [Read-Write] Maximum length of time, in seconds, lateral sway should take to decay. Maximum length of time (in seconds) lateral sway should take to decay back to an upright orientation once lateral movement stops. Defaults to 0.15, must be greater than zero.

minimum_distance

(float) – [Read-Write] The minimum distance in cm the object can be moved in depth relative to the headpose. This must be greater than zero and less than MaximumDistance.

movement_type

(MagicLeapMovementType) – [Read-Write] The movement type to use when updating the transform of the set controller.

sway_history_size

(int32) – [Read-Write] Number of frames of sway history to track. Increase to improve smoothing. Minimum value of 3.