@needle-tools/engine 4.7.0-next.22483b4 → 4.7.0-next.4bd7749

package/plugins/vite/logger.js

@@ -0,0 +1,101 @@
+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 | null}
+ */
+export const needleLogger = (command, config, userSettings) => {
+
+    if (userSettings?.disableLogging === true) {
+        return null;
+    }
+
+    patchConsoleLogs();
+    captureLogMessage("server", "info", "Vite started with command \"" + command + "\" in " + __dirname, null);
+
+    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) {
+    /**
+     * Logs a message to the server console and captures it.
+     * @type {Map<import("vite").WebSocket, {id:string}>}
+     */
+    const connectedClients = new Map();
+    let index = 0;
+
+    if ("ws" in server) {
+        // Clent connections
+        server.ws.on('connection', (socket, request) => {
+            const clientId = String(index++);
+            connectedClients.set(socket, { id: clientId });
+            const ip = request.socket.remoteAddress || 'unknown';
+            captureLogMessage("server", "connection", `New websocket connection established ${clientId} from ${ip}`, clientId);
+            socket.on('close', () => {
+                captureLogMessage("server", "connection", `Websocket connection closed ${clientId}`, clientId);
+            });
+        });
+        // 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;
+            }
+            const socket = client.socket;
+            const info = connectedClients.get(socket);
+            captureLogMessage("client", data.level, data.message, info ? info.id : null);
+        });
+    }
+    // Log HTTP requests
+    if (log_http_requests) {
+        server.middlewares.use((req, res, next) => {
+            captureLogMessage("client-http", "info", [req.method, req.url], null);
+            next();
+        });
+    }
+}

package/plugins/vite/materialx.js

@@ -1,8 +1,8 @@
 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";
+const materialx_import_chunk = `
+import { useNeedleMaterialX } from "@needle-tools/materialx/needle";
 useNeedleMaterialX();
 `
 
@@ -20,8 +20,10 @@ export const needleMaterialXLoader = (command, config, userSettings) => {
         transform: (code, id) => {
             if (id.endsWith("src/main.ts")) {
                 if (userSettings?.loadMaterialX !== false && existsSync(materialx_packagejson_path)) {
-                    console.log("[needle-materialx-loader] Adding MaterialX import to main.ts");
-                    code = materialx_import_chunk + "\n" + code;
+                    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/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();

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

@@ -42,7 +42,7 @@ export class Antialiasing extends PostProcessingEffect {
         });
 
         this.preset.onValueChanged = (newValue) => {
-            if(debug) console.log("Antialiasing preset changed to", newValue, effect);
+            if(debug) console.log("Antialiasing preset changed to", newValue);
             effect.applyPreset(newValue);
         };
         // setInterval(()=> {

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

@@ -183,7 +183,7 @@ export class PostProcessingHandler {
                         });
                     }
 
-                    function validateEffect(source:string, effect: Effect | Pass): boolean {
+                    function validateEffect(source: string, effect: Effect | Pass): boolean {
                         if (!effect) {
                             return false;
                         }
@@ -461,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).`);
                             }
                         }
                     }