docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    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.ReadValueFromStateIntoBuffer(void*, void*, int)
    InputDevice.CompareValue(void*, void*)
    InputDevice.MakeCurrent()
    InputDevice.OnAdded()
    InputDevice.OnRemoved()
    InputDevice.OnConfigurationChanged()
    InputDevice.ExecuteCommand<TCommand>(ref 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
    InputDevice.all
    InputControl.m_StateBlock
    InputControl.ToString()
    InputControl.EvaluateMagnitude()
    InputControl.EvaluateMagnitude(void*)
    InputControl.WriteValueFromBufferIntoState(void*, int, void*)
    InputControl.WriteValueFromObjectIntoState(object, void*)
    InputControl.TryGetChildControl(string)
    InputControl.TryGetChildControl<TControl>(string)
    InputControl.GetChildControl(string)
    InputControl.GetChildControl<TControl>(string)
    InputControl.RefreshConfigurationIfNeeded()
    InputControl.RefreshConfiguration()
    InputControl.CalculateOptimizedControlDataType()
    InputControl.ApplyParameterChanges()
    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.this[string]
    InputControl.magnitude
    InputControl.currentStatePtr
    InputControl.previousFrameStatePtr
    InputControl.defaultStatePtr
    InputControl.noiseMaskPtr
    InputControl.stateOffsetRelativeToDeviceRoot
    InputControl.optimizedControlDataType
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: UnityEngine.XR.OpenXR.Features.Interactions
    Assembly: solution.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 HandInteraction.grip OpenXR binding.

    Declaration
    [Preserve]
    [InputControlAttribute]
    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]
    [InputControlAttribute]
    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]
    [InputControlAttribute]
    public QuaternionControl deviceRotation { get; }
    Property Value
    Type Description
    QuaternionControl

    graspReady

    An AxisControl that represents the graspReady OpenXR binding.

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

    graspValue

    An AxisControl that represents the graspValue OpenXR binding.

    Declaration
    [Preserve]
    [InputControlAttribute]
    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]
    [InputControlAttribute]
    public ButtonControl isTracked { get; }
    Property Value
    Type Description
    ButtonControl

    pinchPose

    A PoseControl that represents the HandInteraction.pinch OpenXR binding.

    Declaration
    [Preserve]
    [InputControlAttribute]
    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]
    [InputControlAttribute]
    public Vector3Control pinchPosition { get; }
    Property Value
    Type Description
    Vector3Control

    pinchReady

    An AxisControl that represents the pinchReady OpenXR binding.

    Declaration
    [Preserve]
    [InputControlAttribute]
    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]
    [InputControlAttribute]
    public QuaternionControl pinchRotation { get; }
    Property Value
    Type Description
    QuaternionControl

    pinchValue

    An AxisControl that represents the pinchValue OpenXR binding.

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

    pointer

    A PoseControl that represents the HandInteraction.aim OpenXR binding.

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

    pointerActivateReady

    An AxisControl that represents the pointerActivateReady OpenXR binding.

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

    pointerActivateValue

    An AxisControl that represents the pointerActivateValue OpenXR binding.

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

    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]
    [InputControlAttribute]
    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]
    [InputControlAttribute]
    public QuaternionControl pointerRotation { get; }
    Property Value
    Type Description
    QuaternionControl

    pokePose

    A PoseControl that represents the HandInteraction.poke OpenXR binding.

    Declaration
    [Preserve]
    [InputControlAttribute]
    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]
    [InputControlAttribute]
    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]
    [InputControlAttribute]
    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]
    [InputControlAttribute]
    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
    XRController.FinishSetup()
    In This Article
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)