@needle-tools/gltf-build-pipeline 1.4.10 → 1.5.0-alpha

package/CHANGELOG.md

@@ -4,6 +4,14 @@ 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.5.0-alpha] - 2023-05-01
+- add: NEEDLE_opaque `node: <index>` retargeting
+- add: passthrough VRM extension
+
+## [1.4.11] - 2023-04-29
+- add: NEEDLE_progressive mesh now run sparse transform
+- change: cli params for debug and caching are now `--debug` and `--no-caching`
+
 ## [1.4.10] - 2023-04-23
 - add: NEEDLE_progressive can now load and process already draco compressed meshes
 

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

@@ -3,6 +3,7 @@ declare interface IExtensibleProperty {
 }
 export type Options = {
     debug?: boolean;
+    breakpoint?: boolean;
     write?: boolean;
 };
 export interface IOpaqueExtension {

package/dist/extensions/NEEDLE_opaque/NEEDLE_opaque.js

@@ -19,6 +19,8 @@ export function createOpaqueExtension(name, types, opts) {
         // private roots: Array<OpaqueProperty> = [];
         jsonPointerHandler;
         read(context) {
+            if (opts.breakpoint === true)
+                debugger;
             currentGenerator = context.jsonDoc.json.asset?.generator;
             if (debugLog)
                 console.log("READ " + EXTENSION_NAME);
@@ -222,6 +224,8 @@ export function createOpaqueExtension(name, types, opts) {
             }
         }
         write(context) {
+            if (opts.breakpoint === true)
+                debugger;
             if (opts?.write === false) {
                 return this;
             }
@@ -276,6 +280,8 @@ export function createOpaqueExtension(name, types, opts) {
                         if (prop instanceof OpaqueProperty) {
                             prop.onWrite(context, root);
                         }
+                        else if (debugLog)
+                            console.warn("WARN: no extension found on root", EXTENSION_NAME);
                         break;
                 }
             }
@@ -552,7 +558,7 @@ class JsonPointerHandler {
                             if (object) {
                                 const res = new TexturePointerResolver(this.document, object, definition);
                                 res.init(context); // < init here otherwise the fields defined in the TexturePointer will be undefined (this caused e.g. finding the previous texture filter to fail)
-                                pointer = new JsonPointer(path, res);
+                                pointer = new JsonPointer(path, res, value);
                                 pointer.debug = this.debug;
                                 this.map.set(value, pointer);
                             }
@@ -585,7 +591,7 @@ class JsonPointerHandler {
                                 const definition = context.jsonDoc.json.materials[index];
                                 const res = new MaterialPointerResolver(this.document, mat, definition);
                                 res.init(context); // < init here otherwise the fields defined in the TexturePointer will be undefined (this caused e.g. finding the previous texture filter to fail)
-                                pointer = new JsonPointer("/materials/", res);
+                                pointer = new JsonPointer("/materials/", res, value);
                                 pointer.debug = this.debug;
                                 this.map.set(value, pointer);
                             }
@@ -594,6 +600,23 @@ class JsonPointerHandler {
                     }
                 }
                 break;
+            case 'number':
+                if (key === "node") {
+                    const object = context.nodes[value];
+                    if (object) {
+                        const res = new NodeIndexResolver(this.document, object, context.jsonDoc.json.nodes[value]);
+                        res.init(context);
+                        const dictKey = "/nodes/" + value;
+                        let pointer = this.map.get(dictKey);
+                        if (!pointer) {
+                            pointer = new JsonPointer(null, res, value);
+                        }
+                        pointer.debug = this.debug;
+                        pointer.register(obj, key);
+                        this.map.set(dictKey, pointer);
+                    }
+                }
+                break;
         }
     }
     resolveAndWrite(context) {
@@ -607,9 +630,11 @@ class JsonPointer {
     debug = false;
     resolver;
     pointerBase;
-    constructor(pointerBase, resolver) {
+    oldPointer;
+    constructor(pointerBase, resolver, oldPointer) {
         this.pointerBase = pointerBase;
         this.resolver = resolver;
+        this.oldPointer = oldPointer;
     }
     _objects = [];
     _props = [];
@@ -622,9 +647,19 @@ class JsonPointer {
         //@ts-ignore
         this.resolver.debug = this.debug;
         const index = this.resolver.resolve(context);
-        this.newPointer = this.pointerBase + index;
-        if (this.debug)
-            console.log("RESOLVED", this.pointerBase, index, " to → ", this.newPointer);
+        if (index != undefined) {
+            if (this.pointerBase != null) {
+                this.newPointer = this.pointerBase + index;
+            }
+            else {
+                this.newPointer = index;
+            }
+            if (this.debug)
+                console.log(`RESOLVED ${this.oldPointer} to → ${this.newPointer}`);
+        }
+        else {
+            console.log("ERR: failed to resolve pointer", this.pointerBase);
+        }
     }
     write() {
         for (let i = 0; i < this._objects.length; i++) {
@@ -746,3 +781,10 @@ class MaterialPointerResolver extends PointerResolver {
         return context.materialIndexMap.get(this.inputObject);
     }
 }
+class NodeIndexResolver extends PointerResolver {
+    init(context) {
+    }
+    resolve(context) {
+        return context.nodeIndexMap.get(this.inputObject);
+    }
+}

package/dist/extensions/NEEDLE_opaque/index.js

@@ -17,4 +17,5 @@ export const ALL_EXTENSIONS = [
     createOpaqueExtension("EXT_texture_exr", [PropertyType.TEXTURE], { ...opaqueOptions }),
     createOpaqueExtension("NEEDLE_editor", [PropertyType.NODE, PropertyType.MATERIAL], { ...opaqueOptions }),
     createOpaqueExtension("NEEDLE_gltf_dependencies", [PropertyType.ROOT], { ...opaqueOptions }),
+    createOpaqueExtension("VRM", [PropertyType.ROOT], { ...opaqueOptions }),
 ];

package/dist/transforms/needle_progressive.js

@@ -21,7 +21,7 @@ export async function make_progressive(opts) {
             console.log(`Progressive Transform: Ignore existing LOD file at ${f}`);
             return;
         }
-        await process(f, opts);
+        await onProcess(f, opts);
     });
 }
 function registerExtensions(io) {
@@ -37,7 +37,7 @@ function registerExtensions(io) {
         // createOpaqueExtension(NEEDLE_mesh_compression.EXTENSION_NAME, [PropertyType.ROOT, PropertyType.MESH, PropertyType.PRIMITIVE]),
     ]);
 }
-async function process(file, opts) {
+async function onProcess(file, opts) {
     if (!file.endsWith(".glb") && !file.endsWith(".gltf")) {
         console.log("ERR: file is not gltf/glb");
         return;
@@ -722,6 +722,7 @@ async function createMeshLod(doc, basePath, level, mesh, meshInfo, guid, lodLeve
         console.log(`[${NAME}] Pass compression format to mesh LOD ${level} → ${JSON.stringify(compressionExt.model)}`);
         newDoc.getRoot().setExtension(NEEDLE_mesh_compression.EXTENSION_NAME, newProp);
     }
+    await newDoc.transform(sparse());
     const newIo = new NodeIO();
     registerExtensions(newIo);
     console.log(`[${NAME}] Write mesh LOD ${level} with to \"${fileName}\"`);

package/dist/utils/fileutils.js

@@ -48,6 +48,10 @@ export async function foreachGLTF(args, callback) {
     }
 }
 async function testEntry(entry, callback, context) {
+    // ignore argument names (e.g. --debug)
+    if (entry.startsWith("--")) {
+        return false;
+    }
     if (entry === "." || entry === "./") {
         if (context.baseDirectory) {
             entry = context.baseDirectory;
@@ -62,7 +66,7 @@ async function testEntry(entry, callback, context) {
         // Try resolve potential relative path
         const newPath = context.baseDirectory + "/" + entry;
         if (existsSync(newPath) === false) {
-            console.log(`INFO: Resolved path failed: ${entry} -> ${newPath} (doesnt exist or is locked by another process)`);
+            console.log(`INFO: Resolved path failed: \"${entry}\" -> ${newPath} (doesnt exist or is locked by another process)`);
             return;
         }
         else {

package/make-progressive.mjs

@@ -7,8 +7,8 @@ console.log(`[Needle Build Pipeline] transform to progressive — version ${getV
 
 make_progressive({
     path: args,
-    debug: args.includes("debug"),
-    useCache: args.includes("no-caching") === false,
+    debug: args.includes("--debug"),
+    useCache: args.includes("--no-caching") === false,
 });
 
 

package/pack-gltf.mjs

@@ -58,12 +58,12 @@ if (debug) {
 }
 
 let allowCaching = true;
-if (args.includes("no-caching")) {
+if (args.includes("--no-caching")) {
     console.log("Caching is disabled")
     allowCaching = false;
 }
 else if (showHelp)
-    console.log("Caching is enabled, use \"no-caching\" to disable it");
+    console.log("Caching is enabled, use \"--no-caching\" to disable it");
 
 const noToktx = args.includes("no-toktx");
 if (noToktx)

package/package.json

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