unreal.XRMotionControllerData

class unreal.XRMotionControllerData(valid: bool = False, device_name: Name = 'None', application_instance_id: Guid = [], device_visual_type: XRVisualType = Ellipsis, hand_index: ControllerHand = Ellipsis, tracking_status: TrackingStatus = Ellipsis, grip_position: Vector = Ellipsis, grip_rotation: Quat = Ellipsis, aim_position: Vector = Ellipsis, aim_rotation: Quat = Ellipsis, hand_key_positions: Array[Vector] = [], hand_key_rotations: Array[Quat] = [], hand_key_radii: Array[float] = [], is_grasped: bool = False)

Bases: StructBase

XRMotion Controller Data

C++ Source:

  • Module: HeadMountedDisplay

  • File: HeadMountedDisplayTypes.h

Editor Properties: (see get_editor_property/set_editor_property)

  • aim_position (Vector): [Read-Write] Aim Position: for hand controllers, provides a more steady vector based on the elbow

  • aim_rotation (Quat): [Read-Write] Aim Rotation

  • application_instance_id (Guid): [Read-Write] Application Instance ID

  • device_name (Name): [Read-Write] Device Name

  • device_visual_type (XRVisualType): [Read-Write] Device Visual Type

  • grip_position (Vector): [Read-Write] Grip Position

  • grip_rotation (Quat): [Read-Write] Grip Rotation

  • hand_index (ControllerHand): [Read-Write] Hand Index

  • hand_key_positions (Array[Vector]): [Read-Write] Hand Key Positions: The indices of this array are the values of EHandKeypoint (Palm, Wrist, ThumbMetacarpal, etc).

  • hand_key_radii (Array[float]): [Read-Write] Hand Key Radii: The indices of this array are the values of EHandKeypoint (Palm, Wrist, ThumbMetacarpal, etc).

  • hand_key_rotations (Array[Quat]): [Read-Write] Hand Key Rotations: The indices of this array are the values of EHandKeypoint (Palm, Wrist, ThumbMetacarpal, etc).

  • is_grasped (bool): [Read-Write] Is Grasped

  • tracking_status (TrackingStatus): [Read-Write] Tracking Status

  • valid (bool): [Read-Write] Valid

property aim_position: Vector

[Read-Only] Aim Position: for hand controllers, provides a more steady vector based on the elbow

Type:

(Vector)

property aim_rotation: Quat

[Read-Only] Aim Rotation

Type:

(Quat)

property application_instance_id: Guid

[Read-Only] Application Instance ID

Type:

(Guid)

property device_name: Name

[Read-Only] Device Name

Type:

(Name)

property device_visual_type: XRVisualType

[Read-Only] Device Visual Type

Type:

(XRVisualType)

property grip_position: Vector

[Read-Only] Grip Position

Type:

(Vector)

property grip_rotation: Quat

[Read-Only] Grip Rotation

Type:

(Quat)

property hand_index: ControllerHand

[Read-Only] Hand Index

Type:

(ControllerHand)

property hand_key_positions: Array[Vector]

[Read-Only] Hand Key Positions: The indices of this array are the values of EHandKeypoint (Palm, Wrist, ThumbMetacarpal, etc).

Type:

(Array[Vector])

property hand_key_radii: Array[float]

[Read-Only] Hand Key Radii: The indices of this array are the values of EHandKeypoint (Palm, Wrist, ThumbMetacarpal, etc).

Type:

(Array[float])

property hand_key_rotations: Array[Quat]

[Read-Only] Hand Key Rotations: The indices of this array are the values of EHandKeypoint (Palm, Wrist, ThumbMetacarpal, etc).

Type:

(Array[Quat])

property is_grasped: bool

[Read-Only] Is Grasped

Type:

(bool)

property tracking_status: TrackingStatus

[Read-Only] Tracking Status

Type:

(TrackingStatus)

property valid: bool

[Read-Only] Valid

Type:

(bool)