unreal.XRMotionControllerData

class unreal.XRMotionControllerData(valid=False, device_name='None', application_instance_id=[], device_visual_type=XRVisualType.CONTROLLER, hand_index=ControllerHand.LEFT, tracking_status=TrackingStatus.NOT_TRACKED, grip_position=[0.0, 0.0, 0.0], grip_rotation=[0.0, 0.0, 0.0, 0.0], aim_position=[0.0, 0.0, 0.0], aim_rotation=[0.0, 0.0, 0.0, 0.0], hand_key_positions=[], hand_key_rotations=[], hand_key_radii=[], is_grasped=False)

Bases: unreal.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

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

Type

(Vector)

property aim_rotation

[Read-Only] Aim Rotation

Type

(Quat)

property application_instance_id

[Read-Only] Application Instance ID

Type

(Guid)

property device_name

[Read-Only] Device Name

Type

(Name)

property device_visual_type

[Read-Only] Device Visual Type

Type

(XRVisualType)

property grip_position

[Read-Only] Grip Position

Type

(Vector)

property grip_rotation

[Read-Only] Grip Rotation

Type

(Quat)

property hand_index

[Read-Only] Hand Index

Type

(ControllerHand)

property hand_key_positions

[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

[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

[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

[Read-Only] Is Grasped

Type

(bool)

property tracking_status

[Read-Only] Tracking Status

Type

(TrackingStatus)

property valid

[Read-Only] Valid

Type

(bool)