@needle-tools/materialx 1.3.3 → 1.3.4

package/README.md

@@ -2,9 +2,11 @@
 
 Web runtime support to load and display MaterialX materials in Needle Engine and three.js via the MaterialX WebAssembly library. glTF files containing the `NEEDLE_materials_mtlx` extension can be loaded with this package. There is also experimental support for loading raw MaterialX XML files.
 
-> [!TIP]
 > When using Needle Engine for Unity, this package can be added to your project via the Needle Engine component. Add it to the "NpmDef Dependencies" field. MaterialX files will then be automatically generated from compatible Shader Graphs with the "MaterialX" export type.    
-> [Learn more in the Needle Engine documentation](https://engine.needle.tools/docs/materialx.html).
+> [Learn more in the Needle Engine documentation](https://engine.needle.tools/docs/how-to-guides/export/materialx.html).
+
+[![](https://cloud.needle.tools/-/media/Xc99R6zbaD-kpoTw1cMRKA.gif)](https://engine.needle.tools/samples/material-x)
+
 
 ## Installation
 `npm i @needle-tools/materialx`  

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@needle-tools/materialx",
-  "version": "1.3.3",
+  "version": "1.3.4",
   "type": "module",
   "main": "index.js",
   "types": "index.d.ts",

package/src/loader/loader.three.js

@@ -92,7 +92,7 @@ export class MaterialXLoader {
 
         /** @type {MaterialDefinition} */
         const materialDef = this.parser.json.materials?.[materialIndex];
-        if (debug) console.log("[MaterialX] extension found in material:", materialDef.extensions?.[this.name]);
+        if (debug) console.debug("[MaterialX] extension found in material:", materialDef.extensions?.[this.name]);
 
         // Handle different types of MaterialX data
         /** @type {MaterialX_material_extension} */

package/src/materialx.helper.js

@@ -4,6 +4,7 @@
 //
 import * as THREE from 'three';
 import { debug, debugUpdate } from './utils.js';
+import { isDevEnvironment } from './utils.js';
 
 const IMAGE_PROPERTY_SEPARATOR = "_";
 const UADDRESS_MODE_SUFFIX = IMAGE_PROPERTY_SEPARATOR + "uaddressmode";
@@ -223,7 +224,7 @@ function toThreeUniform(uniforms, type, value, name, loaders, searchPath) {
             const key = type + ':' + name;
             if (!valueTypeWarningMap.has(key)) {
                 valueTypeWarningMap.set(key, true);
-                console.warn(`MaterialX: Unsupported uniform type: ${type} for uniform: ${name}`);
+                if (debug || isDevEnvironment()) console.warn(`MaterialX: Unsupported uniform '${name}': ${type}`);
             }
             break;
     }
@@ -425,11 +426,11 @@ export function getLightData(lights, genContext) {
 
         const lightDefinitionName = threeLightTypeToMaterialXNodeName(light.type);
 
-        if(!lightDefinitionName){
+        if (!lightDefinitionName) {
             continue; // Unsupported light type
         }
         if (!lightTypesBound[lightDefinitionName]) {
-            if(debug) console.error("MaterialX: Light type not registered in context. Make sure to register light types before using them.", lightDefinitionName);
+            if (debug) console.error("MaterialX: Light type not registered in context. Make sure to register light types before using them.", lightDefinitionName);
         }
 
         const wp = light.getWorldPosition(new THREE.Vector3());

package/src/materialx.js

@@ -214,9 +214,9 @@ export class MaterialXEnvironment {
         }
         this._lastUpdateFrame = frame;
         this.updateLighting(false);
-        const textures = this._getTextures(scene.environment);
 
         if (debug && !this["_debug"]) {
+            const textures = this._getTextures(scene.environment);
             this["_debug"] = true;
             // Show both of them on cubes in the scene
             const unlitMat = new MeshBasicMaterial();

package/src/materialx.material.js

@@ -6,7 +6,6 @@ import { cloneUniforms, cloneUniformsGroups } from "three/src/renderers/shaders/
 
 // Add helper matrices for uniform updates (similar to MaterialX example)
 const normalMat = new Matrix3();
-const worldViewPos = new Vector3();
 
 /**
  * @typedef {Object} MaterialXMaterialInitParameters
@@ -241,8 +240,9 @@ export class MaterialXMaterial extends ShaderMaterial {
         const env = MaterialXEnvironment.get(_scene);
         if (env) {
             env.update(frame, _scene, renderer);
-            this.updateUniforms(env, renderer, object, camera, time, frame);
+            this.updateEnvironmentUniforms(env);
         }
+        this.updateUniforms(renderer, object, camera, time, frame);
     }
 
     /** @type {number} */
@@ -251,24 +251,32 @@ export class MaterialXMaterial extends ShaderMaterial {
     envMap = null; // Environment map texture, can be set externally
 
     /**
-     * @param {MaterialXEnvironment} environment
      * @param {WebGLRenderer} _renderer
      * @param {Object3D} object
      * @param {Camera} camera
      * @param {number} [time]
      * @param {number} [frame]
      */
-    updateUniforms = (environment, _renderer, object, camera, time, frame) => {
+    updateUniforms = (_renderer, object, camera, time, frame) => {
+
+        // window.showBalloonMessage(`Updating MaterialX uniforms for ${object.name} at frame ${frame}`);
 
         const uniforms = this.uniforms;
 
         // Update standard transformation matrices
         if (uniforms.u_worldMatrix) {
-            uniforms.u_worldMatrix.value = object.matrixWorld;
+            uniforms.u_worldMatrix.value.copy(object.matrixWorld);
             // @ts-ignore
             uniforms.u_worldMatrix.needsUpdate = true;
         }
 
+        // Update view position
+        if (uniforms.u_viewPosition) {
+            uniforms.u_viewPosition.value.setFromMatrixPosition(camera.matrixWorld);
+            // @ts-ignore
+            uniforms.u_viewPosition.needsUpdate = true;
+        }
+
         if (uniforms.u_viewProjectionMatrix) {
             uniforms.u_viewProjectionMatrix.value.multiplyMatrices(camera.projectionMatrix, camera.matrixWorldInverse);
             // @ts-ignore
@@ -281,12 +289,6 @@ export class MaterialXMaterial extends ShaderMaterial {
             uniforms.u_worldInverseTransposeMatrix.needsUpdate = true;
         }
 
-        if (uniforms.u_viewPosition) {
-            uniforms.u_viewPosition.value.copy(camera.getWorldPosition(worldViewPos));
-            // @ts-ignore
-            uniforms.u_viewPosition.needsUpdate = true;
-        }
-
         // if (uniforms.u_shadowMap) {
         //     const light = environment.lights?.[2] || null;
         //     uniforms.u_shadowMatrix.value = light?.shadow?.matrix.clone().premultiply(object.matrixWorld.clone()).invert();
@@ -306,9 +308,6 @@ export class MaterialXMaterial extends ShaderMaterial {
         }
 
         this.uniformsNeedUpdate = true;
-
-        // Update light uniforms
-        this.updateEnvironmentUniforms(environment);
     }
 
     /**

package/src/utils.js

@@ -56,4 +56,10 @@ export async function waitForNetworkIdle() {
         console.debug("[MaterialX] Can not wait for network idle, using fallback");
         return new Promise(res => setTimeout(res, 100)); // Fallback to a short delay
     }
+}
+
+
+export function isDevEnvironment() {
+    // check if we're in localhost or using an ip address
+    return window.location.hostname === "localhost" || /^\d{1,3}(\.\d{1,3}){3}$/.test(window.location.hostname);
 }