Class HandInteractionProfile.HandInteraction

A new interaction profile for hand tracking input device to provide actions through the OpenXR action system.

Inheritance
object
InputControl
InputDevice
TrackedDevice
XRController
HandInteractionProfile.HandInteraction
Inherited Members
XRController.leftHand
XRController.rightHand
InputDevice.InvalidDeviceId
InputDevice.ReadValueFromBufferAsObject(void*, int)
InputDevice.ReadValueFromStateAsObject(void*)
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 = "Hand Interaction (OpenXR)", commonUsages = new string[] { "LeftHand", "RightHand" })]
public class HandInteractionProfile.HandInteraction : XRController

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. This value is equivalent to mapping gripPose/position.

Declaration
[Preserve]
[InputControl(offset = 8, noisy = true, 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. This value is equivalent to mapping gripPose/rotation.

Declaration
[Preserve]
[InputControl(offset = 20, noisy = true, alias = "gripRotation")]
public QuaternionControl deviceRotation { get; }
Property Value
Type Description
QuaternionControl

graspFirm

An ButtonControl that represents the graspValue OpenXR binding.

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

graspReady

An AxisControl that represents the graspReady OpenXR binding.

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

graspValue

An AxisControl that represents the graspValue OpenXR binding.

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

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 gripPose/isTracked.

Declaration
[Preserve]
[InputControl(offset = 2)]
public ButtonControl isTracked { get; }
Property Value
Type Description
ButtonControl

pinchPose

A PoseControl that represents the pinch OpenXR binding.

Declaration
[Preserve]
[InputControl(offset = 0, usage = "Pinch")]
public PoseControl pinchPose { get; }
Property Value
Type Description
PoseControl

pinchPosition

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

Declaration
[Preserve]
[InputControl(offset = 188, noisy = true)]
public Vector3Control pinchPosition { get; }
Property Value
Type Description
Vector3Control

pinchReady

An AxisControl that represents the pinchReady OpenXR binding.

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

pinchRotation

A QuaternionControl required for backwards compatibility with the XRSDK layouts. This is the pinch orientation. This value is equivalent to mapping pinchPose/rotation.

Declaration
[Preserve]
[InputControl(offset = 200, noisy = true)]
public QuaternionControl pinchRotation { get; }
Property Value
Type Description
QuaternionControl

pinchTouched

An ButtonControl that represents the pinchValue OpenXR binding.

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

pinchValue

An AxisControl that represents the pinchValue OpenXR binding.

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

pointer

A PoseControl that represents the aim OpenXR binding.

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

pointerActivateReady

An AxisControl that represents the pointerActivateReady OpenXR binding.

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

pointerActivateValue

An AxisControl that represents the pointerActivateValue OpenXR binding.

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

pointerActivated

An ButtonControl that represents the pointerActivateValue OpenXR binding.

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

pointerPosition

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

Declaration
[Preserve]
[InputControl(offset = 68, noisy = true)]
public Vector3Control pointerPosition { get; }
Property Value
Type Description
Vector3Control

pointerRotation

A QuaternionControl required for backwards compatibility with the XRSDK layouts. This is the aim orientation. This value is equivalent to mapping aimPose/rotation.

Declaration
[Preserve]
[InputControl(offset = 80, noisy = true)]
public QuaternionControl pointerRotation { get; }
Property Value
Type Description
QuaternionControl

pokePose

A PoseControl that represents the poke OpenXR binding.

Declaration
[Preserve]
[InputControl(offset = 0, usage = "Poke")]
public PoseControl pokePose { get; }
Property Value
Type Description
PoseControl

pokePosition

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

Declaration
[Preserve]
[InputControl(offset = 128, noisy = true)]
public Vector3Control pokePosition { get; }
Property Value
Type Description
Vector3Control

pokeRotation

A QuaternionControl required for backwards compatibility with the XRSDK layouts. This is the poke orientation. This value is equivalent to mapping pokePose/rotation.

Declaration
[Preserve]
[InputControl(offset = 140, noisy = true)]
public QuaternionControl pokeRotation { get; }
Property Value
Type Description
QuaternionControl

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 gripPose/trackingState.

Declaration
[Preserve]
[InputControl(offset = 4)]
public IntegerControl trackingState { get; }
Property Value
Type Description
IntegerControl

Methods

FinishSetup()

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

Declaration
protected override void FinishSetup()
Overrides

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