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

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

@@ -35,7 +35,7 @@ import {
 import {NumberArray, TypedArray} from '@loaders.gl/loader-utils';
 import {Geoid} from '@math.gl/geoid';
 import {prepareDataForAttributesConversion} from './gltf-attributes';
-import {handleBatchIdsExtensions} from './batch-ids-extensions';
+import {getTextureByMetadataClass, handleBatchIdsExtensions} from './batch-ids-extensions';
 import {checkPropertiesLength, flattenPropertyTableByFeatureIds} from './feature-attributes';
 import {GL} from '@loaders.gl/math';
 
@@ -47,6 +47,7 @@ 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';
 
 // Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.7/pbrMetallicRoughness.cmn.md
 const DEFAULT_ROUGHNESS_FACTOR = 1;
@@ -67,9 +68,6 @@ const OBJECT_ID_TYPE = 'Oid32';
  */
 const BATCHED_ID_POSSIBLE_ATTRIBUTE_NAMES = ['CUSTOM_ATTRIBUTE_2', '_BATCHID', 'BATCHID'];
 
-const EXT_FEATURE_METADATA = 'EXT_feature_metadata';
-const EXT_MESH_FEATURES = 'EXT_mesh_features';
-
 let scratchVector = new Vector3();
 
 /**
@@ -87,7 +85,8 @@ let scratchVector = new Vector3();
  * @param generateBoundingVolumes - is converter should create accurate bounding voulmes from geometry attributes
  * @param shouldMergeMaterials - Try to merge similar materials to be able to merge meshes into one node
  * @param geoidHeightModel - model to convert elevation from elipsoidal to geoid
- * @param workerSource - source code of used workers
+ * @param libraries - dynamicaly loaded 3rd-party libraries
+ * @param metadataClass `- user selected feature metadata class name`
  * @returns Array of node resources to create one or more i3s nodes
  */
 export default async function convertB3dmToI3sGeometry(
@@ -102,7 +101,8 @@ export default async function convertB3dmToI3sGeometry(
   generateBoundingVolumes: boolean,
   shouldMergeMaterials: boolean,
   geoidHeightModel: Geoid,
-  workerSource: {[key: string]: string}
+  libraries: Record<string, string>,
+  metadataClass?: string
 ): Promise<I3SConvertedResources[] | null> {
   const useCartesianPositions = generateBoundingVolumes;
   const materialAndTextureList: I3SMaterialWithTexture[] = await convertMaterials(
@@ -115,10 +115,12 @@ export default async function convertB3dmToI3sGeometry(
     tileTransform,
     tileBoundingVolume
   );
+  const featureTexture = getTextureByMetadataClass(tileContent, metadataClass);
   const convertedAttributesMap: Map<string, ConvertedAttributes> = await convertAttributes(
     dataForAttributesConversion,
     materialAndTextureList,
-    useCartesianPositions
+    useCartesianPositions,
+    featureTexture
   );
   /** Usage of worker here brings more overhead than advantage */
   // const convertedAttributesMap: Map<string, ConvertedAttributes> =
@@ -156,7 +158,7 @@ export default async function convertB3dmToI3sGeometry(
         propertyTable,
         attributeStorageInfo,
         draco,
-        workerSource
+        libraries
       })
     );
   }
@@ -208,7 +210,7 @@ function _generateBoundingVolumesFromGeometry(
  * @param params.propertyTable - batch table (corresponding to feature attributes data)
  * @param params.attributeStorageInfo - attributes metadata from 3DSceneLayer json
  * @param params.draco - is converter should create draco compressed geometry
- * @param params.workerSource - source code of used workers
+ * @param libraries - dynamicaly loaded 3rd-party libraries
  * @returns Array of I3S node resources
  */
 async function _makeNodeResources({
@@ -221,7 +223,7 @@ async function _makeNodeResources({
   propertyTable,
   attributeStorageInfo,
   draco,
-  workerSource
+  libraries
 }: {
   convertedAttributes: ConvertedAttributes;
   material: I3SMaterialDefinition;
@@ -232,7 +234,7 @@ async function _makeNodeResources({
   propertyTable: FeatureTableJson | null;
   attributeStorageInfo?: AttributeStorageInfo[];
   draco: boolean;
-  workerSource: {[key: string]: string};
+  libraries: Record<string, string>;
 }): Promise<I3SConvertedResources> {
   const boundingVolumes = convertedAttributes.boundingVolumes;
   const vertexCount = convertedAttributes.positions.length / VALUES_PER_VERTEX;
@@ -277,7 +279,7 @@ async function _makeNodeResources({
           featureIds,
           faceRange
         },
-        workerSource.draco
+        libraries
       )
     : null;
 
@@ -312,12 +314,14 @@ async function _makeNodeResources({
  * @param materialAndTextureList - array of data about materials and textures of the content
  * @param useCartesianPositions - convert positions to absolute cartesian coordinates instead of cartographic offsets.
  * Cartesian coordinates will be required for creating bounding voulmest from geometry positions
+ * @param featureTexture - feature texture key
  * @returns map of converted geometry attributes
  */
 export async function convertAttributes(
   attributesData: GLTFAttributesData,
   materialAndTextureList: I3SMaterialWithTexture[],
-  useCartesianPositions: boolean
+  useCartesianPositions: boolean,
+  featureTexture: string | null
 ): Promise<Map<string, ConvertedAttributes>> {
   const {nodes, images, cartographicOrigin, cartesianModelMatrix} = attributesData;
   const attributesMap = new Map<string, ConvertedAttributes>();
@@ -345,7 +349,9 @@ export async function convertAttributes(
     cartographicOrigin,
     cartesianModelMatrix,
     attributesMap,
-    useCartesianPositions
+    useCartesianPositions,
+    undefined,
+    featureTexture
   );
 
   for (const attrKey of attributesMap.keys()) {
@@ -379,6 +385,7 @@ export async function convertAttributes(
  * @param useCartesianPositions - convert positions to absolute cartesian coordinates instead of cartographic offsets.
  * Cartesian coordinates will be required for creating bounding voulmest from geometry positions
  * @param matrix - transformation matrix - cumulative transformation matrix formed from all parent node matrices
+ * @param featureTexture - feature texture key
  * @returns {void}
  */
 function convertNodes(
@@ -388,7 +395,8 @@ function convertNodes(
   cartesianModelMatrix: Matrix4,
   attributesMap: Map<string, ConvertedAttributes>,
   useCartesianPositions: boolean,
-  matrix: Matrix4 = new Matrix4([1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1])
+  matrix: Matrix4 = new Matrix4([1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]),
+  featureTexture: string | null
 ) {
   if (nodes) {
     for (const node of nodes) {
@@ -399,7 +407,8 @@ function convertNodes(
         cartesianModelMatrix,
         attributesMap,
         useCartesianPositions,
-        matrix
+        matrix,
+        featureTexture
       );
     }
   }
@@ -441,11 +450,12 @@ function getCompositeTransformationMatrix(node: GLTFNodePostprocessed, matrix: M
  * @param images - gltf images array
  * @param cartographicOrigin - cartographic origin of bounding volume
  * @param cartesianModelMatrix - cartesian model matrix to convert coordinates to cartographic
- * @param {Map} attributesMap Map<{positions: Float32Array, normals: Float32Array, texCoords: Float32Array, colors: Uint8Array, featureIndices: Array}> - for recursive concatenation of
+ * @param attributesMap Map<{positions: Float32Array, normals: Float32Array, texCoords: Float32Array, colors: Uint8Array, featureIndices: Array}> - for recursive concatenation of
  *   attributes
  * @param useCartesianPositions - convert positions to absolute cartesian coordinates instead of cartographic offsets.
  * Cartesian coordinates will be required for creating bounding voulmest from geometry positions
- * @param {Matrix4} matrix - transformation matrix - cumulative transformation matrix formed from all parent node matrices
+ * @param matrix - transformation matrix - cumulative transformation matrix formed from all parent node matrices
+ * @param featureTexture - feature texture key
  */
 function convertNode(
   node: GLTFNodePostprocessed,
@@ -454,7 +464,8 @@ function convertNode(
   cartesianModelMatrix: Matrix4,
   attributesMap: Map<string, ConvertedAttributes>,
   useCartesianPositions,
-  matrix = new Matrix4([1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1])
+  matrix = new Matrix4([1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]),
+  featureTexture: string | null
 ) {
   const transformationMatrix = getCompositeTransformationMatrix(node, matrix);
 
@@ -468,7 +479,8 @@ function convertNode(
       cartesianModelMatrix,
       attributesMap,
       useCartesianPositions,
-      transformationMatrix
+      transformationMatrix,
+      featureTexture
     );
   }
 
@@ -479,7 +491,8 @@ function convertNode(
     cartesianModelMatrix,
     attributesMap,
     useCartesianPositions,
-    transformationMatrix
+    transformationMatrix,
+    featureTexture
   );
 }
 
@@ -491,12 +504,12 @@ function convertNode(
  * @param cartesianModelMatrix - cartesian model matrix to convert coordinates to cartographic
  * @param attributesMap Map<{positions: Float32Array, normals: Float32Array, texCoords: Float32Array, colors: Uint8Array, featureIndices: Array}> - for recursive concatenation of
  *   attributes
- * @param useCartesianPositions - convert positions to absolute cartesian coordinates instead of cartographic offsets. 
+ * @param useCartesianPositions - convert positions to absolute cartesian coordinates instead of cartographic offsets.
  * Cartesian coordinates will be required for creating bounding voulmest from geometry positions
  * @param attributesMap Map<{positions: Float32Array, normals: Float32Array, texCoords: Float32Array, colors: Uint8Array, featureIndices: Array}> - for recursive concatenation of
  *   attributes
- 
- * @param {Matrix4} matrix - transformation matrix - cumulative transformation matrix formed from all parent node matrices
+ * @param matrix - transformation matrix - cumulative transformation matrix formed from all parent node matrices
+ * @param featureTexture - feature texture key
  */
 function convertMesh(
   mesh: GLTFMeshPostprocessed,
@@ -505,7 +518,8 @@ function convertMesh(
   cartesianModelMatrix: Matrix4,
   attributesMap: Map<string, ConvertedAttributes>,
   useCartesianPositions = false,
-  matrix = new Matrix4([1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1])
+  matrix = new Matrix4([1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]),
+  featureTexture: string | null
 ) {
   for (const primitive of mesh.primitives) {
     let outputAttributes: ConvertedAttributes | null | undefined = null;
@@ -576,7 +590,7 @@ function convertMesh(
 
     outputAttributes.featureIndicesGroups = outputAttributes.featureIndicesGroups || [];
     outputAttributes.featureIndicesGroups.push(
-      flattenBatchIds(getBatchIds(attributes, primitive, images), indices)
+      flattenBatchIds(getBatchIds(attributes, primitive, images, featureTexture), indices)
     );
   }
 }
@@ -803,15 +817,23 @@ function flattenBatchIds(batchedIds: NumberArray, indices: TypedArray): number[]
  * @param attributes - gltf accessors
  * @param primitive - gltf primitive data
  * @param images - gltf texture images
+ * @param featureTexture - feature texture key
+ * @return batch IDs
  */
 function getBatchIds(
   attributes: {
     [key: string]: GLTFAccessorPostprocessed;
   },
   primitive: GLTFMeshPrimitivePostprocessed,
-  images: (TextureImageProperties | null)[]
+  images: (TextureImageProperties | null)[],
+  featureTexture: string | null
 ): NumberArray {
-  const batchIds: NumberArray = handleBatchIdsExtensions(attributes, primitive, images);
+  const batchIds: NumberArray = handleBatchIdsExtensions(
+    attributes,
+    primitive,
+    images,
+    featureTexture
+  );
 
   if (batchIds.length) {
     return batchIds;
@@ -1451,17 +1473,17 @@ function generateBigUint64Array(featureIds: any[]): BigUint64Array {
 
 /**
  * Generates draco compressed geometry
- * @param {Number} vertexCount
- * @param {Object} convertedAttributes - get rid of this argument here
- * @param {Object} attributes - geometry attributes to compress
- * @param {string} dracoWorkerSoure - draco worker source code
- * @returns {Promise<object>} - COmpressed geometry.
+ * @param vertexCount
+ * @param convertedAttributes - get rid of this argument here
+ * @param attributes - geometry attributes to compress
+ * @param libraries - dynamicaly loaded 3rd-party libraries
+ * @returns - Compressed geometry.
  */
 async function generateCompressedGeometry(
   vertexCount: number,
   convertedAttributes: Record<string, any>,
   attributes: Record<string, any>,
-  dracoWorkerSoure: string
+  libraries: Record<string, string>
 ): Promise<ArrayBuffer> {
   const {positions, normals, texCoords, colors, uvRegions, featureIds, faceRange} = attributes;
   const indices = new Uint32Array(vertexCount);
@@ -1510,12 +1532,17 @@ async function generateCompressedGeometry(
 
   return encode({attributes: compressedAttributes, indices}, DracoWriterWorker, {
     ...DracoWriterWorker.options,
-    source: dracoWorkerSoure,
     reuseWorkers: true,
     _nodeWorkers: true,
+    modules: libraries,
+    useLocalLibraries: true,
     draco: {
       method: 'MESH_SEQUENTIAL_ENCODING',
       attributesMetadata
+    },
+    ['draco-writer']: {
+      // We need to load local fs workers because nodejs can't load workers from the Internet
+      workerUrl: './modules/draco/dist/draco-writer-worker-node.js'
     }
   });
 }
@@ -1550,9 +1577,13 @@ 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
  */
-export function getPropertyTable(tileContent: Tiles3DTileContent | null): FeatureTableJson | null {
+export function getPropertyTable(
+  tileContent: Tiles3DTileContent | null,
+  metadataClass?: string
+): FeatureTableJson | null {
   if (!tileContent) {
     return null;
   }
@@ -1571,7 +1602,10 @@ export function getPropertyTable(tileContent: Tiles3DTileContent | null): Featur
       return null;
     }
     case EXT_FEATURE_METADATA: {
-      return getPropertyTableFromExtFeatureMetadata(extension as GLTF_EXT_feature_metadata_GLTF);
+      return getPropertyTableFromExtFeatureMetadata(
+        extension as GLTF_EXT_feature_metadata_GLTF,
+        metadataClass
+      );
     }
     default:
       return null;
@@ -1614,10 +1648,11 @@ function getPropertyTableExtension(tileContent: Tiles3DTileContent): {
 
 /**
  * Handle EXT_feature_metadata to get property table
- * @param extension
+ * @param extension - global level of EXT_FEATURE_METADATA extension
  */
 function getPropertyTableFromExtFeatureMetadata(
-  extension: GLTF_EXT_feature_metadata_GLTF
+  extension: GLTF_EXT_feature_metadata_GLTF,
+  metadataClass?: string
 ): FeatureTableJson | null {
   if (extension?.featureTables) {
     /**
@@ -1641,15 +1676,16 @@ function getPropertyTableFromExtFeatureMetadata(
   }
 
   if (extension?.featureTextures) {
-    /**
-     * Take only first feature texture to generate attributes storage info object.
-     * TODO: Think about getting data from all feature textures?
-     * It can be tricky just because 3dTiles is able to have multiple featureTextures.
-     * In I3S we should decide which featureTextures will be passed to geometry data.
-     */
-    const firstTextureName = Object.keys(extension.featureTextures)?.[0];
-    if (firstTextureName) {
-      const featureTable = extension?.featureTextures[firstTextureName];
+    let featureTexture: string | undefined;
+    for (const textureKey in extension.featureTextures) {
+      const texture = extension.featureTextures[textureKey];
+      if (texture.class === metadataClass) {
+        featureTexture = textureKey;
+      }
+    }
+
+    if (typeof featureTexture === 'string') {
+      const featureTable = extension?.featureTextures[featureTexture];
       const propertyTable = {};
 
       for (const propertyName in featureTable.properties) {

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

@@ -1,20 +1,21 @@
 import {Tiles3DTileContent} from '@loaders.gl/3d-tiles';
-import {GltfPrimitiveModeString, PreprocessData} from '../types';
-import {GLTF, GLTFLoader} from '@loaders.gl/gltf';
+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';
 
 /**
  * glTF primitive modes
  * @see https://registry.khronos.org/glTF/specs/2.0/glTF-2.0.html#_mesh_primitive_mode
  */
 export const GLTF_PRIMITIVE_MODES = [
-  GltfPrimitiveModeString.POINTS, // 0
-  GltfPrimitiveModeString.LINES, // 1
-  GltfPrimitiveModeString.LINE_LOOP, // 2
-  GltfPrimitiveModeString.LINE_STRIP, // 3
-  GltfPrimitiveModeString.TRIANGLES, // 4
-  GltfPrimitiveModeString.TRIANGLE_STRIP, // 5
-  GltfPrimitiveModeString.TRIANGLE_FAN // 6
+  GLTFPrimitiveModeString.POINTS, // 0
+  GLTFPrimitiveModeString.LINES, // 1
+  GLTFPrimitiveModeString.LINE_LOOP, // 2
+  GLTFPrimitiveModeString.LINE_STRIP, // 3
+  GLTFPrimitiveModeString.TRIANGLES, // 4
+  GLTFPrimitiveModeString.TRIANGLE_STRIP, // 5
+  GLTFPrimitiveModeString.TRIANGLE_FAN // 6
 ];
 
 /**
@@ -26,11 +27,12 @@ export const GLTF_PRIMITIVE_MODES = [
 export const analyzeTileContent = async (
   tileContent: Tiles3DTileContent | null
 ): Promise<PreprocessData> => {
-  const result: PreprocessData = {
-    meshTopologyTypes: new Set()
+  const defaultResult = {
+    meshTopologyTypes: new Set<GLTFPrimitiveModeString>(),
+    metadataClasses: new Set<string>()
   };
   if (!tileContent?.gltfArrayBuffer) {
-    return result;
+    return defaultResult;
   }
 
   const gltfData = await parse(tileContent.gltfArrayBuffer, GLTFLoader, {
@@ -39,11 +41,14 @@ export const analyzeTileContent = async (
   const gltf = gltfData.json;
 
   if (!gltf) {
-    return result;
+    return defaultResult;
   }
-  const meshTypes = getMeshTypesFromGltf(gltf);
-  result.meshTopologyTypes = meshTypes;
-  return result;
+  const meshTopologyTypes = getMeshTypesFromGltf(gltf);
+  const metadataClasses = getMetadataClassesFromGltf(gltf);
+  return {
+    meshTopologyTypes,
+    metadataClasses
+  };
 };
 
 /**
@@ -51,8 +56,8 @@ export const analyzeTileContent = async (
  * @param gltfJson - JSON part of GLB content
  * @returns array of mesh types found
  */
-const getMeshTypesFromGltf = (gltfJson: GLTF): Set<GltfPrimitiveModeString> => {
-  const result: Set<GltfPrimitiveModeString> = new Set();
+const getMeshTypesFromGltf = (gltfJson: GLTF): Set<GLTFPrimitiveModeString> => {
+  const result: Set<GLTFPrimitiveModeString> = new Set();
   for (const mesh of gltfJson.meshes || []) {
     for (const primitive of mesh.primitives) {
       let {mode} = primitive;
@@ -65,6 +70,26 @@ const getMeshTypesFromGltf = (gltfJson: GLTF): Set<GltfPrimitiveModeString> => {
   return result;
 };
 
+/**
+ * Get feature metadata classes from glTF
+ * @param gltfJson - JSON part of GLB content
+ * @returns array of classes
+ */
+const getMetadataClassesFromGltf = (gltfJson: GLTF): Set<string> => {
+  const result: Set<string> = new Set();
+
+  const classes = (gltfJson.extensions?.[EXT_FEATURE_METADATA] as GLTF_EXT_feature_metadata_GLTF)
+    ?.schema?.classes;
+
+  if (classes) {
+    for (const classKey of Object.keys(classes)) {
+      result.add(classKey);
+    }
+  }
+
+  return result;
+};
+
 /**
  * Merge object2 into object1
  * @param object1
@@ -76,4 +101,9 @@ export const mergePreprocessData = (object1: PreprocessData, object2: Preprocess
   for (const type of object2.meshTopologyTypes) {
     object1.meshTopologyTypes.add(type);
   }
+
+  // Merge feature metadata classes
+  for (const metadataClass of object2.metadataClasses) {
+    object1.metadataClasses.add(metadataClass);
+  }
 };