@needle-tools/engine 3.9.0-alpha.1 → 3.10.0-alpha

package/src/engine-components/SceneSwitcher.ts

@@ -38,6 +38,13 @@ export class SceneSwitcher extends Behaviour {
     @serializable()
     queryParameterName: string = "scene";
 
+    /** 
+     * when enabled the scene name will be used as the query parameter (otherwise the scene index will be used)
+     * Needs `queryParameterName` set
+     * */
+    @serializable()
+    useSceneName: boolean = true;
+
     @serializable()
     clamp: boolean = true;
 
@@ -281,9 +288,15 @@ export class SceneSwitcher extends Behaviour {
                 if (this.useSceneLighting)
                     this.context.sceneLighting.enable(scene)
                 if (this.useHistory && index >= 0) {
+                    // take the index as the query parameter value
+                    let queryParameterValue = index.toString();
+                    // unless the user defines that he wants to use the scene name
+                    if (this.useSceneName) {
+                        queryParameterValue = sceneUriToName(scene.uri);
+                    }
                     // save the loaded scene as an url parameter
                     if (this.queryParameterName?.length)
-                        setParamWithoutReload(this.queryParameterName, index.toString(), this.useHistory);
+                        setParamWithoutReload(this.queryParameterName, queryParameterValue, this.useHistory);
                     // or set the history state without updating the url parameter
                     else {
                         const lastState = history.state;
@@ -328,9 +341,11 @@ export class SceneSwitcher extends Behaviour {
             }
             else {
                 // Try to find a scene with a matching name
+                // we don't care about casing. e.g. Scene1 and scene1 should both match
+                const lowerCaseValue = value.toLowerCase();
                 for (let i = 0; i < this.scenes.length; i++) {
                     const scene = this.scenes[i];
-                    if (scene.uri.toLowerCase().includes(value)) {
+                    if (sceneUriToName(scene.uri).toLowerCase().includes(lowerCaseValue)) {
                         return this.select(i);;
                     }
                 }
@@ -349,6 +364,13 @@ export class SceneSwitcher extends Behaviour {
 }
 
 
+function sceneUriToName(uri: string): string {
+    const name = uri.split("/").pop();
+    let value = name?.split(".").shift();
+    if (value?.length) return value;
+    return uri;
+}
+
 
 
 class PreLoadScheduler {

package/src/engine-components/webxr/WebXR.ts

@@ -21,7 +21,7 @@ import { showBalloonWarning } from '../../engine/debug';
 const debugWebXR = getParam("debugwebxr");
 
 export async function detectARSupport() {
-    if(isMozillaXR()) return true;
+    if (isMozillaXR()) return true;
     if ("xr" in navigator) {
         //@ts-ignore
         return (await navigator["xr"].isSessionSupported('immersive-ar')) === true;
@@ -136,7 +136,7 @@ export class WebXR extends Behaviour {
         return arButton;
     }
 
-    private static onModifyAROptions(options){
+    private static onModifyAROptions(options) {
         WebXR.dispatchEvent(WebXREvent.ModifyAROptions, options);
     }
 
@@ -255,11 +255,10 @@ export class WebXR extends Behaviour {
         this.context.appendHTMLElement(buttonsContainer);
 
         const forceButtons = debugWebXR;
-        if(debugWebXR) console.log("ARSupported?", arSupported, "VRSupported?", vrSupported);
+        if (debugWebXR) console.log("ARSupported?", arSupported, "VRSupported?", vrSupported);
 
         // AR support
-        if (forceButtons || (this.createARButton && this.enableAR && arSupported)) 
-        {
+        if (forceButtons || (this.createARButton && this.enableAR && arSupported)) {
             arButton = WebXR.createARButton(this);
             this._arButton = arButton;
             buttonsContainer.appendChild(arButton);
@@ -271,7 +270,7 @@ export class WebXR extends Behaviour {
             this._vrButton = vrButton;
             buttonsContainer.appendChild(vrButton);
         }
-        
+
         setTimeout(() => {
             WebXR.resetButtonStyles(vrButton);
             WebXR.resetButtonStyles(arButton);
@@ -289,11 +288,11 @@ export class WebXR extends Behaviour {
         // TODO: figure out why screen is black if we enable the code written here
         // const referenceSpace = renderer.xr.getReferenceSpace();
         const session = this.context.renderer.xr.getSession();
-        
+
 
         if (session) {
             const pose = frame.getViewerPose(this.context.renderer.xr.getReferenceSpace());
-            if(!pose) return;
+            if (!pose) return;
             this._currentHeadPose = pose;
             const transform: XRRigidTransform = pose?.transform;
             if (transform) {
@@ -356,7 +355,7 @@ export class WebXR extends Behaviour {
             this._originalCameraRotation.copy(getWorldQuaternion(this.context.mainCamera));
             this._originalCameraParent = this.context.mainCamera.parent;
         }
-        if(this.Rig){
+        if (this.Rig) {
             this._originalXRRigParent = this.Rig.parent;
             this._originalXRRigPosition.copy(this.Rig.position);
             this._originalXRRigRotation.copy(this.Rig.quaternion);
@@ -415,9 +414,9 @@ export class WebXR extends Behaviour {
         const xr = this.context.renderer.xr;
         if (this.context.mainCamera) {
             const cam = xr.getCamera() as WebXRArrayCamera;
-            if(debugWebXR) console.log("WebXRCamera", cam);
+            if (debugWebXR) console.log("WebXRCamera", cam);
             const cull = this.context.mainCameraComponent?.cullingMask;
-            if(cam && cull !== undefined){
+            if (cam && cull !== undefined) {
                 for (const c of cam.cameras) {
                     c.layers.mask = cull;
                 }
@@ -467,8 +466,14 @@ export class WebXR extends Behaviour {
 
         const wasInAR = this._isInAR;
 
-        if (this._isInAR && session) {
-            this.webAR?.onEnd(session);
+        if (session) {
+            if (this._isInAR) {
+                this.webAR?.onEnd(session);
+            }
+            else {
+                // if in VR we want to restore the FOV
+                this.context.mainCameraComponent?.applyClearFlagsIfIsActiveCamera();
+            }
         }
 
         this._isInAR = false;
@@ -491,7 +496,7 @@ export class WebXR extends Behaviour {
             this.context.mainCamera.scale.set(1, 1, 1);
         }
 
-        if(wasInAR){
+        if (wasInAR) {
             this._originalXRRigParent?.add(this.rig);
             this.rig.position.copy(this._originalXRRigPosition);
             this.rig.quaternion.copy(this._originalXRRigRotation);
@@ -599,6 +604,12 @@ export class WebAR {
 
         if (!this.sessionRoot || this.sessionRoot.destroyed || !this.sessionRoot.activeAndEnabled)
             this.sessionRoot = GameObject.findObjectOfType(WebARSessionRoot, context);
+        if (!this.sessionRoot) {
+            // TODO: adding it on the scene directly doesnt work (probably because then everything in the scene is disabled including this component). See code a bit furhter below where we add this component to a temporary object inside the scene
+            const obj = this.webxr.gameObject;
+            this.sessionRoot = GameObject.addNewComponent(obj, WebARSessionRoot);
+            console.warn("WebAR: No ARSessionRoot found, creating one automatically on the WebXR object");
+        }
 
         this.previousBackground = context.scene.background;
         this.previousEnvironment = context.scene.environment;