docs.unity3d.com
    Show / Hide Table of Contents

    Class DPadInteraction

    This OpenXRInteractionFeature enables the use of DPad feature in OpenXR.

    Inheritance
    Object
    Object
    ScriptableObject
    OpenXRFeature
    OpenXRInteractionFeature
    DPadInteraction
    Inherited Members
    OpenXRInteractionFeature.AddActionMap(OpenXRInteractionFeature.ActionMapConfig)
    OpenXRInteractionFeature.OnEnabledChange()
    OpenXRFeature.enabled
    OpenXRFeature.xrGetInstanceProcAddr
    OpenXRFeature.HookGetInstanceProcAddr(IntPtr)
    OpenXRFeature.OnSubsystemCreate()
    OpenXRFeature.OnSubsystemStart()
    OpenXRFeature.OnSubsystemStop()
    OpenXRFeature.OnSubsystemDestroy()
    OpenXRFeature.OnSystemChange(UInt64)
    OpenXRFeature.OnSessionCreate(UInt64)
    OpenXRFeature.OnAppSpaceChange(UInt64)
    OpenXRFeature.OnSessionStateChange(Int32, Int32)
    OpenXRFeature.OnSessionBegin(UInt64)
    OpenXRFeature.OnSessionEnd(UInt64)
    OpenXRFeature.OnSessionExiting(UInt64)
    OpenXRFeature.OnSessionDestroy(UInt64)
    OpenXRFeature.OnInstanceDestroy(UInt64)
    OpenXRFeature.OnSessionLossPending(UInt64)
    OpenXRFeature.OnInstanceLossPending(UInt64)
    OpenXRFeature.OnFormFactorChange(Int32)
    OpenXRFeature.OnViewConfigurationTypeChange(Int32)
    OpenXRFeature.OnEnvironmentBlendModeChange(XrEnvironmentBlendMode)
    OpenXRFeature.PathToString(UInt64)
    OpenXRFeature.StringToPath(String)
    OpenXRFeature.GetCurrentInteractionProfile(UInt64)
    OpenXRFeature.GetCurrentInteractionProfile(String)
    OpenXRFeature.GetCurrentAppSpace()
    OpenXRFeature.GetViewConfigurationTypeForRenderPass(Int32)
    OpenXRFeature.SetEnvironmentBlendMode(XrEnvironmentBlendMode)
    OpenXRFeature.GetEnvironmentBlendMode()
    OpenXRFeature.CreateSubsystem<TDescriptor, TSubsystem>(List<TDescriptor>, String)
    OpenXRFeature.StartSubsystem<T>()
    OpenXRFeature.StopSubsystem<T>()
    OpenXRFeature.DestroySubsystem<T>()
    OpenXRFeature.OnEnable()
    OpenXRFeature.OnDisable()
    OpenXRFeature.Awake()
    OpenXRFeature.GetAction(InputAction)
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(String)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(Object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, Boolean)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, Boolean)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsSortMode)
    UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
    UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
    UnityEngine.Object.FindFirstObjectByType<T>()
    UnityEngine.Object.FindAnyObjectByType<T>()
    UnityEngine.Object.FindFirstObjectByType<T>(UnityEngine.FindObjectsInactive)
    UnityEngine.Object.FindAnyObjectByType<T>(UnityEngine.FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, Boolean)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: UnityEngine.XR.OpenXR.Features.Interactions
    Syntax
    public class DPadInteraction : OpenXRInteractionFeature

    Fields

    centerRegionLeft

    the radius in the input value space, of a logically circular region in the center of the input, in the range (0, 1).

    Declaration
    public float centerRegionLeft
    Field Value
    Type Description
    Single

    centerRegionRight

    the radius in the input value space, of a logically circular region in the center of the input, in the range (0, 1).

    Declaration
    public float centerRegionRight
    Field Value
    Type Description
    Single

    extensionStrings

    The OpenXR Extension strings. This is used by OpenXR to check if this extension is available or enabled. ///

    Declaration
    public string[] extensionStrings
    Field Value
    Type Description
    String[]

    featureId

    The feature id string. This is used to give the feature a well known id for reference.

    Declaration
    public const string featureId = "com.unity.openxr.feature.input.dpadinteraction"
    Field Value
    Type Description
    String

    forceThresholdLeft

    a number in the half-open range (0, 1] representing the force value threshold at or above which ≥ a dpad input will transition from inactive to active.

    Declaration
    public float forceThresholdLeft
    Field Value
    Type Description
    Single

    forceThresholdReleaseLeft

    a number in the half-open range (0, 1] representing the force value threshold strictly below which less than a dpad input will transition from active to inactive.

    Declaration
    public float forceThresholdReleaseLeft
    Field Value
    Type Description
    Single

    forceThresholdReleaseRight

    a number in the half-open range (0, 1] representing the force value threshold strictly below which less than a dpad input will transition from active to inactive.

    Declaration
    public float forceThresholdReleaseRight
    Field Value
    Type Description
    Single

    forceThresholdRight

    a number in the half-open range (0, 1] representing the force value threshold at or above which ≥ a dpad input will transition from inactive to active.

    Declaration
    public float forceThresholdRight
    Field Value
    Type Description
    Single

    isStickyLeft

    indicates that the implementation will latch the first region that is activated and continue to indicate that the binding for that region is true until the user releases the input underlying the virtual dpad.

    Declaration
    public bool isStickyLeft
    Field Value
    Type Description
    Boolean

    isStickyRight

    indicates that the implementation will latch the first region that is activated and continue to indicate that the binding for that region is true until the user releases the input underlying the virtual dpad.

    Declaration
    public bool isStickyRight
    Field Value
    Type Description
    Boolean

    profile

    A unique string for dpad feature

    Declaration
    public const string profile = "/interaction_profiles/unity/dpad"
    Field Value
    Type Description
    String

    thumbstickDpadDown

    Constant for a boolean interaction binding '.../thumbstick/dpad_down' OpenXR Input Binding.

    Declaration
    public const string thumbstickDpadDown = "/input/thumbstick/dpad_down"
    Field Value
    Type Description
    String

    thumbstickDpadLeft

    Constant for a boolean interaction binding '.../thumbstick/dpad_left' OpenXR Input Binding.

    Declaration
    public const string thumbstickDpadLeft = "/input/thumbstick/dpad_left"
    Field Value
    Type Description
    String

    thumbstickDpadRight

    Constant for a boolean interaction binding '.../thumbstick/dpad_right' OpenXR Input Binding.

    Declaration
    public const string thumbstickDpadRight = "/input/thumbstick/dpad_right"
    Field Value
    Type Description
    String

    thumbstickDpadUp

    Constant for a boolean interaction binding '.../thumbstick/dpad_up' OpenXR Input Binding.

    Declaration
    public const string thumbstickDpadUp = "/input/thumbstick/dpad_up"
    Field Value
    Type Description
    String

    trackpadDpadCenter

    Constant for a boolean interaction binding '.../trackpad/dpad_center' OpenXR Input Binding.

    Declaration
    public const string trackpadDpadCenter = "/input/trackpad/dpad_center"
    Field Value
    Type Description
    String

    trackpadDpadDown

    Constant for a boolean interaction binding '.../trackpad/dpad_down' OpenXR Input Binding.

    Declaration
    public const string trackpadDpadDown = "/input/trackpad/dpad_down"
    Field Value
    Type Description
    String

    trackpadDpadLeft

    Constant for a boolean interaction binding '.../trackpad/dpad_left' OpenXR Input Binding.

    Declaration
    public const string trackpadDpadLeft = "/input/trackpad/dpad_left"
    Field Value
    Type Description
    String

    trackpadDpadRight

    Constant for a boolean interaction binding '.../trackpad/dpad_right' OpenXR Input Binding.

    Declaration
    public const string trackpadDpadRight = "/input/trackpad/dpad_right"
    Field Value
    Type Description
    String

    trackpadDpadUp

    Constant for a boolean interaction binding '.../trackpad/dpad_up' OpenXR Input Binding.

    Declaration
    public const string trackpadDpadUp = "/input/trackpad/dpad_up"
    Field Value
    Type Description
    String

    wedgeAngleLeft

    indicates the angle in radians of each direction region and is a value in the half-open range (0, π].

    Declaration
    public float wedgeAngleLeft
    Field Value
    Type Description
    Single

    wedgeAngleRight

    indicates the angle in radians of each direction region and is a value in the half-open range [0, π].

    Declaration
    public float wedgeAngleRight
    Field Value
    Type Description
    Single

    Methods

    OnInstanceCreate(UInt64)

    Called after xrCreateInstance.

    Declaration
    protected override bool OnInstanceCreate(ulong instance)
    Parameters
    Type Name Description
    UInt64 instance
    Returns
    Type Description
    Boolean
    Overrides
    OpenXRInteractionFeature.OnInstanceCreate(UInt64)

    RegisterActionMapsWithRuntime()

    Register action maps for this device with the OpenXR Runtime. Called at runtime before Start.

    Declaration
    protected override void RegisterActionMapsWithRuntime()
    Overrides
    OpenXRInteractionFeature.RegisterActionMapsWithRuntime()

    RegisterDeviceLayout()

    Registers the DPadInteraction.DPad layout with the Input System.

    Declaration
    protected override void RegisterDeviceLayout()
    Overrides
    OpenXRInteractionFeature.RegisterDeviceLayout()

    UnregisterDeviceLayout()

    Removes the DPadInteraction.DPad layout with the Input System.

    Declaration
    protected override void UnregisterDeviceLayout()
    Overrides
    OpenXRInteractionFeature.UnregisterDeviceLayout()
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023