@needle-tools/gltf-build-pipeline 1.4.1-beta.13 → 1.4.1-beta.15

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.4.1-beta.15] - 2023-04-02
+- fix: issue where discarding all LODs might result in broken mesh due to simplify having modified the original mesh
+- fix: don't produce LODs if GLB/glTF was produced with old generator
+
 ## [1.4.1-beta.13] - 2023-03-26
 - change: passthrough `NEEDLE_editor` & `NEEDLE_gltf_dependencies` extensions
 

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

@@ -20,5 +20,6 @@ export interface IExtensionWriter {
     assignTo?(obj: object): any;
     write(context: WriterContext, prop: IExtensibleProperty): void;
 }
+export declare let currentGenerator: string;
 export declare function createOpaqueExtension(name: string, types: PropertyType | PropertyType[], opts?: Options): IOpaqueExtension;
 export {};

package/dist/extensions/NEEDLE_opaque/NEEDLE_opaque.js

@@ -4,6 +4,7 @@ const ALL_PROPERTY_TYPES = [];
 for (const key in PropertyType) {
     ALL_PROPERTY_TYPES.push(PropertyType[key]);
 }
+export let currentGenerator = "";
 // an opaque extension can be used to pass data through the gltf transform process
 // it should also be able to re-write/fix json pointers after the transformation which might have shuffled them around 
 export function createOpaqueExtension(name, types, opts) {
@@ -18,6 +19,7 @@ export function createOpaqueExtension(name, types, opts) {
         // private roots: Array<OpaqueProperty> = [];
         jsonPointerHandler;
         read(context) {
+            currentGenerator = context.jsonDoc.json.asset?.generator;
             if (debugLog)
                 console.log("READ " + EXTENSION_NAME);
             this.jsonPointerHandler = new JsonPointerHandler(this.document, EXTENSION_NAME);

package/dist/transforms/needle_progressive.js

@@ -1,7 +1,7 @@
 import { BufferUtils, Document, NodeIO, PropertyType } from '@gltf-transform/core';
 import { SIMPLIFY_DEFAULTS, WELD_DEFAULTS, listTextureSlots, sparse } from '@gltf-transform/functions';
 import { NEEDLE_PROGRESSIVE_EXTENSION_NAME, NEEDLE_progressive } from "../extensions/NEEDLE_progressive/index.js";
-import { createOpaqueExtension, NEEDLE_compression_texture, NEEDLE_mesh_compression, NEEDLE_progressive_mesh_settings, NEEDLE_progressive_texture_settings, registerExtensions as registerDefaultExtensions } from '../extensions/index.js';
+import { createOpaqueExtension, currentGenerator, NEEDLE_compression_texture, NEEDLE_mesh_compression, NEEDLE_progressive_mesh_settings, NEEDLE_progressive_texture_settings, registerExtensions as registerDefaultExtensions } from '../extensions/index.js';
 import path from 'path';
 import { existsSync, readFileSync, rmSync, statSync, writeFileSync } from 'fs';
 import { addMetaToCache, addToCache, getHash, getKey, tryGetFromCache, tryGetMetaFromCache } from '../cache/index.js';
@@ -299,6 +299,12 @@ export function make_progressive_meshes(filePath, _options, opts) {
     // const fileNameWithoutExtension = path.basename(filePath, path.extname(filePath));
     const outputDirectory = directory + "/";
     return createTransform("PROGRESSIVE_MESHES", async (doc, _context) => {
+        // this is to ensure we're not creating progressive meshes for engine versions that don't support loading them yet
+        // the generator should include the version or the app that produced the GLB too (needle engine repo: 2c00d0e304e205cf9d4ac0499faabb92a706a5c4)
+        if (currentGenerator == "Needle Engine") {
+            console.log("WARN: Skip creating mesh LODs - Unsupported generator found... Please update your editor integration");
+            return;
+        }
         if (isMeshLOD(filePath)) {
             console.log("Progressive Mesh Transform: skip lod at " + filePath);
             return Promise.resolve();
@@ -331,8 +337,13 @@ export function make_progressive_meshes(filePath, _options, opts) {
         }
         /** Map of visited GUID -> extension */
         const visited = new Map();
-        const meshes = doc.getRoot().listMeshes();
+        const root = doc.getRoot();
+        const meshes = root.listMeshes();
         for (const mesh of meshes) {
+            await processMesh(mesh);
+        }
+        console.log(`[${NAME}]: Finished generating progressive meshes for \"${filename}\"`);
+        async function processMesh(mesh) {
             /** The size and vertex count of the original mesh */
             const originalMeshInformation = getMeshInformation(mesh);
             const { totalVertexCount: originalTotalVertexCount, maxVertexCount: originalMaxVertexCount } = originalMeshInformation;
@@ -340,7 +351,7 @@ export function make_progressive_meshes(filePath, _options, opts) {
             if (!settings) {
                 if (originalMaxVertexCount < 32) {
                     logger.debug(`[${NAME}] Skipping, no settings found and no primitive with more than 32 vertices. mesh[${index}] has ${originalTotalVertexCount} vertices (max: ${originalMaxVertexCount})`);
-                    continue;
+                    return;
                 }
                 else {
                     settings = {
@@ -352,12 +363,12 @@ export function make_progressive_meshes(filePath, _options, opts) {
             }
             else if (settings.generateLods === false) {
                 logger.debug(`[${NAME}] progressive mesh disabled for mesh at index ${index++}`);
-                continue;
+                return;
             }
             const progressiveExt = doc.createExtension(NEEDLE_progressive);
             if (!progressiveExt || !progressiveExt.createMesh) {
                 logger.debug(`[${NAME}] Skipping because progressive extension is not available. ${index++}`);
-                continue;
+                return;
             }
             // check if we have already produced LODs for this mesh
             let needsToGenerateLODs = true;
@@ -449,7 +460,11 @@ export function make_progressive_meshes(filePath, _options, opts) {
             let maxDensity = 0;
             let primitiveIndex = 0;
             const lodLevelInFile = generatedLODInfos.length;
+            const clonedData = new Array();
             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`);
                 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);
@@ -476,7 +491,14 @@ export function make_progressive_meshes(filePath, _options, opts) {
                 catch (err) {
                     logger.error(`ERR: [${NAME}] Failed to remove LOD files for \"${mesh.getName()}\"`);
                 }
-                continue;
+                // reset data (simplify might have changed the mesh data that we cloned before)
+                const primitives = mesh.listPrimitives();
+                if (clonedData.length == primitives.length) {
+                    for (let i = 0; i < primitives.length; i++) {
+                        setPrimitiveData(primitives[i], clonedData[i]);
+                    }
+                }
+                return;
             }
             if (generatedLODInfos.length > 0) {
                 const model = progressiveExt.createMesh({
@@ -501,9 +523,31 @@ export function make_progressive_meshes(filePath, _options, opts) {
                 }
             }
         }
-        console.log(`[${NAME}]: Finished generating progressive meshes for \"${filename}\"`);
     });
 }
+function clonePrimitiveData(prim) {
+    const indices = new Uint32Array(prim.getIndices().getArray());
+    const attributes = {};
+    for (const attr of prim.listSemantics()) {
+        const accessor = prim.getAttribute(attr);
+        if (accessor) {
+            attributes[attr] = new Float32Array(accessor.getArray());
+        }
+    }
+    return { indices, attributes };
+}
+function setPrimitiveData(prim, data) {
+    const indices = prim.getIndices();
+    if (indices) {
+        indices.setArray(data.indices);
+    }
+    for (const attr of prim.listSemantics()) {
+        const accessor = prim.getAttribute(attr);
+        if (accessor) {
+            accessor.setArray(data.attributes[attr]);
+        }
+    }
+}
 /**
  * @param basePath the base path to save the lod files
  * @param level: 0 = original, 1 = first lod, 2 = second lod, ...

package/package.json

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