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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/tile-converter",
-  "version": "4.0.0-alpha.17",
+  "version": "4.0.0-alpha.18",
   "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.17",
-    "@loaders.gl/crypto": "4.0.0-alpha.17",
-    "@loaders.gl/draco": "4.0.0-alpha.17",
-    "@loaders.gl/gltf": "4.0.0-alpha.17",
-    "@loaders.gl/i3s": "4.0.0-alpha.17",
-    "@loaders.gl/images": "4.0.0-alpha.17",
-    "@loaders.gl/loader-utils": "4.0.0-alpha.17",
-    "@loaders.gl/polyfills": "4.0.0-alpha.17",
-    "@loaders.gl/textures": "4.0.0-alpha.17",
-    "@loaders.gl/tiles": "4.0.0-alpha.17",
-    "@loaders.gl/worker-utils": "4.0.0-alpha.17",
-    "@loaders.gl/zip": "4.0.0-alpha.17",
+    "@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",
     "@math.gl/core": "^3.5.1",
     "@math.gl/culling": "^3.5.1",
     "@math.gl/geoid": "^3.5.1",
@@ -79,7 +79,7 @@
     "join-images": "^1.1.3",
     "sharp": "^0.31.3"
   },
-  "gitHead": "68a743e2460cc89bf89edabfd08b395380d7d10c",
+  "gitHead": "7bc633f46560f661bdd46cf1015ea27b3694ebce",
   "devDependencies": {
     "@types/express": "^4.17.17",
     "@types/node": "^20.4.2"

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

@@ -1,4 +1,9 @@
-import type {AttributeStorageInfo, FeatureAttribute, NodeReference} from '@loaders.gl/i3s';
+import type {
+  AttributeStorageInfo,
+  FeatureAttribute,
+  NodeReference,
+  I3STilesetHeader
+} from '@loaders.gl/i3s';
 import type {Tiles3DTileJSON} from '@loaders.gl/3d-tiles';
 
 import {join} from 'path';
@@ -6,7 +11,6 @@ import process from 'process';
 import transform from 'json-map-transform';
 import {load, isBrowser} from '@loaders.gl/core';
 import {I3SLoader, I3SAttributeLoader, COORDINATE_SYSTEM} from '@loaders.gl/i3s';
-import {Tileset3D, Tile3D} from '@loaders.gl/tiles';
 import {Geoid} from '@math.gl/geoid';
 
 import {PGMLoader} from '../pgm-loader';
@@ -19,6 +23,9 @@ import {createObbFromMbs} from '../i3s-converter/helpers/coordinate-converter';
 import {WorkerFarm} from '@loaders.gl/worker-utils';
 import {BROWSER_ERROR_MESSAGE} from '../constants';
 import B3dmConverter, {I3SAttributesData} from './helpers/b3dm-converter';
+import {I3STileHeader} from '@loaders.gl/i3s/src/types';
+import {loadI3SContent} from './helpers/load-i3s';
+import {I3SLoaderOptions} from '@loaders.gl/i3s/src/i3s-loader';
 
 const I3S = 'I3S';
 
@@ -31,9 +38,18 @@ export default class Tiles3DConverter {
   vertexCounter: number;
   conversionStartTime: [number, number];
   geoidHeightModel: Geoid | null;
-  sourceTileset: Tileset3D | null;
-  attributeStorageInfo: AttributeStorageInfo | null;
+  sourceTileset: I3STilesetHeader | null;
+  attributeStorageInfo?: AttributeStorageInfo[] | null;
   workerSource: {[key: string]: string} = {};
+  loaderOptions: I3SLoaderOptions = {
+    _nodeWorkers: true,
+    reuseWorkers: true,
+    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': {
+      workerUrl: './modules/i3s/dist/i3s-content-worker-node.js'
+    }
+  };
 
   constructor() {
     this.options = {};
@@ -74,28 +90,19 @@ export default class Tiles3DConverter {
     this.geoidHeightModel = await load(egmFilePath, PGMLoader);
     console.log('Loading egm file completed!'); // eslint-disable-line
 
-    const sourceTilesetJson = await load(inputUrl, I3SLoader, {});
+    this.sourceTileset = await load(inputUrl, I3SLoader, this.loaderOptions);
 
-    this.sourceTileset = new Tileset3D(sourceTilesetJson, {
-      loadOptions: {
-        _nodeWorkers: true,
-        reuseWorkers: true,
-        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': {
-          workerUrl: './modules/i3s/dist/i3s-content-worker-node.js'
-        }
-      }
-    });
+    if (!this.sourceTileset) {
+      return;
+    }
 
-    await this.sourceTileset.tilesetInitializationPromise;
-    const rootNode = this.sourceTileset.root!;
-    if (!rootNode.header.obb) {
-      rootNode.header.obb = createObbFromMbs(rootNode.header.mbs);
+    const rootNode = this.sourceTileset?.root;
+    if (!rootNode.obb) {
+      rootNode.obb = createObbFromMbs(rootNode.mbs);
     }
 
     this.tilesetPath = join(`${outputPath}`, `${tilesetName}`);
-    this.attributeStorageInfo = sourceTilesetJson.attributeStorageInfo;
+    this.attributeStorageInfo = this.sourceTileset.attributeStorageInfo;
     // Removing the tilesetPath needed to exclude erroneous files after conversion
     try {
       await removeDir(this.tilesetPath);
@@ -105,7 +112,7 @@ export default class Tiles3DConverter {
 
     const rootTile: Tiles3DTileJSON = {
       boundingVolume: {
-        box: i3sObbTo3dTilesObb(rootNode.header.obb, this.geoidHeightModel)
+        box: i3sObbTo3dTilesObb(rootNode.obb, this.geoidHeightModel)
       },
       geometricError: convertScreenThresholdToGeometricError(rootNode),
       children: []
@@ -131,28 +138,33 @@ export default class Tiles3DConverter {
    * @param childNodeInfo child node to convert
    */
   private async convertChildNode(
-    parentSourceNode: Tile3D,
+    parentSourceNode: I3STileHeader,
     parentNode: Tiles3DTileJSON,
     level: number,
     childNodeInfo: NodeReference
   ): Promise<void> {
     const sourceChild = await this._loadChildNode(parentSourceNode, childNodeInfo);
-    parentSourceNode.children.push(sourceChild);
     if (sourceChild.contentUrl) {
-      await this.sourceTileset!._loadTile(sourceChild);
-      this.vertexCounter += sourceChild.content.vertexCount;
+      const content = await loadI3SContent(this.sourceTileset, sourceChild, this.loaderOptions);
+
+      if (!content) {
+        await this._addChildren(sourceChild, parentNode, level + 1);
+        return;
+      }
+
+      this.vertexCounter += content?.vertexCount || 0;
 
       let featureAttributes: FeatureAttribute | null = null;
       if (this.attributeStorageInfo) {
         featureAttributes = await this._loadChildAttributes(sourceChild, this.attributeStorageInfo);
       }
 
-      if (!sourceChild.header.obb) {
-        sourceChild.header.obb = createObbFromMbs(sourceChild.header.mbs);
+      if (!sourceChild.obb) {
+        sourceChild.obb = createObbFromMbs(sourceChild.mbs);
       }
 
       const boundingVolume = {
-        box: i3sObbTo3dTilesObb(sourceChild.header.obb, this.geoidHeightModel)
+        box: i3sObbTo3dTilesObb(sourceChild.obb, this.geoidHeightModel)
       };
       const child: Tiles3DTileJSON = {
         boundingVolume,
@@ -161,8 +173,9 @@ export default class Tiles3DConverter {
       };
 
       const i3sAttributesData: I3SAttributesData = {
-        tileContent: sourceChild.content,
-        textureFormat: sourceChild?.header?.textureFormat
+        tileContent: content,
+        box: boundingVolume.box,
+        textureFormat: sourceChild.textureFormat
       };
 
       const b3dmConverter = new B3dmConverter();
@@ -175,7 +188,6 @@ export default class Tiles3DConverter {
       await writeFile(this.tilesetPath, new Uint8Array(b3dm), `${sourceChild.id}.b3dm`);
       parentNode.children.push(child);
 
-      sourceChild.unloadContent();
       await this._addChildren(sourceChild, child, level + 1);
     } else {
       await this._addChildren(sourceChild, parentNode, level + 1);
@@ -189,7 +201,7 @@ export default class Tiles3DConverter {
    * @param level a current level of a tree depth
    */
   private async _addChildren(
-    parentSourceNode: Tile3D,
+    parentSourceNode: I3STileHeader,
     parentNode: Tiles3DTileJSON,
     level: number
   ): Promise<void> {
@@ -197,7 +209,7 @@ export default class Tiles3DConverter {
       return;
     }
     const promises: Promise<void>[] = [];
-    for (const childNodeInfo of parentSourceNode.header.children || []) {
+    for (const childNodeInfo of parentSourceNode.children || []) {
       promises.push(this.convertChildNode(parentSourceNode, parentNode, level, childNodeInfo));
     }
     await Promise.all(promises);
@@ -209,29 +221,31 @@ export default class Tiles3DConverter {
    * @param childNodeInfo child information from 3DNodeIndexDocument
    *   (https://github.com/Esri/i3s-spec/blob/master/docs/1.7/nodeReference.cmn.md)
    */
-  private async _loadChildNode(parentNode: Tile3D, childNodeInfo: NodeReference): Promise<Tile3D> {
+  private async _loadChildNode(
+    parentNode: I3STileHeader,
+    childNodeInfo: NodeReference
+  ): Promise<I3STileHeader> {
     let header;
-    if (this.sourceTileset!.tileset.nodePages) {
+    if (this.sourceTileset?.nodePagesTile) {
       console.log(`Node conversion: ${childNodeInfo.id}`); // eslint-disable-line no-console,no-undef
-      header = await this.sourceTileset!.tileset.nodePagesTile.formTileFromNodePages(
-        childNodeInfo.id
+      header = await this.sourceTileset.nodePagesTile.formTileFromNodePages(
+        parseInt(childNodeInfo.id)
       );
     } else {
-      const {loader} = this.sourceTileset!;
       const nodeUrl = this._relativeUrlToFullUrl(parentNode.url, childNodeInfo.href!);
       // load metadata
       const options = {
         i3s: {
-          ...this.sourceTileset!.loadOptions,
+          ...this.loaderOptions,
           isTileHeader: true,
           loadContent: false
         }
       };
 
       console.log(`Node conversion: ${nodeUrl}`); // eslint-disable-line no-console,no-undef
-      header = await load(nodeUrl, loader, options);
+      header = await load(nodeUrl, I3SLoader, options);
     }
-    return new Tile3D(this.sourceTileset!, header, parentNode);
+    return header;
   }
 
   /**
@@ -239,7 +253,7 @@ export default class Tiles3DConverter {
    * @param baseUrl the base url. A resulting url will be related from this url
    * @param relativeUrl a realtive url of a resource
    */
-  private _relativeUrlToFullUrl(baseUrl: string, relativeUrl: string): string {
+  private _relativeUrlToFullUrl(baseUrl: string = '', relativeUrl: string): string {
     let resultArray = baseUrl.split('/');
     const relativeUrlArray = relativeUrl.split('/');
     for (const folder of relativeUrlArray) {
@@ -263,11 +277,11 @@ export default class Tiles3DConverter {
    * @returns Promise of attributes object.
    */
   private async _loadChildAttributes(
-    sourceChild: Tile3D,
-    attributeStorageInfo: AttributeStorageInfo
+    sourceChild: I3STileHeader,
+    attributeStorageInfo: AttributeStorageInfo[]
   ): Promise<FeatureAttribute> {
     const promises: any[] = [];
-    const {attributeUrls} = sourceChild.header;
+    const {attributeUrls = []} = sourceChild;
 
     for (let index = 0; index < attributeUrls.length; index++) {
       const inputUrl = attributeUrls[index];

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

@@ -1,3 +1,4 @@
+import type {I3STileContent} from '@loaders.gl/i3s';
 import {encodeSync} from '@loaders.gl/core';
 import {GLTFScenegraph, GLTFWriter} from '@loaders.gl/gltf';
 import {Tile3DWriter} from '@loaders.gl/3d-tiles';
@@ -10,7 +11,8 @@ const Z_UP_TO_Y_UP_MATRIX = new Matrix4([1, 0, 0, 0, 0, 0, -1, 0, 0, 1, 0, 0, 0,
 const scratchVector = new Vector3();
 
 export type I3SAttributesData = {
-  tileContent: any;
+  tileContent: I3STileContent;
+  box: number[];
   textureFormat: string;
 };
 
@@ -53,15 +55,8 @@ export default class B3dmConverter {
     i3sAttributesData: I3SAttributesData,
     featureAttributes: any
   ): Promise<ArrayBuffer> {
-    const {tileContent, textureFormat} = i3sAttributesData;
-    const {
-      material,
-      attributes,
-      indices: originalIndices,
-      cartesianOrigin,
-      cartographicOrigin,
-      modelMatrix
-    } = tileContent;
+    const {tileContent, textureFormat, box} = i3sAttributesData;
+    const {material, attributes, indices: originalIndices, modelMatrix} = tileContent;
     const gltfBuilder = new GLTFScenegraph();
 
     const textureIndex = await this._addI3sTextureToGltf(tileContent, textureFormat, gltfBuilder);
@@ -78,6 +73,12 @@ export default class B3dmConverter {
       );
     }
 
+    const cartesianOrigin = new Vector3(box);
+    const cartographicOrigin = Ellipsoid.WGS84.cartesianToCartographic(
+      cartesianOrigin,
+      new Vector3()
+    );
+
     attributes.positions.value = this._normalizePositions(
       positionsValue,
       cartesianOrigin,

package/src/3d-tiles-converter/helpers/load-i3s.ts

@@ -0,0 +1,51 @@
+import {load} from '@loaders.gl/core';
+import {
+  I3STileContent,
+  I3STileHeader,
+  I3STilesetHeader,
+  I3SLoader,
+  I3SLoaderOptions
+} from '@loaders.gl/i3s';
+
+/**
+ * Load I3S node content
+ * @param sourceTileset - source layer JSON
+ * @param sourceTile - source I3S node metadata
+ * @param tilesetLoadOptions - load options for Tiles3DLoader
+ * @returns - 3DTiles tile content or null
+ */
+export const loadI3SContent = async (
+  sourceTileset: I3STilesetHeader | null,
+  sourceTile: I3STileHeader,
+  tilesetLoadOptions: I3SLoaderOptions
+): Promise<I3STileContent | null> => {
+  if (!sourceTileset || !sourceTile.contentUrl) {
+    return null;
+  }
+
+  const loadOptions = {
+    ...tilesetLoadOptions,
+    i3s: {
+      ...tilesetLoadOptions.i3s,
+      isTileset: false,
+      isTileHeader: false,
+      _tileOptions: {
+        attributeUrls: sourceTile.attributeUrls,
+        textureUrl: sourceTile.textureUrl,
+        textureFormat: sourceTile.textureFormat,
+        textureLoaderOptions: sourceTile.textureLoaderOptions,
+        materialDefinition: sourceTile.materialDefinition,
+        isDracoGeometry: sourceTile.isDracoGeometry,
+        mbs: sourceTile.mbs
+      },
+      _tilesetOptions: {
+        store: sourceTileset.store,
+        attributeStorageInfo: sourceTileset.attributeStorageInfo,
+        fields: sourceTileset.fields
+      }
+    }
+  };
+  const tileContent = await load(sourceTile.contentUrl, I3SLoader, loadOptions);
+
+  return tileContent;
+};

package/src/3d-tiles-converter/helpers/texture-atlas.ts

@@ -1,3 +1,5 @@
+import type {TypedArray} from '@loaders.gl/loader-utils';
+
 /**
  * Apply uvRegions to texture coordinates.
  * Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.7/geometryUVRegion.cmn.md
@@ -5,7 +7,7 @@
  * @param texCoords
  * @param uvRegions
  */
-export function convertTextureAtlas(texCoords: Float32Array, uvRegions: Uint16Array): Float32Array {
+export function convertTextureAtlas(texCoords: TypedArray, uvRegions: TypedArray): Float32Array {
   const convertedTexCoords = new Float32Array(texCoords.length);
   const normalisedRegions = normalizeRegions(uvRegions);
 
@@ -43,7 +45,9 @@ function fract(uv: [number, number]): [number, number] {
  * Normalize uvRegions by dividing by the maximum Uint16 value
  * @param regions
  */
-function normalizeRegions(regions: Uint16Array): number[] {
+function normalizeRegions(regions: TypedArray): number[] {
+  // The code is for Uint16Array because it is the spec requirement
+  // https://github.com/Esri/i3s-spec/blob/master/docs/1.8/geometryUVRegion.cmn.md
   const MAX_UINT_16_VALUE = 65535;
   const normalizedRegions: number[] = [];
 

package/src/lib/utils/lod-conversion-utils.ts

@@ -1,6 +1,6 @@
 import {Tiles3DTileJSONPostprocessed} from '@loaders.gl/3d-tiles';
 import {BoundingVolumes} from '@loaders.gl/i3s';
-import {Tile3D} from '@loaders.gl/tiles';
+import {I3STileHeader} from '@loaders.gl/i3s/src/types';
 
 // https://cesium.com/docs/cesiumjs-ref-doc/Cesium3DTileset.html
 const DEFAULT_MAXIMUM_SCREEN_SPACE_ERROR = 16;
@@ -64,11 +64,15 @@ export function convertGeometricErrorToScreenThreshold(
  * @param node - i3s node data
  * @returns lod metric in 3d-tiles format
  */
-export function convertScreenThresholdToGeometricError(node: Tile3D): number {
-  const metricData = node.header.lodSelection.maxScreenThreshold || {};
-  let maxError = metricData.maxError;
+export function convertScreenThresholdToGeometricError(node: I3STileHeader): number {
+  const metricData = node.lodSelection?.find(
+    (metric) => metric.metricType === 'maxScreenThreshold'
+  );
+  let maxError = metricData?.maxError;
   if (!maxError) {
-    const sqMetricData = node.header.lodSelection.maxScreenThresholdSQ;
+    const sqMetricData = node.lodSelection?.find(
+      (metric) => metric.metricType === 'maxScreenThresholdSQ'
+    );
     if (sqMetricData) {
       maxError = Math.sqrt(sqMetricData.maxError / (Math.PI * 0.25));
     }
@@ -78,5 +82,5 @@ export function convertScreenThresholdToGeometricError(node: Tile3D): number {
     maxError = DEFAULT_MAXIMUM_SCREEN_SPACE_ERROR;
   }
 
-  return (node.header.mbs[3] * 2 * DEFAULT_MAXIMUM_SCREEN_SPACE_ERROR) / maxError;
+  return (node.mbs[3] * 2 * DEFAULT_MAXIMUM_SCREEN_SPACE_ERROR) / maxError;
 }