Class PoseControl

A control representing a Pose in 3D space, relative to an XR tracking origin

Inheritance
Object
InputControl
InputControl<PoseState>
PoseControl
Inherited Members
Namespace: UnityEngine.InputSystem.XR
Syntax
[Preserve]
public class PoseControl : InputControl<PoseState>
Remarks

Note that unlike most other control types, PoseControls do not have a flexible memory layout. They are hardwired to PoseState and will not work correctly with a different memory layouts. Additional fields may be appended to the struct but what's there in the struct has to be located at exactly those memory addresses.

For more information on tracking origins see TrackingOriginModeFlags.

Constructors

PoseControl()

Default-initialize the pose control.

Declaration
public PoseControl()
Remarks

Sets the format to "Pose".

Properties

angularVelocity

The angular velocity of this tracked pose relative to the tracking origin.

Declaration
public Vector3Control angularVelocity { get; }
Property Value
Type Description
Vector3Control

Control representing whether the pose is being fully tracked. Maps to the angularVelocity value of the pose retrieved from this control.
Remarks

The data for this control is only valid if the value returned from trackingState contains AngularVelocity value.

See Also

isTracked

Represents whether this pose is fully tracked or unavailable/simulated.

Declaration
public ButtonControl isTracked { get; }
Property Value
Type Description
ButtonControl

Control representing whether the pose is being fully tracked. Maps to the isTracked value.
See Also

position

The position, in meters, of this tracked pose relative to the tracking origin.

Declaration
public Vector3Control position { get; }
Property Value
Type Description
Vector3Control

Control representing whether the pose is being fully tracked. Maps to the position value of the pose retrieved from this control.
Remarks

The data for this control is only valid if the value returned from trackingState contains Position value.

See Also

rotation

The rotation of this tracked pose relative to the tracking origin.

Declaration
public QuaternionControl rotation { get; }
Property Value
Type Description
QuaternionControl

Control representing whether the pose is being fully tracked. Maps to the rotation value of the pose retrieved from this control.
Remarks

The data for this control is only valid if the value returned from trackingState contains Rotation value.

See Also

trackingState

The other controls on this PoseControl that are currently reporting data.

Declaration
public IntegerControl trackingState { get; }
Property Value
Type Description
IntegerControl

Control representing whether the pose is being fully tracked. Maps to the trackingState value of the pose retrieved from this control.
Remarks

This can be missing values when the device tracking this pose is restricted or not tracking properly.

See Also

velocity

The velocity, in meters per second, of this tracked pose relative to the tracking origin.

Declaration
public Vector3Control velocity { get; }
Property Value
Type Description
Vector3Control

Control representing whether the pose is being fully tracked. Maps to the velocity value of the pose retrieved from this control.
Remarks

The data for this control is only valid if the value returned from trackingState contains Velocity value.

See Also

Methods

FinishSetup()

Perform final initialization tasks after the control hierarchy has been put into place.

Declaration
protected override void FinishSetup()
Overrides
Remarks

This method can be overridden to perform control- or device-specific setup work. The most common use case is for looking up child controls and storing them in local getters.

public class MyDevice : InputDevice
{
    public ButtonControl button { get; private set; }
    public AxisControl axis { get; private set; }

    protected override void OnFinishSetup()
    {
        // Cache controls in getters.
        button = GetChildControl("button");
        axis = GetChildControl("axis");
    }
}

ReadUnprocessedValueFromState(Void*)

Declaration
public override PoseState ReadUnprocessedValueFromState(void *statePtr)
Parameters
Type Name Description
Void* statePtr
Returns
Type Description
PoseState
Overrides
UnityEngine.InputSystem.InputControl<UnityEngine.InputSystem.XR.PoseState>.ReadUnprocessedValueFromState(System.Void*)

WriteValueIntoState(PoseState, Void*)

Declaration
public override void WriteValueIntoState(PoseState value, void *statePtr)
Parameters
Type Name Description
PoseState value
Void* statePtr
Overrides
UnityEngine.InputSystem.InputControl<UnityEngine.InputSystem.XR.PoseState>.WriteValueIntoState(UnityEngine.InputSystem.XR.PoseState, System.Void*)

Extension Methods