Class VIVEFocus3Profile.VIVEFocus3Controller

An Input System device based on the hand interaction profile in the Interaction Profile.

Inheritance
object
InputControl
InputDevice
TrackedDevice
XRController
XRControllerWithRumble
VIVEFocus3Profile.VIVEFocus3Controller
Inherited Members
Namespace: VIVE.OpenXR
Assembly: VIVE.OpenXR.dll
Syntax
[Preserve]
[InputControlLayout(displayName = "VIVE Focus 3 Controller (OpenXR)", commonUsages = new string[] { "LeftHand", "RightHand" })]
public class VIVEFocus3Profile.VIVEFocus3Controller : XRControllerWithRumble

Properties

devicePose

A UnityEngine.XR.OpenXR.Input.PoseControl that represents the gripPose OpenXR binding. The grip pose represents the location of the user's palm or holding a motion controller.

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. For the VIVE Focus 3 device, this is both the device 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 VIVE Focus 3 device, this is both the device 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 the grip 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 the gripPress OpenXR binding.

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

gripTouched

A ButtonControl that represents the gripTouch OpenXR binding.

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

haptic

A UnityEngine.XR.OpenXR.Input.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 = 24, usage = "IsTracked")]
public ButtonControl isTracked { get; }
Property Value
Type Description
ButtonControl

menu

A ButtonControl that represents the menu OpenXR bindings, depending on handedness.

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

parkingTouched

A ButtonControl that represents the thumbrest OpenXR binding.

Declaration
[Preserve]
[InputControl(aliases = new string[] { "ParkingTouched" })]
public ButtonControl parkingTouched { get; }
Property Value
Type Description
ButtonControl

pointerPose

A UnityEngine.XR.OpenXR.Input.PoseControl that represents the pointerPose OpenXR binding. The pointer pose represents the tip of the controller pointing forward.

Declaration
[Preserve]
[InputControl(offset = 0, alias = "aimPose", usage = "Pointer")]
public PoseControl pointerPose { 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

primaryButton

A ButtonControl that represents the buttonA buttonX OpenXR bindings, depending on handedness.

Declaration
[Preserve]
[InputControl(aliases = new string[] { "A", "X", "buttonA", "buttonX" }, usage = "PrimaryButton")]
public ButtonControl primaryButton { get; }
Property Value
Type Description
ButtonControl

secondaryButton

A ButtonControl that represents the buttonB buttonY OpenXR bindings, depending on handedness.

Declaration
[Preserve]
[InputControl(aliases = new string[] { "B", "Y", "buttonB", "buttonY" }, usage = "SecondaryButton")]
public ButtonControl secondaryButton { get; }
Property Value
Type Description
ButtonControl

thumbstick

A Vector2Control that represents the thumbstick OpenXR binding.

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

thumbstickClicked

A ButtonControl that represents the thumbstickClick OpenXR binding.

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

thumbstickTouched

A ButtonControl that represents the thumbstickTouch OpenXR binding.

Declaration
[Preserve]
[InputControl(aliases = new string[] { "Primary2DAxisTouch", "joystickTouch" }, 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 to indicate what data is valid. This value is equivalent to mapping devicePose/trackingState.

Declaration
[Preserve]
[InputControl(offset = 28, usage = "TrackingState")]
public IntegerControl trackingState { get; }
Property Value
Type Description
IntegerControl

trigger

A AxisControl that represents the trigger OpenXR binding.

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

triggerPressed

A ButtonControl that represents the triggerClick OpenXR binding.

Declaration
[Preserve]
[InputControl(aliases = new string[] { "triggerButton", "triggerClick" }, usage = "TriggerButton")]
public ButtonControl triggerPressed { get; }
Property Value
Type Description
ButtonControl

triggerTouched

A ButtonControl that represents the triggerTouch OpenXR binding.

Declaration
[Preserve]
[InputControl(aliases = new string[] { "triggerTouch", "indexTouch", "indexNearTouched" }, usage = "TriggerTouch")]
public ButtonControl triggerTouched { get; }
Property Value
Type Description
ButtonControl

Methods

FinishSetup()

Internal call used to assign controls to the the correct element.

Declaration
protected override void FinishSetup()
Overrides
UnityEngine.InputSystem.XR.XRController.FinishSetup()

OnUpdate()

Declaration
public void OnUpdate()