@loaders.gl/tile-converter 4.2.0-alpha.4 → 4.2.0-alpha.5

package/dist/3d-tiles-converter/helpers/b3dm-converter.js

@@ -10,217 +10,274 @@ const scratchVector = new Vector3();
 const KHR_MATERIALS_UNLIT = 'KHR_materials_unlit';
 const METALLIC_FACTOR_DEFAULT = 1.0;
 const ROUGHNESS_FACTOR_DEFAULT = 1.0;
+/**
+ * Converts content of an I3S node to *.b3dm's file content
+ */
 export default class B3dmConverter {
-  constructor() {
-    this.rtcCenter = void 0;
-    this.i3sTile = void 0;
-  }
-  async convert(i3sAttributesData) {
-    let featureAttributes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : null;
-    const gltf = await this.buildGLTF(i3sAttributesData, featureAttributes);
-    const b3dm = encodeSync({
-      gltfEncoded: new Uint8Array(gltf),
-      type: 'b3dm',
-      featuresLength: this._getFeaturesLength(featureAttributes),
-      batchTable: featureAttributes
-    }, Tile3DWriter);
-    return b3dm;
-  }
-  async buildGLTF(i3sAttributesData, featureAttributes) {
-    const {
-      tileContent,
-      textureFormat,
-      box
-    } = i3sAttributesData;
-    const {
-      material,
-      attributes,
-      indices: originalIndices,
-      modelMatrix
-    } = tileContent;
-    const gltfBuilder = new GLTFScenegraph();
-    const textureIndex = await this._addI3sTextureToGLTF(tileContent, textureFormat, gltfBuilder);
-    const pbrMetallicRoughness = material === null || material === void 0 ? void 0 : 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);
+    /**
+     * The starter of content conversion
+     * @param i3sTile - Tile3D instance for I3S node
+     * @returns - encoded content
+     */
+    async convert(i3sAttributesData, featureAttributes = null) {
+        const gltf = await this.buildGLTF(i3sAttributesData, featureAttributes);
+        const b3dm = encodeSync({
+            gltfEncoded: new Uint8Array(gltf),
+            type: 'b3dm',
+            featuresLength: this._getFeaturesLength(featureAttributes),
+            batchTable: featureAttributes
+        }, Tile3DWriter);
+        return b3dm;
     }
-    const pbrMaterialInfo = this._convertI3sMaterialToGLTFMaterial(material, textureIndex);
-    const materialIndex = gltfBuilder.addMaterial(pbrMaterialInfo);
-    const positions = attributes.positions;
-    const positionsValue = positions.value;
-    if (attributes.uvRegions && attributes.texCoords) {
-      attributes.texCoords.value = convertTextureAtlas(attributes.texCoords.value, attributes.uvRegions.value);
-    }
-    const cartesianOrigin = new Vector3(box);
-    const cartographicOrigin = Ellipsoid.WGS84.cartesianToCartographic(cartesianOrigin, new Vector3());
-    attributes.positions.value = this._normalizePositions(positionsValue, cartesianOrigin, cartographicOrigin, modelMatrix);
-    this._createBatchIds(tileContent, featureAttributes);
-    if (attributes.normals && !this._checkNormals(attributes.normals.value)) {
-      delete attributes.normals;
+    /**
+     * Build and encode gltf
+     * @param i3sTile - Tile3D instance for I3S node
+     * @returns - encoded glb content
+     */
+    async buildGLTF(i3sAttributesData, featureAttributes) {
+        const { tileContent, textureFormat, box } = i3sAttributesData;
+        const { material, attributes, indices: originalIndices, modelMatrix } = tileContent;
+        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);
+        const positions = attributes.positions;
+        const positionsValue = positions.value;
+        if (attributes.uvRegions && attributes.texCoords) {
+            attributes.texCoords.value = convertTextureAtlas(attributes.texCoords.value, attributes.uvRegions.value);
+        }
+        const cartesianOrigin = new Vector3(box);
+        const cartographicOrigin = Ellipsoid.WGS84.cartesianToCartographic(cartesianOrigin, new Vector3());
+        attributes.positions.value = this._normalizePositions(positionsValue, cartesianOrigin, cartographicOrigin, modelMatrix);
+        this._createBatchIds(tileContent, featureAttributes);
+        if (attributes.normals && !this._checkNormals(attributes.normals.value)) {
+            delete attributes.normals;
+        }
+        const indices = originalIndices || generateSyntheticIndices(positionsValue.length / positions.size);
+        const meshIndex = gltfBuilder.addMesh({
+            attributes,
+            indices,
+            material: materialIndex,
+            mode: 4
+        });
+        const transformMatrix = this._generateTransformMatrix(cartesianOrigin);
+        const nodeIndex = gltfBuilder.addNode({ meshIndex, matrix: transformMatrix });
+        const sceneIndex = gltfBuilder.addScene({ nodeIndices: [nodeIndex] });
+        gltfBuilder.setDefaultScene(sceneIndex);
+        gltfBuilder.createBinaryChunk();
+        const gltfBuffer = encodeSync(gltfBuilder.gltf, GLTFWriter);
+        return gltfBuffer;
     }
-    const indices = originalIndices || generateSyntheticIndices(positionsValue.length / positions.size);
-    const meshIndex = gltfBuilder.addMesh({
-      attributes,
-      indices,
-      material: materialIndex,
-      mode: 4
-    });
-    const transformMatrix = this._generateTransformMatrix(cartesianOrigin);
-    const nodeIndex = gltfBuilder.addNode({
-      meshIndex,
-      matrix: transformMatrix
-    });
-    const sceneIndex = gltfBuilder.addScene({
-      nodeIndices: [nodeIndex]
-    });
-    gltfBuilder.setDefaultScene(sceneIndex);
-    gltfBuilder.createBinaryChunk();
-    const gltfBuffer = encodeSync(gltfBuilder.gltf, GLTFWriter);
-    return gltfBuffer;
-  }
-  async _addI3sTextureToGLTF(tileContent, textureFormat, gltfBuilder) {
-    const {
-      texture,
-      material,
-      attributes
-    } = tileContent;
-    let textureIndex = null;
-    let selectedTexture = texture;
-    if (!texture && material) {
-      selectedTexture = material.pbrMetallicRoughness && material.pbrMetallicRoughness.baseColorTexture && material.pbrMetallicRoughness.baseColorTexture.texture.source.image;
+    /**
+     * Update gltfBuilder with texture from I3S tile
+     * @param {object} i3sTile - Tile3D object
+     * @param {GLTFScenegraph} gltfBuilder - gltfScenegraph instance to construct GLTF
+     * @returns {Promise<number | null>} - GLTF texture index
+     */
+    async _addI3sTextureToGLTF(tileContent, textureFormat, gltfBuilder) {
+        const { texture, material, attributes } = tileContent;
+        let textureIndex = null;
+        let selectedTexture = texture;
+        if (!texture && material) {
+            selectedTexture =
+                material.pbrMetallicRoughness &&
+                    material.pbrMetallicRoughness.baseColorTexture &&
+                    material.pbrMetallicRoughness.baseColorTexture.texture.source.image;
+        }
+        if (selectedTexture) {
+            const mimeType = this._deduceMimeTypeFromFormat(textureFormat);
+            const imageIndex = gltfBuilder.addImage(selectedTexture, mimeType);
+            textureIndex = gltfBuilder.addTexture({ imageIndex });
+            delete attributes.colors;
+        }
+        return textureIndex;
     }
-    if (selectedTexture) {
-      const mimeType = this._deduceMimeTypeFromFormat(textureFormat);
-      const imageIndex = gltfBuilder.addImage(selectedTexture, mimeType);
-      textureIndex = gltfBuilder.addTexture({
-        imageIndex
-      });
-      delete attributes.colors;
+    /**
+     * Generate a positions array which is correct for 3DTiles/GLTF format
+     * @param {Float64Array} positionsValue - the input geometry positions array
+     * @param {number[]} cartesianOrigin - the tile center in the cartesian coordinate system
+     * @param {number[]} cartographicOrigin - the tile center in the cartographic coordinate system
+     * @param {number[]} modelMatrix - the model matrix of geometry
+     * @returns {Float32Array} - the output geometry positions array
+     */
+    _normalizePositions(positionsValue, cartesianOrigin, cartographicOrigin, modelMatrix) {
+        const newPositionsValue = new Float32Array(positionsValue.length);
+        for (let index = 0; index < positionsValue.length; index += 3) {
+            const vertex = positionsValue.subarray(index, index + 3);
+            const cartesianOriginVector = new Vector3(cartesianOrigin);
+            let vertexVector = new Vector3(Array.from(vertex))
+                .transform(modelMatrix)
+                .add(cartographicOrigin);
+            Ellipsoid.WGS84.cartographicToCartesian(vertexVector, scratchVector);
+            vertexVector = scratchVector.subtract(cartesianOriginVector);
+            newPositionsValue.set(vertexVector, index);
+        }
+        return newPositionsValue;
     }
-    return textureIndex;
-  }
-  _normalizePositions(positionsValue, cartesianOrigin, cartographicOrigin, modelMatrix) {
-    const newPositionsValue = new Float32Array(positionsValue.length);
-    for (let index = 0; index < positionsValue.length; index += 3) {
-      const vertex = positionsValue.subarray(index, index + 3);
-      const cartesianOriginVector = new Vector3(cartesianOrigin);
-      let vertexVector = new Vector3(Array.from(vertex)).transform(modelMatrix).add(cartographicOrigin);
-      Ellipsoid.WGS84.cartographicToCartesian(vertexVector, scratchVector);
-      vertexVector = scratchVector.subtract(cartesianOriginVector);
-      newPositionsValue.set(vertexVector, index);
+    /**
+     * Generate the transformation matrix for GLTF node:
+     * https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#reference-node
+     * 1. Create the translate transformation from cartesianOrigin (the positions array stores offsets from this cartesianOrigin)
+     * 2. Create the rotation transformation to rotate model from z-up coordinates (I3S specific) to y-up coordinates (GLTF specific)
+     * @param {number[]} cartesianOrigin - the tile center in the cartesian coordinate system
+     * @returns {Matrix4} - an array of 16 numbers (4x4 matrix)
+     */
+    _generateTransformMatrix(cartesianOrigin) {
+        const translateOriginMatrix = new Matrix4().translate(cartesianOrigin);
+        const result = translateOriginMatrix.multiplyLeft(Z_UP_TO_Y_UP_MATRIX);
+        return result;
     }
-    return newPositionsValue;
-  }
-  _generateTransformMatrix(cartesianOrigin) {
-    const translateOriginMatrix = new Matrix4().translate(cartesianOrigin);
-    const result = translateOriginMatrix.multiplyLeft(Z_UP_TO_Y_UP_MATRIX);
-    return result;
-  }
-  _createBatchIds(i3sContent, featureAttributes) {
-    const {
-      featureIds
-    } = i3sContent;
-    const {
-      OBJECTID: objectIds
-    } = featureAttributes || {};
-    if (!featureIds || !objectIds) {
-      return;
+    /**
+     * Create _BATCHID attribute
+     * @param {Object} i3sContent - the source object
+     * @returns {void}
+     */
+    _createBatchIds(i3sContent, featureAttributes) {
+        const { featureIds } = i3sContent;
+        const { OBJECTID: objectIds } = featureAttributes || {};
+        if (!featureIds || !objectIds) {
+            return;
+        }
+        for (let i = 0; i < featureIds.length; i++) {
+            const featureId = featureIds[i];
+            const batchId = objectIds.indexOf(featureId);
+            featureIds[i] = batchId;
+        }
+        i3sContent.attributes._BATCHID = {
+            size: 1,
+            byteOffset: 0,
+            value: featureIds
+        };
     }
-    for (let i = 0; i < featureIds.length; i++) {
-      const featureId = featureIds[i];
-      const batchId = objectIds.indexOf(featureId);
-      featureIds[i] = batchId;
+    /**
+     * Deduce mime type by format from `textureSetDefinition.formats[0].format`
+     * https://github.com/Esri/i3s-spec/blob/master/docs/1.7/textureSetDefinitionFormat.cmn.md
+     * @param {string} format - format name
+     * @returns {string} mime type.
+     */
+    _deduceMimeTypeFromFormat(format) {
+        switch (format) {
+            case 'jpg':
+                return 'image/jpeg';
+            case 'png':
+                return 'image/png';
+            case 'ktx2':
+                return 'image/ktx2';
+            default:
+                console.warn(`Unexpected texture format in I3S: ${format}`); // eslint-disable-line no-console, no-undef
+                return 'image/jpeg';
+        }
     }
-    i3sContent.attributes._BATCHID = {
-      size: 1,
-      byteOffset: 0,
-      value: featureIds
-    };
-  }
-  _deduceMimeTypeFromFormat(format) {
-    switch (format) {
-      case 'jpg':
-        return 'image/jpeg';
-      case 'png':
-        return 'image/png';
-      case 'ktx2':
-        return 'image/ktx2';
-      default:
-        console.warn(`Unexpected texture format in I3S: ${format}`);
-        return 'image/jpeg';
+    /**
+     * Convert i3s material to GLTF compatible material
+     * @param {object} material - i3s material definition
+     * @param {number | null} textureIndex - texture index in GLTF
+     * @returns {object} GLTF material
+     */
+    _convertI3sMaterialToGLTFMaterial(material, textureIndex) {
+        const isTextureIndexExists = textureIndex !== null;
+        if (!material) {
+            material = {
+                alphaMode: 'OPAQUE',
+                doubleSided: false,
+                pbrMetallicRoughness: {
+                    metallicFactor: 0,
+                    roughnessFactor: 1
+                }
+            };
+            if (isTextureIndexExists) {
+                material.pbrMetallicRoughness.baseColorTexture = {
+                    index: textureIndex,
+                    texCoord: 0
+                };
+            }
+            else {
+                material.pbrMetallicRoughness.baseColorFactor = [1, 1, 1, 1];
+            }
+            return material;
+        }
+        if (textureIndex !== null) {
+            material = this._setGLTFTexture(material, textureIndex);
+        }
+        return material;
     }
-  }
-  _convertI3sMaterialToGLTFMaterial(material, textureIndex) {
-    const isTextureIndexExists = textureIndex !== null;
-    if (!material) {
-      material = {
-        alphaMode: 'OPAQUE',
-        doubleSided: false,
-        pbrMetallicRoughness: {
-          metallicFactor: 0,
-          roughnessFactor: 1
-        }
-      };
-      if (isTextureIndexExists) {
-        material.pbrMetallicRoughness.baseColorTexture = {
-          index: textureIndex,
-          texCoord: 0
+    /**
+     * Set texture properties in material with GLTF textureIndex
+     * @param {object} materialDefinition - i3s material definition
+     * @param {number} textureIndex - texture index in GLTF
+     * @returns {void}
+     */
+    _setGLTFTexture(materialDefinition, textureIndex) {
+        const material = {
+            ...materialDefinition,
+            pbrMetallicRoughness: { ...materialDefinition.pbrMetallicRoughness }
         };
-      } else {
-        material.pbrMetallicRoughness.baseColorFactor = [1, 1, 1, 1];
-      }
-      return material;
-    }
-    if (textureIndex !== null) {
-      material = this._setGLTFTexture(material, textureIndex);
+        // I3SLoader now support loading only one texture. This elseif sequence will assign this texture to one of
+        // properties defined in materialDefinition
+        if (materialDefinition.pbrMetallicRoughness &&
+            materialDefinition.pbrMetallicRoughness.baseColorTexture) {
+            material.pbrMetallicRoughness.baseColorTexture = {
+                index: textureIndex,
+                texCoord: 0
+            };
+        }
+        else if (materialDefinition.emissiveTexture) {
+            material.emissiveTexture = {
+                index: textureIndex,
+                texCoord: 0
+            };
+        }
+        else if (materialDefinition.pbrMetallicRoughness &&
+            materialDefinition.pbrMetallicRoughness.metallicRoughnessTexture) {
+            material.pbrMetallicRoughness.metallicRoughnessTexture = {
+                index: textureIndex,
+                texCoord: 0
+            };
+        }
+        else if (materialDefinition.normalTexture) {
+            material.normalTexture = {
+                index: textureIndex,
+                texCoord: 0
+            };
+        }
+        else if (materialDefinition.occlusionTexture) {
+            material.occlusionTexture = {
+                index: textureIndex,
+                texCoord: 0
+            };
+        }
+        return material;
     }
-    return material;
-  }
-  _setGLTFTexture(materialDefinition, textureIndex) {
-    const material = {
-      ...materialDefinition,
-      pbrMetallicRoughness: {
-        ...materialDefinition.pbrMetallicRoughness
-      }
-    };
-    if (materialDefinition.pbrMetallicRoughness && materialDefinition.pbrMetallicRoughness.baseColorTexture) {
-      material.pbrMetallicRoughness.baseColorTexture = {
-        index: textureIndex,
-        texCoord: 0
-      };
-    } else if (materialDefinition.emissiveTexture) {
-      material.emissiveTexture = {
-        index: textureIndex,
-        texCoord: 0
-      };
-    } else if (materialDefinition.pbrMetallicRoughness && materialDefinition.pbrMetallicRoughness.metallicRoughnessTexture) {
-      material.pbrMetallicRoughness.metallicRoughnessTexture = {
-        index: textureIndex,
-        texCoord: 0
-      };
-    } else if (materialDefinition.normalTexture) {
-      material.normalTexture = {
-        index: textureIndex,
-        texCoord: 0
-      };
-    } else if (materialDefinition.occlusionTexture) {
-      material.occlusionTexture = {
-        index: textureIndex,
-        texCoord: 0
-      };
+    /*
+     * Returns Features length based on attribute array in attribute object.
+     * @param {Object} attributes
+     * @returns {Number} Features length .
+     */
+    _getFeaturesLength(attributes) {
+        if (!attributes) {
+            return 0;
+        }
+        const firstKey = Object.keys(attributes)[0];
+        return firstKey ? attributes[firstKey].length : 0;
     }
-    return material;
-  }
-  _getFeaturesLength(attributes) {
-    if (!attributes) {
-      return 0;
+    /* Checks that normals buffer is correct
+     * @param {TypedArray} normals
+     * @returns {boolean} true - normals are correct; false - normals are incorrect
+     */
+    _checkNormals(normals) {
+        // If all normals === 0, the resulting tileset is all in black colors on Cesium
+        return normals.find((value) => value);
     }
-    const firstKey = Object.keys(attributes)[0];
-    return firstKey ? attributes[firstKey].length : 0;
-  }
-  _checkNormals(normals) {
-    return normals.find(value => value);
-  }
 }
-//# sourceMappingURL=b3dm-converter.js.map

package/dist/3d-tiles-converter/helpers/i3s-obb-to-3d-tiles-obb.js

@@ -1,10 +1,19 @@
 import { Vector3 } from '@math.gl/core';
 import { Ellipsoid } from '@math.gl/geospatial';
 import { OrientedBoundingBox } from '@math.gl/culling';
+/**
+ * Convert quaternion-based OBB to half-axes-based OBB
+ * @param i3SObb quaternion based OBB
+ * @param geoidHeightModel the Earth Gravity Model instance
+ * @returns number[12] 3DTiles OBB https://github.com/CesiumGS/3d-tiles/tree/master/specification#box
+ */
 export function i3sObbTo3dTilesObb(i3SObb, geoidHeightModel) {
-  const tiles3DCenter = [i3SObb.center[0], i3SObb.center[1], i3SObb.center[2] + geoidHeightModel.getHeight(i3SObb.center[1], i3SObb.center[0])];
-  const cartesianCenter = Ellipsoid.WGS84.cartographicToCartesian(tiles3DCenter, new Vector3());
-  const tiles3DObb = new OrientedBoundingBox().fromCenterHalfSizeQuaternion(cartesianCenter, i3SObb.halfSize, i3SObb.quaternion);
-  return [...tiles3DObb.center, ...tiles3DObb.halfAxes.toArray()];
+    const tiles3DCenter = [
+        i3SObb.center[0],
+        i3SObb.center[1],
+        i3SObb.center[2] + geoidHeightModel.getHeight(i3SObb.center[1], i3SObb.center[0])
+    ];
+    const cartesianCenter = Ellipsoid.WGS84.cartographicToCartesian(tiles3DCenter, new Vector3());
+    const tiles3DObb = new OrientedBoundingBox().fromCenterHalfSizeQuaternion(cartesianCenter, i3SObb.halfSize, i3SObb.quaternion);
+    return [...tiles3DObb.center, ...tiles3DObb.halfAxes.toArray()];
 }
-//# sourceMappingURL=i3s-obb-to-3d-tiles-obb.js.map