docs.unity3d.com
    Show / Hide Table of Contents

    Class OpenXRInteractionFeature

    A Unity OpenXR Interaction feature. This class can be inherited from to add a custom action mapping for OpenXR.

    Inheritance
    Object
    Object
    ScriptableObject
    OpenXRFeature
    OpenXRInteractionFeature
    EyeGazeInteraction
    HTCViveControllerProfile
    KHRSimpleControllerProfile
    MicrosoftHandInteraction
    MicrosoftMotionControllerProfile
    OculusTouchControllerProfile
    ValveIndexControllerProfile
    Inherited Members
    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.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.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
    Object.FindObjectOfType<T>()
    UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindObjectOfType(Type, Boolean)
    Object.ToString()
    Object.name
    Object.hideFlags
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: UnityEngine.XR.OpenXR.Features
    Syntax
    [Serializable]
    public abstract class OpenXRInteractionFeature : OpenXRFeature

    Methods

    AddActionMap(OpenXRInteractionFeature.ActionMapConfig)

    Add an action map to the Unity Input System.

    This method must be called from within the RegisterActionMapsWithRuntime method.

    Declaration
    protected void AddActionMap(OpenXRInteractionFeature.ActionMapConfig map)
    Parameters
    Type Name Description
    OpenXRInteractionFeature.ActionMapConfig map

    Action map to add

    OnEnabledChange()

    Handle enabled state change to register/unregister device layouts as needed

    Declaration
    protected override void OnEnabledChange()
    Overrides
    OpenXRFeature.OnEnabledChange()

    OnInstanceCreate(UInt64)

    Called after xrCreateInstance.

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

    RegisterActionMapsWithRuntime()

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

    Declaration
    protected virtual void RegisterActionMapsWithRuntime()

    RegisterDeviceLayout()

    Register a device layout with the Unity Input System. Called whenever this interaction profile is enabled in the Editor.

    Declaration
    protected virtual void RegisterDeviceLayout()

    UnregisterDeviceLayout()

    Remove a device layout from the Unity Input System. Called whenever this interaction profile is disabled in the Editor.

    Declaration
    protected virtual void UnregisterDeviceLayout()
    Back to top
    Terms of use
    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