@needle-tools/engine 4.7.0-next.da47826 → 4.7.0-next.ef983f9

package/plugins/vite/logger.client.js

@@ -0,0 +1,216 @@
+
+/**
+ * Patches console methods to capture log messages and send them to the server.
+ * This is useful for debugging and logging in the client.
+ * @param {"log" | "warn" | "info" | "debug" | "error" | "internal"} level
+ * @param {any} message - The log message to capture.
+ */
+function sendLogToServer(level, ...message) {
+    if ("hot" in import.meta) {
+        message = stringifyLog(message);
+        // @ts-ignore
+        import.meta.hot.send("needle:client-log", { level, message: message });
+    }
+}
+
+
+// const obj = {
+//     hello: "world"
+// }
+// obj["test"] = obj;
+// sendLogToServer("internal", "Test circular reference", obj);
+
+if (import.meta && "hot" in import.meta) {
+
+    const originalLog = console.log;
+    const originalWarn = console.warn;
+    const originalInfo = console.info;
+    const originalDebug = console.debug;
+    const originalError = console.error;
+
+    console.log = (...args) => {
+        originalLog(...args);
+        sendLogToServer("log", ...args);
+    }
+    console.warn = (...args) => {
+        originalWarn(...args);
+        sendLogToServer("warn", ...args);
+    }
+    console.info = (...args) => {
+        originalInfo(...args);
+        sendLogToServer("info", ...args);
+    }
+    console.debug = (...args) => {
+        originalDebug(...args);
+        sendLogToServer("debug", ...args);
+    }
+    console.error = (...args) => {
+        originalError(...args);
+        sendLogToServer("error", ...args);
+    }
+
+    try {
+        sendLogToServer("internal", `Page loaded
+URL: ${window.location.href}
+UserAgent: ${navigator.userAgent}
+Screen: ${window.innerWidth} x ${window.innerHeight}px
+Device Pixel Ratio: ${window.devicePixelRatio}
+Device Memory: ${"deviceMemory" in navigator ? navigator.deviceMemory : "Not available"} GB
+Online: ${navigator.onLine}
+Language: ${navigator.language}
+Timezone: ${Intl.DateTimeFormat().resolvedOptions().timeZone}
+Connection: ${"connection" in navigator ? JSON.stringify(navigator.connection) : "Not available"}
+User Activation: ${"userActivation" in navigator ? JSON.stringify(navigator.userActivation) : "Not available"}
+`);
+
+        if ("gpu" in navigator) {
+
+            // @ts-ignore
+            navigator.gpu.requestAdapter()
+                .then(adapter => adapter ? adapter.requestDevice() : null)
+                .then(device => {
+                    if (device) {
+                        const adapterInfo = device.adapterInfo;
+                        if (adapterInfo) {
+                            sendLogToServer("internal", [`WebGPU adapter info`, {
+                                vendor: adapterInfo.vendor,
+                                architecture: adapterInfo.architecture,
+                                device: adapterInfo.device,
+                                description: adapterInfo.description,
+                                features: adapterInfo.features,
+                                limits: adapterInfo.limits
+                            }]);
+                        }
+                    }
+                });
+        }
+    }
+    catch (e) {
+        // silently fail
+        sendLogToServer("error", `Error during initial log: ${e.message}`);
+    }
+
+    window.addEventListener('error', (event) => {
+        const errorMessage = event.error ? event.error.stack || event.error.message : event.message;
+        sendLogToServer("error", errorMessage);
+    });
+    window.addEventListener('unhandledrejection', (event) => {
+        const reason = event.reason ? event.reason.stack || event.reason.message : "Unhandled rejection without reason";
+        sendLogToServer("error", `Unhandled promise rejection: ${reason}`);
+    });
+    window.addEventListener('beforeunload', () => {
+        sendLogToServer("internal", "Page is unloading");
+    });
+    document.addEventListener('visibilitychange', () => {
+        console.log("Visibility changed:", document.visibilityState);
+        if (document.visibilityState === 'hidden') {
+            sendLogToServer("internal", "Page is hidden");
+        }
+        else if (document.visibilityState === 'visible') {
+            sendLogToServer("internal", "Page is visible again");
+        }
+        else {
+            sendLogToServer("internal", `Page visibility changed to ${document.visibilityState}`);
+        }
+    });
+    window.addEventListener("focus", () => {
+        sendLogToServer("internal", "Page gained focus");
+    });
+    window.addEventListener("blur", () => {
+        sendLogToServer("internal", "Page lost focus");
+    });
+    window.addEventListener('load', () => {
+        sendLogToServer("internal", "Page fully loaded");
+    });
+    window.addEventListener('DOMContentLoaded', () => {
+        sendLogToServer("internal", "DOM fully loaded and parsed");
+    });
+    window.addEventListener('online', () => {
+        sendLogToServer("internal", "Browser is online");
+    });
+    window.addEventListener('offline', () => {
+        sendLogToServer("warn", "Browser is offline");
+    });
+    window.addEventListener('resize', () => {
+        sendLogToServer("internal", `Window resized to ${window.innerWidth}x${window.innerHeight}px`);
+    });
+    window.addEventListener('orientationchange', () => {
+        sendLogToServer("internal", `Orientation changed to ${screen.orientation.type}`);
+    });
+    window.addEventListener('fullscreenchange', () => {
+        if (document.fullscreenElement) {
+            sendLogToServer("internal", "Entered fullscreen mode");
+        } else {
+            sendLogToServer("internal", "Exited fullscreen mode");
+        }
+    });
+
+
+    // url change event
+    window.addEventListener('hashchange', () => {
+        sendLogToServer("internal", `URL hash changed to ${location.hash}`);
+    });
+    window.addEventListener('popstate', () => {
+        sendLogToServer("internal", `History state changed: ${JSON.stringify(history.state)}`);
+    });
+
+
+
+}
+
+
+
+
+
+// #region copied from common/logger.js
+
+
+
+
+/**
+ * Stringifies a log message, handling circular references and formatting.
+ * @param {any} log
+ * @param {Set<any>} [seen]
+ */
+function stringifyLog(log, seen = new Set()) {
+
+    if (typeof log === "string") {
+        if (log.length > 2000) log = `${log.slice(0, 2000)}... [truncated: ${log.length - 2000} more characters]`;
+        return log;
+    }
+    if (typeof log === "number" || typeof log === "boolean") {
+        return String(log);
+    }
+    if (log === null) {
+        return "null";
+    }
+    if (log === undefined) {
+        return "undefined";
+    }
+
+    if (seen.has(log)) return "[circular]";
+    seen.add(log);
+
+    if (Array.isArray(log)) {
+
+        let res = "";
+        for (let i = 0; i < log.length; i++) {
+            let item = log[i];
+            if (res) res += ", ";
+            if (i > 100) res += "[truncated: " + (log.length - i) + " more items]";
+            res += stringifyLog(item, seen);
+        }
+        return res;
+    }
+    if (typeof log === "object") {
+        let entries = Object.entries(log).map(([key, value], index) => {
+            if (index > 100) return `"${key}": [truncated]`;
+            return `"${key}": ${stringifyLog(value, seen)}`;
+        });
+        return `{ ${entries.join(", ")} }`;
+    }
+    if (log instanceof Buffer) {
+        return `Buffer(${log.length}, ${log.byteLength}, ${log.byteOffset})`;
+    }
+    return String(log);
+}

package/plugins/vite/logger.js

@@ -0,0 +1,85 @@
+import { existsSync, readFileSync } from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { captureLogMessage, patchConsoleLogs } from '../common/logger.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+
+/**
+ * write logs to local file
+ * @param {import('../types/userconfig.js').userSettings} userSettings
+ * @returns {import('vite').Plugin}
+ */
+export const needleLogger = (command, config, userSettings) => {
+
+    patchConsoleLogs();
+    captureLogMessage("server", "info", "Vite started with command \"" + command + "\" in " + __dirname);
+
+    return {
+        name: "needle:logger",
+        enforce: 'pre',
+        configureServer(server) {
+            logRequests(server);
+        },
+        configurePreviewServer(server) {
+            logRequests(server);
+        },
+        transformIndexHtml: {
+            order: 'pre',
+            handler(html, ctx) {
+                // inject client logger script during development
+                if (command === 'serve') {
+                    const file = path.join(__dirname, 'logger.client.js');
+                    if (existsSync(file)) {
+                        const scriptContent = readFileSync(file, 'utf8');
+                        return [
+                            {
+                                tag: 'script',
+                                attrs: {
+                                    type: 'module',
+                                },
+                                children: scriptContent,
+                                injectTo: 'head-prepend',
+                            },
+                        ];
+                    }
+                }
+            },
+        },
+    }
+}
+
+
+/**
+ * Logs HTTP requests to the console.
+ * This function is used in the Vite server to log incoming HTTP requests.
+ * @param {import('vite').PreviewServer | import('vite').ViteDevServer} server
+ */
+function logRequests(server, log_http_requests = false) {
+    if ("ws" in server) {
+        // Clent connections
+        server.ws.on('connection', (socket, request) => {
+            captureLogMessage("server", "connection", "New websocket connection established");
+            socket.on('close', () => {
+                captureLogMessage("server", "connection", "Websocket connection closed");
+            });
+        });
+        // Client log messages via websocket
+        server.ws.on('needle:client-log', async (data, client) => {
+            if (!data || !data.level || !data.message) {
+                console.warn("Received empty log data, ignoring");
+                return;
+            }
+            captureLogMessage("client", data.level, data.message);
+        });
+    }
+    // Log HTTP requests
+    if (log_http_requests) {
+        server.middlewares.use((req, res, next) => {
+            captureLogMessage("client-http", "info", [req.method, req.url]);
+            next();
+        });
+    }
+}

package/plugins/vite/materialx.js

@@ -0,0 +1,32 @@
+import { existsSync } from 'fs';
+
+const materialx_packagejson_path = "node_modules/@needle-tools/materialx/package.json";
+const materialx_import_chunk = `
+import { useNeedleMaterialX } from "@needle-tools/materialx/needle";
+useNeedleMaterialX();
+`
+
+/**
+ * Vite plugin to automatically setup the MaterialX loader for Needle Engine.
+ * @param {string} command 
+ * @param {object} config
+ * @param {import('../types/userconfig.js').userSettings} userSettings
+ * @returns {import('vite').Plugin}
+ */
+export const needleMaterialXLoader = (command, config, userSettings) => {
+
+    return {
+        name: 'needle-materialx-loader',
+        transform: (code, id) => {
+            if (id.endsWith("src/main.ts")) {
+                if (userSettings?.loadMaterialX !== false && existsSync(materialx_packagejson_path)) {
+                    if (!code.includes("@needle-tools/materialx")) {
+                        console.log("[needle-materialx-loader] Adding MaterialX import to main.ts");
+                        code = materialx_import_chunk + "\n" + code;
+                    }
+                }
+            }
+            return code;
+        }
+    }
+}

package/plugins/vite/transform.js

@@ -3,6 +3,7 @@
 
 /** 
  * @param {import('../types').userSettings} userSettings
+ * @returns {import('vite').Plugin[]}
  */
 export const needleTransformCode = (command, config, userSettings) => {
 

package/src/engine/engine_context.ts

@@ -751,7 +751,7 @@ export class Context implements IContext {
 		ContextRegistry.dispatchCallback(ContextEvent.ContextClearing, this);
 		invokeLifecycleFunctions(this, ContextEvent.ContextClearing);
 		// NOTE: this does dispose the environment/background image too
-		// which is probably not desired if it is set via the skybox-image attribute
+		// which is probably not desired if it is set via the background-image attribute
 		destroy(this.scene, true, true);
 		this.scene = new Scene();
 		this.addressables?.dispose();
@@ -1618,10 +1618,11 @@ export class Context implements IContext {
 			}
 
 			const backgroundColor = this.renderer.getClearColor(this._tempClearColor);
+			const clearAlpha = this.renderer.getClearAlpha();
 			this._tempClearColor2.copy(backgroundColor);
-			this.renderer.setClearColor(backgroundColor.convertSRGBToLinear());
+			this.renderer.setClearColor(backgroundColor.convertSRGBToLinear(), this.renderer.getClearAlpha());
 			this.composer.render(this.time.deltaTime);
-			this.renderer.setClearColor(this._tempClearColor2); // restore clear color
+			this.renderer.setClearColor(this._tempClearColor2, clearAlpha); // restore clear color
 		}
 		else if (camera) {
 			// Workaround for issue on Vision Pro – 

package/src/engine/engine_three_utils.ts

@@ -734,6 +734,9 @@ export function getBoundingBox(objects: Object3D | Object3D[], ignore: ((obj: Ob
                 console.warn(`Object \"${obj.name}\" has NaN values in position or scale.... will ignore it`, pos, scale);
                 return;
             }
+            // Sanitize for the three.js method that only checks for undefined here
+            // @ts-ignore
+            if (obj.geometry === null) obj.geometry = undefined;
             box.expandByObject(obj, true);
             obj.children = children;
         }

package/src/engine/webcomponents/needle-engine.attributes.ts

@@ -44,7 +44,7 @@ type LoadingAttributes = {
 }
 
 type SkyboxAttributes = {
-    /** use background-image instead - URL to .exr, .hdr, .png, .jpg to be used as skybox */
+    /** @deprecated. Use background-image instead - URL to .exr, .hdr, .png, .jpg to be used as skybox */
     "skybox-image"?: string,
     /** URL to .exr, .hdr, .png, .jpg to be used as skybox */
     "background-image"?: string, 

package/src/engine-components/Camera.ts

@@ -560,7 +560,7 @@ export class Camera extends Behaviour implements ICamera {
             console.debug(msg);
         }
 
-        const hasBackgroundImageOrColorAttribute = this.context.domElement.getAttribute("background-image") || this.context.domElement.getAttribute("background-color") || this.context.domElement.getAttribute("skybox-image");
+        const hasBackgroundImageOrColorAttribute = this.context.domElement.getAttribute("background-image") || this.context.domElement.getAttribute("background-color");
 
         switch (this._clearFlags) {
             case ClearFlags.None:

package/src/engine-components/CameraUtils.ts

@@ -36,12 +36,14 @@ ContextRegistry.registerCallback(ContextEvent.MissingCamera, (evt) => {
     if (transparentAttribute != undefined) {
         camInstance.clearFlags = ClearFlags.Uninitialized;
     }
-    // Set the clearFlags to a skybox if we have one OR if the user set a skybox image attribute
-    else if (evt.context.domElement.getAttribute("skybox-image")?.length || evt.context.domElement.getAttribute("background-image")?.length || (evt.context as Context).lightmaps.tryGetSkybox(camInstance.sourceId)) {
+    // Set the clearFlags to a skybox if we have one OR if the user set a background-image attribute
+    else if (evt.context.domElement.getAttribute("background-image")?.length || (evt.context as Context).lightmaps.tryGetSkybox(camInstance.sourceId)) {
         camInstance.clearFlags = ClearFlags.Skybox;
         // TODO: can we store the backgroundBlurriness in the gltf file somewhere except inside the camera?
         // e.g. when we export a scene from blender without a camera in the scene
-        camInstance.backgroundBlurriness = .2; // same as in blender 0.5
+        if (evt.context.domElement.getAttribute("background-blurriness") === null) {
+            evt.context.scene.backgroundBlurriness = 0.2; // default value, same as in Blender
+        }
     }
     else {
         camInstance.clearFlags = ClearFlags.SolidColor;

package/src/engine-components/Skybox.ts

@@ -16,10 +16,10 @@ import { Behaviour, GameObject } from "./Component.js";
 
 const debug = getParam("debugskybox");
 
-registerObservableAttribute("skybox-image");
+registerObservableAttribute("background-image");
 registerObservableAttribute("environment-image");
 
-function createRemoteSkyboxComponent(context: IContext, url: string, skybox: boolean, environment: boolean, attribute: "skybox-image" | "environment-image") {
+function createRemoteSkyboxComponent(context: IContext, url: string, skybox: boolean, environment: boolean, attribute: "background-image" | "environment-image") {
     const remote = new RemoteSkybox();
     remote.allowDrop = false;
     remote.allowNetworking = false;
@@ -42,7 +42,7 @@ function createRemoteSkyboxComponent(context: IContext, url: string, skybox: boo
 const promises = new Array<Promise<any>>();
 ContextRegistry.registerCallback(ContextEvent.ContextCreationStart, (args) => {
     const context = args.context;
-    const skyboxImage = context.domElement.getAttribute("skybox-image") || context.domElement.getAttribute("background-image");
+    const skyboxImage = context.domElement.getAttribute("background-image");
     const environmentImage = context.domElement.getAttribute("environment-image");
     if (skyboxImage) {
         if (debug)
@@ -50,8 +50,8 @@ ContextRegistry.registerCallback(ContextEvent.ContextCreationStart, (args) => {
         // if the user is loading a GLB without a camera then the CameraUtils (which creates the default camera)
         // checks if we have this attribute set and then sets the skybox clearflags accordingly
         // if the user has a GLB with a camera but set to solid color then the skybox image is not visible -> we will just warn then and not override the camera settings
-        if (context.mainCameraComponent?.clearFlags !== ClearFlags.Skybox) console.warn("\"skybox-image\"/\"background-image\" attribute has no effect: camera clearflags are not set to \"Skybox\"");
-        const promise = createRemoteSkyboxComponent(context, skyboxImage, true, false, "skybox-image");
+        if (context.mainCameraComponent?.clearFlags !== ClearFlags.Skybox) console.warn("\"background-image\" attribute has no effect: camera clear flags are not set to \"Skybox\"");
+        const promise = createRemoteSkyboxComponent(context, skyboxImage, true, false, "background-image");
         promises.push(promise);
     }
     if (environmentImage) {

package/src/engine-components/postprocessing/Effects/Antialiasing.ts

@@ -1,10 +1,13 @@
 import { MODULES } from "../../../engine/engine_modules.js";
 import { serializable } from "../../../engine/engine_serialization.js";
+import { getParam } from "../../../engine/engine_utils.js";
 import { type EffectProviderResult, PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";
 import { registerCustomEffectType } from "../VolumeProfile.js";
 
 
+const debug = getParam("debugpost");
+
 
 export enum QualityLevel {
     LOW = 0,
@@ -32,15 +35,19 @@ export class Antialiasing extends PostProcessingEffect {
 
     onCreateEffect(): EffectProviderResult {
         const effect = new MODULES.POSTPROCESSING.MODULE.SMAAEffect({
-            preset: MODULES.POSTPROCESSING.MODULE.SMAAPreset.HIGH,
+            preset: this.preset?.value ?? MODULES.POSTPROCESSING.MODULE.SMAAPreset.HIGH,
             edgeDetectionMode: MODULES.POSTPROCESSING.MODULE.EdgeDetectionMode.LUMA,
             // Keep predication mode disabled (default) since it looks better
             // predicationMode: MODULES.POSTPROCESSING.MODULE.PredicationMode.DEPTH,
         });
 
         this.preset.onValueChanged = (newValue) => {
+            if(debug) console.log("Antialiasing preset changed to", newValue);
             effect.applyPreset(newValue);
         };
+        // setInterval(()=> {
+        //     effect.applyPreset(Math.floor(Math.random()*3))
+        // }, 1000)
 
         // effect.edgeDetectionMaterial.edgeDetectionThreshold = .01;
 

package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.ts

@@ -124,7 +124,7 @@ export class ScreenSpaceAmbientOcclusionN8 extends PostProcessingEffect {
             cam,
             width, height
         ) as N8AOPostPass;
-        ssao.name = "SSAO N8";
+        ssao.name = "SSAO_N8";
 
         const mode = ScreenSpaceAmbientOcclusionN8QualityMode[this.quality];
         ssao.setQualityMode(mode);

package/src/engine-components/postprocessing/PostProcessingHandler.ts

@@ -162,9 +162,11 @@ export class PostProcessingHandler {
                     const res = component.apply(ctx);
                     if (!res) continue;
 
+                    const name = component.typeName || component.constructor.name;
 
                     if (Array.isArray(res)) {
                         for (const effect of res) {
+                            if (!validateEffect(name, effect)) continue;
                             this._effects.push({
                                 effect,
                                 typeName: component.typeName,
@@ -173,12 +175,23 @@ export class PostProcessingHandler {
                         }
                     }
                     else {
+                        if (!validateEffect(name, res)) continue;
                         this._effects.push({
                             effect: res,
                             typeName: component.typeName,
                             priority: component.order
                         });
                     }
+
+                    function validateEffect(source: string, effect: Effect | Pass): boolean {
+                        if (!effect) {
+                            return false;
+                        }
+                        if (!(effect instanceof MODULES.POSTPROCESSING.MODULE.Effect || effect instanceof MODULES.POSTPROCESSING.MODULE.Pass)) {
+                            console.warn(`PostprocessingEffect ${source} created neither Effect nor Pass - this might be caused by a bundler error or false import. Below you find some possible solutions:\n- If you create custom effect try creating it like this: 'new NEEDLE_ENGINE_MODULES.POSTPROCESSING.MODULE.Effect(...)' instead of 'new Effect(...)'`);
+                        }
+                        return true;
+                    }
                 }
             }
             else {
@@ -403,7 +416,7 @@ export class PostProcessingHandler {
                     if (attributes & convolution) {
                         if (debug) console.log("[PostProcessing] Convolution effect: " + ef.name);
                         if (hasConvolutionEffectInArray) {
-                            if (debug) console.log("[PostProcessing] Merging effects with convolution", effectsToMerge.map(e => e.name).join(", "));
+                            if (debug) console.log("[PostProcessing] → Merging effects [" + effectsToMerge.map(e => e.name).join(", ") + "]");
                             this.createPassForMergeableEffects(effectsToMerge, composer, cam, scene);
                         }
                         hasConvolutionEffectInArray = true;
@@ -448,7 +461,6 @@ export class PostProcessingHandler {
                 }
                 foundEnabled = true;
             }
-
             pass.renderToScreen = renderToScreen;
 
             if ((pass as any)?.configuration !== undefined) {

package/src/engine-components/postprocessing/Volume.ts

@@ -194,7 +194,7 @@ export class Volume extends Behaviour implements IEditorModificationReceiver, IP
                         if (this._postprocessing.multisampling !== 0) {
                             this._postprocessing.multisampling = 0;
                             if (debug || isDevEnvironment()) {
-                                console.warn(`[PostProcessing] Disabling multisampling you're using SMAA and have set the 'multisampling: auto' on your PostprocessingManager/Volume component. If you need anti-aliasing, consider adding an Antialiasing component or SMAA effect to the PostprocessingManager.`);
+                                console.log(`[PostProcessing] multisampling is disabled because it's set to 'auto' on your PostprocessingManager/Volume component that also has an SMAA effect.\n\nIf you need multisampling consider changing 'auto' to a fixed value (e.g. 4).`);
                             }
                         }
                     }