@needle-tools/materialx 1.7.0-next.0d06218 → 1.7.0-next.8333b4d

package/CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Improved texture sampling, alpha-mode render state, environment rotation, and PMREM handling for Three.js integration.
 
 ### Fixed
+- Removed browser-hostile runtime imports of `three/src`, `UniformsLib`, and WebGL-only Three.js exports so the package can share the host application's Three.js import map in WebGL and WebGPU contexts.
 - Corrected material parameter editing for color values, environment controls, and graph-loaded materials in the viewer examples.
 - Kept viewer debug panels and camera controls consistent across the material library, graph, shadows, and complex scenes.
 

package/LICENSE.txt

@@ -0,0 +1,131 @@
+# PolyForm Noncommercial License 1.0.0
+
+<https://polyformproject.org/licenses/noncommercial/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree
+to them as both strict obligations and conditions to all
+your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the
+software to do everything you might do with the software
+that would otherwise infringe the licensor's copyright
+in it for any permitted purpose.  However, you may
+only distribute the software according to [Distribution
+License](#distribution-license) and make changes or new works
+based on the software according to [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license
+to distribute copies of the software.  Your license
+to distribute covers distributing the software with
+changes and new works permitted by [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of
+the software from you also gets a copy of these terms or the
+URL for them above, as well as copies of any plain-text lines
+beginning with `Required Notice:` that the licensor provided
+with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to
+make changes and new works based on the software for any
+permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that
+covers patent claims the licensor can license, or becomes able
+to license, that you would infringe by using the software.
+
+## Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for
+the benefit of public knowledge, personal study, private
+entertainment, hobby projects, amateur pursuits, or religious
+observance, without any anticipated commercial application,
+is use for a permitted purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution,
+public research organization, public safety or health
+organization, environmental protection organization,
+or government institution is use for a permitted purpose
+regardless of the source of funding or obligations resulting
+from the funding.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the
+law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of
+your licenses to anyone else, or prevent the licensor from
+granting licenses to anyone else.  These terms do not imply
+any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or
+contributes to infringement of any patent, your patent license
+for the software granted under these terms ends immediately. If
+your company makes such a claim, your patent license ends
+immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have
+violated any of these terms, or done anything with the software
+not covered by your licenses, your licenses can nonetheless
+continue if you come into full compliance with these terms,
+and take practical steps to correct past violations, within
+32 days of receiving notice.  Otherwise, all your licenses
+end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without
+any warranty or condition, and the licensor will not be liable
+to you for any damages arising out of these terms or the use
+or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these
+terms, and the **software** is the software the licensor makes
+available under these terms.
+
+**You** refers to the individual or entity agreeing to these
+terms.
+
+**Your company** is any legal entity, sole proprietorship,
+or other kind of organization that you work for, plus all
+organizations that have control over, are under the control of,
+or are under common control with that organization.  **Control**
+means ownership of substantially all the assets of an entity,
+or the power to direct its management and policies by vote,
+contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the
+software under these terms.
+
+**Use** means anything you do with the software requiring one
+of your licenses.

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@needle-tools/materialx",
   "description": "MaterialX material support for three.js and Needle Engine – render physically based MaterialX shaders in the browser via WebAssembly",
-  "version": "1.7.0-next.0d06218",
+  "version": "1.7.0-next.8333b4d",
   "type": "module",
+  "license": "PolyForm-Noncommercial-1.0.0",
   "main": "index.js",
   "types": "index.d.ts",
   "exports": {
@@ -35,6 +36,9 @@
     "jsdom": "^29.0.1",
     "three": "npm:@needle-tools/three@^0.169.5"
   },
+  "overrides": {
+    "@needle-tools/gltf-progressive": "3.6.0-beta.2"
+  },
   "files": [
     "index.js",
     "index.d.ts",

package/src/constants.js

@@ -1,6 +1,5 @@
-// Bare JSON import works in all bundlers (Vite, Webpack, Rollup).
-// Node.js 22+ requires --experimental-json-modules or import attributes,
-// but this file is only loaded in bundler context at runtime.
-// Unit tests that run under Node.js use the --import flag in package.json.
+// Bare JSON import works in bundlers (Vite, Webpack, Rollup) and keeps the
+// runtime version tied to package.json. Node.js 22+ requires JSON import
+// attributes, so unit tests use tests/unit/register-json-loader.js.
 import pkg from '../package.json';
 export const VERSION = pkg.version;

package/src/materialx.helper.d.ts

@@ -16,7 +16,7 @@ export interface LightData {
     outer_angle: number;
 }
 
-export function prepareEnvTexture(texture: THREE.Texture, capabilities: any): THREE.Texture;
+export function prepareEnvTexture(texture: THREE.Texture, capabilities?: any): THREE.Texture;
 
 export function getLightRotation(): THREE.Matrix4;
 

package/src/materialx.helper.js

@@ -21,7 +21,7 @@ const IMAGE_PATH_SEPARATOR = "/";
 export function prepareEnvTexture(texture, capabilities) {
     const newTexture = new THREE.DataTexture(texture.image.data, texture.image.width, texture.image.height, /** @type {any} */(texture.format), texture.type);
     newTexture.wrapS = THREE.RepeatWrapping;
-    newTexture.anisotropy = capabilities.getMaxAnisotropy();
+    newTexture.anisotropy = capabilities?.getMaxAnisotropy?.() ?? 1;
     newTexture.minFilter = THREE.LinearMipmapLinearFilter;
     newTexture.magFilter = THREE.LinearFilter;
     newTexture.generateMipmaps = true;

package/src/materialx.js

@@ -1,7 +1,7 @@
 import MaterialX from "../bin/JsMaterialXGenShader.js";
 import { debug, waitForNetworkIdle } from "./utils.js";
 import { renderPMREMToEquirect, renderPMREMToPrefilteredEquirect } from "./utils.texture.js";
-import { CubeUVReflectionMapping, Light, Mesh, MeshBasicMaterial, Object3D, PlaneGeometry, PMREMGenerator, Scene, Texture, WebGLRenderer } from "three";
+import { CubeUVReflectionMapping, Light, Mesh, MeshBasicMaterial, Object3D, PlaneGeometry, PMREMGenerator, Scene, Texture } from "three";
 import { registerLights, getLightData } from "./materialx.helper.js";
 import { whiteTexture } from "./utils.texture.js";
 import { VERSION } from "./constants.js";
@@ -229,7 +229,7 @@ export class MaterialXEnvironment {
 
     /**
      * Initialize with Needle Engine context
-     * @param {WebGLRenderer} renderer
+     * @param {import("three").WebGLRenderer} renderer
      * @returns {Promise<boolean>}
      */
     async initialize(renderer) {
@@ -243,7 +243,7 @@ export class MaterialXEnvironment {
     /**
      * @param {number} frame
      * @param {Scene} scene
-     * @param {WebGLRenderer} renderer
+     * @param {import("three").WebGLRenderer} renderer
      */
     update(frame, scene, renderer) {
         if (!this._initializePromise) {
@@ -334,13 +334,13 @@ export class MaterialXEnvironment {
 
     /** @type {PMREMGenerator | null} */
     _pmremGenerator = null;
-    /** @type {WebGLRenderer | null} */
+    /** @type {import("three").WebGLRenderer | null} */
     _renderer = null;
     /** @type {Map<Texture | null, Map<string, EnvironmentTextureSet>>} */
     _texturesCache = new Map();
 
     /**
-     * @param {WebGLRenderer} renderer
+     * @param {import("three").WebGLRenderer} renderer
      * @returns {Promise<boolean>}
      */
     async _initialize(renderer) {

package/src/materialx.material.js

@@ -1,8 +1,7 @@
-import { BufferGeometry, Camera, Euler, FrontSide, GLSL3, Group, Matrix4, Object3D, Scene, ShaderMaterial, Texture, UniformsLib, Vector3, WebGLRenderer } from "three";
+import { BufferGeometry, Camera, Euler, FrontSide, GLSL3, Group, Matrix4, Object3D, Scene, ShaderMaterial, Texture, Vector3 } from "three";
 import { debug, getFrame, getTime } from "./utils.js";
 import { MaterialXEnvironment } from "./materialx.js";
 import { generateMaterialPropertiesForUniforms, getUniformValues, getLightTypeIds } from "./materialx.helper.js";
-import { cloneUniforms, cloneUniformsGroups, mergeUniforms } from "three/src/renderers/shaders/UniformsUtils.js";
 
 export const DEFAULT_ENVIRONMENT_RADIANCE_MODE = "three-pmrem";
 
@@ -15,6 +14,83 @@ const worldViewProjectionMat = new Matrix4();
 const envMat = new Matrix4();
 const envRotation = new Euler();
 
+// Local copy of Three.js UniformsUtils.cloneUniforms from
+// three/src/renderers/shaders/UniformsUtils.js. Keep this in sync with the
+// minimum supported Three.js version when Three changes uniform cloning.
+function cloneUniforms(src) {
+    const dst = {};
+    for (const uniformName in src) {
+        dst[uniformName] = {};
+        for (const propertyName in src[uniformName]) {
+            const property = src[uniformName][propertyName];
+            if (property && (
+                property.isColor ||
+                property.isMatrix3 || property.isMatrix4 ||
+                property.isVector2 || property.isVector3 || property.isVector4 ||
+                property.isTexture || property.isQuaternion
+            )) {
+                dst[uniformName][propertyName] = property.isRenderTargetTexture ? null : property.clone();
+            }
+            else if (Array.isArray(property)) {
+                dst[uniformName][propertyName] = property.slice();
+            }
+            else {
+                dst[uniformName][propertyName] = property;
+            }
+        }
+    }
+    return dst;
+}
+
+// Local copy of Three.js UniformsUtils.mergeUniforms from
+// three/src/renderers/shaders/UniformsUtils.js. Copied to avoid importing from
+// three/src, which breaks package consumers using Three's public ESM surface.
+function mergeUniforms(uniforms) {
+    const merged = {};
+    for (const uniformSet of uniforms) {
+        const tmp = cloneUniforms(uniformSet);
+        for (const propertyName in tmp) {
+            merged[propertyName] = tmp[propertyName];
+        }
+    }
+    return merged;
+}
+
+// Local copy of Three.js UniformsUtils.cloneUniformsGroups from
+// three/src/renderers/shaders/UniformsUtils.js. Keep alongside cloneUniforms
+// and mergeUniforms so ShaderMaterial.clone() stays behavior-compatible.
+function cloneUniformsGroups(src) {
+    return src.map(group => group.clone());
+}
+
+function createThreeLightUniforms() {
+    return {
+        ambientLightColor: { value: [] },
+        lightProbe: { value: [] },
+        directionalLights: { value: [], properties: { direction: {}, color: {} } },
+        directionalLightShadows: { value: [], properties: { shadowIntensity: 1, shadowBias: {}, shadowNormalBias: {}, shadowRadius: {}, shadowMapSize: {} } },
+        directionalShadowMap: { value: [] },
+        directionalShadowMatrix: { value: [] },
+        spotLights: { value: [], properties: { color: {}, position: {}, direction: {}, distance: {}, coneCos: {}, penumbraCos: {}, decay: {} } },
+        spotLightShadows: { value: [], properties: { shadowIntensity: 1, shadowBias: {}, shadowNormalBias: {}, shadowRadius: {}, shadowMapSize: {} } },
+        spotLightMap: { value: [] },
+        spotShadowMap: { value: [] },
+        spotLightMatrix: { value: [] },
+        pointLights: { value: [], properties: { color: {}, position: {}, decay: {}, distance: {} } },
+        pointLightShadows: { value: [], properties: { shadowIntensity: 1, shadowBias: {}, shadowNormalBias: {}, shadowRadius: {}, shadowMapSize: {}, shadowCameraNear: {}, shadowCameraFar: {} } },
+        pointShadowMap: { value: [] },
+        pointShadowMatrix: { value: [] },
+        hemisphereLights: { value: [], properties: { direction: {}, skyColor: {}, groundColor: {} } },
+        rectAreaLights: { value: [], properties: { color: {}, position: {}, width: {}, height: {} } },
+        ltc_1: { value: null },
+        ltc_2: { value: null },
+        probesSH: { value: null },
+        probesMin: { value: new Vector3() },
+        probesMax: { value: new Vector3() },
+        probesResolution: { value: new Vector3() },
+    };
+}
+
 const CUBE_UV_REFLECTION_FUNCTIONS = `
 float mx_cubeuv_getFace(vec3 direction) {
     vec3 absDirection = abs(direction);
@@ -623,37 +699,39 @@ $2`
         this.environmentRadianceMode = environmentRadianceMode;
         this.specularAntialiasing = specularAntialiasing;
 
-        Object.assign(this.uniforms, {
-            // Three.js light uniforms (required when lights: true)
-            ...UniformsLib.lights,
-
-            ...getUniformValues(init.shader.getStage('vertex'), init.loaders, searchPath, pendingTextureLoads),
-            ...getUniformValues(init.shader.getStage('pixel'), init.loaders, searchPath, pendingTextureLoads),
-
-            u_worldMatrix: { value: new Matrix4() },
-            u_worldInverseMatrix: { value: new Matrix4() },
-            u_worldTransposeMatrix: { value: new Matrix4() },
-            u_worldInverseTransposeMatrix: { value: new Matrix4() },
-            u_worldViewMatrix: { value: new Matrix4() },
-            u_viewProjectionMatrix: { value: new Matrix4() },
-            u_worldViewProjectionMatrix: { value: new Matrix4() },
-            u_viewPosition: { value: new Vector3() },
-
-            u_envMatrix: { value: new Matrix4() },
-            u_envRadiance: { value: null, type: 't' },
-            u_envRadianceMips: { value: 8, type: 'i' },
-            u_envRadianceCubeUVTexelWidth: { value: 1 / 768 },
-            u_envRadianceCubeUVTexelHeight: { value: 1 / 1024 },
-            u_envRadianceCubeUVMaxMip: { value: 8 },
-            // TODO we need to figure out how we can set a PMREM here... doing many texture samples is prohibitively expensive
-            u_envRadianceSamples: { value: 8, type: 'i' },
-            u_envIrradiance: { value: null, type: 't' },
-            envMapIntensity: { value: 1.0 },
-            u_refractionEnv: { value: true },
-            u_refractionTwoSided: { value: false },
-            u_numActiveLightSources: { value: 0 },
-            u_lightData: { value: [], needsUpdate: false }, // Array of light data. We need to set needsUpdate to false until we actually update it
-        });
+        Object.assign(this.uniforms,
+            // Three.js light uniforms (required when lights: true). These use
+            // Three's merge/clone semantics; generated MaterialX texture
+            // uniforms below must keep their original object identity so async
+            // texture resolution updates the same uniform object.
+            mergeUniforms([createThreeLightUniforms()]),
+            getUniformValues(init.shader.getStage('vertex'), init.loaders, searchPath, pendingTextureLoads),
+            getUniformValues(init.shader.getStage('pixel'), init.loaders, searchPath, pendingTextureLoads),
+            {
+                u_worldMatrix: { value: new Matrix4() },
+                u_worldInverseMatrix: { value: new Matrix4() },
+                u_worldTransposeMatrix: { value: new Matrix4() },
+                u_worldInverseTransposeMatrix: { value: new Matrix4() },
+                u_worldViewMatrix: { value: new Matrix4() },
+                u_viewProjectionMatrix: { value: new Matrix4() },
+                u_worldViewProjectionMatrix: { value: new Matrix4() },
+                u_viewPosition: { value: new Vector3() },
+
+                u_envMatrix: { value: new Matrix4() },
+                u_envRadiance: { value: null, type: 't' },
+                u_envRadianceMips: { value: 8, type: 'i' },
+                u_envRadianceCubeUVTexelWidth: { value: 1 / 768 },
+                u_envRadianceCubeUVTexelHeight: { value: 1 / 1024 },
+                u_envRadianceCubeUVMaxMip: { value: 8 },
+                // TODO we need to figure out how we can set a PMREM here... doing many texture samples is prohibitively expensive
+                u_envRadianceSamples: { value: 8, type: 'i' },
+                u_envIrradiance: { value: null, type: 't' },
+                envMapIntensity: { value: 1.0 },
+                u_refractionEnv: { value: true },
+                u_refractionTwoSided: { value: false },
+                u_numActiveLightSources: { value: 0 },
+                u_lightData: { value: [], needsUpdate: false }, // Array of light data. We need to set needsUpdate to false until we actually update it
+            });
         this.ready = Promise.all(pendingTextureLoads).then(() => undefined);
 
         generateMaterialPropertiesForUniforms(this, init.shader.getStage('pixel'));
@@ -673,7 +751,7 @@ $2`
     _missingTangentsWarned = false;
 
     /**
-     * @param {WebGLRenderer} renderer
+     * @param {import("three").WebGLRenderer} renderer
      * @param {Scene} _scene
      * @param {Camera} camera
      * @param {BufferGeometry} geometry
@@ -710,7 +788,7 @@ $2`
     specularAntialiasing = true;
 
     /**
-     * @param {WebGLRenderer} _renderer
+     * @param {import("three").WebGLRenderer} _renderer
      * @param {Object3D} object
      * @param {Camera} camera
      * @param {number} [time]

package/src/utils.texture.js

@@ -1,4 +1,4 @@
-import { WebGLRenderer, Scene, WebGLRenderTarget, PlaneGeometry, OrthographicCamera, ShaderMaterial, RGBAFormat, FloatType, LinearFilter, Mesh, EquirectangularReflectionMapping, RepeatWrapping, LinearMipMapLinearFilter, DataTexture, UnsignedByteType, Vector4 } from 'three';
+import { Scene, WebGLRenderTarget, PlaneGeometry, OrthographicCamera, ShaderMaterial, RGBAFormat, FloatType, LinearFilter, Mesh, EquirectangularReflectionMapping, RepeatWrapping, LinearMipMapLinearFilter, DataTexture, UnsignedByteType, Vector4 } from 'three';
 import { getParam } from './utils.js';
 
 const debug = getParam("debugmaterialx");
@@ -96,7 +96,7 @@ function createPrefilteredEquirectMaterial(pmremTexture, cubeUVSize) {
 
 /**
  * Renders a PMREM environment map to an equirectangular texture with specified roughness
- * @param {WebGLRenderer} renderer - Three.js WebGL renderer
+ * @param {import("three").WebGLRenderer} renderer - Three.js WebGL renderer
  * @param {Texture} pmremTexture - PMREM texture (2D CubeUV layout) to convert
  * @param {number} [roughness=0.0] - Roughness value (0.0 to 1.0)
  * @param {number} [width=1024] - Output texture width
@@ -249,7 +249,7 @@ export function renderPMREMToEquirect(renderer, pmremTexture, roughness = 0.0, w
 /**
  * Renders a Three.js PMREM CubeUV texture to an equirectangular texture whose mip
  * levels encode increasing roughness for MaterialX SPECULAR_ENVIRONMENT_PREFILTER.
- * @param {WebGLRenderer} renderer
+ * @param {import("three").WebGLRenderer} renderer
  * @param {Texture} pmremTexture
  * @param {number} [width=2048]
  * @param {number} [height=1024]