@needle-tools/gltf-build-pipeline 1.1.3 → 1.1.5

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.1.5] - 2023-06-26
+- change: bump gltf-transform dependency to latest 3.4.3
+
+## [1.1.4] - 2023-06-09
+- fix: progressive texture transform didnt pass mesh compression setting through
+
 ## [1.1.3] - 2023-05-24
 - minor change adding info about reduced size after processing gltf files
 

package/dist/extensions/NEEDLE_opaque/NEEDLE_opaque.d.ts

@@ -10,6 +10,10 @@ export interface IOpaqueExtension {
 export interface IOpaqueProperty {
     /** used by progressive texture extension to pass an extension between documents */
     getExtensionDefinition(): object;
+    /** register a reference so gltf-transform will not remove it in e.g. dedup
+     * https://github.com/donmccurdy/glTF-Transform/issues/980#issuecomment-1585748202
+     */
+    setReference(name: string, value: any): any;
 }
 export interface IExtensionWriter {
     /** used by progressive texture extension to pass an extension between documents */

package/dist/extensions/NEEDLE_opaque/NEEDLE_opaque.js

@@ -199,7 +199,7 @@ export function createOpaqueExtension(name, types, opts) {
                     // attach the property
                     target[index].setExtension(EXTENSION_NAME, prop);
                     // capture all the json pointers in the extension
-                    this.jsonPointerHandler.read(context, target[index], ext);
+                    this.jsonPointerHandler.read(context, target[index], ext, prop);
                     // make sure we write our extension back to the gltf
                     prop.add(new OpaqueWriter(map, gltfField, ext));
                 });
@@ -293,7 +293,11 @@ export function createOpaqueExtension(name, types, opts) {
         extensionName = typeof EXTENSION_NAME;
         parentTypes = ExtensionPropertyTypes;
         propertyType = "NEEDLE_opaque_property";
-        init() { }
+        setReference(name, value) {
+            this.setRef(name, value, { modifyChild: true });
+        }
+        init() {
+        }
         writers = [];
         add(writer) {
             if (typeof writer === "function") {
@@ -495,7 +499,7 @@ class JsonPointerHandler {
         this.document = document;
         this.id = id;
     }
-    read(context, prop, obj, key, fullPath) {
+    read(context, prop, obj, ext, key, fullPath) {
         const value = key !== undefined ? obj[key] : obj;
         // the pointer path contains the full path from the root object to the json pointer
         if (key !== undefined) {
@@ -506,7 +510,7 @@ class JsonPointerHandler {
             case 'object':
                 if (value !== null && value !== undefined) {
                     for (const key of Object.keys(value)) {
-                        this.read(context, prop, value, key, fullPath);
+                        this.read(context, prop, value, ext, key, fullPath);
                     }
                 }
                 break;
@@ -551,6 +555,19 @@ class JsonPointerHandler {
                         else
                             console.warn("WARN: failed registering pointer", fullPath, value);
                     }
+                    if (value.startsWith("/materials/")) {
+                        // set a reference to the material to avoid dedup
+                        // see https://github.com/donmccurdy/glTF-Transform/issues/980#issuecomment-1585748202
+                        if (this.debug)
+                            console.log("Read pointer", value);
+                        const index = parseInt(value.substring("/materials/".length));
+                        const mat = context.materials[index];
+                        if (mat) {
+                            if (ext) {
+                                ext.setReference(key, mat);
+                            }
+                        }
+                    }
                 }
                 break;
         }

package/dist/transforms/needle_asset.js

@@ -1,22 +1,11 @@
 import { createTransform } from '@gltf-transform/functions';
-import { existsSync, readFileSync } from 'fs';
-let version = undefined;
+import { getVersion } from '../index.js';
 export function needle_asset() {
     return createTransform("needle_asset_transform", (document) => {
         const root = document.getRoot();
         const asset = root.getAsset();
         if (asset) {
-            if (version === undefined) {
-                version = null;
-                const path = process.cwd() + "/package.json";
-                if (existsSync(path)) {
-                    const packageJson = readFileSync(path, "utf8");
-                    const packageVersion = JSON.parse(packageJson).version;
-                    version = packageVersion ?? null;
-                }
-                else
-                    console.log("Could not find package.json at " + path);
-            }
+            const version = getVersion();
             if (!asset.generator.startsWith("Needle glTF Build Pipeline")) {
                 asset.generator = "Needle glTF Build Pipeline";
                 if (version?.length > 0) {

package/dist/transforms/needle_mesh_transform.js

@@ -30,6 +30,7 @@ async function applyMeshCompression(document, _context) {
         }
     }
     // by default we still want to run draco if the root doesnt have a compression model configured
+    console.log(`[${NAME}]: No compression model configured → will apply draco mesh compression`);
     return draco()(document, _context);
 }
 async function simplifierTransform(document, _context, _options) {

package/dist/transforms/needle_progressive.js

@@ -17,7 +17,7 @@ function registerExtensions(io) {
         //@ts-ignore
         createOpaqueExtension(NEEDLE_compression_texture.EXTENSION_NAME, PropertyType.TEXTURE),
         //@ts-ignore
-        createOpaqueExtension(NEEDLE_mesh_compression.EXTENSION_NAME, [PropertyType.MESH, PropertyType.PRIMITIVE])
+        createOpaqueExtension(NEEDLE_mesh_compression.EXTENSION_NAME, [PropertyType.ROOT, PropertyType.MESH, PropertyType.PRIMITIVE])
     ]);
 }
 export async function make_progressive(opts) {

package/dist/utils/index.d.ts

@@ -1 +1,2 @@
 export * from "./fileutils.js";
+export * from "./version.js";

package/dist/utils/index.js

@@ -1 +1,2 @@
 export * from "./fileutils.js";
+export * from "./version.js";

package/dist/utils/version.d.ts

@@ -0,0 +1 @@
+export declare function getVersion(marklocal?: boolean): string;

package/dist/utils/version.js

@@ -0,0 +1,21 @@
+import { existsSync, readFileSync } from 'fs';
+let version = undefined;
+let isLocal = false;
+export function getVersion(marklocal = true) {
+    if (version === undefined) {
+        version = null;
+        const path = process.cwd() + "/package.json";
+        isLocal = !path.includes("node_modules");
+        if (existsSync(path)) {
+            const packageJson = readFileSync(path, "utf8");
+            const packageVersion = JSON.parse(packageJson).version;
+            version = packageVersion ?? null;
+        }
+        else
+            console.log("Could not find package.json at " + path);
+    }
+    let res = version;
+    if (marklocal && isLocal)
+        res += " (local)";
+    return res;
+}

package/make-progressive.mjs

@@ -1,7 +1,10 @@
+import { getVersion } from './dist/index.js';
 import { make_progressive } from './dist/transforms/needle_progressive.js';
 
 const args = process.argv;
 
+console.log(`[Needle Build Pipeline] transform to progressive — version ${getVersion()}`)
+
 make_progressive({
     path: args,
     debug: args.includes("debug"),

package/pack-gltf.mjs

@@ -14,6 +14,9 @@ import { needle_animation_transform } from "./dist/transforms/needle_animation_t
 import { foreachGLTF } from './fileutils.mjs';
 import { needle_asset } from './dist/transforms/needle_asset.js';
 import { MeshoptDecoder, MeshoptEncoder } from 'meshoptimizer';
+import { getVersion } from './dist/index.js';
+
+console.log(`[Needle Build Pipeline] pack glTF — version ${getVersion()}`)
 
 const args = process.argv;
 const showHelp = args.includes("help");
@@ -139,11 +142,13 @@ async function packFile(file) {
     }
 }
 
+
+
 let startTime = Date.now();
 foreachGLTF(process.argv, async (file) => {
     await packFile(file);
 }).then(() => {
     const duration = Date.now() - startTime;
     const durationInMinutes = duration / 1000 / 60;
-    console.log(`Finished packing ${totalFilesProcessed} files in ${durationInMinutes.toFixed(1)} minutes; total size ${totalFileSizeInMBBefore.toFixed(1)} MB → ${totalFileSizeInMB.toFixed(1)} MB, total GPU memory: ${totalGPUMemoryInMB.toFixed(1)} MB`);
+    console.log(`[Needle Build Pipeline] v${getVersion()} — Finished packing ${totalFilesProcessed} files in ${durationInMinutes.toFixed(1)} minutes; total size ${totalFileSizeInMBBefore.toFixed(1)} MB → ${totalFileSizeInMB.toFixed(1)} MB, total GPU memory: ${totalGPUMemoryInMB.toFixed(1)} MB`);
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@needle-tools/gltf-build-pipeline",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "description": "Pipeline and tools for optimizing gltf files using gltf-transform and compression settings within glTF extensions",
   "main": "index.mjs",
   "type": "module",
@@ -16,9 +16,9 @@
     "compile": "tsc || exit 1"
   },
   "dependencies": {
-    "@gltf-transform/core": "^3.1.4",
-    "@gltf-transform/extensions": "^3.1.4",
-    "@gltf-transform/functions": "^3.1.4",
+    "@gltf-transform/core": "^3.4.3",
+    "@gltf-transform/extensions": "^3.4.3",
+    "@gltf-transform/functions": "^3.4.3",
     "@squoosh/lib": "^0.4.0",
     "command-exists": "^1.2.9",
     "command-line-args": "^5.2.1",