@needle-tools/engine 4.8.6 → 4.8.7

package/src/engine/api.ts

@@ -33,6 +33,7 @@ export * from "./engine_context.js";
 export * from "./engine_context_registry.js";
 export * from "./engine_coroutine.js"
 export * from "./engine_create_objects.js";
+export * from "./engine_feature_flags.js"
 export * from "./engine_gameobject.js";
 export { Gizmos } from "./engine_gizmos.js"
 export * from "./engine_gltf.js";
@@ -42,7 +43,7 @@ export { InstancingUtil } from "./engine_instancing.js";
 export { hasCommercialLicense, hasIndieLicense, hasProLicense } from "./engine_license.js";
 export * from "./engine_lifecycle_api.js";
 export { NeedleEngineModelLoader } from "./engine_loaders.callbacks.js";
-export { loadAsset, loadSync,parseSync } from "./engine_loaders.js";
+export { loadAsset, loadSync, parseSync } from "./engine_loaders.js";
 export * from "./engine_math.js";
 export { MODULES as NEEDLE_ENGINE_MODULES } from "./engine_modules.js";
 export * from "./engine_networking.js";
@@ -59,6 +60,7 @@ export * from "./engine_physics.js";
 export * from "./engine_physics.types.js";
 export * from "./engine_physics_rapier.js";
 export * from "./engine_playerview.js";
+export { loadPMREM } from "./engine_pmrem.js";
 export * from "./engine_scenelighting.js";
 export * from "./engine_serialization.js";
 export { type ISerializable } from "./engine_serialization_core.js";

package/src/engine/engine_feature_flags.ts

@@ -0,0 +1,8 @@
+
+
+export namespace NEEDLE_ENGINE_FEATURE_FLAGS {
+
+    // eslint-disable-next-line prefer-const
+    export let experimentalSmartHierarchyUpdate = false;
+
+}

package/src/engine/engine_gameobject.ts

@@ -105,11 +105,7 @@ export class InstantiateOptions implements IInstantiateOptions {
 // });
 
 
-const $isActive = Symbol("isActive");
 export function isActiveSelf(go: Object3D): boolean {
-    // if (go[$isActive] === undefined) {
-    //     go[$isActive] = true;
-    // }
     return go.visible;
 }
 

package/src/engine/engine_mainloop_utils.ts

@@ -3,6 +3,7 @@ import { CubeCamera, Object3D, Scene, WebGLCubeRenderTarget } from 'three';
 import { isDevEnvironment } from "./debug/index.js";
 import * as constants from "./engine_constants.js";
 import { ContextRegistry } from "./engine_context_registry.js";
+import { NEEDLE_ENGINE_FEATURE_FLAGS } from './engine_feature_flags.js';
 import { isActiveSelf } from './engine_gameobject.js';
 import { safeInvoke } from "./engine_generic_utils.js";
 import type { IComponent, IContext } from './engine_types.js';
@@ -31,7 +32,7 @@ export function processNewScripts(context: IContext) {
     if (debug)
         console.log("Register new components", context.new_scripts.length, [...context.new_scripts], context.alias ? ("element: " + context.alias) : context["hash"], context);
 
-    
+
     if (context.new_scripts_pre_setup_callbacks.length > 0) {
         for (const cb of context.new_scripts_pre_setup_callbacks) {
             if (!cb) continue;
@@ -39,7 +40,7 @@ export function processNewScripts(context: IContext) {
         }
         context.new_scripts_pre_setup_callbacks.length = 0;
     }
-    
+
     if (context.new_scripts.length <= 0) return;
 
     // TODO: update all the code from above to use this logic
@@ -269,8 +270,22 @@ export function isNeedleXRSessionEventReceiver(script: any, mode: XRSessionMode
 }
 
 
+let needsUpdate = true;
+export function markHierarchyDirty() {
+    needsUpdate = true;
+}
+
 /** @internal */
-export function updateIsActive(obj?: Object3D) {
+export function updateIsActive(obj?: Object3D, force: boolean = false) {
+
+    if (NEEDLE_ENGINE_FEATURE_FLAGS.experimentalSmartHierarchyUpdate) {
+
+        if (!force) {
+            if (!needsUpdate) return;
+        }
+        needsUpdate = false;
+    }
+
     if (!obj) obj = ContextRegistry.Current.scene;
     if (!obj) {
         console.trace("Invalid call - no current context.");
@@ -295,11 +310,11 @@ function updateIsActiveInHierarchyRecursiveRuntime(go: Object3D, activeInHierarc
         return false;
     }
 
-    const isActive = isActiveSelf(go);
+    const activeSelf = isActiveSelf(go);
     if (activeInHierarchy) {
-        activeInHierarchy = isActive;
+        activeInHierarchy = activeSelf;
         // IF we update activeInHierarchy within a disabled hierarchy we need to check the parent
-        if (activeInHierarchy && go.parent) {
+        if (activeInHierarchy && go.parent && level === 0) {
             const parent = go.parent;
             activeInHierarchy = parent[constants.activeInHierarchyFieldName];
             if (activeInHierarchy === undefined) {
@@ -315,12 +330,13 @@ function updateIsActiveInHierarchyRecursiveRuntime(go: Object3D, activeInHierarc
 
     const prevActive = go[constants.activeInHierarchyFieldName];
     const changed = prevActive !== activeInHierarchy;
-    go[constants.activeInHierarchyFieldName] = activeInHierarchy;
 
     // only raise events here if we didnt call enable etc already
     if (changed) {
+        go[constants.activeInHierarchyFieldName] = activeInHierarchy;
+
         if (debugHierarchy)
-            console.warn("ACTIVE CHANGE", go.name, isActive, go.visible, activeInHierarchy, "changed?" + changed, go);
+            console.warn("ACTIVE CHANGE", go.name, activeSelf, go.visible, activeInHierarchy, "changed?" + changed, go);
         if (allowEventCall) {
             perComponent(go, comp => {
                 if (activeInHierarchy) {

package/src/engine/engine_pmrem.ts

@@ -4,12 +4,16 @@ import { EXRLoader } from "three/examples/jsm/loaders/EXRLoader";
 import { KTX2Loader } from "three/examples/jsm/loaders/KTX2Loader";
 import { RGBELoader } from "three/examples/jsm/loaders/RGBELoader";
 
-import { disposeObjectResources, setDisposable } from "./engine_assetdatabase.js";
-
 const running: Map<string, Promise<Texture | null>> = new Map();
 
 // #region api
 
+/**
+ * Loads a PMREM texture from the given URL. This also supports the ultra-fast preprocessed environment maps (PMREM) format.
+ * @param url The URL of the PMREM texture to load.
+ * @param renderer The WebGLRenderer to use for loading the texture.
+ * @returns A promise that resolves to the loaded texture or null if loading failed.
+ */
 export function loadPMREM(url: string, renderer: WebGLRenderer): Promise<Texture | null> {
     if (running.has(url)) {
         return running.get(url)!;
@@ -17,47 +21,13 @@ export function loadPMREM(url: string, renderer: WebGLRenderer): Promise<Texture
     const actualUrl = new URL(url, window.location.href);
     const promise = internalLoadPMREM(actualUrl, renderer);
     running.set(url, promise);
+    promise.finally(() => {
+        running.delete(url);
+    });
     return promise;
 }
 
 
-
-// #region Cache
-
-declare type SkyboxCacheEntry = { src: string, texture: Promise<Texture | null> };
-function ensureGlobalCache() {
-    if (!globalThis["NEEDLE_ENGINE_SKYBOX_TEXTURES"])
-        globalThis["NEEDLE_ENGINE_SKYBOX_TEXTURES"] = new Array<SkyboxCacheEntry>();
-    return globalThis["NEEDLE_ENGINE_SKYBOX_TEXTURES"] as Array<SkyboxCacheEntry>;
-}
-
-function tryGetPreviouslyLoadedTexture(src: string) {
-    const cache = ensureGlobalCache();
-    const found = cache.find(x => x.src === src);
-    if (found) {
-        return found.texture;
-    }
-    return null;
-}
-async function disposeCachedTexture(tex: Promise<Texture | null>) {
-    const texture = await tex;
-    if (!texture) return;
-    setDisposable(texture, true);
-    disposeObjectResources(texture);
-}
-function registerPromise(src: string, texture: Promise<Texture | null>) {
-    const cache = ensureGlobalCache();
-    // Make sure the cache doesnt get too big
-    while (cache.length > 5) {
-        const entry = cache.shift();
-        if (entry) { disposeCachedTexture(entry.texture); }
-    }
-    texture.then(t => { return setDisposable(t, false) });
-    cache.push({ src, texture });
-}
-
-
-
 // #region loading
 
 
@@ -67,11 +37,6 @@ async function internalLoadPMREM(url: URL, renderer: WebGLRenderer) {
     const pathname = url.pathname;
     const isPMREM_URL: boolean = url.toString().toLowerCase().includes("pmrem") || url.searchParams.get("pmrem") != null;
 
-    const cached = tryGetPreviouslyLoadedTexture(pathname);
-    if (cached) {
-        const res = await cached;
-        if (res?.source?.data?.length > 0 || res?.source?.data?.data?.length) return res;
-    }
     const isEXR = pathname.endsWith(".exr");
     const isHdr = pathname.endsWith(".hdr");
     const isKtx2 = pathname.endsWith(".ktx2");
@@ -110,7 +75,6 @@ async function internalLoadPMREM(url: URL, renderer: WebGLRenderer) {
             return tex;
         });
 
-    registerPromise(str, promise);
     const texture = await promise.catch(_err => {
         console.warn("Failed to load texture from url:", url);
         return null;

package/src/engine/extensions/extensions.ts

@@ -22,11 +22,11 @@ const debug = getParam("debugextensions");
 
 // lazily import the GLTFAnimationPointerExtension in case it doesnt exist (e.g. using vanilla three)
 let GLTFAnimationPointerExtension: any;
-const KHR_ANIMATIONPOINTER_IMPORT = import("three/examples/jsm/loaders/GLTFLoaderAnimationPointer.js").then(async mod => {
+const KHR_ANIMATIONPOINTER_IMPORT = import("@needle-tools/three-animation-pointer").then(async mod => {
     GLTFAnimationPointerExtension = mod.GLTFAnimationPointerExtension;
     return GLTFAnimationPointerExtension;
 }).catch(e => {
-    console.warn("Failed to import GLTFLoaderAnimationPointer. Please use @needle-tools/three for full KHR_animation support", e);
+    console.warn("Failed to import GLTFLoaderAnimationPointer. Please use @needle-tools/three-animationpointer for full KHR_animation support", e);
 });
 
 

package/src/engine/js-extensions/Object3D.ts

@@ -1,7 +1,7 @@
 import { Object3D, Quaternion, Vector3 } from "three";
 import { TransformControlsGizmo } from "three/examples/jsm/controls/TransformControls.js";
 
-import { addComponent, addNewComponent, getComponent, getComponentInChildren, getComponentInParent, getComponents, getComponentsInChildren, getComponentsInParent, getOrAddComponent, removeComponent } from "../../engine/engine_components.js";
+import { addComponent, getComponent, getComponentInChildren, getComponentInParent, getComponents, getComponentsInChildren, getComponentsInParent, getOrAddComponent, removeComponent } from "../../engine/engine_components.js";
 import { destroy, isActiveSelf, setActive } from "../../engine/engine_gameobject.js";
 import {
     getTempVector,
@@ -15,7 +15,9 @@ import {
     setWorldScale
 }
     from "../../engine/engine_three_utils.js";
-import type { ComponentInit, Constructor, ConstructorConcrete, HideFlags,IComponent as Component, IComponent } from "../../engine/engine_types.js";
+import type { ComponentInit, Constructor, ConstructorConcrete, HideFlags, IComponent as Component, IComponent } from "../../engine/engine_types.js";
+import { NEEDLE_ENGINE_FEATURE_FLAGS } from "../engine_feature_flags.js";
+import { markHierarchyDirty } from "../engine_mainloop_utils.js";
 import { applyPrototypeExtensions, registerPrototypeExtensions } from "./ExtensionUtils.js";
 
 
@@ -150,6 +152,27 @@ export function apply(object: Object3D) {
     }
 }
 
+if (NEEDLE_ENGINE_FEATURE_FLAGS.experimentalSmartHierarchyUpdate) {
+
+    const addFn = Object3D.prototype.add;
+    Object3D.prototype.add = function (...args: any) {
+        markHierarchyDirty();
+        return addFn.apply(this, args);
+    }
+
+    const attachFn = Object3D.prototype.attach;
+    Object3D.prototype.attach = function (...args: any) {
+        markHierarchyDirty();
+        return attachFn.apply(this, args);
+    }
+
+    const removeFn = Object3D.prototype.remove;
+    Object3D.prototype.remove = function (...args: any) {
+        markHierarchyDirty();
+        return removeFn.apply(this, args);
+    }
+}
+
 
 Object3D.prototype["SetActive"] = function (active: boolean) {
     this.visible = active;

package/src/engine-components/Skybox.ts

@@ -217,9 +217,9 @@ export class RemoteSkybox extends Behaviour {
             if (debug) console.warn("RemoteSkybox: Failed to load texture from url", url);
             return false;
         }
-        // Check if we're still enabled
-        if (!this.enabled) {
-            if (debug) console.warn("RemoteSkybox: Component is not enabled, aborting setSkybox");
+        // Check if we're not disabled or destroyed
+        if (!this.enabled || this.destroyed) {
+            if (debug) console.warn("RemoteSkybox: Component is disabled or destroyed");
             return false;
         }
         // Check if the url has changed while loading
@@ -239,7 +239,6 @@ export class RemoteSkybox extends Behaviour {
         const envMap = this._prevLoadedEnvironment;
         if (!envMap) return;
 
-
         if ((envMap instanceof CubeTexture || envMap instanceof CompressedCubeTexture) || envMap.mapping == CubeUVReflectionMapping) {
             // Nothing to do
         }
@@ -248,6 +247,11 @@ export class RemoteSkybox extends Behaviour {
             envMap.needsUpdate = true;
         }
 
+        if(this.destroyed) return;
+        if(!this.context) {
+            console.warn("RemoteSkybox: Context is not available - can not apply skybox.");
+            return;
+        }
 
         // capture state
         if (this.context.scene.background !== envMap)