docs.unity3d.com
    Show / Hide Table of Contents

    Class HTCViveControllerProfile.ViveController

    An Input System device based off the HTC Vive Controller.

    Inheritance
    Object
    InputControl
    InputDevice
    TrackedDevice
    XRController
    XRControllerWithRumble
    HTCViveControllerProfile.ViveController
    Inherited Members
    XRControllerWithRumble.SendImpulse(Single, Single)
    XRController.leftHand
    XRController.rightHand
    InputDevice.InvalidDeviceId
    InputDevice.ReadValueFromBufferAsObject(Void*, Int32)
    InputDevice.ReadValueFromStateAsObject(Void*)
    InputDevice.ReadValueFromStateIntoBuffer(Void*, Void*, Int32)
    InputDevice.CompareValue(Void*, Void*)
    InputDevice.MakeCurrent()
    InputDevice.OnAdded()
    InputDevice.OnRemoved()
    InputDevice.OnConfigurationChanged()
    InputDevice.ExecuteCommand<TCommand>(TCommand)
    InputDevice.ExecuteCommand(InputDeviceCommand*)
    InputDevice.description
    InputDevice.enabled
    InputDevice.canRunInBackground
    InputDevice.added
    InputDevice.remote
    InputDevice.native
    InputDevice.updateBeforeRender
    InputDevice.deviceId
    InputDevice.lastUpdateTime
    InputDevice.wasUpdatedThisFrame
    InputDevice.allControls
    InputDevice.valueType
    InputDevice.valueSizeInBytes
    UnityEngine.InputSystem.InputDevice.all
    InputControl.m_StateBlock
    InputControl.ToString()
    InputControl.EvaluateMagnitude()
    InputControl.EvaluateMagnitude(Void*)
    InputControl.WriteValueFromBufferIntoState(Void*, Int32, Void*)
    InputControl.WriteValueFromObjectIntoState(Object, Void*)
    InputControl.TryGetChildControl(String)
    InputControl.TryGetChildControl<TControl>(String)
    InputControl.GetChildControl(String)
    InputControl.GetChildControl<TControl>(String)
    InputControl.RefreshConfigurationIfNeeded()
    InputControl.RefreshConfiguration()
    InputControl.name
    InputControl.displayName
    InputControl.shortDisplayName
    InputControl.path
    InputControl.layout
    InputControl.variants
    InputControl.device
    InputControl.parent
    InputControl.children
    InputControl.usages
    InputControl.aliases
    InputControl.stateBlock
    InputControl.noisy
    InputControl.synthetic
    InputControl.Item[String]
    InputControl.currentStatePtr
    InputControl.previousFrameStatePtr
    InputControl.defaultStatePtr
    InputControl.noiseMaskPtr
    InputControl.stateOffsetRelativeToDeviceRoot
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: UnityEngine.XR.OpenXR.Features.Interactions
    Syntax
    [Preserve]
    [InputControlLayout(displayName = "HTC Vive Controller (OpenXR)", commonUsages = new string[]{"LeftHand", "RightHand"})]
    public class ViveController : XRControllerWithRumble

    Properties

    devicePose

    A PoseControl that represents information from the grip OpenXR binding.

    Declaration
    [Preserve]
    public PoseControl devicePose { get; }
    Property Value
    Type Description
    PoseControl

    devicePosition

    A Vector3Control required for back compatibility with the XRSDK layouts. This is the device position. For the Oculus Touch device, this is both the grip and the pointer position. This value is equivalent to mapping devicePose/position.

    Declaration
    [Preserve]
    public Vector3Control devicePosition { get; }
    Property Value
    Type Description
    Vector3Control

    deviceRotation

    A QuaternionControl required for backwards compatibility with the XRSDK layouts. This is the device orientation. For the Oculus Touch device, this is both the grip and the pointer rotation. This value is equivalent to mapping devicePose/rotation.

    Declaration
    [Preserve]
    public QuaternionControl deviceRotation { get; }
    Property Value
    Type Description
    QuaternionControl

    grip

    A AxisControl that represents information from the squeeze OpenXR binding.

    Declaration
    [Preserve]
    public AxisControl grip { get; }
    Property Value
    Type Description
    AxisControl

    gripPressed

    A ButtonControl that represents information from the squeeze OpenXR binding.

    Declaration
    [Preserve]
    public ButtonControl gripPressed { get; }
    Property Value
    Type Description
    ButtonControl

    haptic

    A HapticControl that represents the haptic binding.

    Declaration
    [Preserve]
    public HapticControl haptic { get; }
    Property Value
    Type Description
    HapticControl

    isTracked

    A ButtonControl required for backwards compatibility with the XRSDK layouts. This represents the overall tracking state of the device. This value is equivalent to mapping devicePose/isTracked.

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

    menu

    A ButtonControl that represents information from the menu OpenXR binding.

    Declaration
    [Preserve]
    public ButtonControl menu { get; }
    Property Value
    Type Description
    ButtonControl

    pointer

    A PoseControl that represents information from the aim OpenXR binding.

    Declaration
    [Preserve]
    public PoseControl pointer { get; }
    Property Value
    Type Description
    PoseControl

    pointerPosition

    A Vector3Control required for back compatibility with the XRSDK layouts. This is the pointer position. This value is equivalent to mapping pointerPose/position.

    Declaration
    [Preserve]
    public Vector3Control pointerPosition { get; }
    Property Value
    Type Description
    Vector3Control

    pointerRotation

    A QuaternionControl required for backwards compatibility with the XRSDK layouts. This is the pointer rotation. This value is equivalent to mapping pointerPose/rotation.

    Declaration
    [Preserve]
    public QuaternionControl pointerRotation { get; }
    Property Value
    Type Description
    QuaternionControl

    select

    A ButtonControl that represents information from the HTC Vive Controller Profile select OpenXR binding.

    Declaration
    [Preserve]
    public ButtonControl select { get; }
    Property Value
    Type Description
    ButtonControl

    trackingState

    A IntegerControl required for back compatibility with the XRSDK layouts. This represents the bit flag set indicating what data is valid. This value is equivalent to mapping devicePose/trackingState.

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

    trackpad

    A Vector2Control that represents information from the trackpad OpenXR binding.

    Declaration
    [Preserve]
    public Vector2Control trackpad { get; }
    Property Value
    Type Description
    Vector2Control

    trackpadClicked

    A ButtonControl that represents information from the trackpadClick OpenXR binding.

    Declaration
    [Preserve]
    public ButtonControl trackpadClicked { get; }
    Property Value
    Type Description
    ButtonControl

    trackpadTouched

    A ButtonControl that represents information from the trackpadTouch OpenXR binding.

    Declaration
    [Preserve]
    public ButtonControl trackpadTouched { get; }
    Property Value
    Type Description
    ButtonControl

    trigger

    A AxisControl that represents information from the trigger OpenXR binding.

    Declaration
    [Preserve]
    public AxisControl trigger { get; }
    Property Value
    Type Description
    AxisControl

    triggerPressed

    A ButtonControl that represents information from the triggerClick OpenXR binding.

    Declaration
    [Preserve]
    public ButtonControl triggerPressed { get; }
    Property Value
    Type Description
    ButtonControl

    Methods

    FinishSetup()

    OpenXR Input System device

    Declaration
    protected override void FinishSetup()
    Overrides
    XRController.FinishSetup()
    See Also
    InputDevice
    In This Article
    • Properties
      • devicePose
      • devicePosition
      • deviceRotation
      • grip
      • gripPressed
      • haptic
      • isTracked
      • menu
      • pointer
      • pointerPosition
      • pointerRotation
      • select
      • trackingState
      • trackpad
      • trackpadClicked
      • trackpadTouched
      • trigger
      • triggerPressed
    • Methods
      • FinishSetup()
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023