@loaders.gl/tile-converter 4.0.0-alpha.22 → 4.0.0-alpha.23

package/package.json

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

package/src/constants.ts

@@ -1,5 +1,2 @@
 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/i3s-converter/helpers/batch-ids-extensions.ts

@@ -3,11 +3,16 @@ 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
+  GLTF_EXT_feature_metadata_Primitive,
+  GLTF_EXT_structural_metadata
 } from '@loaders.gl/gltf';
+
+import type {GLTF_EXT_mesh_features} from '@loaders.gl/gltf';
+
 import {TypedArray} from '@math.gl/core';
 import {TextureImageProperties} from '../types';
-import {EXT_FEATURE_METADATA, EXT_MESH_FEATURES} from '../../constants';
+import {emod} from '@loaders.gl/math';
+import {EXT_STRUCTURAL_METADATA, EXT_MESH_FEATURES, EXT_FEATURE_METADATA} from '@loaders.gl/gltf';
 import {Tiles3DTileContent} from '@loaders.gl/3d-tiles';
 
 /**
@@ -52,7 +57,6 @@ export function handleBatchIdsExtensions(
   featureTexture: string | null
 ): NumericArray {
   const extensions = primitive?.extensions;
-
   if (!extensions) {
     return [];
   }
@@ -67,8 +71,13 @@ export function handleBatchIdsExtensions(
           featureTexture
         );
       case EXT_MESH_FEATURES:
-        console.warn('EXT_mesh_features extension is not supported yet');
-        return [];
+        return handleExtMeshFeaturesExtension(attributes, extensionData as GLTF_EXT_mesh_features);
+      case EXT_STRUCTURAL_METADATA:
+        return handleExtStructuralMetadataExtension(
+          attributes,
+          extensionData as GLTF_EXT_structural_metadata
+        );
+
       default:
         return [];
     }
@@ -77,6 +86,45 @@ export function handleBatchIdsExtensions(
   return [];
 }
 
+function handleExtStructuralMetadataExtension(
+  attributes: {
+    [key: string]: GLTFAccessorPostprocessed;
+  },
+  extStructuralMetadata: GLTF_EXT_structural_metadata
+): NumericArray {
+  // Take only first extension object to get batchIds attribute name.
+  const dataAttributeNames = extStructuralMetadata?.dataAttributeNames;
+  if (dataAttributeNames?.length) {
+    // Let's use the first element of the array
+    // TODO: What to do with others if any?
+    const batchIdsAttribute = attributes[dataAttributeNames[0]];
+    return batchIdsAttribute.value;
+  }
+  return [];
+}
+
+/**
+ * Getting batchIds from EXT_mesh_features extensions.
+ * @param attributes - gltf accessors
+ * @param extMeshFeatures - EXT_mesh_features extension
+ * @returns an array of attribute values
+ */
+function handleExtMeshFeaturesExtension(
+  attributes: {
+    [key: string]: GLTFAccessorPostprocessed;
+  },
+  extMeshFeatures: GLTF_EXT_mesh_features
+): NumericArray {
+  const dataAttributeNames = extMeshFeatures?.dataAttributeNames;
+  if (dataAttributeNames?.length) {
+    // Let's use the first element of the array
+    // TODO: What to do with others if any?
+    const batchIdsAttribute = attributes[dataAttributeNames[0]];
+    return batchIdsAttribute.value;
+  }
+  return [];
+}
+
 /**
  * Get batchIds from EXT_feature_metadata extension.
  * Docs - https://github.com/CesiumGS/glTF/tree/3d-tiles-next/extensions/2.0/Vendor/EXT_feature_metadata
@@ -218,12 +266,3 @@ function generateBatchIdsFromTexture(
 
   return batchIds;
 }
-
-/**
- * Handle UVs if they are out of range [0,1].
- * @param n
- * @param m
- */
-function emod(n: number): number {
-  return ((n % 1) + 1) % 1;
-}

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

@@ -39,12 +39,14 @@ export function flattenPropertyTableByFeatureIds(
  * @param properties
  * @param featureIds
  */
-function getPropertiesByFeatureIds(properties: any[], featureIds: number[]): any[] {
-  const resultProperties: any = [];
+function getPropertiesByFeatureIds(properties: unknown[], featureIds: number[]): unknown[] {
+  const resultProperties: unknown[] = [];
 
-  for (const featureId of featureIds) {
-    const property = properties[featureId] || null;
-    resultProperties.push(property);
+  if (properties) {
+    for (const featureId of featureIds) {
+      const property = properties[featureId] || null;
+      resultProperties.push(property);
+    }
   }
 
   return resultProperties;
@@ -64,7 +66,7 @@ export function checkPropertiesLength(
   let needFlatten = false;
 
   for (const attribute of Object.values(propertyTable)) {
-    if (featureIds.length !== attribute.length) {
+    if (!featureIds || !attribute || featureIds.length !== attribute.length) {
       needFlatten = true;
     }
   }

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

@@ -1,5 +1,7 @@
 import type {FeatureTableJson, Tiles3DTileContent} from '@loaders.gl/3d-tiles';
 import type {
+  GLTF_EXT_mesh_features,
+  GLTF_EXT_structural_metadata,
   GLTFAccessorPostprocessed,
   GLTFMaterialPostprocessed,
   GLTFNodePostprocessed,
@@ -47,7 +49,8 @@ import {GL} from '@loaders.gl/math';
 import type {GLTFAttributesData, TextureImageProperties, TypedArrayConstructor} from '../types';
 import {generateSyntheticIndices} from '../../lib/utils/geometry-utils';
 import {BoundingSphere, OrientedBoundingBox} from '@math.gl/culling';
-import {EXT_FEATURE_METADATA, EXT_MESH_FEATURES} from '../../constants';
+
+import {EXT_MESH_FEATURES, EXT_FEATURE_METADATA, EXT_STRUCTURAL_METADATA} from '@loaders.gl/gltf';
 
 // Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.7/pbrMetallicRoughness.cmn.md
 const DEFAULT_ROUGHNESS_FACTOR = 1;
@@ -1358,10 +1361,12 @@ function convertPropertyTableToAttributeBuffers(
 
   for (const propertyName in propertyTableWithObjectIds) {
     const type = getAttributeType(propertyName, attributeStorageInfo);
-    const value = propertyTableWithObjectIds[propertyName];
-    const attributeBuffer = generateAttributeBuffer(type, value);
+    if (type) {
+      const value = propertyTableWithObjectIds[propertyName];
+      const attributeBuffer = generateAttributeBuffer(type, value);
 
-    attributeBuffers.push(attributeBuffer);
+      attributeBuffers.push(attributeBuffer);
+    }
   }
 
   return attributeBuffers;
@@ -1401,6 +1406,20 @@ function generateAttributeBuffer(type: string, value: any): ArrayBuffer {
  */
 function getAttributeType(key: string, attributeStorageInfo: any[]): string {
   const attribute = attributeStorageInfo.find((attr) => attr.name === key);
+  if (!attribute) {
+    console.error(
+      `attribute is null, key=${key}, attributeStorageInfo=${JSON.stringify(
+        attributeStorageInfo,
+        null,
+        2
+      )}`
+    );
+    return '';
+  }
+  if (!attribute.attributeValues) {
+    console.error(`attributeValues is null, attribute=${attribute}`);
+    return '';
+  }
   return attribute.attributeValues.valueType;
 }
 
@@ -1577,8 +1596,8 @@ function generateFeatureIndexAttribute(
  * Find property table in tile
  * For example it can be batchTable for b3dm files or property table in gLTF extension.
  * @param tileContent - 3DTiles tile content
- * @param metadataClass - - user selected feature metadata class name
- * @return batch table from b3dm / feature properties from EXT_FEATURE_METADATA
+ * @param metadataClass - user selected feature metadata class name
+ * @return batch table from b3dm / feature properties from EXT_FEATURE_METADATA, EXT_MESH_FEATURES or EXT_STRUCTURAL_METADATA
  */
 export function getPropertyTable(
   tileContent: Tiles3DTileContent | null,
@@ -1587,7 +1606,7 @@ export function getPropertyTable(
   if (!tileContent) {
     return null;
   }
-
+  let propertyTable: FeatureTableJson | null;
   const batchTableJson = tileContent?.batchTableJson;
 
   if (batchTableJson) {
@@ -1598,14 +1617,25 @@ export function getPropertyTable(
 
   switch (extensionName) {
     case EXT_MESH_FEATURES: {
-      console.warn('The I3S converter does not yet support the EXT_mesh_features extension');
-      return null;
+      propertyTable = getPropertyTableFromExtMeshFeatures(
+        extension as GLTF_EXT_mesh_features,
+        metadataClass
+      );
+      return propertyTable;
+    }
+    case EXT_STRUCTURAL_METADATA: {
+      propertyTable = getPropertyTableFromExtStructuralMetadata(
+        extension as GLTF_EXT_structural_metadata,
+        metadataClass
+      );
+      return propertyTable;
     }
     case EXT_FEATURE_METADATA: {
-      return getPropertyTableFromExtFeatureMetadata(
+      propertyTable = getPropertyTableFromExtFeatureMetadata(
         extension as GLTF_EXT_feature_metadata_GLTF,
         metadataClass
       );
+      return propertyTable;
     }
     default:
       return null;
@@ -1618,9 +1648,18 @@ export function getPropertyTable(
  */
 function getPropertyTableExtension(tileContent: Tiles3DTileContent): {
   extensionName: null | string;
-  extension: string | GLTF_EXT_feature_metadata_GLTF | null;
+  extension:
+    | string
+    | GLTF_EXT_feature_metadata_GLTF
+    | GLTF_EXT_structural_metadata
+    | GLTF_EXT_mesh_features
+    | null;
 } {
-  const extensionsWithPropertyTables = [EXT_FEATURE_METADATA, EXT_MESH_FEATURES];
+  const extensionsWithPropertyTables = [
+    EXT_FEATURE_METADATA,
+    EXT_STRUCTURAL_METADATA,
+    EXT_MESH_FEATURES
+  ];
   const extensionsUsed = tileContent?.gltf?.extensionsUsed;
 
   if (!extensionsUsed) {
@@ -1649,6 +1688,8 @@ function getPropertyTableExtension(tileContent: Tiles3DTileContent): {
 /**
  * Handle EXT_feature_metadata to get property table
  * @param extension - global level of EXT_FEATURE_METADATA extension
+ * @param metadataClass - user selected feature metadata class name
+ * @returns {FeatureTableJson | null} Property table or null if the extension can't be handled properly.
  */
 function getPropertyTableFromExtFeatureMetadata(
   extension: GLTF_EXT_feature_metadata_GLTF,
@@ -1701,3 +1742,85 @@ function getPropertyTableFromExtFeatureMetadata(
   );
   return null;
 }
+
+/**
+ * Handle EXT_structural_metadata to get property table
+ * @param extension - global level of EXT_STRUCTURAL_METADATA extension
+ * @param metadataClass - user selected feature metadata class name
+ * @returns {FeatureTableJson | null} Property table or null if the extension can't be handled properly.
+ */
+function getPropertyTableFromExtStructuralMetadata(
+  extension: GLTF_EXT_structural_metadata,
+  metadataClass?: string
+): FeatureTableJson | null {
+  if (extension?.propertyTables) {
+    /**
+     * Take only first feature table to generate attributes storage info object.
+     * TODO: Think about getting data from all feature tables?
+     * It can be tricky just because 3dTiles is able to have multiple featureId attributes and multiple feature tables.
+     * In I3S we should decide which featureIds attribute will be passed to geometry data.
+     */
+    const firstPropertyTable = extension?.propertyTables[0];
+    const propertyTableWithData = {};
+
+    for (const propertyName in firstPropertyTable.properties) {
+      propertyTableWithData[propertyName] = firstPropertyTable.properties[propertyName].data;
+    }
+
+    return propertyTableWithData;
+  }
+
+  if (extension?.propertyTextures) {
+    /**
+     * Take only first feature table to generate attributes storage info object.
+     * TODO: Think about getting data from all feature tables?
+     * It can be tricky just because 3dTiles is able to have multiple featureId attributes and multiple feature tables.
+     * In I3S we should decide which featureIds attribute will be passed to geometry data.
+     */
+    if (extension?.propertyTextures) {
+      const firstPropertyTexture = extension?.propertyTextures[0];
+      const propertyTableWithData = {};
+
+      for (const propertyName in firstPropertyTexture.properties) {
+        propertyTableWithData[propertyName] = firstPropertyTexture.properties[propertyName].data;
+      }
+
+      return propertyTableWithData;
+    }
+  }
+
+  console.warn(
+    "The I3S converter couldn't handle EXT_structural_metadata extension: There is neither propertyTables, no propertyTextures in the extension."
+  );
+  return null;
+}
+
+/**
+ * Handle EXT_mesh_features to get property table
+ * @param extension - global level of EXT_MESH_FEATURES extension
+ * @param metadataClass - user selected feature metadata class name
+ * @returns {FeatureTableJson | null} Property table or null if the extension can't be handled properly.
+ */
+function getPropertyTableFromExtMeshFeatures(
+  extension: GLTF_EXT_mesh_features,
+  metadataClass?: string
+): FeatureTableJson | null {
+  if (extension?.featureIds) {
+    const firstFeatureId = extension?.featureIds[0];
+    const propertyTableWithData = {};
+
+    // When firstFeatureId.propertyTable is defined, the property data will be taken from EXT_structural_metadata extension
+    if (!firstFeatureId.propertyTable) {
+      console.warn(
+        'Should be implemented as we have the tileset with Ext_mesh_features not linked with EXT_structural_metadata extension'
+      );
+    }
+
+    return propertyTableWithData;
+  }
+
+  console.warn(
+    "The I3S converter couldn't handle EXT_mesh_features extension: There is no featureIds in the extension."
+  );
+  return null;
+}

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

@@ -323,7 +323,11 @@ export class NodeIndexDocument {
         parentNode.converter.layers0?.attributeStorageInfo?.length
       ) {
         node.attributeData = [];
-        for (let index = 0; index < attributes.length; index++) {
+        const minimumLength =
+          attributes.length < parentNode.converter.layers0.attributeStorageInfo.length
+            ? attributes.length
+            : parentNode.converter.layers0.attributeStorageInfo.length;
+        for (let index = 0; index < minimumLength; index++) {
           const folderName = parentNode.converter.layers0.attributeStorageInfo[index].key;
           node.attributeData.push({href: `./attributes/${folderName}/0`});
         }

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

@@ -2,7 +2,7 @@ import {Tiles3DTileContent} from '@loaders.gl/3d-tiles';
 import {GLTFPrimitiveModeString, PreprocessData} from '../types';
 import {GLTF, GLTFLoader, GLTF_EXT_feature_metadata_GLTF} from '@loaders.gl/gltf';
 import {parse} from '@loaders.gl/core';
-import {EXT_FEATURE_METADATA} from '../../constants';
+import {EXT_FEATURE_METADATA} from '@loaders.gl/gltf';
 
 /**
  * glTF primitive modes

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

@@ -12,7 +12,8 @@ import type {
   SceneLayer3D,
   BoundingVolumes,
   MaxScreenThresholdSQ,
-  NodeInPage
+  NodeInPage,
+  AttributeStorageInfo
 } from '@loaders.gl/i3s';
 import {load, encode, isBrowser} from '@loaders.gl/core';
 import {CesiumIonLoader, Tiles3DLoader} from '@loaders.gl/3d-tiles';
@@ -649,7 +650,14 @@ export default class I3SConverter {
 
     const propertyTable = getPropertyTable(tileContent, this.options.metadataClass);
 
-    if (propertyTable && !this.layers0?.attributeStorageInfo?.length) {
+    if (propertyTable) {
+      /*
+        Call the convertion procedure even if the node attributes have been already created.
+        We will append new attributes only in case the property table is updated.
+        According to ver 1.9 (see https://github.com/Esri/i3s-spec/blob/master/docs/1.9/attributeStorageInfo.cmn.md):
+        "The attributeStorageInfo object describes the structure of the binary attribute data resource of a layer, which is the same for every node in the layer."
+        But the specification of ver 2.1 doesn't have such a requirement ("...the same for every node...")
+      */
       this._convertPropertyTableToNodeAttributes(propertyTable);
     }
 
@@ -735,7 +743,7 @@ export default class I3SConverter {
    * @param boundingVolume - initialized bounding volume of the source tile
    * @param tileContent - content of the source tile
    * @param parentId - id of parent node in node pages
-   * @param propertyTable - batch table from b3dm / feature properties from EXT_FEATURE_METADATA
+   * @param propertyTable - batch table from b3dm / feature properties from EXT_FEATURE_METADATA, EXT_MESH_FEATURES or EXT_STRUCTURAL_METADATA
    * @returns - converted node resources
    */
   private async _convertResources(
@@ -1068,7 +1076,12 @@ export default class I3SConverter {
     slpkChildPath: string
   ): Promise<void> {
     if (attributes?.length && this.layers0?.attributeStorageInfo?.length) {
-      for (let index = 0; index < attributes.length; index++) {
+      const minimumLength =
+        attributes.length < this.layers0.attributeStorageInfo.length
+          ? attributes.length
+          : this.layers0.attributeStorageInfo.length;
+
+      for (let index = 0; index < minimumLength; index++) {
         const folderName = this.layers0.attributeStorageInfo[index].key;
         const fileBuffer = new Uint8Array(attributes[index]);
 
@@ -1150,19 +1163,31 @@ export default class I3SConverter {
     };
 
     for (const key in propertyTableWithObjectId) {
-      const firstAttribute = propertyTableWithObjectId[key][0];
-      const attributeType = getAttributeType(key, firstAttribute);
-
-      const storageAttribute = createdStorageAttribute(attributeIndex, key, attributeType);
-      const fieldAttributeType = getFieldAttributeType(attributeType);
-      const fieldAttribute = createFieldAttribute(key, fieldAttributeType);
-      const popupInfo = createPopupInfo(propertyTableWithObjectId);
-
-      this.layers0!.attributeStorageInfo!.push(storageAttribute);
-      this.layers0!.fields!.push(fieldAttribute);
-      this.layers0!.popupInfo = popupInfo;
-      this.layers0!.layerType = _3D_OBJECT_LAYER_TYPE;
-
+      /*
+        We will append new attributes only in case the property table is updated.
+        According to ver 1.9 (see https://github.com/Esri/i3s-spec/blob/master/docs/1.9/attributeStorageInfo.cmn.md):
+        "The attributeStorageInfo object describes the structure of the binary attribute data resource of a layer, which is the same for every node in the layer."
+        But the specification of ver 2.1 doesn't have such a requirement ("...the same for every node...")
+      */
+      const found = this.layers0!.attributeStorageInfo!.find((element) => element.name === key);
+      if (!found) {
+        const firstAttribute = propertyTableWithObjectId[key][0];
+        const attributeType = getAttributeType(key, firstAttribute);
+
+        const storageAttribute: AttributeStorageInfo = createdStorageAttribute(
+          attributeIndex,
+          key,
+          attributeType
+        );
+        const fieldAttributeType = getFieldAttributeType(attributeType);
+        const fieldAttribute = createFieldAttribute(key, fieldAttributeType);
+        const popupInfo = createPopupInfo(propertyTableWithObjectId);
+
+        this.layers0!.attributeStorageInfo!.push(storageAttribute);
+        this.layers0!.fields!.push(fieldAttribute);
+        this.layers0!.popupInfo = popupInfo;
+        this.layers0!.layerType = _3D_OBJECT_LAYER_TYPE;
+      }
       attributeIndex += 1;
     }
   }

package/src/i3s-server/controllers/slpk-controller.ts

@@ -1,6 +1,6 @@
 import '@loaders.gl/polyfills';
 import {parseSLPK} from '@loaders.gl/i3s';
-import {FileHandleFile} from '@loaders.gl/zip';
+import {FileHandleFile} from '@loaders.gl/loader-utils';
 
 let slpkArchive;
 

package/src/slpk-extractor/slpk-extractor.ts

@@ -2,7 +2,8 @@ import {isBrowser} from '@loaders.gl/core';
 
 import {BROWSER_ERROR_MESSAGE} from '../constants';
 import {path} from '@loaders.gl/loader-utils';
-import {FileHandleFile, parseZipLocalFileHeader} from '@loaders.gl/zip';
+import {FileHandleFile} from '@loaders.gl/loader-utils';
+import {parseZipLocalFileHeader} from '@loaders.gl/zip';
 import {GZipCompression} from '@loaders.gl/compression';
 import {writeFile} from '../lib/utils/file-utils';