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(float, float)
XRController.leftHand
XRController.rightHand
InputDevice.InvalidDeviceId
InputDevice.ReadValueFromBufferAsObject(void*, int)
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 = "HTC Vive Controller (OpenXR)", commonUsages = new string[] { "LeftHand", "RightHand" })]
public class HTCViveControllerProfile.ViveController : XRControllerWithRumble

Properties

devicePose

A PoseControl that represents information from 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 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]
[InputControl(offset = 32, 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. For the Oculus Touch device, this is both the grip and the pointer rotation. This value is equivalent to mapping devicePose/rotation.

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

grip

A AxisControl that represents information from the squeeze OpenXR binding.

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

gripPressed

A ButtonControl that represents information from the squeeze 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 = 26)]
public ButtonControl isTracked { get; }
Property Value
Type Description
ButtonControl

menu

A ButtonControl that represents information from the menu OpenXR binding.

Declaration
[Preserve]
[InputControl(aliases = new string[] { "Primary", "menubutton" }, usage = "MenuButton")]
public ButtonControl menu { get; }
Property Value
Type Description
ButtonControl

pointer

A PoseControl that represents information from the aim 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 back compatibility with the XRSDK layouts. This is the pointer position. This value is equivalent to mapping pointerPose/position.

Declaration
[Preserve]
[InputControl(offset = 92)]
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 = 104, alias = "pointerOrientation")]
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]
[InputControl(aliases = new string[] { "Secondary", "selectbutton" }, usage = "SystemButton")]
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]
[InputControl(offset = 28)]
public IntegerControl trackingState { get; }
Property Value
Type Description
IntegerControl

trackpad

A Vector2Control/StickControl that represents information from the trackpad OpenXR binding.

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

trackpadClicked

A ButtonControl that represents information from the trackpadClick OpenXR binding.

Declaration
[Preserve]
[InputControl(aliases = new string[] { "joystickorpadpressed", "touchpadpressed" }, usage = "Primary2DAxisClick")]
public ButtonControl trackpadClicked { get; }
Property Value
Type Description
ButtonControl

trackpadTouched

A ButtonControl that represents information from the trackpadTouch OpenXR binding.

Declaration
[Preserve]
[InputControl(aliases = new string[] { "joystickorpadtouched", "touchpadtouched" }, usage = "Primary2DAxisTouch")]
public ButtonControl trackpadTouched { get; }
Property Value
Type Description
ButtonControl

trigger

A AxisControl that represents information from the trigger OpenXR binding.

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

triggerPressed

A ButtonControl that represents information from the triggerClick OpenXR binding.

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

Methods

FinishSetup()

OpenXR Input System device

Declaration
protected override void FinishSetup()
Overrides
See Also

Did you find this page useful? Please give it a rating: