@loaders.gl/tile-converter 4.1.0-alpha.1 → 4.1.0-alpha.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/tile-converter",
-  "version": "4.1.0-alpha.1",
+  "version": "4.1.0-alpha.11",
   "description": "Converter",
   "license": "MIT",
   "type": "module",
@@ -21,9 +21,9 @@
   "module": "dist/index.js",
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
-      "require": "./dist/index.cjs",
-      "types": "./dist/index.d.ts"
+      "require": "./dist/index.cjs"
     }
   },
   "sideEffects": false,
@@ -52,18 +52,18 @@
     "build-i3s-server-bundle": "esbuild src/i3s-server/bin/www.ts --outfile=dist/i3s-server/bin/i3s-server.min.cjs --platform=node --target=esnext,node14 --minify --bundle --define:__VERSION__=\\\"$npm_package_version\\\""
   },
   "dependencies": {
-    "@loaders.gl/3d-tiles": "4.1.0-alpha.1",
-    "@loaders.gl/crypto": "4.1.0-alpha.1",
-    "@loaders.gl/draco": "4.1.0-alpha.1",
-    "@loaders.gl/gltf": "4.1.0-alpha.1",
-    "@loaders.gl/i3s": "4.1.0-alpha.1",
-    "@loaders.gl/images": "4.1.0-alpha.1",
-    "@loaders.gl/loader-utils": "4.1.0-alpha.1",
-    "@loaders.gl/polyfills": "4.1.0-alpha.1",
-    "@loaders.gl/textures": "4.1.0-alpha.1",
-    "@loaders.gl/tiles": "4.1.0-alpha.1",
-    "@loaders.gl/worker-utils": "4.1.0-alpha.1",
-    "@loaders.gl/zip": "4.1.0-alpha.1",
+    "@loaders.gl/3d-tiles": "4.1.0-alpha.11",
+    "@loaders.gl/crypto": "4.1.0-alpha.11",
+    "@loaders.gl/draco": "4.1.0-alpha.11",
+    "@loaders.gl/gltf": "4.1.0-alpha.11",
+    "@loaders.gl/i3s": "4.1.0-alpha.11",
+    "@loaders.gl/images": "4.1.0-alpha.11",
+    "@loaders.gl/loader-utils": "4.1.0-alpha.11",
+    "@loaders.gl/polyfills": "4.1.0-alpha.11",
+    "@loaders.gl/textures": "4.1.0-alpha.11",
+    "@loaders.gl/tiles": "4.1.0-alpha.11",
+    "@loaders.gl/worker-utils": "4.1.0-alpha.11",
+    "@loaders.gl/zip": "4.1.0-alpha.11",
     "@math.gl/core": "^4.0.0",
     "@math.gl/culling": "^4.0.0",
     "@math.gl/geoid": "^4.0.0",
@@ -87,7 +87,7 @@
     "join-images": "^1.1.3",
     "sharp": "^0.31.3"
   },
-  "gitHead": "6a4d3da93d45115ad99861474a43c3f4a0b280a7",
+  "gitHead": "5d3e23bf93762b48c8c1d6d926ede7a97fe43ab0",
   "devDependencies": {
     "@types/express": "^4.17.17",
     "@types/node": "^20.4.2"

package/src/3d-tiles-converter/helpers/b3dm-converter.ts

@@ -9,6 +9,9 @@ import {generateSyntheticIndices} from '../../lib/utils/geometry-utils';
 
 const Z_UP_TO_Y_UP_MATRIX = new Matrix4([1, 0, 0, 0, 0, 0, -1, 0, 0, 1, 0, 0, 0, 0, 0, 1]);
 const scratchVector = new Vector3();
+const KHR_MATERIALS_UNLIT = 'KHR_materials_unlit';
+const METALLIC_FACTOR_DEFAULT = 1.0;
+const ROUGHNESS_FACTOR_DEFAULT = 1.0;
 
 export type I3SAttributesData = {
   tileContent: I3STileContent;
@@ -60,6 +63,22 @@ export default class B3dmConverter {
     const gltfBuilder = new GLTFScenegraph();
 
     const textureIndex = await this._addI3sTextureToGLTF(tileContent, textureFormat, gltfBuilder);
+
+    // Add KHR_MATERIALS_UNLIT extension in the following cases:
+    // - metallicFactor or roughnessFactor are set to default values
+    // - metallicFactor or roughnessFactor are not set
+    const pbrMetallicRoughness = material?.pbrMetallicRoughness;
+    if (
+      pbrMetallicRoughness &&
+      (pbrMetallicRoughness.metallicFactor === undefined ||
+        pbrMetallicRoughness.metallicFactor === METALLIC_FACTOR_DEFAULT) &&
+      (pbrMetallicRoughness.roughnessFactor === undefined ||
+        pbrMetallicRoughness.roughnessFactor === ROUGHNESS_FACTOR_DEFAULT)
+    ) {
+      gltfBuilder.addObjectExtension(material, KHR_MATERIALS_UNLIT, {});
+      gltfBuilder.addExtension(KHR_MATERIALS_UNLIT);
+    }
+
     const pbrMaterialInfo = this._convertI3sMaterialToGLTFMaterial(material, textureIndex);
     const materialIndex = gltfBuilder.addMaterial(pbrMaterialInfo);
 

package/src/constants.ts

@@ -1,2 +1,3 @@
 export const BROWSER_ERROR_MESSAGE =
   'Tile converter does not work in browser, only in node js environment';
+export const DUMP_FILE_SUFFIX = '.dump.json';

package/src/converter-cli.ts

@@ -11,6 +11,9 @@ import {
   getURLValue,
   validateOptionsWithEqual
 } from './lib/utils/cli-utils';
+import {addOneFile, composeHashFile, makeZipCDHeaderIterator} from '@loaders.gl/zip';
+import {FileHandleFile} from '@loaders.gl/loader-utils';
+import {copyFile} from 'node:fs/promises';
 
 type TileConversionOptions = {
   /** "I3S" - for I3S to 3DTiles conversion, "3DTILES" for 3DTiles to I3S conversion */
@@ -50,6 +53,8 @@ type TileConversionOptions = {
   maxDepth?: number;
   /** 3DTiles->I3S only. Whether the converter generates *.slpk (Scene Layer Package) I3S output file */
   slpk: boolean;
+  /** adds hash file to the slpk if there's no one */
+  addHash: boolean;
   /** Feature metadata class from EXT_FEATURE_METADATA or EXT_STRUCTURAL_METADATA extensions  */
   metadataClass?: string;
   /** With this options the tileset content will be analyzed without conversion */
@@ -92,6 +97,48 @@ async function main() {
     return;
   }
 
+  if (options.addHash) {
+    const validatedOptions = validateOptions(options, true);
+    let finalPath = validatedOptions.tileset;
+    if (validatedOptions.output === 'data') {
+      const nameWithoutExt = validatedOptions.tileset.substring(
+        0,
+        validatedOptions.tileset.length - 5
+      );
+
+      const result = await inquirer.prompt<{isNewFileRequired: boolean}>([
+        {
+          name: 'isNewFileRequired',
+          type: 'list',
+          message: 'What would you like to do?',
+          choices: [
+            {
+              name: 'Add hash file to the current SLPK file',
+              value: false
+            },
+            {
+              name: `Create a new file ${nameWithoutExt}-hash.slpk with hash file inside`,
+              value: true
+            }
+          ]
+        }
+      ]);
+
+      if (result.isNewFileRequired) {
+        finalPath = `${nameWithoutExt}-hash.slpk`;
+      }
+    } else {
+      finalPath = validatedOptions.output;
+    }
+    if (finalPath !== validatedOptions.tileset) {
+      await copyFile(validatedOptions.tileset, finalPath);
+    }
+    const hashTable = await composeHashFile(makeZipCDHeaderIterator(new FileHandleFile(finalPath)));
+    await addOneFile(finalPath, hashTable, '@specialIndexFileHASH128@');
+
+    return;
+  }
+
   const validatedOptions: ValidatedTileConversionOptions = validateOptions(options);
 
   await convert(validatedOptions);
@@ -199,7 +246,10 @@ async function convert(options: ValidatedTileConversionOptions) {
  * @param options - input options of the CLI command
  * @returns validated options
  */
-function validateOptions(options: TileConversionOptions): ValidatedTileConversionOptions {
+function validateOptions(
+  options: TileConversionOptions,
+  addHash?: boolean
+): ValidatedTileConversionOptions {
   const mandatoryOptionsWithExceptions: {
     [key: string]: {
       getMessage: () => void;
@@ -208,7 +258,7 @@ function validateOptions(options: TileConversionOptions): ValidatedTileConversio
   } = {
     name: {
       getMessage: () => console.log('Missed: --name [Tileset name]'),
-      condition: (value: any) => Boolean(value) || Boolean(options.analyze)
+      condition: (value: any) => addHash || Boolean(value) || Boolean(options.analyze)
     },
     output: {getMessage: () => console.log('Missed: --output [Output path name]')},
     sevenZipExe: {getMessage: () => console.log('Missed: --7zExe [7z archiver executable path]')},
@@ -218,7 +268,7 @@ function validateOptions(options: TileConversionOptions): ValidatedTileConversio
       getMessage: () =>
         console.log('Missed/Incorrect: --input-type [tileset input type: I3S or 3DTILES]'),
       condition: (value) =>
-        Boolean(value) && Object.values(TILESET_TYPE).includes(value.toUpperCase())
+        addHash || (Boolean(value) && Object.values(TILESET_TYPE).includes(value.toUpperCase()))
     }
   };
   const exceptions: (() => void)[] = [];
@@ -256,7 +306,8 @@ function parseOptions(args: string[]): TileConversionOptions {
     generateTextures: false,
     generateBoundingVolumes: false,
     validate: false,
-    slpk: false
+    slpk: false,
+    addHash: false
   };
 
   // eslint-disable-next-line complexity
@@ -287,6 +338,9 @@ function parseOptions(args: string[]): TileConversionOptions {
         case '--slpk':
           opts.slpk = getBooleanValue(index, args);
           break;
+        case '--add-hash':
+          opts.addHash = getBooleanValue(index, args);
+          break;
         case '--7zExe':
           opts.sevenZipExe = getStringValue(index, args);
           break;

package/src/deps-installer/deps-installer.ts

@@ -1,7 +1,7 @@
 import {load, fetchFile} from '@loaders.gl/core';
 import {ZipLoader} from '@loaders.gl/zip';
 import {writeFile} from '../lib/utils/file-utils';
-import {join} from 'path';
+import {join, dirname} from 'path';
 import {ChildProcessProxy} from '@loaders.gl/worker-utils';
 import {DRACO_EXTERNAL_LIBRARIES, DRACO_EXTERNAL_LIBRARY_URLS} from '@loaders.gl/draco';
 import {BASIS_EXTERNAL_LIBRARIES} from '@loaders.gl/textures';
@@ -80,8 +80,9 @@ export class DepsInstaller {
 
     console.log('Installing "join-images" npm package');
     const childProcess = new ChildProcessProxy();
+    const nodeDir = dirname(process.execPath);
     await childProcess.start({
-      command: process.platform === 'win32' ? 'npm.cmd' : 'npm',
+      command: `${nodeDir}/${process.platform === 'win32' ? 'npm.cmd' : 'npm'}`,
       // `npm install sharp join-images` works unstable. It fails because installed `sharp` version
       // may be different from the version required by `join-images`. Pointing to specific versions
       // resolve this issue