Question How do you implement OpenXR Focus Management in Unity 2020?

Hello,

I am trying to implement the focus requirement for Oculus store submissions with OpenXR, there is a short overview of the states which look similar to OVR, but the sample code above makes zero sense to me. I was wondering if anyone already has done this and was able to share how to listen to these "session state change events".

OpenXR Focus Management is described at the bottom of:
https://developer.oculus.com/documentation/native/pc/dg-vr-focus/
https://developer.oculus.com/documentation/native/pc/dg-dash

 

I know right now players are reporting that attempting to close out of the game via the SteamVR or Oculus overlay does not work (the in-game exit button is fine), so it seems that "ShouldQuit" is not being triggered or perhaps received correctly. Could you let me know how to listen and catch these events? I've been looking for tutorial or code snippet examples but no one seems to know much about this at all. Would be much appreciated.

 

I'm not sure about his issue, but that is an issue I am having.

 

@the_real_apoxol
Thank you, this works.
Can you expand on how features work or is there any doc on this?

How would you expand this to trigger a function for a recenter request?

I looked at OpenXRFeature parent class to see if there were other functions to override and found:

Code (CSharp):

1. protected override void OnSessionStateChange(int oldState, int newState) {
2.         base.OnSessionStateChange(oldState, newState);
3.         Debug.Log($"Session State Change {oldState} -> {newState}");
4.     }

Which seems to trigger when the headset startsup/wakes/put on, so that technically answers my original question.
But if i could also catch the recenter request that would be useful.

 

I copied over your work around and enabled in the OpenXR features. However, if I quit SteamVR from the desktop then it still does not exit the game. Quitting from within SteamVR doesn't exit it either. Any ideas?

EDIT:
Nevermind, I just noticed that the feature disabled itself somehow. I'll try enabling it again and see what happens.

 

Just retested and it seems to be working, thanks!

 

@the_real_apoxol
I just noticed that the "reset standing position" doesn't appear on the SteamVR overlay when in a Unity game.

My setup:
- Created new Unity Project 2020.3
- Setup XR Manager with OpenXR 1.2.2
- Setup default XR Rig + XRI Interaction Action Maps
- Setup SteamVR to Standing Only

- When the game is not running, bringing up the SteamVR overlay, the option to "Reset Standing Position" found in the lower right is present and works. Activating it will start a 3-sec countdown where it will then recenter + reorient you as expected.
- When the game is played, bringing up the SteamVR overlay, the option no longer exists.
- The option via the desktop window's hamburger menu is always present and works fine.

Is SteamVR standing-only room setup being overridden by Unity?

 

Is there anything else I would have to do to get it to work than defining these features and enabling them? I'm not getting any of my overrides to be called. I must be missing something.

The documentation on OpenXR Features says this:

"Intercepting OpenXR function calls
To intercept OpenXR function calls, override OpenXRFeature.HookGetInstanceProcAddr. Returning a different function pointer allows intercepting any OpenXR method. For an example, see the Intercept Feature sample"

 

Hey sorry I was too quick. I am getting the overrides when playing from build! but not from editor at the moment.

[Edit] Was being stupid again. I hadn't enabled the feature under PC, Mac & Linux tab. Was testing in Android build.

 

Hi, Is it possible to intercept XrEventDataViveTrackerConnectedHTCX by defining a custom feature? currently, I am trying to detect if the HTC Vive Tracker is connected after the launch of the application. I have ViveTrackerProfile https://forum.unity.com/attachments/htcvivetrackerprofile-cs.986229/ which works if the trackers are connected before the launch of the app, but doesn't detect the tracker if connected after the launch of the app.

 

For me, on the app space change the player is not recentered. I created a feature that should catch OnAppSpaceChange, but it does not work either. I found a workaround as OnSessionBegin works, not reset view, but on editing the guardian. Anyways, wanted to let you know that here might be a bug. MetaXR Feature does not log OnAppSpaceChange as it is supposed to, but logs OnSessionBegin (and others)

The code that is not working:

Code (CSharp):

1. using System.Collections;
2. using System.Collections.Generic;
3. using UnityEditor;
4. using UnityEngine;
5. using UnityEngine.Events;
6. using UnityEngine.XR.OpenXR.Features;
7.  
8. #if UNITY_EDITOR
9. [UnityEditor.XR.OpenXR.Features.OpenXRFeature(UiName = "Reset View Feature",
10.     BuildTargetGroups = new[] { BuildTargetGroup.Standalone, BuildTargetGroup.Android },
11.     Company = "Unknown",
12.     Desc = "Feature to catch reset view in headset and apply it in the app.",
13.     //DocumentationLink = "https://docs.unity.cn/Packages/com.unity.xr.openxr@0.1/manual/index.html",
14.     OpenxrExtensionStrings = "", // this extension doesn't exist, a log message will be printed that it couldn't be enabled
15.     Version = "0.0.1",
16.     FeatureId = featureId)]
17. #endif
18.  
19. public class ResetViewFeature : OpenXRFeature
20. {
21.     public const string featureId = "com.unkonwn.resetview";
22.     public static UnityEvent AppSpaceChanged = new UnityEvent();
23.     protected override void OnAppSpaceChange(xrSpace)
24.     {
25.         base.OnAppSpaceChange(xrSpace);
26.        }
27.         AppSpaceChanged.Invoke();
28.         Debug.Log("AppSpaceChange detected in the feature");
29.     }
30. }
31.  

The code that is working:

Code (CSharp):

1. using System.Collections;
2. using System.Collections.Generic;
3. using UnityEditor;
4. using UnityEngine;
5. using UnityEngine.Events;
6. using UnityEngine.XR.OpenXR.Features;
7.  
8. #if UNITY_EDITOR
9. [UnityEditor.XR.OpenXR.Features.OpenXRFeature(UiName = "Reset View Feature",
10.     BuildTargetGroups = new[] { BuildTargetGroup.Standalone, BuildTargetGroup.Android },
11.     Company = "Unknown",
12.     Desc = "Feature to catch reset view in headset and apply it in the app.",
13.     //DocumentationLink = "https://docs.unity.cn/Packages/com.unity.xr.openxr@0.1/manual/index.html",
14.     OpenxrExtensionStrings = "", // this extension doesn't exist, a log message will be printed that it couldn't be enabled
15.     Version = "0.0.1",
16.     FeatureId = featureId)]
17. #endif
18.  
19. public class ResetViewFeature : OpenXRFeature
20. {
21.     public const string featureId = "com.unkonwn.resetview";
22.     public static UnityEvent AppSpaceChanged = new UnityEvent();
23.     protected override void OnSessionBegin(ulong xrSession)
24.     {
25.         base.OnSessionBegin(ulong xrSession);
26.         AppSpaceChanged.Invoke();
27.         Debug.Log("AppSpaceChange detected in the feature");
28.     }
29. }
30.  

Unity version 2021.3.24f1, OpenXR plugin 1.7.0