docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class XRInteractionSimulatorState

    State class for the XRInteractionSimulator.

    Inheritance
    object
    XRInteractionSimulatorState
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEngine.XR.Interaction.Toolkit.Inputs.Simulation
    Assembly: Unity.XR.Interaction.Toolkit.dll
    Syntax
    public class XRInteractionSimulatorState
    Remarks

    Settable properties are assigned each frame in XRInteractionSimulator.

    Properties

    activeControllerHotkeyButtons

    The currently active hotkey buttons for the controller device.

    Declaration
    public HeldHotkeyButtons activeControllerHotkeyButtons { get; }
    Property Value
    Type Description
    HeldHotkeyButtons
    See Also
    currentState
    previousState

    currentControllerInputMode

    The controller input mode which the controller should currently simulate.

    Declaration
    public ControllerInputMode currentControllerInputMode { get; }
    Property Value
    Type Description
    ControllerInputMode
    See Also
    currentState
    previousState

    currentHandExpression

    The hand expression which the simulated hands should currently simulate.

    Declaration
    public SimulatedHandExpression currentHandExpression { get; }
    Property Value
    Type Description
    SimulatedHandExpression
    See Also
    currentState
    previousState

    deviceMode

    Whether the simulator is in controller mode or tracked hand mode.

    Declaration
    public SimulatedDeviceLifecycleManager.DeviceMode deviceMode { get; }
    Property Value
    Type Description
    SimulatedDeviceLifecycleManager.DeviceMode
    See Also
    currentState
    previousState

    handExpressionToggleHeld

    Whether a hand expression toggle input is currently held.

    Declaration
    public bool handExpressionToggleHeld { get; }
    Property Value
    Type Description
    bool
    See Also
    toggleInput

    isRotatingDown

    Whether or not the active device in the simulator is rotating down.

    Declaration
    public bool isRotatingDown { get; }
    Property Value
    Type Description
    bool
    See Also
    currentState
    previousState

    isRotatingLeft

    Whether or not the active device in the simulator is rotating left.

    Declaration
    public bool isRotatingLeft { get; }
    Property Value
    Type Description
    bool
    See Also
    currentState
    previousState

    isRotatingRight

    Whether or not the active device in the simulator is rotating right.

    Declaration
    public bool isRotatingRight { get; }
    Property Value
    Type Description
    bool
    See Also
    currentState
    previousState

    isRotatingUp

    Whether or not the active device in the simulator is rotating up.

    Declaration
    public bool isRotatingUp { get; }
    Property Value
    Type Description
    bool
    See Also
    currentState
    previousState

    isTranslatingBackward

    Whether or not the active device in the simulator is translating backward.

    Declaration
    public bool isTranslatingBackward { get; }
    Property Value
    Type Description
    bool
    See Also
    currentState
    previousState

    isTranslatingDown

    Whether or not the active device in the simulator is translating down.

    Declaration
    public bool isTranslatingDown { get; }
    Property Value
    Type Description
    bool
    See Also
    currentState
    previousState

    isTranslatingForward

    Whether or not the active device in the simulator is translating forward.

    Declaration
    public bool isTranslatingForward { get; }
    Property Value
    Type Description
    bool
    See Also
    currentState
    previousState

    isTranslatingLeft

    Whether or not the active device in the simulator is translating left.

    Declaration
    public bool isTranslatingLeft { get; }
    Property Value
    Type Description
    bool
    See Also
    currentState
    previousState

    isTranslatingRight

    Whether or not the active device in the simulator is translating right.

    Declaration
    public bool isTranslatingRight { get; }
    Property Value
    Type Description
    bool
    See Also
    currentState
    previousState

    isTranslatingUp

    Whether or not the active device in the simulator is translating up.

    Declaration
    public bool isTranslatingUp { get; }
    Property Value
    Type Description
    bool
    See Also
    currentState
    previousState

    leftControllerInputMode

    The left controller input mode which the controller should currently simulate.

    Declaration
    public ControllerInputMode leftControllerInputMode { get; }
    Property Value
    Type Description
    ControllerInputMode
    See Also
    currentState
    previousState

    leftDeviceHotkeyModifierPressed

    Whether the modifier for left-handed hotkeys is actively pressed.

    Declaration
    public bool leftDeviceHotkeyModifierPressed { get; }
    Property Value
    Type Description
    bool
    See Also
    currentState
    previousState

    leftHandExpression

    The left hand expression which the simulated hands should currently simulate.

    Declaration
    public SimulatedHandExpression leftHandExpression { get; }
    Property Value
    Type Description
    SimulatedHandExpression
    See Also
    currentState
    previousState

    manipulatingFPS

    Whether the simulator is manipulating the HMD, Left Controller, and Right Controller as if the whole player was turning their torso, similar to a typical FPS style.

    Declaration
    public bool manipulatingFPS { get; }
    Property Value
    Type Description
    bool
    See Also
    currentState
    previousState

    manipulatingHMD

    Whether the simulator is manipulating the HMD.

    Declaration
    public bool manipulatingHMD { get; }
    Property Value
    Type Description
    bool
    See Also
    currentState
    previousState

    manipulatingLeftController

    Whether the simulator is manipulating the Left Controller.

    Declaration
    public bool manipulatingLeftController { get; }
    Property Value
    Type Description
    bool
    See Also
    currentState
    previousState

    manipulatingLeftDevice

    Whether the simulator is manipulating the Left device (controller or hand).

    Declaration
    public bool manipulatingLeftDevice { get; }
    Property Value
    Type Description
    bool
    See Also
    currentState
    previousState

    manipulatingLeftHand

    Whether the simulator is manipulating the Left Hand.

    Declaration
    public bool manipulatingLeftHand { get; }
    Property Value
    Type Description
    bool
    See Also
    currentState
    previousState

    manipulatingRightController

    Whether the simulator is manipulating the Right Controller.

    Declaration
    public bool manipulatingRightController { get; }
    Property Value
    Type Description
    bool
    See Also
    currentState
    previousState

    manipulatingRightDevice

    Whether the simulator is manipulating the Right device (controller or hand).

    Declaration
    public bool manipulatingRightDevice { get; }
    Property Value
    Type Description
    bool
    See Also
    currentState
    previousState

    manipulatingRightHand

    Whether the simulator is manipulating the Right Hand.

    Declaration
    public bool manipulatingRightHand { get; }
    Property Value
    Type Description
    bool
    See Also
    currentState
    previousState

    performingLeftQuickAction

    Whether the simulator is currently performing a quick-action on the left-handed device.

    Declaration
    public bool performingLeftQuickAction { get; }
    Property Value
    Type Description
    bool
    See Also
    currentState
    previousState

    performingRightQuickAction

    Whether the simulator is currently performing a quick-action on the right-handed device.

    Declaration
    public bool performingRightQuickAction { get; }
    Property Value
    Type Description
    bool
    See Also
    currentState
    previousState

    rightControllerInputMode

    The right controller input mode which the controller should currently simulate.

    Declaration
    public ControllerInputMode rightControllerInputMode { get; }
    Property Value
    Type Description
    ControllerInputMode
    See Also
    currentState
    previousState

    rightHandExpression

    The right hand expression which the simulated hands should currently simulate.

    Declaration
    public SimulatedHandExpression rightHandExpression { get; }
    Property Value
    Type Description
    SimulatedHandExpression
    See Also
    currentState
    previousState

    targetedDeviceInput

    The currently active/targeted devices in the interaction simulator.

    Declaration
    public TargetedDevices targetedDeviceInput { get; }
    Property Value
    Type Description
    TargetedDevices
    See Also
    currentState
    previousState

    See Also

    currentState
    previousState
    In This Article
    Back to top
    Copyright © 2026 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)