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

package/CHANGELOG.md

@@ -4,6 +4,10 @@ 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.2] - 2023-05-03
+- fix: VRM format should be saved as GLB. See https://github.com/donmccurdy/glTF-Transform/issues/1390
+- fix: VRM texture index handling
+
 ## [1.5.0-alpha] - 2023-05-01
 - add: NEEDLE_opaque `node: <index>` retargeting
 - add: passthrough VRM extension

package/dist/extensions/NEEDLE_opaque/NEEDLE_opaque.js

@@ -556,7 +556,7 @@ class JsonPointerHandler {
                                 console.log("Texture index", index, imageIndex, context.jsonDoc.json.textures.length, "Textures:" + context.textures.length);
                             const object = tryGetInArray(context.textures, imageIndex);
                             if (object) {
-                                const res = new TexturePointerResolver(this.document, object, definition);
+                                const res = new TextureIndexResolver(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, value);
                                 pointer.debug = this.debug;
@@ -589,7 +589,7 @@ class JsonPointerHandler {
                             let pointer = this.map.get(value);
                             if (!pointer) {
                                 const definition = context.jsonDoc.json.materials[index];
-                                const res = new MaterialPointerResolver(this.document, mat, definition);
+                                const res = new MaterialIndexResolver(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, value);
                                 pointer.debug = this.debug;
@@ -601,12 +601,27 @@ class JsonPointerHandler {
                 }
                 break;
             case 'number':
-                if (key === "node") {
+                if (key === "node" || key === "mesh") {
                     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;
+                        const dictKey = `/${key}/${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);
+                    }
+                }
+                else if (fullPath.match(/materialProperties\/\d+?\/textureProperties/g)) {
+                    const object = context.textures[value];
+                    if (object) {
+                        const res = new TextureIndexResolver(this.document, object, context.jsonDoc.json.textures[value]);
+                        res.init(context);
+                        const dictKey = `/textures/${value}`;
                         let pointer = this.map.get(dictKey);
                         if (!pointer) {
                             pointer = new JsonPointer(null, res, value);
@@ -684,7 +699,7 @@ class PointerResolver {
     }
     debug = false;
 }
-class TexturePointerResolver extends PointerResolver {
+class TextureIndexResolver extends PointerResolver {
     _debugName;
     _samplerDef;
     init(context) {
@@ -774,7 +789,7 @@ function findSource(texDef) {
     }
     return undefined;
 }
-class MaterialPointerResolver extends PointerResolver {
+class MaterialIndexResolver extends PointerResolver {
     init(context) {
     }
     resolve(context) {

package/dist/transforms/needle_progressive.js

@@ -7,7 +7,7 @@ import path, { basename } from 'path';
 import { existsSync, readFileSync, rmSync, statSync, writeFileSync } from 'fs';
 import { addMetaToCache, addToCache, getHash, getKeyWithHash, tryGetFromCache, tryGetMetaFromCache } from '../cache/index.js';
 import sharp from "sharp";
-import { foreachGLTF, generateGuid } from '../utils/index.js';
+import { foreachGLTF, generateGuid, writeNodeIO } from '../utils/index.js';
 import { needle_asset, writeNeedleAsset } from './needle_asset.js';
 import { MeshoptDecoder, MeshoptSimplifier } from 'meshoptimizer';
 import { compressPrimitive } from './needle_mesh_transform.js';
@@ -81,7 +81,7 @@ async function onProcess(file, opts) {
                 // add new extension
                 filename = filename + ".debug." + extension;
             }
-            io.write(filename, document);
+            await writeNodeIO(io, filename, document);
         }
     }
     catch (err) {

package/dist/utils/index.d.ts

@@ -2,3 +2,4 @@ export * from "./fileutils.js";
 export * from "./version.js";
 export * from "./mesh.js";
 export * from "./guid.js";
+export * from "./nodeio.js";

package/dist/utils/index.js

@@ -2,3 +2,4 @@ export * from "./fileutils.js";
 export * from "./version.js";
 export * from "./mesh.js";
 export * from "./guid.js";
+export * from "./nodeio.js";

package/dist/utils/nodeio.d.ts

@@ -0,0 +1,5 @@
+import { NodeIO, Document } from "@gltf-transform/core";
+/**
+ * Handle writing glTf, GLB and VRM files
+ */
+export declare function writeNodeIO(nodeio: NodeIO, filename: string, document: Document): Promise<string>;

package/dist/utils/nodeio.js

@@ -0,0 +1,17 @@
+import { renameSync } from "fs";
+/**
+ * Handle writing glTf, GLB and VRM files
+ */
+export async function writeNodeIO(nodeio, filename, document) {
+    let filename_write = filename;
+    // see https://github.com/donmccurdy/glTF-Transform/issues/1390
+    if (filename.endsWith(".vrm")) {
+        filename_write = filename_write.replace(".vrm", ".glb");
+    }
+    await nodeio.write(filename_write, document);
+    if (filename.endsWith(".vrm")) {
+        // rename the file to .vrm
+        renameSync(filename_write, filename);
+    }
+    return filename;
+}

package/pack-gltf.mjs

@@ -13,6 +13,7 @@ import { foreachGLTF } from './fileutils.mjs';
 import { needle_asset } from './dist/transforms/needle_asset.js';
 import { MeshoptDecoder, MeshoptEncoder } from 'meshoptimizer';
 import { getVersion, getHash, addToCache, tryGetFromCache, isLOD, ensureCacheSize as ensureMaxCacheSize, isMeshLOD } from './dist/index.js';
+import { writeNodeIO } from './dist/utils/nodeio.js';
 
 console.log(`[Needle Build Pipeline] pack glTF — version ${getVersion()}`)
 
@@ -139,7 +140,8 @@ async function packFile(file) {
             // draco(),
         );
         if (debug) file += ".debug.glb";
-        await io.write(file, document);
+
+        await writeNodeIO(io, file, document);
 
         if (allowCaching && cacheKey != undefined && existsSync(file))
             addToCache(cacheKey, readFileSync(file));

package/package.json

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