@needle-tools/engine 4.5.8 → 4.6.0-next.74b55ae

package/src/engine/engine_context.ts

@@ -758,6 +758,9 @@ export class Context implements IContext {
 		this.physics?.engine?.clearCaches();
 		this.lodsManager.disable();
 
+		this._onBeforeRenderListeners.clear();
+		this._onAfterRenderListeners.clear();
+
 		if (!this.isManagedExternally) {
 			if (this.renderer) {
 				this.renderer.renderLists.dispose();
@@ -889,16 +892,17 @@ export class Context implements IContext {
 		}
 	}
 
-	private _onBeforeRenderListeners = new Map<string, OnRenderCallback[]>();
-	private _onAfterRenderListeners = new Map<string, OnRenderCallback[]>();
+	private readonly _onBeforeRenderListeners = new Map<string, OnRenderCallback[]>();
+	private readonly _onAfterRenderListeners = new Map<string, OnRenderCallback[]>();
 
 	/** Use to subscribe to onBeforeRender events on threejs objects.
 	 * @link https://threejs.org/docs/#api/en/core/Object3D.onBeforeRender
 	 */
 	addBeforeRenderListener(target: Object3D, callback: OnRenderCallback) {
 		if (!this._onBeforeRenderListeners.has(target.uuid)) {
-			this._onBeforeRenderListeners.set(target.uuid, []);
-			target.onBeforeRender = this._createRenderCallbackWrapper(target, this._onBeforeRenderListeners);
+			const arr: OnRenderCallback[] = [];
+			this._onBeforeRenderListeners.set(target.uuid, arr);
+			target.onBeforeRender = this._createRenderCallbackWrapper(arr);
 		}
 		this._onBeforeRenderListeners.get(target.uuid)!.push(callback);
 	}
@@ -919,8 +923,9 @@ export class Context implements IContext {
 	*/
 	addAfterRenderListener(target: Object3D, callback: OnRenderCallback) {
 		if (!this._onAfterRenderListeners.has(target.uuid)) {
-			this._onAfterRenderListeners.set(target.uuid, []);
-			target.onAfterRender = this._createRenderCallbackWrapper(target, this._onAfterRenderListeners);
+			const arr = [];
+			this._onAfterRenderListeners.set(target.uuid, arr);
+			target.onAfterRender = this._createRenderCallbackWrapper(arr);
 		}
 		this._onAfterRenderListeners.get(target.uuid)?.push(callback);
 	}
@@ -937,12 +942,10 @@ export class Context implements IContext {
 	}
 
 
-	private _createRenderCallbackWrapper(target: Object3D, array: Map<string, OnRenderCallback[]>): OnRenderCallback {
+	private _createRenderCallbackWrapper(array: OnRenderCallback[]): OnRenderCallback {
 		return (renderer, scene, camera, geometry, material, group) => {
-			const arr = array.get(target.uuid);
-			if (!arr) return;
-			for (let i = 0; i < arr.length; i++) {
-				const fn = arr[i];
+			for (let i = 0; i < array.length; i++) {
+				const fn = array[i];
 				fn(renderer, scene, camera, geometry, material, group);
 			}
 		}

package/src/engine/engine_utils.ts

@@ -905,7 +905,7 @@ export async function generateQRCode(args: { domElement?: HTMLElement, text: str
 
     // Ensure that the QRCode library is loaded
     if (!globalThis["QRCode"]) {
-        const url = "https://cdn.rawgit.com/davidshimjs/qrcodejs/gh-pages/qrcode.min.js";
+        const url = "https://cdn.jsdelivr.net/gh/davidshimjs/qrcodejs@gh-pages/qrcode.min.js";
         let script = document.head.querySelector(`script[src="${url}"]`) as HTMLScriptElement;
         if (!script) {
             script = document.createElement("script");

package/src/engine-components/AudioSource.ts

@@ -96,10 +96,10 @@ export class AudioSource extends Behaviour {
     /**
      * When true, the audio clip will be loaded during initialization rather than when play() is called.
      * This can reduce playback delay but increases initial loading time.
-     * @default false
+     * @default true
      */
     @serializable()
-    preload: boolean = false;
+    preload: boolean = true;
 
     /**
      * When true, audio will continue playing when the browser tab loses focus.
@@ -347,7 +347,8 @@ export class AudioSource extends Behaviour {
 
     /** @internal */
     awake() {
-        if (debug) console.log(this);
+        if (debug) console.log("[AudioSource]", this);
+
         this.audioLoader = new AudioLoader();
         if (this.playOnAwake) this.shouldPlay = true;
 
@@ -431,7 +432,6 @@ export class AudioSource extends Behaviour {
         if (this.context.application.muted) sound.setVolume(0);
         else sound.setVolume(this.volume);
         sound.autoplay = this.shouldPlay && AudioSource.userInteractionRegistered;
-
         this.applySpatialDistanceSettings();
 
         if (sound.isPlaying)
@@ -509,7 +509,7 @@ export class AudioSource extends Behaviour {
                     console.log("load audio", clip);
                 const buffer = await this.audioLoader.loadAsync(clip).catch(console.error);
                 if(this.destroyed) return;
-                this._lastClipStartedLoading = null;
+                if(this._lastClipStartedLoading === clip) this._lastClipStartedLoading = null;
                 if (buffer) this.createAudio(buffer);
             }
             else console.warn("Unsupported audio clip type", clip)

package/src/engine-components/ReflectionProbe.ts

@@ -22,6 +22,10 @@ export class ReflectionProbe extends Behaviour {
 
     private static _probes: Map<Context, ReflectionProbe[]> = new Map();
 
+    static isUsingReflectionProbe(material: Material) {
+        return !!(material[$reflectionProbeKey] || material[$originalMaterial]?.[$reflectionProbeKey]);
+    }
+
     public static get(object: Object3D | null | undefined, context: Context, isAnchor: boolean, anchor?: Object3D): ReflectionProbe | null {
         if (!object || object.isObject3D !== true) return null;
         if (disable) return null;
@@ -29,7 +33,7 @@ export class ReflectionProbe extends Behaviour {
         if (probes) {
             for (const probe of probes) {
                 if (!probe.__didAwake) probe.__internalAwake();
-                if (probe.enabled) {
+                if (probe.activeAndEnabled) {
                     if (anchor) {
                         // test if anchor is reflection probe object
                         if (probe.gameObject === anchor) {

package/src/engine-components/Renderer.ts

@@ -708,7 +708,15 @@ export class Renderer extends Behaviour implements IRenderer {
         if (this.reflectionProbeUsage !== ReflectionProbeUsage.Off && this._reflectionProbe) {
             this._reflectionProbe.onSet(this);
         }
-
+        // since three 163 we need to set the envMap to the scene envMap if it is not set
+        // otherwise the envmapIntensity has no effect: https://github.com/mrdoob/three.js/pull/27903
+        // internal issue: https://linear.app/needle/issue/NE-6363
+        for (const mat of this._sharedMaterials) {
+            // If the material has a envMap and is NOT using a reflection probe we set the envMap to the scene environment
+            if (mat && "envMap" in mat && "envMapIntensity" in mat && !ReflectionProbe.isUsingReflectionProbe(mat)) {
+                mat.envMap = this.context.scene.environment;
+            }
+        }
     }
 
     private onBeforeRenderThree = (_renderer, _scene, _camera, _geometry, material, _group) => {
@@ -716,11 +724,6 @@ export class Renderer extends Behaviour implements IRenderer {
             const factor = this.hasLightmap ? Math.PI : 1;
             const environmentIntensity = this.context.mainCameraComponent?.environmentIntensity ?? 1;
             material.envMapIntensity = Math.max(0, environmentIntensity * this.context.sceneLighting.environmentIntensity / factor);
-            
-            // since three 163 we need to set the envMap to the scene envMap if it is not set
-            // otherwise the envmapIntensity has no effect: https://github.com/mrdoob/three.js/pull/27903
-            // internal issue: https://linear.app/needle/issue/NE-6363
-            if (!material.envMap) material.envMap = this.context.scene.environment;
         }
 
         if (this._lightmaps) {
@@ -856,7 +859,7 @@ export class SkinnedMeshRenderer extends MeshRenderer {
                         mesh.computeBoundingSphere();
                         mesh.geometry = geometry;
                     }
-                    catch(err) {
+                    catch (err) {
                         console.error(`Error updating bounding sphere for ${mesh.name}`, err);
                     }
                 }

package/src/engine-components/Skybox.ts

@@ -124,11 +124,17 @@ function registerLoadedTexture(src: string, texture: Promise<Texture>) {
  *    evt.detail.apply(url);
  * });
  * ```
+ * 
+ * @example update skybox url
+ * ```ts
+ * skybox.setSkybox("https://example.com/skybox.hdr");
+ * ```
  */
 export class RemoteSkybox extends Behaviour {
 
     /**
-     * URL to a remote skybox. This value can also use a magic skybox name. Options are "quicklook", "quicklook-ar", "studio", "blurred-skybox".
+     * URL to a remote skybox. This value can also use a magic skybox name. Options are "quicklook", "quicklook-ar", "studio", "blurred-skybox".  
+     * To update the skybox/environment map use `setSkybox(url)`
      * @example
      * ```ts
      * skybox.url = "https://example.com/skybox.hdr";
@@ -197,6 +203,9 @@ export class RemoteSkybox extends Behaviour {
             if (this.isRemoteTexture(this.url)) {
                 this.setSkybox(this.url);
             }
+            else if (debug) {
+                console.warn(`RemoteSkybox: Not setting skybox: ${this.url} is not a remote texture. If you want to set a local texture, set allowNetworking to false.`);
+            }
         }
     }
 
@@ -222,7 +231,7 @@ export class RemoteSkybox extends Behaviour {
         if (debug) console.log("Set remote skybox url: " + url);
 
         if (this._prevUrl === url && this._prevLoadedEnvironment) {
-            this.applySkybox();
+            this.apply();
             return true;
         }
         else {
@@ -231,19 +240,30 @@ export class RemoteSkybox extends Behaviour {
         }
         this._prevUrl = url;
 
-        const envMap = await this.loadTexture(url, name);
-        if (!envMap) return false;
+        const texture = await this.loadTexture(url, name);
+        if (!texture) {
+            if (debug) console.warn("RemoteSkybox: Failed to load texture from url", url);
+            return false;
+        }
         // Check if we're still enabled
-        if (!this.enabled) return false;
+        if (!this.enabled) {
+            if (debug) console.warn("RemoteSkybox: Component is not enabled, aborting setSkybox");
+            return false;
+        }
+        // Check if the url has changed while loading
+        if (this._prevUrl !== url) {
+            if (debug) console.warn("RemoteSkybox: URL changed while loading texture, aborting setSkybox");
+            return false; // URL changed while loading
+        }
         // Update the current url
         this.url = url;
         const nameIndex = url.lastIndexOf("/");
-        envMap.name = url.substring(nameIndex >= 0 ? nameIndex + 1 : 0);
+        texture.name = url.substring(nameIndex >= 0 ? nameIndex + 1 : 0);
         if (this._loader instanceof TextureLoader) {
-            envMap.colorSpace = SRGBColorSpace;
+            texture.colorSpace = SRGBColorSpace;
         }
-        this._prevLoadedEnvironment = envMap;
-        this.applySkybox();
+        this._prevLoadedEnvironment = texture;
+        this.apply();
         return true;
     }
 
@@ -284,7 +304,7 @@ export class RemoteSkybox extends Behaviour {
         return envMap;
     }
 
-    private applySkybox() {
+    private apply() {
         const envMap = this._prevLoadedEnvironment;
         if (!envMap) return;