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

package/CHANGELOG.md

@@ -4,8 +4,9 @@ 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.14] - 2023-04-02
+## [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();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@needle-tools/gltf-build-pipeline",
-  "version": "1.4.1-beta.14",
+  "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",