@loaders.gl/tile-converter 4.0.0-alpha.18 → 4.0.0-alpha.20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/tile-converter",
-  "version": "4.0.0-alpha.18",
+  "version": "4.0.0-alpha.20",
   "description": "Converter",
   "license": "MIT",
   "publishConfig": {
@@ -45,18 +45,18 @@
     "build-i3s-server-bundle": "esbuild src/i3s-server/bin/www.ts --outfile=dist/esm/i3s-server/bin/i3s-server.min.js --platform=node --target=esnext,node14 --external:join-images --minify --bundle --define:__VERSION__=\\\"$npm_package_version\\\""
   },
   "dependencies": {
-    "@loaders.gl/3d-tiles": "4.0.0-alpha.18",
-    "@loaders.gl/crypto": "4.0.0-alpha.18",
-    "@loaders.gl/draco": "4.0.0-alpha.18",
-    "@loaders.gl/gltf": "4.0.0-alpha.18",
-    "@loaders.gl/i3s": "4.0.0-alpha.18",
-    "@loaders.gl/images": "4.0.0-alpha.18",
-    "@loaders.gl/loader-utils": "4.0.0-alpha.18",
-    "@loaders.gl/polyfills": "4.0.0-alpha.18",
-    "@loaders.gl/textures": "4.0.0-alpha.18",
-    "@loaders.gl/tiles": "4.0.0-alpha.18",
-    "@loaders.gl/worker-utils": "4.0.0-alpha.18",
-    "@loaders.gl/zip": "4.0.0-alpha.18",
+    "@loaders.gl/3d-tiles": "4.0.0-alpha.20",
+    "@loaders.gl/crypto": "4.0.0-alpha.20",
+    "@loaders.gl/draco": "4.0.0-alpha.20",
+    "@loaders.gl/gltf": "4.0.0-alpha.20",
+    "@loaders.gl/i3s": "4.0.0-alpha.20",
+    "@loaders.gl/images": "4.0.0-alpha.20",
+    "@loaders.gl/loader-utils": "4.0.0-alpha.20",
+    "@loaders.gl/polyfills": "4.0.0-alpha.20",
+    "@loaders.gl/textures": "4.0.0-alpha.20",
+    "@loaders.gl/tiles": "4.0.0-alpha.20",
+    "@loaders.gl/worker-utils": "4.0.0-alpha.20",
+    "@loaders.gl/zip": "4.0.0-alpha.20",
     "@math.gl/core": "^3.5.1",
     "@math.gl/culling": "^3.5.1",
     "@math.gl/geoid": "^3.5.1",
@@ -66,6 +66,7 @@
     "crypt": "^0.0.2",
     "debug": "~4.3.4",
     "express": "~4.18.2",
+    "inquirer": "^8.0.0",
     "json-map-transform": "^1.2.6",
     "jszip": "^3.5.0",
     "md5": "^2.3.0",
@@ -79,7 +80,7 @@
     "join-images": "^1.1.3",
     "sharp": "^0.31.3"
   },
-  "gitHead": "7bc633f46560f661bdd46cf1015ea27b3694ebce",
+  "gitHead": "ac122e83102657c38207d59c631a5ce4e7aa46bd",
   "devDependencies": {
     "@types/express": "^4.17.17",
     "@types/node": "^20.4.2"

package/src/constants.ts

@@ -1,2 +1,5 @@
 export const BROWSER_ERROR_MESSAGE =
   'Tile converter does not work in browser, only in node js environment';
+
+export const EXT_MESH_FEATURES = 'EXT_mesh_features';
+export const EXT_FEATURE_METADATA = 'EXT_feature_metadata';

package/src/converter-cli.ts

@@ -1,6 +1,7 @@
 /* eslint-disable no-console */
 import '@loaders.gl/polyfills';
 import {join} from 'path';
+import inquirer from 'inquirer';
 import {I3SConverter, Tiles3DConverter} from '@loaders.gl/tile-converter';
 import {DepsInstaller} from './deps-installer/deps-installer';
 import {
@@ -49,6 +50,8 @@ type TileConversionOptions = {
   maxDepth?: number;
   /** 3DTiles->I3S only. Whether the converter generates *.slpk (Scene Layer Package) I3S output file */
   slpk: boolean;
+  /** Feature metadata class from EXT_FEATURE_METADATA or EXT_STRUCTURAL_METADATA extensions  */
+  metadataClass?: string;
 };
 
 /* During validation we check that particular options are defined so they can't be undefined */
@@ -132,8 +135,9 @@ function printHelp(): void {
   console.log(
     '--generate-textures [Enable KTX2 textures generation if only one of (JPG, PNG) texture is provided or generate JPG texture if only KTX2 is provided]'
   );
+  console.log('--generate-bounding-volumes [Generate obb and mbs bounding volumes from geometry]');
   console.log(
-    '--generate-bounding-volumes [Will generate obb and mbs bounding volumes from geometry]'
+    '--metadata-class [One of the list of feature metadata classes, detected by converter on "analyze" stage, default: not set]'
   );
   console.log('--validate [Enable validation]');
   process.exit(0); // eslint-disable-line
@@ -175,7 +179,8 @@ async function convert(options: ValidatedTileConversionOptions) {
         generateTextures: options.generateTextures,
         generateBoundingVolumes: options.generateBoundingVolumes,
         validate: options.validate,
-        instantNodeWriting: options.instantNodeWriting
+        instantNodeWriting: options.instantNodeWriting,
+        inquirer
       });
       break;
     default:
@@ -292,6 +297,8 @@ function parseOptions(args: string[]): TileConversionOptions {
         case '--generate-bounding-volumes':
           opts.generateBoundingVolumes = getBooleanValue(index, args);
           break;
+        case '--metadata-class':
+          opts.metadataClass = getStringValue(index, args);
         case '--help':
           printHelp();
           break;

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

@@ -3,6 +3,8 @@ import {ZipLoader} from '@loaders.gl/zip';
 import {writeFile} from '../lib/utils/file-utils';
 import {join} 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';
 
 // @ts-ignore TS2304: Cannot find name '__VERSION__'.
 const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'beta';
@@ -23,7 +25,7 @@ export class DepsInstaller {
    *    This path is '' by default and is not used by tile-converter.
    *    It is used in tests to prevent rewriting actual workers during tests running
    */
-  async install(path: string = '', workersPath: string = ''): Promise<void> {
+  async install(path: string = ''): Promise<void> {
     console.log('Installing "EGM2008-5" model...'); // eslint-disable-line no-console
     const fileMap = await load(PGM_LINK, ZipLoader, {});
 
@@ -34,14 +36,47 @@ export class DepsInstaller {
 
     await writeFile(depsPath, new Uint8Array(fileMap['geoids/egm2008-5.pgm']), 'egm2008-5.pgm');
 
-    console.log('Installing "I3S Content Loader worker"'); // eslint-disable-line no-console
-    await this.installWorker('i3s', 'i3s-content-worker-node.js', workersPath);
+    console.log('Installing "I3S Content Loader" worker'); // eslint-disable-line no-console
+    await this.installFromNpm('i3s', 'i3s-content-worker-node.js');
 
-    console.log('Installing "Draco Loader worker"'); // eslint-disable-line no-console
-    await this.installWorker('draco', 'draco-worker-node.js', workersPath);
+    console.log('Installing "Draco Loader" worker'); // eslint-disable-line no-console
+    await this.installFromNpm('draco', 'draco-worker-node.js');
 
-    console.log('Installing "Basis Loader worker"'); // eslint-disable-line no-console
-    await this.installWorker('textures', 'basis-worker-node.js', workersPath);
+    console.log('Installing "Draco Writer" worker'); // eslint-disable-line no-console
+    await this.installFromNpm('draco', 'draco-writer-worker-node.js');
+
+    console.log('Installing "Basis Loader" worker'); // eslint-disable-line no-console
+    await this.installFromNpm('textures', 'basis-worker-node.js');
+
+    console.log('Installing "KTX2 Basis Writer" worker'); // eslint-disable-line no-console
+    await this.installFromNpm('textures', 'ktx2-basis-writer-worker-node.js');
+
+    console.log('Installing "Draco decoder" library'); // eslint-disable-line no-console
+    await this.installFromUrl(
+      DRACO_EXTERNAL_LIBRARY_URLS[DRACO_EXTERNAL_LIBRARIES.DECODER],
+      'draco',
+      DRACO_EXTERNAL_LIBRARIES.DECODER
+    );
+    await this.installFromUrl(
+      DRACO_EXTERNAL_LIBRARY_URLS[DRACO_EXTERNAL_LIBRARIES.DECODER_WASM],
+      'draco',
+      DRACO_EXTERNAL_LIBRARIES.DECODER_WASM
+    );
+
+    console.log('Installing "Draco encoder" library'); // eslint-disable-line no-console
+    await this.installFromUrl(
+      DRACO_EXTERNAL_LIBRARY_URLS[DRACO_EXTERNAL_LIBRARIES.ENCODER],
+      'draco',
+      DRACO_EXTERNAL_LIBRARIES.ENCODER
+    );
+
+    console.log('Installing "Basis transcoder" library'); // eslint-disable-line no-console
+    await this.installFromNpm('textures', BASIS_EXTERNAL_LIBRARIES.TRANSCODER, 'libs');
+    await this.installFromNpm('textures', BASIS_EXTERNAL_LIBRARIES.TRANSCODER_WASM, 'libs');
+
+    console.log('Installing "Basis encoder" library'); // eslint-disable-line no-console
+    await this.installFromNpm('textures', BASIS_EXTERNAL_LIBRARIES.ENCODER, 'libs');
+    await this.installFromNpm('textures', BASIS_EXTERNAL_LIBRARIES.ENCODER_WASM, 'libs');
 
     console.log('Installing "join-images" npm package');
     const childProcess = new ChildProcessProxy();
@@ -58,15 +93,25 @@ export class DepsInstaller {
     console.log('All dependencies were installed succesfully.'); // eslint-disable-line no-console
   }
 
-  private async installWorker(module: string, name: string, extraPath: string) {
+  private async installFromNpm(module: string, name: string, extraPath: string = '') {
     const fileResponse = await fetchFile(
-      `https://unpkg.com/@loaders.gl/${module}@${VERSION}/dist/${name}`
+      `https://unpkg.com/@loaders.gl/${module}@${VERSION}/dist/${extraPath}/${name}`
     );
     const fileData = await fileResponse.arrayBuffer();
     if (!fileData) {
       return;
     }
-    const path = join(process.cwd(), extraPath, 'modules', module, 'dist');
+    const path = join(process.cwd(), 'modules', module, 'dist', extraPath);
+    await writeFile(path, fileData, name);
+  }
+
+  private async installFromUrl(url: string, module: string, name: string) {
+    const fileResponse = await fetchFile(url);
+    const fileData = await fileResponse.arrayBuffer();
+    if (!fileData) {
+      return;
+    }
+    const path = join(process.cwd(), 'modules', module, 'dist', 'libs');
     await writeFile(path, fileData, name);
   }
 }

package/src/i3s-converter/helpers/batch-ids-extensions.ts

@@ -2,26 +2,54 @@ import {GLTFAccessorPostprocessed, GLTFMeshPrimitivePostprocessed} from '@loader
 import type {NumericArray} from '@loaders.gl/loader-utils';
 import type {
   GLTF_EXT_feature_metadata_FeatureIdTexture,
+  GLTF_EXT_feature_metadata_GLTF,
   GLTF_EXT_feature_metadata_Primitive
 } from '@loaders.gl/gltf';
 import {TypedArray} from '@math.gl/core';
 import {TextureImageProperties} from '../types';
+import {EXT_FEATURE_METADATA, EXT_MESH_FEATURES} from '../../constants';
+import {Tiles3DTileContent} from '@loaders.gl/3d-tiles';
 
-const EXT_MESH_FEATURES = 'EXT_mesh_features';
-const EXT_FEATURE_METADATA = 'EXT_feature_metadata';
+/**
+ * Get featureTexture by metadataClass
+ * @param tileContent - 3d tile content
+ * @param metadataClass - user selected feature metadata class name
+ * @returns featureTexture key
+ */
+export function getTextureByMetadataClass(
+  tileContent: Tiles3DTileContent,
+  metadataClass?: string
+): string | null {
+  const extFeatureMetadata = tileContent.gltf?.extensions?.[
+    EXT_FEATURE_METADATA
+  ] as GLTF_EXT_feature_metadata_GLTF;
+  if (!extFeatureMetadata?.featureTextures) {
+    return null;
+  }
+  for (const textureKey in extFeatureMetadata.featureTextures) {
+    const texture = extFeatureMetadata.featureTextures[textureKey];
+    if (texture.class === metadataClass) {
+      return textureKey;
+    }
+  }
+  return null;
+}
 
 /**
  * Getting batchIds from 3DTilesNext extensions.
  * @param attributes - gltf accessors
  * @param primitive - gltf primitive data
  * @param images - gltf texture images
+ * @param featureTexture - feature texture key
+ * @return array of batch IDs
  */
 export function handleBatchIdsExtensions(
   attributes: {
     [key: string]: GLTFAccessorPostprocessed;
   },
   primitive: GLTFMeshPrimitivePostprocessed,
-  images: (TextureImageProperties | null)[]
+  images: (TextureImageProperties | null)[],
+  featureTexture: string | null
 ): NumericArray {
   const extensions = primitive?.extensions;
 
@@ -35,7 +63,8 @@ export function handleBatchIdsExtensions(
         return handleExtFeatureMetadataExtension(
           attributes,
           extensionData as GLTF_EXT_feature_metadata_Primitive,
-          images
+          images,
+          featureTexture
         );
       case EXT_MESH_FEATURES:
         console.warn('EXT_mesh_features extension is not supported yet');
@@ -51,16 +80,18 @@ export function handleBatchIdsExtensions(
 /**
  * Get batchIds from EXT_feature_metadata extension.
  * Docs - https://github.com/CesiumGS/glTF/tree/3d-tiles-next/extensions/2.0/Vendor/EXT_feature_metadata
- * @param attributes
- * @param extFeatureMetadata
- * @param textures
+ * @param attributes - glTF attributes
+ * @param extFeatureMetadata - primitive-level EXT_FEATURE_METADATA extension data
+ * @param textures - texture images
+ * @param featureTexture - feature texture key
  */
 function handleExtFeatureMetadataExtension(
   attributes: {
     [key: string]: GLTFAccessorPostprocessed;
   },
   extFeatureMetadata: GLTF_EXT_feature_metadata_Primitive,
-  images: (TextureImageProperties | null)[]
+  images: (TextureImageProperties | null)[],
+  featureTexture: string | null
 ): NumericArray {
   // Take only first extension object to get batchIds attribute name.
   const featureIdAttribute = extFeatureMetadata?.featureIdAttributes?.[0];
@@ -93,10 +124,6 @@ function handleExtFeatureMetadataExtension(
     return generateBatchIdsFromTexture(featureIdTexture, textureCoordinates, images);
   }
 
-  // Take only first extension texture to get batchIds from the root EXT_feature_metadata object.
-  const featureTexture =
-    extFeatureMetadata?.featureTextures && extFeatureMetadata?.featureTextures[0];
-
   if (featureTexture) {
     const batchIdsAttribute = attributes[featureTexture];
     return batchIdsAttribute.value;

package/src/i3s-converter/helpers/geometry-attributes.ts

@@ -199,19 +199,26 @@ function unifyObjectsByFeatureId(
 
   for (let index = 0; index < sortedData.length; index++) {
     const currentObject = sortedData[index];
-    const existedObject = uniqueObjects.find((obj) => obj.featureId === currentObject.featureId);
+    const existingObject = uniqueObjects.find((obj) => obj.featureId === currentObject.featureId);
 
-    if (existedObject) {
-      existedObject.positions = concatenateTypedArrays(
-        existedObject.positions,
+    if (existingObject) {
+      existingObject.positions = concatenateTypedArrays(
+        existingObject.positions,
         currentObject.positions
       );
-      existedObject.normals = concatenateTypedArrays(existedObject.normals, currentObject.normals);
-      existedObject.colors = concatenateTypedArrays(existedObject.colors, currentObject.colors);
-      existedObject.texCoords = concatenateTypedArrays(
-        existedObject.texCoords,
+      existingObject.normals = concatenateTypedArrays(
+        existingObject.normals,
+        currentObject.normals
+      );
+      existingObject.colors = concatenateTypedArrays(existingObject.colors, currentObject.colors);
+      existingObject.texCoords = concatenateTypedArrays(
+        existingObject.texCoords,
         currentObject.texCoords
       );
+      existingObject.uvRegions = concatenateTypedArrays(
+        existingObject.uvRegions,
+        currentObject.uvRegions
+      );
     } else {
       uniqueObjects.push(currentObject);
     }