@loaders.gl/tile-converter 4.4.0-alpha.2 → 4.4.0-alpha.9

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

@@ -1,388 +0,0 @@
-import { join } from 'path';
-import process from 'process';
-import transform from 'json-map-transform';
-import { load, isBrowser } from '@loaders.gl/core';
-import { I3SLoader, I3SAttributeLoader, COORDINATE_SYSTEM } from '@loaders.gl/i3s';
-import { PGMLoader } from "../pgm-loader.js";
-import { i3sObbTo3dTilesObb } from "./helpers/i3s-obb-to-3d-tiles-obb.js";
-import { convertScreenThresholdToGeometricError } from "../lib/utils/lod-conversion-utils.js";
-import { writeFile, removeDir } from "../lib/utils/file-utils.js";
-import { calculateDatasetSize, timeConverter } from "../lib/utils/statistic-utils.js";
-import { TILESET as tilesetTemplate } from "./json-templates/tileset.js";
-import { createObbFromMbs } from "../i3s-converter/helpers/coordinate-converter.js";
-import { WorkerFarm } from '@loaders.gl/worker-utils';
-import { BROWSER_ERROR_MESSAGE } from "../constants.js";
-import { Tiles3DContentConverter } from "./helpers/3d-tiles-content-converter.js";
-import { getNodeCount, loadFromArchive, loadI3SContent, openSLPK } from "./helpers/load-i3s.js";
-import { ConversionDump } from "../lib/utils/conversion-dump.js";
-import { Progress } from "../i3s-converter/helpers/progress.js";
-const I3S = 'I3S';
-/**
- * Converter from i3s to 3d-tiles
- */
-export default class Tiles3DConverter {
-    options;
-    tilesetPath;
-    vertexCounter;
-    conversionStartTime;
-    geoidHeightModel;
-    sourceTileset;
-    attributeStorageInfo;
-    workerSource = {};
-    slpkFilesystem = null;
-    loaderOptions = {
-        _nodeWorkers: true,
-        reuseWorkers: true,
-        // TODO: converter freezes in the end because of i3s-content-worker
-        worker: false,
-        i3s: { coordinateSystem: COORDINATE_SYSTEM.LNGLAT_OFFSETS, decodeTextures: false },
-        // We need to load local fs workers because nodejs can't load workers from the Internet
-        'i3s-content': {
-            workerUrl: './modules/i3s/dist/i3s-content-worker-node.js'
-        }
-    };
-    conversionDump;
-    progress;
-    fileExt;
-    constructor() {
-        this.options = {};
-        this.tilesetPath = '';
-        this.vertexCounter = 0;
-        this.conversionStartTime = [0, 0];
-        this.geoidHeightModel = null;
-        this.sourceTileset = null;
-        this.attributeStorageInfo = null;
-        this.workerSource = {};
-        this.conversionDump = new ConversionDump();
-        this.progress = new Progress();
-        this.fileExt = '';
-    }
-    /**
-     * Convert i3s format data to 3dTiles
-     * @param options
-     * @param options.inputUrl the url to read the tileset from
-     * @param options.outputPath the output filename
-     * @param options.outputVersion the version of 3DTiles
-     * @param options.tilesetName the output name of the tileset
-     * @param options.egmFilePath location of *.pgm file to convert heights from ellipsoidal to gravity-related format
-     * @param options.maxDepth The max tree depth of conversion
-     */
-    // eslint-disable-next-line complexity, max-statements
-    async convert(options) {
-        if (isBrowser) {
-            console.log(BROWSER_ERROR_MESSAGE); // eslint-disable-line no-console
-            return BROWSER_ERROR_MESSAGE;
-        }
-        const { inputUrl, outputPath, outputVersion, tilesetName, maxDepth, egmFilePath, inquirer, analyze } = options;
-        this.conversionStartTime = process.hrtime();
-        this.options = { maxDepth, inquirer, outputVersion };
-        this.fileExt = this.options.outputVersion === '1.0' ? 'b3dm' : 'glb';
-        console.log('Loading egm file...'); // eslint-disable-line
-        this.geoidHeightModel = await load(egmFilePath, PGMLoader);
-        console.log('Loading egm file completed!'); // eslint-disable-line
-        this.slpkFilesystem = await openSLPK(inputUrl);
-        let preprocessResult = true;
-        if (analyze || this.slpkFilesystem) {
-            preprocessResult = await this.preprocessConversion();
-            if (!preprocessResult || analyze) {
-                return undefined;
-            }
-        }
-        this.progress.startMonitoring();
-        this.sourceTileset = await loadFromArchive(inputUrl, I3SLoader, {
-            ...this.loaderOptions,
-            // @ts-expect-error `isTileset` can be boolean of 'auto' but TS expects a string
-            i3s: { ...this.loaderOptions.i3s, isTileset: true }
-        }, this.slpkFilesystem);
-        if (!this.sourceTileset) {
-            return undefined;
-        }
-        const rootNode = this.sourceTileset?.root;
-        if (!rootNode.obb) {
-            rootNode.obb = createObbFromMbs(rootNode.mbs);
-        }
-        this.tilesetPath = join(`${outputPath}`, `${tilesetName}`);
-        this.attributeStorageInfo = this.sourceTileset.attributeStorageInfo;
-        await this.conversionDump.createDump(options);
-        if (this.conversionDump.restored && this.options.inquirer) {
-            const result = await this.options.inquirer.prompt([
-                {
-                    name: 'resumeConversion',
-                    type: 'confirm',
-                    message: 'Dump file of the previous conversion exists, do you want to resume that conversion?'
-                }
-            ]);
-            if (!result.resumeConversion) {
-                this.conversionDump.reset();
-            }
-        }
-        // Removing the tilesetPath needed to exclude erroneous files after conversion
-        if (!this.conversionDump.restored) {
-            try {
-                await removeDir(this.tilesetPath);
-            }
-            catch (e) {
-                // do nothing
-            }
-        }
-        const rootTile = {
-            boundingVolume: {
-                box: i3sObbTo3dTilesObb(rootNode.obb, this.geoidHeightModel)
-            },
-            geometricError: convertScreenThresholdToGeometricError(rootNode),
-            children: [],
-            refine: 'REPLACE'
-        };
-        await this._addChildren(rootNode, rootTile, 1);
-        const tileset = transform({ asset: { version: outputVersion }, root: rootTile }, tilesetTemplate());
-        await writeFile(this.tilesetPath, JSON.stringify(tileset), 'tileset.json');
-        await this.conversionDump.deleteDumpFile();
-        this.progress.stopMonitoring();
-        await this._finishConversion({ slpk: false, outputPath, tilesetName });
-        if (this.slpkFilesystem) {
-            this.slpkFilesystem.destroy();
-        }
-        // Clean up worker pools
-        const workerFarm = WorkerFarm.getWorkerFarm({});
-        workerFarm.destroy();
-        return undefined;
-    }
-    /**
-     * Preprocess stage of the tile converter. Calculate number of nodes
-     * @returns true - the conversion is possible, false - the tileset's content is not supported
-     */
-    async preprocessConversion() {
-        // eslint-disable-next-line no-console
-        console.log('Analyze source layer');
-        const nodesCount = await getNodeCount(this.slpkFilesystem);
-        this.progress.stepsTotal = nodesCount;
-        // eslint-disable-next-line no-console
-        console.log('------------------------------------------------');
-        // eslint-disable-next-line no-console
-        console.log('Preprocess results:');
-        if (this.slpkFilesystem) {
-            // eslint-disable-next-line no-console
-            console.log(`Node count: ${nodesCount}`);
-            if (nodesCount === 0) {
-                // eslint-disable-next-line no-console
-                console.log('Node count is 0. The conversion will be interrupted.');
-                // eslint-disable-next-line no-console
-                console.log('------------------------------------------------');
-                return false;
-            }
-        }
-        else {
-            // eslint-disable-next-line no-console
-            console.log('Node count cannot be calculated for the remote dataset');
-        }
-        // eslint-disable-next-line no-console
-        console.log('------------------------------------------------');
-        return true;
-    }
-    /**
-     * Convert particular I3S Node
-     * @param parentSourceNode the parent node tile object (@loaders.gl/tiles/Tile3D)
-     * @param parentNode object in resulting tileset
-     * @param level a current level of a tree depth
-     * @param childNodeInfo child node to convert
-     */
-    // eslint-disable-next-line complexity, max-statements
-    async convertChildNode(parentSourceNode, parentNode, level, childNodeInfo) {
-        let nextParentNode = parentNode;
-        const sourceChild = await this._loadChildNode(parentSourceNode, childNodeInfo);
-        if (sourceChild.contentUrl) {
-            if (this.conversionDump.restored &&
-                this.conversionDump.isFileConversionComplete(`${sourceChild.id}.${this.fileExt}`) &&
-                (sourceChild.obb || sourceChild.mbs)) {
-                const { child } = this._createChildAndBoundingVolume(sourceChild);
-                parentNode.children.push(child);
-                await this._addChildren(sourceChild, child, level + 1);
-                return;
-            }
-            const content = await loadI3SContent(this.sourceTileset, sourceChild, this.loaderOptions, this.slpkFilesystem);
-            if (!content) {
-                await this._addChildren(sourceChild, parentNode, level + 1);
-                return;
-            }
-            this.vertexCounter += content?.vertexCount || 0;
-            let featureAttributes = null;
-            if (this.attributeStorageInfo) {
-                featureAttributes = await this._loadChildAttributes(sourceChild, this.attributeStorageInfo);
-            }
-            const { child, boundingVolume } = this._createChildAndBoundingVolume(sourceChild);
-            const i3sAttributesData = {
-                tileContent: content,
-                box: boundingVolume.box || [],
-                textureFormat: sourceChild.textureFormat
-            };
-            const converter = new Tiles3DContentConverter({ outputVersion: this.options.outputVersion });
-            const contentData = await converter.convert(i3sAttributesData, featureAttributes, this.attributeStorageInfo);
-            await this.conversionDump.addNode(`${sourceChild.id}.${this.fileExt}`, sourceChild.id);
-            await writeFile(this.tilesetPath, new Uint8Array(contentData), `${sourceChild.id}.${this.fileExt}`);
-            await this.conversionDump.updateConvertedNodesDumpFile(`${sourceChild.id}.${this.fileExt}`, sourceChild.id, true);
-            parentNode.children.push(child);
-            nextParentNode = child;
-        }
-        this.progress.stepsDone += 1;
-        let timeRemainingString = 'Calculating time left...';
-        const timeRemaining = this.progress.getTimeRemainingString();
-        if (timeRemaining) {
-            timeRemainingString = `${timeRemaining} left`;
-        }
-        const percentString = this.progress.getPercentString();
-        const progressString = percentString ? ` ${percentString}%, ${timeRemainingString}` : '';
-        console.log(`[converted${progressString}]: ${childNodeInfo.id}`); // eslint-disable-line
-        await this._addChildren(sourceChild, nextParentNode, level + 1);
-    }
-    /**
-     * The recursive function of traversal of a nodes tree
-     * @param parentSourceNode the parent node tile object (@loaders.gl/tiles/Tile3D)
-     * @param parentNode object in resulting tileset
-     * @param level a current level of a tree depth
-     */
-    async _addChildren(parentSourceNode, parentNode, level) {
-        if (this.options.maxDepth && level > this.options.maxDepth) {
-            return;
-        }
-        for (const childNodeInfo of parentSourceNode.children || []) {
-            await this.convertChildNode(parentSourceNode, parentNode, level, childNodeInfo);
-        }
-    }
-    /**
-     * Load a child node having information from the node header
-     * @param parentNode a parent node tile object (@loaders.gl/tiles/Tile3D)
-     * @param childNodeInfo child information from 3DNodeIndexDocument
-     *   (https://github.com/Esri/i3s-spec/blob/master/docs/1.7/nodeReference.cmn.md)
-     */
-    async _loadChildNode(parentNode, childNodeInfo) {
-        let header;
-        if (this.sourceTileset?.nodePagesTile) {
-            console.log(`Node conversion: ${childNodeInfo.id}`); // eslint-disable-line no-console,no-undef
-            header = await this.sourceTileset.nodePagesTile.formTileFromNodePages(parseInt(childNodeInfo.id));
-        }
-        else {
-            const nodeUrl = this._relativeUrlToFullUrl(parentNode.url, childNodeInfo.href);
-            // load metadata
-            const options = {
-                i3s: {
-                    ...this.loaderOptions,
-                    // @ts-expect-error
-                    isTileHeader: true,
-                    loadContent: false
-                }
-            };
-            console.log(`Node conversion: ${nodeUrl}`); // eslint-disable-line no-console,no-undef
-            header = await loadFromArchive(nodeUrl, I3SLoader, options, this.slpkFilesystem);
-        }
-        return header;
-    }
-    /**
-     * Create child and child's boundingVolume for the converted node
-     * @param sourceChild
-     * @returns child and child's boundingVolume
-     */
-    _createChildAndBoundingVolume(sourceChild) {
-        if (!sourceChild.obb) {
-            sourceChild.obb = createObbFromMbs(sourceChild.mbs);
-        }
-        const boundingVolume = {
-            box: i3sObbTo3dTilesObb(sourceChild.obb, this.geoidHeightModel)
-        };
-        const child = {
-            boundingVolume,
-            geometricError: convertScreenThresholdToGeometricError(sourceChild),
-            children: [],
-            content: {
-                uri: `${sourceChild.id}.${this.fileExt}`,
-                boundingVolume
-            }
-        };
-        return { boundingVolume, child };
-    }
-    /**
-     * Make an url of a resource from its relative url having the base url
-     * @param baseUrl the base url. A resulting url will be related from this url
-     * @param relativeUrl a realtive url of a resource
-     */
-    _relativeUrlToFullUrl(baseUrl = '', relativeUrl) {
-        let resultArray = baseUrl.split('/');
-        const relativeUrlArray = relativeUrl.split('/');
-        for (const folder of relativeUrlArray) {
-            switch (folder) {
-                case '.':
-                    continue; // eslint-disable-line no-continue
-                case '..':
-                    resultArray = resultArray.slice(0, -1);
-                    break;
-                default:
-                    resultArray.push(folder);
-            }
-        }
-        return resultArray.join('/');
-    }
-    /**
-     * Do loading all attributes related to particular node.
-     * @param sourceChild
-     * @param attributeStorageInfo
-     * @returns Promise of attributes object.
-     */
-    async _loadChildAttributes(sourceChild, attributeStorageInfo) {
-        const promises = [];
-        const { attributeUrls = [] } = sourceChild;
-        for (let index = 0; index < attributeUrls.length; index++) {
-            const inputUrl = attributeUrls[index];
-            const attribute = attributeStorageInfo[index];
-            const options = {
-                attributeName: attribute.name,
-                attributeType: this._getAttributeType(attribute)
-            };
-            promises.push(loadFromArchive(inputUrl, I3SAttributeLoader, options, this.slpkFilesystem));
-        }
-        const attributesList = await Promise.all(promises);
-        this._replaceNestedArrays(attributesList);
-        return Object.assign({}, ...attributesList);
-    }
-    /**
-     * Returns attribute type for loading attributes
-     * @param attribute
-     * Workaround for I3S v1.6. There is no attribute.attributeValues.valueType field in attribute.
-     * There is an 'Oid32' type if attribute has objectIds property.
-     * Doc: https://github.com/Esri/i3s-spec/blob/master/docs/1.6/attributeStorageInfo.cmn.md
-     */
-    _getAttributeType(attribute) {
-        if (attribute.attributeValues) {
-            return attribute.attributeValues.valueType;
-        }
-        else if (attribute.objectIds) {
-            return 'Oid32';
-        }
-        return '';
-    }
-    /**
-     * Make simple arrays from attribute typed arrays.
-     * @param attributesList
-     */
-    _replaceNestedArrays(attributesList) {
-        for (let index = 0; index < attributesList.length; index++) {
-            const attributeObject = attributesList[index];
-            for (const key in attributeObject) {
-                attributeObject[key] = Array.from(attributeObject[key]);
-            }
-        }
-    }
-    /**
-     * Print statistics in the end of conversion
-     * @param params - output files data
-     */
-    async _finishConversion(params) {
-        const filesSize = await calculateDatasetSize(params);
-        const diff = process.hrtime(this.conversionStartTime);
-        const conversionTime = timeConverter(diff);
-        console.log(`------------------------------------------------`); // eslint-disable-line
-        console.log(`Finish conversion of ${I3S}`); // eslint-disable-line
-        console.log(`Total conversion time: ${conversionTime}`); // eslint-disable-line
-        console.log(`Vertex count: `, this.vertexCounter); // eslint-disable-line
-        console.log(`File(s) size: `, filesSize, ' bytes'); // eslint-disable-line
-        console.log(`------------------------------------------------`); // eslint-disable-line
-    }
-}

package/dist/3d-tiles-converter/helpers/3d-tiles-content-converter.d.ts

@@ -1,88 +0,0 @@
-import type { I3STileContent, AttributeStorageInfo, I3STileAttributes } from '@loaders.gl/i3s';
-import { Matrix4 } from '@math.gl/core';
-export type I3SAttributesData = {
-    tileContent: I3STileContent;
-    box: number[];
-    textureFormat: string;
-};
-/**
- * Converts content of an I3S node to 3D Tiles file content
- */
-export declare class Tiles3DContentConverter {
-    rtcCenter: Float32Array;
-    i3sTile: any;
-    tileType: string;
-    constructor(options?: {
-        outputVersion: string;
-    });
-    /**
-     * The starter of content conversion
-     * @param i3sTile - Tile3D instance for I3S node
-     * @returns - encoded content
-     */
-    convert(i3sAttributesData: I3SAttributesData, featureAttributes?: I3STileAttributes | null, attributeStorageInfo?: AttributeStorageInfo[] | null | undefined): Promise<ArrayBuffer>;
-    /**
-     * Build and encode gltf
-     * @param i3sTile - Tile3D instance for I3S node
-     * @returns - encoded glb content
-     */
-    buildGLTF(i3sAttributesData: I3SAttributesData, featureAttributes: I3STileAttributes | null, attributeStorageInfo?: AttributeStorageInfo[] | null | undefined): Promise<ArrayBuffer>;
-    private _createMetadataExtensions;
-    private _createPropertyAttibutes;
-    private _convertAttributeStorageInfoToPropertyAttribute;
-    /**
-     * 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
-     */
-    _addI3sTextureToGLTF(tileContent: any, textureFormat: any, gltfBuilder: any): Promise<null>;
-    /**
-     * 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: any, cartesianOrigin: any, cartographicOrigin: any, modelMatrix: any): Float32Array;
-    /**
-     * 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: any): Matrix4;
-    /**
-     * Create _BATCHID attribute
-     * @param {Object} i3sContent - the source object
-     * @returns {void}
-     */
-    _createBatchIds(i3sContent: any, featureAttributes: any): void;
-    /**
-     * 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: any): "image/jpeg" | "image/png" | "image/ktx2";
-    /**
-     * 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: any, textureIndex: any): any;
-    /**
-     * 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: any, textureIndex: any): any;
-    _getFeaturesLength(attributes: any): any;
-    _checkNormals(normals: any): any;
-}
-//# sourceMappingURL=3d-tiles-content-converter.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"3d-tiles-content-converter.d.ts","sourceRoot":"","sources":["../../../src/3d-tiles-converter/helpers/3d-tiles-content-converter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,cAAc,EAAE,oBAAoB,EAAE,iBAAiB,EAAC,MAAM,iBAAiB,CAAC;AAU7F,OAAO,EAAC,OAAO,EAAU,MAAM,eAAe,CAAC;AAY/C,MAAM,MAAM,iBAAiB,GAAG;IAC9B,WAAW,EAAE,cAAc,CAAC;IAC5B,GAAG,EAAE,MAAM,EAAE,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,qBAAa,uBAAuB;IAElC,SAAS,EAAE,YAAY,CAAC;IACxB,OAAO,EAAE,GAAG,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;gBAEL,OAAO,GAAE;QAAC,aAAa,EAAE,MAAM,CAAA;KAA0B;IAKrE;;;;OAIG;IACG,OAAO,CACX,iBAAiB,EAAE,iBAAiB,EACpC,iBAAiB,GAAE,iBAAiB,GAAG,IAAW,EAClD,oBAAoB,CAAC,EAAE,oBAAoB,EAAE,GAAG,IAAI,GAAG,SAAS,GAC/D,OAAO,CAAC,WAAW,CAAC;IAkBvB;;;;OAIG;IAEG,SAAS,CACb,iBAAiB,EAAE,iBAAiB,EACpC,iBAAiB,EAAE,iBAAiB,GAAG,IAAI,EAC3C,oBAAoB,CAAC,EAAE,oBAAoB,EAAE,GAAG,IAAI,GAAG,SAAS,GAC/D,OAAO,CAAC,WAAW,CAAC;IA8EvB,OAAO,CAAC,yBAAyB;IA0BjC,OAAO,CAAC,wBAAwB;IAsBhC,OAAO,CAAC,+CAA+C;IA8DvD;;;;;OAKG;IACG,oBAAoB,CAAC,WAAW,KAAA,EAAE,aAAa,KAAA,EAAE,WAAW,KAAA;IAmBlE;;;;;;;OAOG;IACH,mBAAmB,CAAC,cAAc,KAAA,EAAE,eAAe,KAAA,EAAE,kBAAkB,KAAA,EAAE,WAAW,KAAA;IAepF;;;;;;;OAOG;IACH,wBAAwB,CAAC,eAAe,KAAA;IAMxC;;;;OAIG;IACH,eAAe,CAAC,UAAU,KAAA,EAAE,iBAAiB,KAAA;IAoB7C;;;;;OAKG;IACH,yBAAyB,CAAC,MAAM,KAAA;IAchC;;;;;OAKG;IACH,iCAAiC,CAAC,QAAQ,KAAA,EAAE,YAAY,KAAA;IAgCxD;;;;;OAKG;IACH,eAAe,CAAC,kBAAkB,KAAA,EAAE,YAAY,KAAA;IA+ChD,kBAAkB,CAAC,UAAU,KAAA;IAY7B,aAAa,CAAC,OAAO,KAAA;CAItB"}