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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/tile-converter",
-  "version": "4.0.0-alpha.23",
+  "version": "4.0.0-alpha.25",
   "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.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",
+    "@loaders.gl/3d-tiles": "4.0.0-alpha.25",
+    "@loaders.gl/crypto": "4.0.0-alpha.25",
+    "@loaders.gl/draco": "4.0.0-alpha.25",
+    "@loaders.gl/gltf": "4.0.0-alpha.25",
+    "@loaders.gl/i3s": "4.0.0-alpha.25",
+    "@loaders.gl/images": "4.0.0-alpha.25",
+    "@loaders.gl/loader-utils": "4.0.0-alpha.25",
+    "@loaders.gl/polyfills": "4.0.0-alpha.25",
+    "@loaders.gl/textures": "4.0.0-alpha.25",
+    "@loaders.gl/tiles": "4.0.0-alpha.25",
+    "@loaders.gl/worker-utils": "4.0.0-alpha.25",
+    "@loaders.gl/zip": "4.0.0-alpha.25",
     "@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": "e212f2a0c0e342f7cb65ce84fa2ff39f64b7d94b",
+  "gitHead": "40135f391b869388dbbcd615bbe51178d0c370be",
   "devDependencies": {
     "@types/express": "^4.17.17",
     "@types/node": "^20.4.2"

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

@@ -33,7 +33,7 @@ export default class B3dmConverter {
     i3sAttributesData: I3SAttributesData,
     featureAttributes: any = null
   ): Promise<ArrayBuffer> {
-    const gltf = await this.buildGltf(i3sAttributesData, featureAttributes);
+    const gltf = await this.buildGLTF(i3sAttributesData, featureAttributes);
     const b3dm = encodeSync(
       {
         gltfEncoded: new Uint8Array(gltf),
@@ -51,7 +51,7 @@ export default class B3dmConverter {
    * @param i3sTile - Tile3D instance for I3S node
    * @returns - encoded glb content
    */
-  async buildGltf(
+  async buildGLTF(
     i3sAttributesData: I3SAttributesData,
     featureAttributes: any
   ): Promise<ArrayBuffer> {
@@ -59,8 +59,8 @@ export default class B3dmConverter {
     const {material, attributes, indices: originalIndices, modelMatrix} = tileContent;
     const gltfBuilder = new GLTFScenegraph();
 
-    const textureIndex = await this._addI3sTextureToGltf(tileContent, textureFormat, gltfBuilder);
-    const pbrMaterialInfo = this._convertI3sMaterialToGltfMaterial(material, textureIndex);
+    const textureIndex = await this._addI3sTextureToGLTF(tileContent, textureFormat, gltfBuilder);
+    const pbrMaterialInfo = this._convertI3sMaterialToGLTFMaterial(material, textureIndex);
     const materialIndex = gltfBuilder.addMaterial(pbrMaterialInfo);
 
     const positions = attributes.positions;
@@ -115,7 +115,7 @@ export default class B3dmConverter {
    * @param {GLTFScenegraph} gltfBuilder - gltfScenegraph instance to construct GLTF
    * @returns {Promise<number | null>} - GLTF texture index
    */
-  async _addI3sTextureToGltf(tileContent, textureFormat, gltfBuilder) {
+  async _addI3sTextureToGLTF(tileContent, textureFormat, gltfBuilder) {
     const {texture, material, attributes} = tileContent;
     let textureIndex = null;
     let selectedTexture = texture;
@@ -222,7 +222,7 @@ export default class B3dmConverter {
    * @param {number | null} textureIndex - texture index in GLTF
    * @returns {object} GLTF material
    */
-  _convertI3sMaterialToGltfMaterial(material, textureIndex) {
+  _convertI3sMaterialToGLTFMaterial(material, textureIndex) {
     const isTextureIndexExists = textureIndex !== null;
 
     if (!material) {
@@ -248,7 +248,7 @@ export default class B3dmConverter {
     }
 
     if (textureIndex !== null) {
-      material = this._setGltfTexture(material, textureIndex);
+      material = this._setGLTFTexture(material, textureIndex);
     }
 
     return material;
@@ -260,7 +260,7 @@ export default class B3dmConverter {
    * @param {number} textureIndex - texture index in GLTF
    * @returns {void}
    */
-  _setGltfTexture(materialDefinition, textureIndex) {
+  _setGLTFTexture(materialDefinition, textureIndex) {
     const material = {
       ...materialDefinition,
       pbrMetallicRoughness: {...materialDefinition.pbrMetallicRoughness}

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

@@ -47,5 +47,6 @@ export const loadI3SContent = async (
   };
   const tileContent = await load(sourceTile.contentUrl, I3SLoader, loadOptions);
 
+  // @ts-expect-error
   return tileContent;
 };

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

@@ -3,8 +3,7 @@ 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_structural_metadata
+  GLTF_EXT_feature_metadata_Primitive
 } from '@loaders.gl/gltf';
 
 import type {GLTF_EXT_mesh_features} from '@loaders.gl/gltf';
@@ -12,11 +11,14 @@ import type {GLTF_EXT_mesh_features} from '@loaders.gl/gltf';
 import {TypedArray} from '@math.gl/core';
 import {TextureImageProperties} from '../types';
 import {emod} from '@loaders.gl/math';
-import {EXT_STRUCTURAL_METADATA, EXT_MESH_FEATURES, EXT_FEATURE_METADATA} from '@loaders.gl/gltf';
+import {EXT_MESH_FEATURES, EXT_FEATURE_METADATA} from '@loaders.gl/gltf';
 import {Tiles3DTileContent} from '@loaders.gl/3d-tiles';
 
 /**
- * Get featureTexture by metadataClass
+ * Get featureTexture by a metadata class.
+ * Metadata classes come from a structural metadata extesion (EXT_feature_metadata or EXT_structural_metadata).
+ * The glTF might contain multiple texel-level metadata textures related to different classes. Having only one metadata class
+ * selected to convert to I3S, we have to pick only one texture to convert to per-vertex property.
  * @param tileContent - 3d tile content
  * @param metadataClass - user selected feature metadata class name
  * @returns featureTexture key
@@ -72,12 +74,6 @@ export function handleBatchIdsExtensions(
         );
       case EXT_MESH_FEATURES:
         return handleExtMeshFeaturesExtension(attributes, extensionData as GLTF_EXT_mesh_features);
-      case EXT_STRUCTURAL_METADATA:
-        return handleExtStructuralMetadataExtension(
-          attributes,
-          extensionData as GLTF_EXT_structural_metadata
-        );
-
       default:
         return [];
     }
@@ -86,23 +82,6 @@ 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
@@ -115,19 +94,19 @@ function handleExtMeshFeaturesExtension(
   },
   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;
+  for (let ids of extMeshFeatures.featureIds) {
+    if (typeof ids.propertyTable !== 'undefined') {
+      // propertyTable is an index that can be 0
+      // return the first featureID set that corresponts to property table.
+      return ids.data as NumericArray;
+    }
   }
   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
+ * @see - https://github.com/CesiumGS/glTF/tree/3d-tiles-next/extensions/2.0/Vendor/EXT_feature_metadata
  * @param attributes - glTF attributes
  * @param extFeatureMetadata - primitive-level EXT_FEATURE_METADATA extension data
  * @param textures - texture images
@@ -182,7 +161,7 @@ function handleExtFeatureMetadataExtension(
 
 /**
  * Generates implicit feature ids
- * Spec - https://github.com/CesiumGS/glTF/tree/3d-tiles-next/extensions/2.0/Vendor/EXT_feature_metadata#implicit-feature-ids
+ * @see - https://github.com/CesiumGS/glTF/tree/3d-tiles-next/extensions/2.0/Vendor/EXT_feature_metadata#implicit-feature-ids
  * @param featuresCount
  * @param constant
  * @param devisor

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

@@ -9,26 +9,26 @@ import {
 } from '@loaders.gl/i3s';
 
 /**
- * Takes attributes from property table based on featureIds.
+ * Takes attributes from property table based on featureIdsMap.
  * If there is no property value for particular featureId (index) the property will be null.
  * Example:
  * Initial data:
- *   OBJECTID: [0, 1, 5]
+ *   OBJECTID: {0: 0, 3: 33, 4: 333}
  *   component: ['Windows', 'Frames', 'Wall', 'Roof', 'Skylight']
  * Result:
- *   OBJECTID: [0, 1, 5]
- *   component: ['Windows', 'Frames', 'null']
- * @param featureIds
+ *   OBJECTID: [0, 33, 333]
+ *   component: ['Windows', 'Roof', 'Skylight']
+ * @param featureIdsMap
  * @param propertyTable
  */
 export function flattenPropertyTableByFeatureIds(
-  featureIds: number[],
+  featureIdsMap: Record<string, number>,
   propertyTable: FeatureTableJson
 ): FeatureTableJson {
   const resultPropertyTable: FeatureTableJson = {};
   for (const propertyName in propertyTable) {
     const properties = propertyTable[propertyName];
-    resultPropertyTable[propertyName] = getPropertiesByFeatureIds(properties, featureIds);
+    resultPropertyTable[propertyName] = getPropertiesByFeatureIds(properties, featureIdsMap);
   }
 
   return resultPropertyTable;
@@ -37,14 +37,17 @@ export function flattenPropertyTableByFeatureIds(
 /**
  * Getting properties by featureId index
  * @param properties
- * @param featureIds
+ * @param featureIdsMap
  */
-function getPropertiesByFeatureIds(properties: unknown[], featureIds: number[]): unknown[] {
+function getPropertiesByFeatureIds(
+  properties: unknown[],
+  featureIdsMap: Record<string, number>
+): unknown[] {
   const resultProperties: unknown[] = [];
 
   if (properties) {
-    for (const featureId of featureIds) {
-      const property = properties[featureId] || null;
+    for (const featureIdKey in featureIdsMap) {
+      const property = properties[featureIdKey] || null;
       resultProperties.push(property);
     }
   }

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

@@ -1,4 +1,9 @@
-import type {GeometryAttributes, ConvertedAttributes, GroupedByFeatureIdAttributes} from '../types';
+import type {
+  GeometryAttributes,
+  ConvertedAttributes,
+  GroupedByFeatureIdAttributes,
+  GroupedAttributes
+} from '../types';
 import {concatenateTypedArrays} from '@loaders.gl/loader-utils';
 
 const VALUES_PER_VERTEX = 3;
@@ -125,6 +130,11 @@ function makeAttributeObjects(attributes: GeometryAttributes): GroupedByFeatureI
   let colorsList = new Uint8Array(colors);
   let texCoordsList = new Float32Array(texCoords);
   let uvRegionsList = new Uint16Array(uvRegions);
+  let positionsOffset = 0;
+  let normalsOffset = 0;
+  let colorsOffset = 0;
+  let uvRegionsOffset = 0;
+  let texCoordsOffset = 0;
 
   for (let index = 0; index < featureIds.length; index++) {
     const startIndex = faceRange[index * 2];
@@ -138,21 +148,21 @@ function makeAttributeObjects(attributes: GeometryAttributes): GroupedByFeatureI
 
     groupedData.push({
       featureId: featureIds[index],
-      positions: positionsList.slice(0, positionsCount),
-      normals: normalsList.slice(0, normalsCount),
-      colors: colorsList.slice(0, colorsCount),
-      uvRegions: uvRegionsList.slice(0, uvRegionsCount),
-      texCoords: texCoordsList.slice(0, texCoordsCount)
+      positions: positionsList.subarray(positionsOffset, positionsOffset + positionsCount),
+      normals: normalsList.subarray(normalsOffset, normalsOffset + normalsCount),
+      colors: colorsList.subarray(colorsOffset, colorsOffset + colorsCount),
+      uvRegions: uvRegionsList.subarray(uvRegionsOffset, uvRegionsOffset + uvRegionsCount),
+      texCoords: texCoordsList.subarray(texCoordsOffset, texCoordsOffset + texCoordsCount)
     });
 
-    positionsList = positionsList.slice(positionsCount);
-    normalsList = normalsList.slice(normalsCount);
-    colorsList = colorsList.slice(colorsCount);
-    uvRegionsList = uvRegionsList.slice(uvRegionsCount);
-    texCoordsList = texCoordsList.slice(texCoordsCount);
+    positionsOffset += positionsCount;
+    normalsOffset += normalsCount;
+    colorsOffset += colorsCount;
+    uvRegionsOffset += uvRegionsCount;
+    texCoordsOffset += texCoordsCount;
   }
 
-  return groupedData.sort((first, second) => first.featureId - second.featureId);
+  return groupedData;
 }
 
 /**
@@ -195,35 +205,32 @@ function getSliceAttributeCount(
 function unifyObjectsByFeatureId(
   sortedData: GroupedByFeatureIdAttributes[]
 ): GroupedByFeatureIdAttributes[] {
-  const uniqueObjects: GroupedByFeatureIdAttributes[] = [];
-
-  for (let index = 0; index < sortedData.length; index++) {
-    const currentObject = sortedData[index];
-    const existingObject = uniqueObjects.find((obj) => obj.featureId === currentObject.featureId);
-
+  const groupedMetadata: {
+    featureId: number;
+    attributes: GroupedByFeatureIdAttributes[];
+  }[] = [];
+  for (const data of sortedData) {
+    const existingObject = groupedMetadata.find((obj) => obj.featureId === data.featureId);
     if (existingObject) {
-      existingObject.positions = concatenateTypedArrays(
-        existingObject.positions,
-        currentObject.positions
-      );
-      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
-      );
+      existingObject.attributes.push(data);
     } else {
-      uniqueObjects.push(currentObject);
+      groupedMetadata.push({
+        featureId: data.featureId,
+        attributes: [data]
+      });
     }
   }
 
+  const uniqueObjects: GroupedByFeatureIdAttributes[] = [];
+  for (const metatada of groupedMetadata) {
+    const attributes = concatenateAttributes(metatada.attributes);
+
+    uniqueObjects.push({
+      featureId: metatada.featureId,
+      ...attributes
+    });
+  }
+
   return uniqueObjects;
 }
 
@@ -238,12 +245,6 @@ function groupAttributesAndRangesByFeatureId(
 ): GeometryAttributes {
   const firstAttributeObject = unifiedObjects[0];
   const featureIds = [firstAttributeObject.featureId || 0];
-
-  let positions = new Float32Array(firstAttributeObject.positions);
-  let normals = new Float32Array(firstAttributeObject.normals);
-  let colors = new Uint8Array(firstAttributeObject.colors);
-  let uvRegions = new Uint16Array(firstAttributeObject.uvRegions);
-  let texCoords = new Float32Array(firstAttributeObject.texCoords);
   const range = [0];
 
   let objIndex = 0;
@@ -253,12 +254,6 @@ function groupAttributesAndRangesByFeatureId(
     const currentAttributesObject = unifiedObjects[index];
     featureIds.push(currentAttributesObject.featureId || 0);
 
-    positions = concatenateTypedArrays(positions, currentAttributesObject.positions);
-    normals = concatenateTypedArrays(normals, currentAttributesObject.normals);
-    colors = concatenateTypedArrays(colors, currentAttributesObject.colors);
-    uvRegions = concatenateTypedArrays(uvRegions, currentAttributesObject.uvRegions);
-    texCoords = concatenateTypedArrays(texCoords, currentAttributesObject.texCoords);
-
     const groupedObject = unifiedObjects[objIndex];
     range.push(groupedObject.positions.length / POSITIONS_AND_NORMALS_PER_TRIANGLE - 1 + sum);
     range.push(groupedObject.positions.length / POSITIONS_AND_NORMALS_PER_TRIANGLE + sum);
@@ -267,8 +262,43 @@ function groupAttributesAndRangesByFeatureId(
     objIndex += 1;
   }
 
-  range.push(positions.length / POSITIONS_AND_NORMALS_PER_TRIANGLE - 1);
+  const attributes = concatenateAttributes(unifiedObjects);
+
+  range.push(attributes.positions.length / POSITIONS_AND_NORMALS_PER_TRIANGLE - 1);
 
   const faceRange = new Uint32Array(range);
-  return {faceRange, featureIds, positions, normals, colors, uvRegions, texCoords, featureCount};
+  return {faceRange, featureIds, featureCount, ...attributes};
+}
+
+/**
+ * Concatenate attributes typed arrays
+ * @param attributes - grouped by featureId typed arrays
+ * @returns - concatenated typed array list
+ */
+function concatenateAttributes(attributes: GroupedByFeatureIdAttributes[]): GroupedAttributes {
+  const positionGroups = attributes.map(({positions}) => positions);
+  const positions =
+    positionGroups.length > 1 ? concatenateTypedArrays(...positionGroups) : positionGroups[0];
+
+  const normalGroups = attributes.map(({normals}) => normals);
+  const normals =
+    normalGroups.length > 1 ? concatenateTypedArrays(...normalGroups) : normalGroups[0];
+
+  const colorGroups = attributes.map(({colors}) => colors);
+  const colors = colorGroups.length > 1 ? concatenateTypedArrays(...colorGroups) : colorGroups[0];
+
+  const texCoordGroups = attributes.map(({texCoords}) => texCoords);
+  const texCoords =
+    texCoordGroups.length > 1 ? concatenateTypedArrays(...texCoordGroups) : texCoordGroups[0];
+
+  const uvRegionGroups = attributes.map(({uvRegions}) => uvRegions);
+  const uvRegions =
+    uvRegionGroups.length > 1 ? concatenateTypedArrays(...uvRegionGroups) : uvRegionGroups[0];
+  return {
+    positions,
+    normals,
+    colors,
+    texCoords,
+    uvRegions
+  };
 }