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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/tile-converter",
-  "version": "4.1.0-alpha.9",
+  "version": "4.2.0-alpha.1",
   "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.9",
-    "@loaders.gl/crypto": "4.1.0-alpha.9",
-    "@loaders.gl/draco": "4.1.0-alpha.9",
-    "@loaders.gl/gltf": "4.1.0-alpha.9",
-    "@loaders.gl/i3s": "4.1.0-alpha.9",
-    "@loaders.gl/images": "4.1.0-alpha.9",
-    "@loaders.gl/loader-utils": "4.1.0-alpha.9",
-    "@loaders.gl/polyfills": "4.1.0-alpha.9",
-    "@loaders.gl/textures": "4.1.0-alpha.9",
-    "@loaders.gl/tiles": "4.1.0-alpha.9",
-    "@loaders.gl/worker-utils": "4.1.0-alpha.9",
-    "@loaders.gl/zip": "4.1.0-alpha.9",
+    "@loaders.gl/3d-tiles": "4.2.0-alpha.1",
+    "@loaders.gl/crypto": "4.2.0-alpha.1",
+    "@loaders.gl/draco": "4.2.0-alpha.1",
+    "@loaders.gl/gltf": "4.2.0-alpha.1",
+    "@loaders.gl/i3s": "4.2.0-alpha.1",
+    "@loaders.gl/images": "4.2.0-alpha.1",
+    "@loaders.gl/loader-utils": "4.2.0-alpha.1",
+    "@loaders.gl/polyfills": "4.2.0-alpha.1",
+    "@loaders.gl/textures": "4.2.0-alpha.1",
+    "@loaders.gl/tiles": "4.2.0-alpha.1",
+    "@loaders.gl/worker-utils": "4.2.0-alpha.1",
+    "@loaders.gl/zip": "4.2.0-alpha.1",
     "@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": "0291d4d78d71202385d0368942f84778d6aafa82",
+  "gitHead": "d4da81f4d8fb2a3b43b0e025109cf7ccfb317d4c",
   "devDependencies": {
     "@types/express": "^4.17.17",
     "@types/node": "^20.4.2"

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

@@ -44,6 +44,8 @@ export default class Tiles3DConverter {
   loaderOptions: I3SLoaderOptions = {
     _nodeWorkers: true,
     reuseWorkers: true,
+    // TODO: converter freezes in the end because of i3s-content-worker
+    worker: false,
     i3s: {coordinateSystem: COORDINATE_SYSTEM.LNGLAT_OFFSETS, decodeTextures: false},
     // We need to load local fs workers because nodejs can't load workers from the Internet
     'i3s-content': {
@@ -115,7 +117,8 @@ export default class Tiles3DConverter {
         box: i3sObbTo3dTilesObb(rootNode.obb, this.geoidHeightModel)
       },
       geometricError: convertScreenThresholdToGeometricError(rootNode),
-      children: []
+      children: [],
+      refine: 'REPLACE'
     };
 
     await this._addChildren(rootNode, rootTile, 1);
@@ -208,11 +211,9 @@ export default class Tiles3DConverter {
     if (this.options.maxDepth && level > this.options.maxDepth) {
       return;
     }
-    const promises: Promise<void>[] = [];
     for (const childNodeInfo of parentSourceNode.children || []) {
-      promises.push(this.convertChildNode(parentSourceNode, parentNode, level, childNodeInfo));
+      await this.convertChildNode(parentSourceNode, parentNode, level, childNodeInfo);
     }
-    await Promise.all(promises);
   }
 
   /**

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/3d-tiles-converter/json-templates/tileset.ts

@@ -14,6 +14,9 @@ const TILE = () => ({
   geometricError: {
     path: 'geometricError'
   },
+  refine: {
+    path: 'refine'
+  },
   content: {
     path: 'content'
   },

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,7 +11,7 @@ import {
   getURLValue,
   validateOptionsWithEqual
 } from './lib/utils/cli-utils';
-import {addOneFile, composeHashFile} from '@loaders.gl/zip';
+import {addOneFile, composeHashFile, makeZipCDHeaderIterator} from '@loaders.gl/zip';
 import {FileHandleFile} from '@loaders.gl/loader-utils';
 import {copyFile} from 'node:fs/promises';
 
@@ -133,7 +133,7 @@ async function main() {
     if (finalPath !== validatedOptions.tileset) {
       await copyFile(validatedOptions.tileset, finalPath);
     }
-    const hashTable = await composeHashFile(new FileHandleFile(finalPath));
+    const hashTable = await composeHashFile(makeZipCDHeaderIterator(new FileHandleFile(finalPath)));
     await addOneFile(finalPath, hashTable, '@specialIndexFileHASH128@');
 
     return;
@@ -205,7 +205,7 @@ async function convert(options: ValidatedTileConversionOptions) {
   switch (inputType) {
     case TILESET_TYPE.I3S:
       const tiles3DConverter = new Tiles3DConverter();
-      tiles3DConverter.convert({
+      await tiles3DConverter.convert({
         inputUrl: options.tileset,
         outputPath: options.output,
         tilesetName: options.name,

package/src/i3s-converter/helpers/attribute-metadata-info.ts

@@ -9,6 +9,12 @@ import type {
 
 import {AttributeType} from '../types';
 
+export type AttributeMetadataInfoObject = {
+  attributeStorageInfo: AttributeStorageInfo[];
+  fields: Field[];
+  popupInfo: PopupInfo | undefined;
+};
+
 export class AttributeMetadataInfo {
   private _attributeStorageInfo: AttributeStorageInfo[];
   private _fields: Field[];
@@ -95,6 +101,16 @@ export class AttributeMetadataInfo {
     }
   }
 
+  /**
+   * Set AttributeMetadataInfo from object
+   * @param object - object with AttributeMetadataInfo props
+   */
+  fromObject(object: AttributeMetadataInfoObject) {
+    this._attributeStorageInfo = object.attributeStorageInfo;
+    this._fields = object.fields;
+    this._popupInfo = object.popupInfo;
+  }
+
   /**
    * Generates storage attribute for map segmentation.
    * @param attributeIndex - order index of attribute (f_0, f_1 ...).

package/src/i3s-converter/helpers/node-index-document.ts

@@ -12,6 +12,7 @@ import {openJson, writeFile, writeFileForSlpk} from '../../lib/utils/file-utils'
 import I3SConverter from '../i3s-converter';
 import {NODE as nodeTemplate} from '../json-templates/node';
 import {I3SConvertedResources} from '../types';
+import {DumpMetadata} from '../../lib/utils/conversion-dump';
 
 /**
  * Wrapper for https://github.com/Esri/i3s-spec/blob/master/docs/1.7/3DNodeIndexDocument.cmn.md data
@@ -287,9 +288,8 @@ export class NodeIndexDocument {
     boundingVolumes: BoundingVolumes,
     lodSelection: LodSelection[],
     nodeInPage: NodeInPage,
-    resources: I3SConvertedResources
+    resources: I3SConvertedResources | DumpMetadata
   ): Promise<Node3DIndexDocument> {
-    const {texture, attributes} = resources;
     const nodeId = nodeInPage.index!;
     const parentNodeData = await parentNode.load();
     const nodeData = {
@@ -313,19 +313,29 @@ export class NodeIndexDocument {
       node.geometryData = [{href: './geometries/0'}];
       node.sharedResource = {href: './shared'};
 
-      if (texture) {
+      if (
+        ('texture' in resources && resources.texture) ||
+        ('texelCountHint' in resources && resources.texelCountHint)
+      ) {
         node.textureData = [{href: './textures/0'}, {href: './textures/1'}];
       }
 
       if (
-        attributes &&
-        attributes.length &&
-        parentNode.converter.layers0?.attributeStorageInfo?.length
+        ('attributes' in resources &&
+          resources.attributes &&
+          resources.attributes.length &&
+          parentNode.converter.layers0?.attributeStorageInfo?.length) ||
+        ('attributesCount' in resources &&
+          resources.attributesCount &&
+          parentNode.converter.layers0?.attributeStorageInfo?.length)
       ) {
+        const attributesLength =
+          ('attributes' in resources ? resources.attributes?.length : resources.attributesCount) ||
+          0;
         node.attributeData = [];
         const minimumLength =
-          attributes.length < parentNode.converter.layers0.attributeStorageInfo.length
-            ? attributes.length
+          attributesLength < parentNode.converter.layers0.attributeStorageInfo.length
+            ? attributesLength
             : parentNode.converter.layers0.attributeStorageInfo.length;
         for (let index = 0; index < minimumLength; index++) {
           const folderName = parentNode.converter.layers0.attributeStorageInfo[index].key;

package/src/i3s-converter/helpers/progress.ts

@@ -119,7 +119,7 @@ export class Progress {
    * @returns Number of milliseconds remaining
    */
   getTimeRemaining(): {timeRemaining: number; trust: boolean} | null {
-    if (!this._stepsDone || !this.startTime) {
+    if (!this._stepsTotal || !this._stepsDone || !this.startTime) {
       return null;
     }