docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class XRCommonHandGestures

    Access to common hand gesture data and callbacks.

    Inheritance
    object
    XRCommonHandGestures
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEngine.XR.Hands
    Assembly: Unity.XR.Hands.dll
    Syntax
    public class XRCommonHandGestures

    Fields

    aimActivateValueUpdated

    Called when the aim activate value is updated. Either the value changed, or the ability to retrieve it changed.

    Declaration
    public Action<XRCommonHandGestures.AimActivateValueUpdatedEventArgs> aimActivateValueUpdated
    Field Value
    Type Description
    Action<XRCommonHandGestures.AimActivateValueUpdatedEventArgs>

    aimPoseUpdated

    Called when the aim pose is updated. Either the pose changed, or the ability to retrieve it changed.

    Declaration
    public Action<XRCommonHandGestures.AimPoseUpdatedEventArgs> aimPoseUpdated
    Field Value
    Type Description
    Action<XRCommonHandGestures.AimPoseUpdatedEventArgs>

    graspValueUpdated

    Called when the grasp value is updated. Either the value changed, or the ability to retrieve it changed.

    Declaration
    public Action<XRCommonHandGestures.GraspValueUpdatedEventArgs> graspValueUpdated
    Field Value
    Type Description
    Action<XRCommonHandGestures.GraspValueUpdatedEventArgs>

    gripPoseUpdated

    Called when the grip pose is updated. Either the pose changed, or the ability to retrieve it changed.

    Declaration
    public Action<XRCommonHandGestures.GripPoseUpdatedEventArgs> gripPoseUpdated
    Field Value
    Type Description
    Action<XRCommonHandGestures.GripPoseUpdatedEventArgs>

    pinchPoseUpdated

    Called when the pinch pose is updated. Either the pose changed, or the ability to retrieve it changed.

    Declaration
    public Action<XRCommonHandGestures.PinchPoseUpdatedEventArgs> pinchPoseUpdated
    Field Value
    Type Description
    Action<XRCommonHandGestures.PinchPoseUpdatedEventArgs>

    pinchValueUpdated

    Called when the pinch value is updated. Either the value changed, or the ability to retrieve it changed.

    Declaration
    public Action<XRCommonHandGestures.PinchValueUpdatedEventArgs> pinchValueUpdated
    Field Value
    Type Description
    Action<XRCommonHandGestures.PinchValueUpdatedEventArgs>

    pokePoseUpdated

    Called when the poke pose is updated. Either the pose changed, or the ability to retrieve it changed.

    Declaration
    public Action<XRCommonHandGestures.PokePoseUpdatedEventArgs> pokePoseUpdated
    Field Value
    Type Description
    Action<XRCommonHandGestures.PokePoseUpdatedEventArgs>

    Methods

    TryGetAimActivateValue(out float)

    Attempts to get the aim activate value.

    Declaration
    public bool TryGetAimActivateValue(out float aimActivateValue)
    Parameters
    Type Name Description
    float aimActivateValue

    Will be filled out with the aim activate value, if successful.

    Returns
    Type Description
    bool

    Returns true and a valid value is filled out. Returns false otherwise.

    TryGetAimPose(out Pose)

    Attempts to get the aim pose.

    Declaration
    public bool TryGetAimPose(out Pose aimPose)
    Parameters
    Type Name Description
    Pose aimPose

    Will be filled out with the aim pose, if successful.

    Returns
    Type Description
    bool

    Returns true if successful, returns false otherwise.

    TryGetGraspValue(out float)

    Attempts to get the grasp value.

    Declaration
    public bool TryGetGraspValue(out float graspValue)
    Parameters
    Type Name Description
    float graspValue

    Will be filled out with the grasp value, if successful.

    Returns
    Type Description
    bool

    Returns true and a valid value is filled out. Returns false otherwise.

    TryGetGripPose(out Pose)

    Attempts to get the grip pose.

    Declaration
    public bool TryGetGripPose(out Pose gripPose)
    Parameters
    Type Name Description
    Pose gripPose

    Will be filled out with the grip pose, if successful.

    Returns
    Type Description
    bool

    Returns true if successful, returns false otherwise.

    TryGetPinchPose(out Pose)

    Attempts to get the pinch pose.

    Declaration
    public bool TryGetPinchPose(out Pose pinchPose)
    Parameters
    Type Name Description
    Pose pinchPose

    Will be filled out with the pinch pose, if successful.

    Returns
    Type Description
    bool

    Returns true if successful, returns false otherwise.

    TryGetPinchValue(out float)

    Attempts to get the pinch value.

    Declaration
    public bool TryGetPinchValue(out float pinchValue)
    Parameters
    Type Name Description
    float pinchValue

    Will be filled out with the pinch value, if successful.

    Returns
    Type Description
    bool

    Returns true and a valid value is filled out. Returns false otherwise.

    TryGetPokePose(out Pose)

    Attempts to get the poke pose.

    Declaration
    public bool TryGetPokePose(out Pose pokePose)
    Parameters
    Type Name Description
    Pose pokePose

    Will be filled out with the poke pose, if successful.

    Returns
    Type Description
    bool

    Returns true if successful, returns false otherwise.

    In This Article
    Back to top
    Copyright © 2025 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)