Merge pull request #147 from De-Panther/onxrchange_improvement

Changed how XR session switch is handled

Author: De-Panther

Packages/webxr/CHANGELOG.md

@@ -5,6 +5,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Changed
+- Scripts execution order.
+- How XR session switch is handled.
+- OnXRChange is called from the Update loop.
+
 ### Fixed
 - User scaling issue in FullView WebGLTemplates
 

Packages/webxr/Runtime/Plugins/WebGL/webxr.jspre

@@ -809,15 +809,24 @@ setTimeout(function () {
         var thisXRMananger = this;
         session.requestReferenceSpace(refSpaceType).then(function (refSpace) {
           session.refSpace = refSpace;
-          thisXRMananger.BrowserObject.resumeAsyncCallbacks();
-          thisXRMananger.BrowserObject.mainLoop.resume();
+          var tempRaf = function (time, xrFrame) {
+            if (thisXRMananger.animate(xrFrame))
+            {
+              thisXRMananger.BrowserObject.resumeAsyncCallbacks();
+              thisXRMananger.BrowserObject.mainLoop.resume();
+            } else {
+              // No XR session yet
+              session.requestAnimationFrame(tempRaf);
+            }
+          }
+          session.requestAnimationFrame(tempRaf);
         });
       }
 
       XRManager.prototype.animate = function (frame) {
         var session = frame.session;
         if (!session) {
-          return;
+          return this.didNotifyUnity;
         }
 
         var glLayer = session.renderState.baseLayer;
@@ -842,12 +851,12 @@ setTimeout(function () {
 
         var pose = frame.getViewerPose(session.refSpace);
         if (!pose) {
-          return;
+          return this.didNotifyUnity;
         }
 
         if (!session.isImmersive)
         {
-          return;
+          return this.didNotifyUnity;
         }
 
         var xrData = this.xrData;
@@ -979,6 +988,7 @@ setTimeout(function () {
           }
           this.didNotifyUnity = true;
         }
+        return this.didNotifyUnity;
       }
 
       XRManager.prototype.updateUnityXRData = function (data) {

Packages/webxr/Runtime/Scripts/WebXRCamera.cs

@@ -2,6 +2,7 @@
 
 namespace WebXR
 {
+  [DefaultExecutionOrder(-2019)]
   public class WebXRCamera : MonoBehaviour
   {
     public enum CameraID
@@ -23,58 +24,61 @@ public enum CameraID
 
     private int viewsCount = 1;
 
-    private bool switched = false;
-
     private bool hasFollower = false;
 
-    void OnEnable()
+    private void Awake()
+    {
+      SwitchXRState();
+    }
+
+    private void OnEnable()
     {
       WebXRManager.OnXRChange += OnXRChange;
       WebXRManager.OnHeadsetUpdate += OnHeadsetUpdate;
       hasFollower = cameraFollower != null;
     }
-    
-    void OnDisable()
+
+    private void OnDisable()
     {
       WebXRManager.OnXRChange -= OnXRChange;
       WebXRManager.OnHeadsetUpdate -= OnHeadsetUpdate;
     }
 
-    void Update()
+    private void Update()
     {
-      if (!switched)
+      UpdateFollower();
+    }
+
+    private void SwitchXRState()
+    {
+      switch (xrState)
       {
-        switched = true;
-        switch (xrState)
-        {
-          case WebXRState.AR:
-            cameraMain.enabled = false;
-            cameraL.enabled = false;
-            cameraR.enabled = false;
-            cameraARL.enabled = viewsCount > 0;
-            cameraARL.rect = leftRect;
-            cameraARR.enabled = viewsCount > 1;
-            cameraARR.rect = rightRect;
-            break;
-          case WebXRState.VR:
-            cameraMain.enabled = false;
-            cameraL.enabled = viewsCount > 0;
-            cameraL.rect = leftRect;
-            cameraR.enabled = viewsCount > 1;
-            cameraR.rect = rightRect;
-            cameraARL.enabled = false;
-            cameraARR.enabled = false;
-            break;
-          case WebXRState.NORMAL:
-            cameraMain.enabled = true;
-            cameraL.enabled = false;
-            cameraR.enabled = false;
-            cameraARL.enabled = false;
-            cameraARR.enabled = false;
-            break;
-        }
+        case WebXRState.AR:
+          cameraMain.enabled = false;
+          cameraL.enabled = false;
+          cameraR.enabled = false;
+          cameraARL.enabled = viewsCount > 0;
+          cameraARL.rect = leftRect;
+          cameraARR.enabled = viewsCount > 1;
+          cameraARR.rect = rightRect;
+          break;
+        case WebXRState.VR:
+          cameraMain.enabled = false;
+          cameraL.enabled = viewsCount > 0;
+          cameraL.rect = leftRect;
+          cameraR.enabled = viewsCount > 1;
+          cameraR.rect = rightRect;
+          cameraARL.enabled = false;
+          cameraARR.enabled = false;
+          break;
+        case WebXRState.NORMAL:
+          cameraMain.enabled = true;
+          cameraL.enabled = false;
+          cameraR.enabled = false;
+          cameraARL.enabled = false;
+          cameraARR.enabled = false;
+          break;
       }
-      UpdateFollower();
     }
 
     private void UpdateFollower()
@@ -153,7 +157,7 @@ private void OnXRChange(WebXRState state, int viewsCount, Rect leftRect, Rect ri
       this.viewsCount = viewsCount;
       this.leftRect = leftRect;
       this.rightRect = rightRect;
-      switched = false;
+      SwitchXRState();
     }
 
     private void OnHeadsetUpdate(

Packages/webxr/Runtime/Scripts/WebXRController.cs

@@ -7,7 +7,7 @@
 
 namespace WebXR
 {
-
+  [DefaultExecutionOrder(-2018)]
   public class WebXRController : MonoBehaviour
   {
     public enum ButtonTypes

Packages/webxr/Runtime/Scripts/WebXRManager.cs

@@ -1,7 +1,10 @@
+using UnityEngine;
+
 namespace WebXR
 {
   public enum WebXRState { VR, AR, NORMAL }
 
+  [DefaultExecutionOrder(-2020)]
   public class WebXRManager : SubsystemLifecycleManager<WebXRSubsystem, WebXRSubsystemDescriptor>
   {
       public static WebXRManager Instance { get; private set; }

Packages/webxr/Runtime/XRPlugin/WebXRSubsystem.cs

@@ -82,6 +82,11 @@ private void UpdateControllersOnEnd()
 
     internal void OnUpdate()
     {
+      if (!reportedXRStateSwitch)
+      {
+        reportedXRStateSwitch = true;
+        OnXRChange?.Invoke(xrState, viewsCount, leftRect, rightRect);
+      }
       if (switchToEnd)
       {
         switchToEnd = false;
@@ -204,6 +209,10 @@ public static extern void set_webxr_events(Action<int, float, float, float, floa
 #endif
 
     internal WebXRState xrState = WebXRState.NORMAL;
+    private int viewsCount = 1;
+    private Rect leftRect;
+    private Rect rightRect;
+    private bool reportedXRStateSwitch = true;
 
     public delegate void XRCapabilitiesUpdate(WebXRDisplayCapabilities capabilities);
 
@@ -300,8 +309,11 @@ public void OnInputProfiles(WebXRControllersProfiles controllersProfiles)
     public void setXrState(WebXRState state, int viewsCount, Rect leftRect, Rect rightRect)
     {
       this.xrState = state;
+      this.viewsCount = viewsCount;
+      this.leftRect = leftRect;
+      this.rightRect = rightRect;
       viewerHitTestOn = false;
-      OnXRChange?.Invoke(state, viewsCount, leftRect, rightRect);
+      reportedXRStateSwitch = false;
     }
 
     // received start AR from WebXR browser