@needle-tools/gltf-build-pipeline 2.4.0-alpha → 2.4.0-alpha.1

package/CHANGELOG.md

@@ -4,7 +4,7 @@ All notable changes to this package will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [2.4.0-alpha] - 2023-06-26
+## [2.4.0-alpha.1] - 2023-06-26
 - add: heuristic for choosing mesh compression if not explictly configured
 
 ## [2.3.0-alpha.2] - 2023-06-26

package/dist/transforms/needle_mesh_transform.js

@@ -53,19 +53,25 @@ async function applyMeshCompression(document, transform_context, context) {
             sizeOfMeshes += prim.getAttribute('POSITION').getArray().length;
         }
     }
-    // consider meshopt if blendshape size is > 256 KB
-    const sizeThreshold = 256 * 1024;
-    if (sizeOfBlendshapes > sizeThreshold) {
-        /** How big are the blendshapes compared to the overall mesh size */
-        const blendshapeRatio = sizeOfBlendshapes / sizeOfMeshes;
-        /** 25% of the size are blendshapres */
-        const ratioThreshold = 0.25;
-        if (blendshapeRatio >= ratioThreshold) {
-            document.getLogger().info(`[${NAME}]: will apply meshopt mesh compression because blendshapes are ${(blendshapeRatio * 100).toFixed(2)}% of the mesh size`);
-            const transform = meshopt({ encoder: MeshoptEncoder });
-            return transform(document, transform_context);
-        }
+    // TODO: make this more robus with progressive loading: when progressive loading is enabled we need to run this check on the root mesh and enforce the same mesh compression for all children. Until we can do that we can not use the code for choosing compression based on blendshape size
+    if (sizeOfBlendshapes > 0) {
+        document.getLogger().info(`[${NAME}]: will apply meshopt mesh compression because the mesh contains blendshapes`);
+        const transform = meshopt({ encoder: MeshoptEncoder });
+        return transform(document, transform_context);
     }
+    // consider meshopt if blendshape size is > 256 KB
+    // const sizeThreshold = 256 * 1024;
+    // if (sizeOfBlendshapes > sizeThreshold) {
+    //     /** How big are the blendshapes compared to the overall mesh size */
+    //     const blendshapeRatio = sizeOfBlendshapes / sizeOfMeshes;
+    //     /** 25% of the size are blendshapres */
+    //     const ratioThreshold = 0.1;
+    //     if (blendshapeRatio >= ratioThreshold) {
+    //         document.getLogger().info(`[${NAME}]: will apply meshopt mesh compression because blendshapes are ${(blendshapeRatio * 100).toFixed(2)}% of the mesh size`);
+    //         const transform = meshopt({ encoder: MeshoptEncoder });
+    //         return transform(document, transform_context);
+    //     }
+    // }
     // by default we still want to run draco if the root doesnt have a compression model configured
     document.getLogger().info(`[${NAME}]: → will apply draco mesh compression (default)`);
     return draco()(document, transform_context);

package/package.json

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