@needle-tools/gltf-build-pipeline 2.12.0 → 2.12.1

package/README.md

@@ -1,7 +1,8 @@
 # glTF Build Pipeline
 
-Creating optimized glTF, GLB and VRM files for the web.   
-Includes support for generating LOD quality level for textures and meshes that can be used with [@needle-tools/gltf-progressive](https://www.npmjs.com/package/@needle-tools/gltf-progressive)
+Creating optimized glTF, GLB and VRM files for the web.    
+
+Includes support for generating LOD quality level for textures and meshes. Use with [@needle-tools/gltf-progressive](https://www.npmjs.com/package/@needle-tools/gltf-progressive)
 
 ## Examples
 
@@ -23,12 +24,14 @@ To load progressively enhanced glTF files in any three.js based engine see examp
 `npx @needle-tools/gltf-build-pipeline@latest`
 
 ### Commands
-- `gltf-build-pipeline help` - use help to see options for each command
-- `gltf-build-pipeline compress <input>`
-- `gltf-build-pipeline transform <input>`
+- `help` - use help to view options
+
+# Contact
+
+For licensing questions please contact us.
 
-# Contact ✒️
-<b>[🌵 needle — tools for creators](https://needle.tools)</b> • 
+<b>[🌵 Needle](https://needle.tools)</b> • 
+[Email](mailto:hi@needle.tools) • 
 [Twitter](https://twitter.com/NeedleTools) • 
 [Discord](https://discord.needle.tools) • 
 [Forum](https://forum.needle.tools)

package/dist/transforms/needle_mesh_transform.js

@@ -199,7 +199,7 @@ export async function compressPrimitive(document, mesh, prim, index, weldOptions
             return;
     }
     // TODO: enable regularize once it's available: https://github.com/zeux/meshoptimizer/pull/914/files
-    logger.debug(`simplify: primitive[${index}] of mesh "${mesh.getName()}" → ratio: ${meshOptions.ratio}, error: ${meshOptions.error}, lockBorder: ${meshOptions.lockBorder}`);
+    logger.debug(`simplify: primitive[${index}] of mesh "${mesh.getName()}" → ratio: ${meshOptions.ratio}, error: ${meshOptions.error}, lockBorder: ${meshOptions.lockBorder}, regularize: ${meshOptions.regularize}, normalWeight: ${meshOptions.normalWeight}, colorWeight: ${meshOptions.colorWeight}, textureWeight: ${meshOptions.textureWeight}`);
     return simplifyPrimitive(prim, meshOptions);
 }
 // function updatePrimitive(prim: Primitive, simplifier: any, positionArray, dstIndicesArray) {

package/dist/transforms/needle_progressive.js

@@ -530,31 +530,42 @@ export function make_progressive_meshes(filePath, _options, opts) {
         const filename = path.basename(filePath);
         logger.info(`[${NAME}]: Begin generating progressive meshes for \"${filename}\"`);
         let index = 0;
+        // Try settings here: https://meshoptimizer.org/demo/simplify.html
         // the lowest LOD (last entry) will be saved in the original file
         let MAX_LODS = 6;
         if (opts.config.usecase === "product") {
             MAX_LODS = 3;
         }
-        const LODS = [
-            {
-                ratio: 1,
-                error: 0,
-                lockBorder: true
-            },
-        ];
+        const lod0_settings = {
+            ratio: 1,
+            error: 0,
+            lockBorder: true,
+            normalWeight: 2,
+            colorWeight: 1,
+            textureWeight: 1
+        };
+        const errorLevel = [0, .003, .005, .01, .02]; // 0.02 is roughly 10^-1.7 → disable scale error and set error https://meshoptimizer.org/demo/simplify.html
+        const LODS = [lod0_settings];
         for (let l = 0; l < MAX_LODS; l++) {
-            const t = l / (MAX_LODS - 1);
-            const latest = LODS[LODS.length - 1];
-            const ratio = latest.ratio * .5;
-            let error = 0.003 + t * .01; // using max 1%, example mesh: https://linear.app/needle/issue/NE-6653
+            const t01 = l / (MAX_LODS - 1);
+            const previous = LODS[LODS.length - 1];
+            const ratio = previous.ratio * .5;
+            let error = errorLevel[Math.min(errorLevel.length - 1, l)]; // example mesh: https://linear.app/needle/issue/NE-6653 or https://cloud-staging.needle.tools/edit/Z1S7sey8bb7061
             if (opts.config.usecase === "product") {
                 error *= .5;
             }
+            const normalWeight = lod0_settings.normalWeight; // keep normalWeight constantly high since it's so important
+            const colorWeight = Math.max(.2, Math.min(1, lod0_settings.colorWeight * (1 - t01)));
+            const textureWeight = Math.max(.2, Math.min(10, lod0_settings.textureWeight * (1 - t01 * 2)));
+            const regularize = l > 1 && l < (MAX_LODS - 2); // only regularize the inner LODs
             LODS.push({
                 ratio: ratio,
                 error,
                 lockBorder: true,
-                // toleranceNormal: 0.1 + t * 0.1,
+                regularize: regularize,
+                normalWeight: normalWeight,
+                colorWeight: colorWeight,
+                textureWeight: textureWeight,
             });
         }
         logger.debug(`[${NAME}]: Generating mesh LODs:\n${JSON.stringify(LODS, undefined, 2)}`);

package/dist/utils/version.gen.d.ts

@@ -1 +1 @@
-export declare const version = "2.12.0";
+export declare const version = "2.12.1";

package/dist/utils/version.gen.js

@@ -1 +1 @@
-export const version = "2.12.0";
+export const version = "2.12.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@needle-tools/gltf-build-pipeline",
-  "version": "2.12.0",
+  "version": "2.12.1",
   "description": "Pipeline and tools for optimizing gltf files using gltf-transform and compression settings within glTF extensions",
   "main": "dist/index.js",
   "type": "module",