Class ValveIndexControllerProfile.ValveIndexController

An Input System device based on the hand interaction profile in the Valve Index Controller.

Inheritance
object
InputControl
InputDevice
TrackedDevice
XRController
XRControllerWithRumble
ValveIndexControllerProfile.ValveIndexController
Inherited Members
InputDevice.InvalidDeviceId
InputDevice.OnAdded()
InputDevice.ExecuteCommand<TCommand>(ref TCommand)
InputDevice.ExecuteCommand(InputDeviceCommand*)
InputDevice.description
InputDevice.enabled
InputDevice.canRunInBackground
InputDevice.added
InputDevice.native
InputDevice.deviceId
InputDevice.lastUpdateTime
InputDevice.allControls
InputDevice.all
InputControl.ToString()
InputControl.EvaluateMagnitude()
InputControl.RefreshConfigurationIfNeeded()
InputControl.RefreshConfiguration()
InputControl.CalculateOptimizedControlDataType()
InputControl.ApplyParameterChanges()
InputControl.displayName
InputControl.shortDisplayName
InputControl.variants
InputControl.device
InputControl.children
InputControl.usages
InputControl.aliases
InputControl.stateBlock
InputControl.synthetic
InputControl.currentStatePtr
InputControl.previousFrameStatePtr
InputControl.defaultStatePtr
InputControl.stateOffsetRelativeToDeviceRoot
Namespace: UnityEngine.XR.OpenXR.Features.Interactions
Assembly: Unity.XR.OpenXR.dll
Syntax
[Preserve]
[InputControlLayout(displayName = "Index Controller (OpenXR)", commonUsages = new string[] { "LeftHand", "RightHand" })]
public class ValveIndexControllerProfile.ValveIndexController : XRControllerWithRumble

Properties

devicePose

A PoseControl that represents the grip OpenXR binding.

Declaration
[Preserve]
[InputControl(offset = 0, aliases = new string[] { "device", "gripPose" }, usage = "Device")]
public PoseControl devicePose { get; }
Property Value
Type Description
PoseControl

devicePosition

A Vector3Control required for backwards compatibility with the XRSDK layouts. This is the device position, or grip position. This value is equivalent to mapping devicePose/position.

Declaration
[Preserve]
[InputControl(offset = 60, alias = "gripPosition")]
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, or grip orientation. This value is equivalent to mapping devicePose/rotation.

Declaration
[Preserve]
[InputControl(offset = 72, alias = "gripOrientation")]
public QuaternionControl deviceRotation { get; }
Property Value
Type Description
QuaternionControl

grip

A AxisControl that represents the squeeze OpenXR binding.

Declaration
[Preserve]
[InputControl(aliases = new string[] { "GripAxis", "squeeze" }, usage = "Grip")]
public AxisControl grip { get; }
Property Value
Type Description
AxisControl

gripForce

A AxisControl that represents the squeezeForce OpenXR binding.

Declaration
[Preserve]
[InputControl(alias = "squeezeForce", usage = "GripForce")]
public AxisControl gripForce { get; }
Property Value
Type Description
AxisControl

gripPressed

A ButtonControl that represents the Valve Index Controller Profile gripPressed OpenXR binding.

Declaration
[Preserve]
[InputControl(aliases = new string[] { "GripButton", "squeezeClicked" }, usage = "GripButton")]
public ButtonControl gripPressed { get; }
Property Value
Type Description
ButtonControl

haptic

A HapticControl that represents the haptic binding.

Declaration
[Preserve]
[InputControl(usage = "Haptic")]
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]
[InputControl(offset = 53)]
public ButtonControl isTracked { get; }
Property Value
Type Description
ButtonControl

pointer

A PoseControl that represents the Valve Index Controller Profile pointer OpenXR binding.

Declaration
[Preserve]
[InputControl(offset = 0, alias = "aimPose", usage = "Pointer")]
public PoseControl pointer { get; }
Property Value
Type Description
PoseControl

pointerPosition

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

Declaration
[Preserve]
[InputControl(offset = 120)]
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]
[InputControl(offset = 132, alias = "pointerOrientation")]
public QuaternionControl pointerRotation { get; }
Property Value
Type Description
QuaternionControl

primaryButton

A ButtonControl that represents the buttonA OpenXR binding.

Declaration
[Preserve]
[InputControl(usage = "PrimaryButton")]
public ButtonControl primaryButton { get; }
Property Value
Type Description
ButtonControl

primaryTouched

A ButtonControl that represents the buttonATouch OpenXR binding.

Declaration
[Preserve]
[InputControl(usage = "PrimaryTouch")]
public ButtonControl primaryTouched { get; }
Property Value
Type Description
ButtonControl

secondaryButton

A ButtonControl that represents the buttonB OpenXR binding.

Declaration
[Preserve]
[InputControl(usage = "SecondaryButton")]
public ButtonControl secondaryButton { get; }
Property Value
Type Description
ButtonControl

secondaryTouched

A ButtonControl that represents the buttonBTouch OpenXR binding.

Declaration
[Preserve]
[InputControl(usage = "SecondaryTouch")]
public ButtonControl secondaryTouched { get; }
Property Value
Type Description
ButtonControl

system

A ButtonControl that represents the system OpenXR binding.

Declaration
[Preserve]
[InputControl(alias = "systemButton", usage = "MenuButton")]
public ButtonControl system { get; }
Property Value
Type Description
ButtonControl

systemTouched

A ButtonControl that represents the systemTouch OpenXR binding.

Declaration
[Preserve]
[InputControl(usage = "MenuTouch")]
public ButtonControl systemTouched { get; }
Property Value
Type Description
ButtonControl

thumbstick

A Vector2Control/StickControl that represents the thumbstick OpenXR binding.

Declaration
[Preserve]
[InputControl(aliases = new string[] { "joystick", "Primary2DAxis" }, usage = "Primary2DAxis")]
public Vector2Control thumbstick { get; }
Property Value
Type Description
Vector2Control

thumbstickClicked

A ButtonControl that represents the thumbstickClick OpenXR binding.

Declaration
[Preserve]
[InputControl(alias = "joystickClicked", usage = "Primary2DAxisClick")]
public ButtonControl thumbstickClicked { get; }
Property Value
Type Description
ButtonControl

thumbstickTouched

A ButtonControl that represents the thumbstickTouch OpenXR binding.

Declaration
[Preserve]
[InputControl(alias = "joystickTouched", usage = "Primary2DAxisTouch")]
public ButtonControl thumbstickTouched { get; }
Property Value
Type Description
ButtonControl

trackingState

A IntegerControl required for backwards 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]
[InputControl(offset = 56)]
public IntegerControl trackingState { get; }
Property Value
Type Description
IntegerControl

trackpad

A Vector2Control/StickControl that represents the trackpad OpenXR binding.

Declaration
[Preserve]
[InputControl(aliases = new string[] { "touchpad", "Secondary2DAxis" }, usage = "Secondary2DAxis")]
public Vector2Control trackpad { get; }
Property Value
Type Description
Vector2Control

trackpadForce

A AxisControl that represents the trackpadForce OpenXR binding.

Declaration
[Preserve]
[InputControl(alias = "touchpadForce", usage = "Secondary2DAxisForce")]
public AxisControl trackpadForce { get; }
Property Value
Type Description
AxisControl

trackpadTouched

A ButtonControl that represents the trackpadTouch OpenXR binding.

Declaration
[Preserve]
[InputControl(alias = "touchpadTouched", usage = "Secondary2DAxisTouch")]
public ButtonControl trackpadTouched { get; }
Property Value
Type Description
ButtonControl

trigger

A AxisControl that represents the trigger OpenXR binding.

Declaration
[Preserve]
[InputControl(usage = "Trigger")]
public AxisControl trigger { get; }
Property Value
Type Description
AxisControl

triggerPressed

A ButtonControl that represents the triggerClick OpenXR binding.

Declaration
[Preserve]
[InputControl(usage = "TriggerButton")]
public ButtonControl triggerPressed { get; }
Property Value
Type Description
ButtonControl

triggerTouched

A ButtonControl that represents the triggerTouch OpenXR binding.

Declaration
[Preserve]
[InputControl(usage = "TriggerTouch")]
public ButtonControl triggerTouched { get; }
Property Value
Type Description
ButtonControl

Methods

FinishSetup()

OpenXR Input System device

Declaration
protected override void FinishSetup()
Overrides
See Also