@loaders.gl/tile-converter 3.1.7 → 3.2.0-alpha.2

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

@@ -0,0 +1,278 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@loaders.gl/core");
+const gltf_1 = require("@loaders.gl/gltf");
+const _3d_tiles_1 = require("@loaders.gl/3d-tiles");
+const core_2 = require("@math.gl/core");
+const geospatial_1 = require("@math.gl/geospatial");
+const texture_atlas_1 = require("./texture-atlas");
+const Z_UP_TO_Y_UP_MATRIX = new core_2.Matrix4([1, 0, 0, 0, 0, 0, -1, 0, 0, 1, 0, 0, 0, 0, 0, 1]);
+const scratchVector = new core_2.Vector3();
+/**
+ * Converts content of an I3S node to *.b3dm's file content
+ */
+class B3dmConverter {
+    /**
+     * 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);
+        const b3dm = (0, core_1.encodeSync)({
+            gltfEncoded: new Uint8Array(gltf),
+            type: 'b3dm',
+            featuresLength: this._getFeaturesLength(featureAttributes),
+            batchTable: featureAttributes
+        }, _3d_tiles_1.Tile3DWriter);
+        return b3dm;
+    }
+    /**
+     * Build and encode gltf
+     * @param i3sTile - Tile3D instance for I3S node
+     * @returns - encoded glb content
+     */
+    async buildGltf(i3sAttributesData) {
+        const { tileContent, textureFormat } = i3sAttributesData;
+        const { material, attributes, indices: originalIndices, cartesianOrigin, cartographicOrigin, modelMatrix } = tileContent;
+        const gltfBuilder = new gltf_1.GLTFScenegraph();
+        const textureIndex = await this._addI3sTextureToGltf(tileContent, textureFormat, gltfBuilder);
+        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 = (0, texture_atlas_1.convertTextureAtlas)(attributes.texCoords.value, attributes.uvRegions.value);
+        }
+        attributes.positions.value = this._normalizePositions(positionsValue, cartesianOrigin, cartographicOrigin, modelMatrix);
+        if (attributes.normals && !this._checkNormals(attributes.normals.value)) {
+            delete attributes.normals;
+        }
+        const indices = originalIndices || this._generateSynteticIndices(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 = (0, core_1.encodeSync)(gltfBuilder.gltf, gltf_1.GLTFWriter);
+        return gltfBuffer;
+    }
+    /**
+     * 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;
+    }
+    /**
+     * 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 core_2.Vector3(cartesianOrigin);
+            let vertexVector = new core_2.Vector3(Array.from(vertex))
+                .transform(modelMatrix)
+                .add(cartographicOrigin);
+            geospatial_1.Ellipsoid.WGS84.cartographicToCartesian(vertexVector, scratchVector);
+            vertexVector = scratchVector.subtract(cartesianOriginVector);
+            newPositionsValue.set(vertexVector, index);
+        }
+        return newPositionsValue;
+    }
+    /**
+     * 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 core_2.Matrix4().translate(cartesianOrigin);
+        const result = translateOriginMatrix.multiplyLeft(Z_UP_TO_Y_UP_MATRIX);
+        return result;
+    }
+    /**
+     * Generate batchId attribute from faceRanges.
+     * @param {Uint32Array} faceRanges - the source array
+     * @returns {Float32Array} batchId list.
+     */
+    _generateBatchId(faceRanges) {
+        const batchIdArraySize = (faceRanges[faceRanges.length - 1] + 1) * 3;
+        const batchId = new Float32Array(batchIdArraySize);
+        let rangeIndex = 0;
+        let currentBatchId = 0;
+        for (let index = 0; index < faceRanges.length / 2; index++) {
+            const fromIndex = faceRanges[rangeIndex] * 3;
+            const untilPosition = (faceRanges[rangeIndex + 1] + 1) * 3;
+            batchId.fill(currentBatchId, fromIndex, untilPosition);
+            rangeIndex += 2;
+            currentBatchId += 1;
+        }
+        return batchId;
+    }
+    /**
+     * luma.gl can not work without indices now:
+     * https://github.com/visgl/luma.gl/blob/d8cad75b9f8ca3e578cf078ed9d19e619c2ddbc9/modules/experimental/src/gltf/gltf-instantiator.js#L115
+     * This method generates syntetic indices array: [0, 1, 2, 3, .... , vertexCount-1]
+     * @param {number} vertexCount - vertex count in the geometry
+     * @returns {Uint32Array} indices array.
+     */
+    _generateSynteticIndices(vertexCount) {
+        const result = new Uint32Array(vertexCount);
+        for (let index = 0; index < vertexCount; index++) {
+            result.set([index], index);
+        }
+        return result;
+    }
+    /**
+     * 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';
+        }
+    }
+    /**
+     * 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;
+    }
+    /**
+     * 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 }
+        };
+        // 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;
+    }
+    /*
+     * 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;
+    }
+    /* 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);
+    }
+}
+exports.default = B3dmConverter;

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

@@ -0,0 +1,13 @@
+import { GeoidHeightModel } from '@loaders.gl/tile-converter/lib/geoid-height-model';
+/**
+ * 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 declare function i3sObbTo3dTilesObb(i3SObb: {
+    center: number[];
+    halfSize: number[];
+    quaternion: number[];
+}, geoidHeightModel: GeoidHeightModel): number[];
+//# sourceMappingURL=i3s-obb-to-3d-tiles-obb.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"i3s-obb-to-3d-tiles-obb.d.ts","sourceRoot":"","sources":["../../../src/3d-tiles-converter/helpers/i3s-obb-to-3d-tiles-obb.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,gBAAgB,EAAC,MAAM,mDAAmD,CAAC;AAEnF;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE;IACN,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB,EACD,gBAAgB,EAAE,gBAAgB,GACjC,MAAM,EAAE,CAaV"}

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

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.i3sObbTo3dTilesObb = void 0;
+const core_1 = require("@math.gl/core");
+const geospatial_1 = require("@math.gl/geospatial");
+const culling_1 = require("@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
+ */
+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 = geospatial_1.Ellipsoid.WGS84.cartographicToCartesian(tiles3DCenter, new core_1.Vector3());
+    const tiles3DObb = new culling_1.OrientedBoundingBox().fromCenterHalfSizeQuaternion(cartesianCenter, i3SObb.halfSize, i3SObb.quaternion);
+    return [...tiles3DObb.center, ...tiles3DObb.halfAxes.toArray()];
+}
+exports.i3sObbTo3dTilesObb = i3sObbTo3dTilesObb;

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

@@ -0,0 +1,9 @@
+/**
+ * Apply uvRegions to texture coordinates.
+ * Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.7/geometryUVRegion.cmn.md
+ * Shader formula vec2 uv = fract(texCoords) * (uvRegions.zw - uvRegions.xy) + uvRegions.xy;
+ * @param texCoords
+ * @param uvRegions
+ */
+export declare function convertTextureAtlas(texCoords: Float32Array, uvRegions: Uint16Array): Float32Array;
+//# sourceMappingURL=texture-atlas.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"texture-atlas.d.ts","sourceRoot":"","sources":["../../../src/3d-tiles-converter/helpers/texture-atlas.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,GAAG,YAAY,CAwBjG"}

package/dist/3d-tiles-converter/helpers/texture-atlas.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertTextureAtlas = void 0;
+/**
+ * Apply uvRegions to texture coordinates.
+ * Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.7/geometryUVRegion.cmn.md
+ * Shader formula vec2 uv = fract(texCoords) * (uvRegions.zw - uvRegions.xy) + uvRegions.xy;
+ * @param texCoords
+ * @param uvRegions
+ */
+function convertTextureAtlas(texCoords, uvRegions) {
+    const convertedTexCoords = new Float32Array(texCoords.length);
+    const normalisedRegions = normalizeRegions(uvRegions);
+    for (let index = 0; index < texCoords.length; index += 2) {
+        const uv = texCoords.subarray(index, index + 2);
+        const regions = normalisedRegions.slice(index * 2, index * 2 + 4);
+        // fract(texCoords)
+        const fractatedUV = fract([uv[0], uv[1]]);
+        // (uvRegions.zw - uvRegions.xy)
+        const subtracted = [regions[2] - regions[0], regions[3] - regions[1]];
+        // fract(texCoords) * (uvRegions.zw - uvRegions.xy)
+        const multiplicationResult = [fractatedUV[0] * subtracted[0], fractatedUV[1] * subtracted[1]];
+        // fract(texCoords) * (uvRegions.zw - uvRegions.xy) + uvRegions.xy;
+        const convertedUV = [
+            multiplicationResult[0] + regions[0],
+            multiplicationResult[1] + regions[1]
+        ];
+        convertedTexCoords[index] = convertedUV[0];
+        convertedTexCoords[index + 1] = convertedUV[1];
+    }
+    return convertedTexCoords;
+}
+exports.convertTextureAtlas = convertTextureAtlas;
+/**
+ * Do fractation of UV array.
+ * @param uv
+ */
+function fract(uv) {
+    return [uv[0] - Math.floor(uv[0]), uv[1] - Math.floor(uv[1])];
+}
+/**
+ * Normalize uvRegions by dividing by the maximum Uint16 value
+ * @param regions
+ */
+function normalizeRegions(regions) {
+    const MAX_UINT_16_VALUE = 65535;
+    const normalizedRegions = [];
+    for (let index = 0; index < regions.length; index++) {
+        normalizedRegions[index] = regions[index] / MAX_UINT_16_VALUE;
+    }
+    return normalizedRegions;
+}

package/dist/3d-tiles-converter/json-templates/tileset.d.ts

@@ -0,0 +1,15 @@
+export declare const TILESET: () => {
+    asset: {
+        path: string;
+        transform: (val: any) => any;
+    };
+    geometricError: {
+        path: string;
+        transform: (val: any) => any;
+    };
+    root: {
+        path: string;
+        transform: (val: any) => any;
+    };
+};
+//# sourceMappingURL=tileset.d.ts.map

package/dist/3d-tiles-converter/json-templates/tileset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tileset.d.ts","sourceRoot":"","sources":["../../../src/3d-tiles-converter/json-templates/tileset.ts"],"names":[],"mappings":"AAyBA,eAAO,MAAM,OAAO;;;;;;;;;;;;;CAalB,CAAC"}

package/dist/3d-tiles-converter/json-templates/tileset.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TILESET = void 0;
+const json_map_transform_1 = __importDefault(require("json-map-transform"));
+const ASSET = () => ({
+    version: {
+        path: 'version',
+        default: '1.0'
+    }
+});
+const TILE = () => ({
+    boundingVolume: {
+        path: 'boundingVolume'
+    },
+    geometricError: {
+        path: 'geometricError'
+    },
+    content: {
+        path: 'content'
+    },
+    children: {
+        path: 'children',
+        transform: (val) => val.map((tile) => (0, json_map_transform_1.default)(tile, TILE()))
+    }
+});
+const TILESET = () => ({
+    asset: {
+        path: 'asset',
+        transform: (val) => (0, json_map_transform_1.default)(val, ASSET())
+    },
+    geometricError: {
+        path: 'root',
+        transform: (val) => val.geometricError
+    },
+    root: {
+        path: 'root',
+        transform: (val) => (0, json_map_transform_1.default)(val, TILE())
+    }
+});
+exports.TILESET = TILESET;

package/dist/bundle.d.ts

@@ -0,0 +1,2 @@
+declare const moduleExports: any;
+//# sourceMappingURL=bundle.d.ts.map

package/dist/bundle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bundle.d.ts","sourceRoot":"","sources":["../src/bundle.ts"],"names":[],"mappings":"AACA,QAAA,MAAM,aAAa,KAAqB,CAAC"}

package/dist/bundle.js

@@ -0,0 +1,5 @@
+"use strict";
+// @ts-nocheck
+const moduleExports = require('./index');
+globalThis.loaders = globalThis.loaders || {};
+module.exports = Object.assign(globalThis.loaders, moduleExports);