@needle-tools/gltf-build-pipeline 1.4.5 → 1.4.7

package/CHANGELOG.md

@@ -4,6 +4,12 @@ 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).
 
+## [1.4.7] - 2023-04-16
+- add: `asset.extras.needle` now contains information about used build pipeline
+
+## [1.4.6] - 2023-04-10
+- fix: NEEDLE_progressive meshes do not revert primitive data for skinned meshes anymore. See NE-4596
+
 ## [1.4.5] - 2023-04-05
 - fix: generating mesh and texture LOD for glbs without `NEEDLE_` extension
 - fix: guid generation for progressive meshes when no `NEEDLE_` extension is present

package/dist/transforms/needle_asset.d.ts

@@ -1,2 +1,3 @@
-import { Transform } from '@gltf-transform/core';
+import { Document, Transform } from '@gltf-transform/core';
+export declare function writeNeedleAsset(document: Document): void;
 export declare function needle_asset(): Transform;

package/dist/transforms/needle_asset.js

@@ -1,17 +1,35 @@
 import { createTransform } from '@gltf-transform/functions';
 import { getVersion } from '../index.js';
+const generatorName = "Needle Build Pipeline";
+export function writeNeedleAsset(document) {
+    const root = document.getRoot();
+    const asset = root.getAsset();
+    if (asset) {
+        asset.extras = writeNeedleExtras(asset.extras);
+        const version = getVersion();
+        asset.generator = generatorName;
+        if (version?.length > 0) {
+            asset.generator += " " + version;
+        }
+    }
+}
 export function needle_asset() {
     return createTransform("needle_asset_transform", (document) => {
-        const root = document.getRoot();
-        const asset = root.getAsset();
-        if (asset) {
-            const version = getVersion();
-            if (!asset.generator.startsWith("Needle glTF Build Pipeline")) {
-                asset.generator = "Needle glTF Build Pipeline";
-                if (version?.length > 0) {
-                    asset.generator += " " + version;
-                }
-            }
-        }
+        writeNeedleAsset(document);
     });
 }
+/** @internal */
+function writeNeedleExtras(extras) {
+    if (!extras)
+        extras = {};
+    if (typeof extras === "object" && !extras["needle"]) {
+        let generator = generatorName;
+        const version = getVersion();
+        if (version?.length > 0)
+            generator += " " + version;
+        extras["needle"] = {
+            generator: generator
+        };
+    }
+    return extras;
+}

package/dist/transforms/needle_progressive.js

@@ -7,7 +7,7 @@ import { existsSync, readFileSync, rmSync, statSync, writeFileSync } from 'fs';
 import { addMetaToCache, addToCache, getHash, getKey, tryGetFromCache, tryGetMetaFromCache } from '../cache/index.js';
 import sharp from "sharp";
 import { foreachGLTF, generateGuid } from '../utils/index.js';
-import { needle_asset } from './needle_asset.js';
+import { needle_asset, writeNeedleAsset } from './needle_asset.js';
 import { MeshoptDecoder, MeshoptSimplifier } from 'meshoptimizer';
 import { compressPrimitive } from './needle_mesh_transform.js';
 import { calculateMeshDensity, getMeshInformation } from "../utils/mesh.js";
@@ -155,7 +155,7 @@ export function make_progressive_textures(filePath, _options = TEXTURE_RESIZE_DE
                 continue;
             }
             const textureGuid = settings.guid?.length ? settings.guid : generateGuid(path + "_texture_" + index.toString());
-            const outPath = createTextureLod(textureLodBasePath, 0, texture, slots, textureGuid, textureIndex);
+            const outPath = createTextureLod(doc, textureLodBasePath, 0, texture, slots, textureGuid, textureIndex);
             if (!outPath) {
                 continue;
             }
@@ -190,7 +190,7 @@ export function make_progressive_textures(filePath, _options = TEXTURE_RESIZE_DE
         logger.debug(`Progressive transform finished in ${((Date.now() - startTime) / 1000).toFixed(1)} sec.`);
     });
 }
-function createTextureLod(basePath, level, texture, slots, guid, textureIndex) {
+function createTextureLod(doc, basePath, level, texture, slots, guid, textureIndex) {
     // const imageBytes = texture.getImage();
     // if (imageBytes) {
     // 	// write bytes
@@ -199,6 +199,7 @@ function createTextureLod(basePath, level, texture, slots, guid, textureIndex) {
     // 	return outPath;
     // }
     const newDoc = new Document();
+    writeNeedleAsset(newDoc);
     newDoc.createScene();
     newDoc.createBuffer();
     // add texture
@@ -474,11 +475,13 @@ export function make_progressive_meshes(filePath, _options, opts) {
             let maxDensity = 0;
             let primitiveIndex = 0;
             const lodLevelInFile = generatedLODInfos.length;
-            const clonedData = new Array();
+            const clonedData = { primitives: [], weights: [...mesh.getWeights()] };
             for (const prim of mesh.listPrimitives()) {
                 const data = clonePrimitiveData(prim);
-                clonedData.push(data);
-                console.log(`[${NAME}] Simplify mesh[${index}] primitive[${primitiveIndex}] with ${data.indices.length / 3} triangles`);
+                if (data != null) {
+                    clonedData.primitives.push(data);
+                }
+                console.log(`[${NAME}] Simplify mesh[${index}] primitive[${primitiveIndex}] (embedded)`);
                 const lastLod = LODS[lodLevelInFile];
                 // TODO: this should be run after simplification but then we need to change the runtime to use the LOD 0 density
                 const density = calculateMeshDensity(prim);
@@ -496,7 +499,7 @@ export function make_progressive_meshes(filePath, _options, opts) {
             }
             else if (difference < 32 || diff01 <= 0.05) {
                 // the lowest LOD has the same vertex count as the original mesh → we don't need to write the extension and can also delete previously generated LODs
-                console.log(`[${NAME}]: Flag mesh LOD ${generatedLODInfos.length}: vertex count difference below threshold (removed ${difference} vertices, ${(-diff01 * 100).toFixed(2)} %) → will remove LODs. \"${mesh.getName()}\"`);
+                console.log(`[${NAME}]: Flag mesh LOD ${generatedLODInfos.length} (embedded): vertex count difference below threshold (removed ${difference} vertices, ${(-diff01 * 100).toFixed(2)} %) → will remove LOD. \"${mesh.getName()}\"`);
                 try {
                     for (const lodInfo of generatedLODInfos) {
                         rmSync(outputDirectory + "/" + lodInfo.path);
@@ -507,9 +510,12 @@ export function make_progressive_meshes(filePath, _options, opts) {
                 }
                 // reset data (simplify might have changed the mesh data that we cloned before)
                 const primitives = mesh.listPrimitives();
-                if (clonedData.length == primitives.length) {
+                if (clonedData.primitives.length == primitives.length) {
+                    if (clonedData.weights?.length > 0) {
+                        mesh.setWeights(clonedData.weights);
+                    }
                     for (let i = 0; i < primitives.length; i++) {
-                        setPrimitiveData(primitives[i], clonedData[i]);
+                        setPrimitiveData(primitives[i], clonedData.primitives[i]);
                     }
                 }
                 return;
@@ -540,9 +546,14 @@ export function make_progressive_meshes(filePath, _options, opts) {
     });
 }
 function clonePrimitiveData(prim) {
+    const semantics = prim.listSemantics();
+    if (semantics.some(s => s.includes("JOINTS"))) {
+        return null;
+    }
     const indices = new Uint32Array(prim.getIndices().getArray());
     const attributes = {};
-    for (const attr of prim.listSemantics()) {
+    for (const attr of semantics) {
+        console.log(`[${NAME}] Clone attribute ${attr}`);
         const accessor = prim.getAttribute(attr);
         if (accessor) {
             attributes[attr] = new Float32Array(accessor.getArray());
@@ -594,6 +605,7 @@ async function createMeshLod(doc, basePath, level, mesh, meshInfo, guid, lodLeve
         }
     }
     const newDoc = new Document();
+    writeNeedleAsset(newDoc);
     const newScene = newDoc.createScene();
     newDoc.createBuffer();
     const newNode = newDoc.createNode();

package/package.json

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