@loaders.gl/tile-converter 4.0.0-alpha.1 → 4.0.0-alpha.11

package/dist/i3s-converter/i3s-converter.d.ts

@@ -0,0 +1,267 @@
+import type { Tiles3DLoaderOptions, Tiles3DTilesetJSONPostprocessed } from '@loaders.gl/3d-tiles';
+import type { WriteQueueItem } from '../lib/utils/write-queue';
+import type { SceneLayer3D } from '@loaders.gl/i3s';
+import { Geoid } from '@math.gl/geoid';
+import NodePages from './helpers/node-pages';
+import { LoaderWithParser } from '@loaders.gl/loader-utils';
+import { I3SMaterialDefinition } from '@loaders.gl/i3s';
+import { PreprocessData } from './types';
+import WriteQueue from '../lib/utils/write-queue';
+/**
+ * Converter from 3d-tiles tileset to i3s layer
+ */
+export default class I3SConverter {
+    nodePages: NodePages;
+    options: any;
+    layers0Path: string;
+    materialMap: Map<string, number>;
+    materialDefinitions: I3SMaterialDefinition[];
+    geometryMap: Map<string, number>;
+    geometryConfigs: {
+        hasTexture: boolean;
+        hasUvRegions: boolean;
+    }[];
+    vertexCounter: number;
+    layers0: SceneLayer3D | null;
+    featuresHashArray: string[];
+    refinementCounter: {
+        tilesCount: number;
+        tilesWithAddRefineCount: number;
+    };
+    validate: boolean;
+    boundingVolumeWarnings?: string[];
+    conversionStartTime: [number, number];
+    refreshTokenTime: [number, number];
+    sourceTileset: Tiles3DTilesetJSONPostprocessed | null;
+    loadOptions: Tiles3DLoaderOptions;
+    geoidHeightModel: Geoid | null;
+    Loader: LoaderWithParser;
+    generateTextures: boolean;
+    generateBoundingVolumes: boolean;
+    layersHasTexture: boolean;
+    workerSource: {
+        [key: string]: string;
+    };
+    writeQueue: WriteQueue<WriteQueueItem>;
+    compressList: string[] | null;
+    preprocessData: PreprocessData;
+    constructor();
+    /**
+     * Convert a 3d tileset
+     * @param options
+     * @param options.inputUrl the url to read the tileset from
+     * @param options.outputPath the output filename
+     * @param options.tilesetName the output name of the tileset
+     * @param options.maxDepth The max tree depth of conversion
+     * @param options.slpk Generate slpk (Scene Layer Packages) output file
+     * @param options.sevenZipExe Location of 7z.exe archiver to create slpk on Windows
+     * @param options.egmFilePath location of *.pgm file to convert heights from ellipsoidal to gravity-related format
+     * @param options.token Token for Cesium ION tilesets authentication
+     * @param options.draco Generate I3S 1.7 draco compressed geometries
+     * @param options.validate -enable validation
+     * @param options.generateTextures - generate alternative type of textures (to have non-compressed jpeg/png and compressed ktx2)
+     * @param options.generateBoundingVolumes - generate bounding volumes from vertices coordinates instead of source tiles bounding volumes
+     * @param options.instantNodeWriting - Keep created 3DNodeIndexDocument files on disk instead of memory. This option reduce memory usage but decelerates conversion speed
+     */
+    convert(options: {
+        inputUrl: string;
+        outputPath: string;
+        tilesetName: string;
+        sevenZipExe: string;
+        egmFilePath: string;
+        maxDepth?: number;
+        slpk?: boolean;
+        token?: string;
+        draco?: boolean;
+        mergeMaterials?: boolean;
+        validate?: boolean;
+        generateTextures?: boolean;
+        generateBoundingVolumes?: boolean;
+        instantNodeWriting?: boolean;
+    }): Promise<string>;
+    /**
+     * Preprocess stage of the tile converter. Traverse all the tiles tree and
+     * check a tile content to be sure that the data is supported
+     * @returns true - the conversion is possible, false - the tileset's content is not supported
+     */
+    private preprocessConversion;
+    /**
+     * Analyze a tile content. The callback for preprocess stage.
+     * @param sourceTile - 3DTiles tile JSON metadata
+     * @param traversalProps - mandatory argument but it is not used for the preprocess stage
+     * @returns - nothing
+     */
+    private analyzeTile;
+    /**
+     * Convert and save the layer and embedded tiles
+     * @param outputPath - path to save output data
+     * @param tilesetName - new tileset path
+     */
+    private _createAndSaveTileset;
+    /**
+     * Form object of 3DSceneLayer https://github.com/Esri/i3s-spec/blob/master/docs/1.7/3DSceneLayer.cmn.md
+     * @param tilesetName - Name of layer
+     * @param sourceBoundingVolume - initialized bounding volume of the source root tile
+     * @param boundingVolumeRegion - region bounding volume of the source root tile
+     */
+    private _formLayers0;
+    /**
+     * Write 3DSceneLayer https://github.com/Esri/i3s-spec/blob/master/docs/1.7/3DSceneLayer.cmn.md in file
+     */
+    private _writeLayers0;
+    /**
+     * Pack files into *.slpk archive
+     * @param tilesetPath - Path to save file
+     */
+    private _createSlpk;
+    /**
+     * Convert the specific 3DTiles tile to I3S nodes.
+     * This is callback function for the traversal generic function
+     * @param sourceTile - current 3DTiles tile JSON metadata
+     * @param traversalProps - traversal properties calculated recursively
+     * @returns - traversal properties for the child tiles
+     */
+    private convertTile;
+    /**
+     * Do final action with nodes after the current node and all child nodes been converted.
+     * @param conversionResults - array of conversion results of the current node
+     * @param currentTraversalProps - traversal properties of the current node
+     */
+    private finalizeTile;
+    /**
+     * Convert tile to one or more I3S nodes
+     * @param parentNode - 3DNodeIndexDocument of parent node
+     * @param sourceTile - source 3DTile data
+     * @param transformationMatrix - transformation matrix of the current tile, calculated recursively multiplying
+     *                               transform of all parent tiles and transform of the current tile
+     * @param level - tree level
+     */
+    private _createNode;
+    /**
+     * Convert tile to one or more I3S nodes
+     * @param sourceTile - source tile (3DTile)
+     * @param transformationMatrix - transformation matrix of the current tile, calculated recursively multiplying
+     *                               transform of all parent tiles and transform of the current tile
+     * @param boundingVolume - initialized bounding volume of the source tile
+     * @param tileContent - content of the source tile
+     * @param parentId - id of parent node in node pages
+     * @param propertyTable - batch table from b3dm / feature properties from EXT_FEATURE_METADATA
+     * @returns - converted node resources
+     */
+    private _convertResources;
+    /**
+     * Update node object (https://github.com/Esri/i3s-spec/blob/master/docs/1.7/node.cmn.md)
+     * in node pages (https://github.com/Esri/i3s-spec/blob/master/docs/1.7/nodePage.cmn.md)
+     * @param maxScreenThresholdSQ - Level of Details (LOD) metric
+     * @param boundingVolumes - Bounding volumes
+     * @param sourceTile - source tile (3DTile)
+     * @param parentId - id of parent node in node pages
+     * @param resources - the node resources data
+     * @param resources.meshMaterial - PBR-like material object
+     * @param resources.texture - texture image
+     * @param resources.vertexCount - number of vertices in geometry
+     * @param resources.featureCount - number of features
+     * @param resources.geometry - Uint8Array with geometry attributes
+     * @return the node object in node pages
+     */
+    private _updateNodeInNodePages;
+    /**
+     * Write node resources in files
+     * @param resources - source tile (3DTile)
+     * @param resources.geometry - Uint8Array with geometry attributes
+     * @param resources.compressedGeometry - Uint8Array with compressed (draco) geometry
+     * @param resources.texture - texture image
+     * @param resources.sharedResources - shared resource data object
+     * @param resources.attributes - feature attributes
+     * @return {Promise<void>}
+     */
+    private _writeResources;
+    /**
+     * Write non-compressed and compressed geometries in files
+     * @param geometryBuffer - Uint8Array with geometry attributes
+     * @param compressedGeometry - Uint8Array with compressed (draco) geometry
+     * @param childPath - a child path to write resources
+     * @param slpkChildPath - resource path inside *slpk file
+     */
+    private _writeGeometries;
+    /**
+     * Write shared resources in a file
+     * @param sharedResources - shared resource data object
+     * @param childPath - a child path to write resources
+     * @param slpkChildPath - resource path inside *slpk file
+     * @param nodePath - a node path
+     */
+    private _writeShared;
+    /**
+     * Generates textures based on texture mime type and fill in textureSetDefinitions data.
+     * @param texture - the texture image
+     * @param childPath - a child path to write resources
+     * @param slpkChildPath - the resource path inside *slpk file
+     */
+    private _writeTexture;
+    /**
+     * Write the texture image in a file
+     * @param textureData
+     * @param name
+     * @param format
+     * @param childPath
+     * @param slpkChildPath
+     */
+    private writeTextureFile;
+    /**
+     * Write feature attributes in files
+     * @param attributes - feature attributes
+     * @param childPath - a child path to write resources
+     * @param slpkChildPath - the resource path inside *slpk file
+     */
+    private _writeAttributes;
+    /**
+     * Return file format by its MIME type
+     * @param mimeType - feature attributes
+     */
+    private _getFormatByMimeType;
+    /**
+     * Find or create material in materialDefinitions array
+     * @param material - end-to-end index of the node
+     * @return material id
+     */
+    private _findOrCreateMaterial;
+    /**
+     * Get unique geometry configuration index
+     * In the end of conversion configurations will be transformed to geometryDefinitions array
+     * @param hasTexture
+     * @param hasUvRegions
+     * @returns
+     */
+    private findOrCreateGeometryDefinition;
+    /**
+     * Do conversion of 3DTiles property table to I3s node attributes.
+     * @param propertyTable - Table with layer meta data.
+     */
+    private _convertPropertyTableToNodeAttributes;
+    /**
+     * Print statistics in the end of conversion
+     * @param params - output files data
+     */
+    private _finishConversion;
+    /**
+     * Fetch preload options for ION tileset
+     */
+    private _fetchPreloadOptions;
+    /**
+     * Update options of source tileset
+     */
+    private _updateTilesetOptions;
+    /** Do calculations of all tiles and tiles with "ADD" type of refinement.
+     * @param tile
+     */
+    private _checkAddRefinementTypeForTile;
+    /**
+     * Check if the tile's content format is supported by the converter
+     * @param sourceTile
+     * @returns
+     */
+    private isContentSupported;
+    private loadWorkers;
+}
+//# sourceMappingURL=i3s-converter.d.ts.map

package/dist/i3s-converter/i3s-converter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"i3s-converter.d.ts","sourceRoot":"","sources":["../../src/i3s-converter/i3s-converter.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAEV,oBAAoB,EAGpB,+BAA+B,EAChC,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,0BAA0B,CAAC;AAC7D,OAAO,KAAK,EACV,YAAY,EAIb,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EAAC,KAAK,EAAC,MAAM,gBAAgB,CAAC;AAOrC,OAAO,SAAS,MAAM,sBAAsB,CAAC;AAuB7C,OAAO,EAAC,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAC,qBAAqB,EAA8B,MAAM,iBAAiB,CAAC;AAGnF,OAAO,EAGL,cAAc,EAEf,MAAM,SAAS,CAAC;AAGjB,OAAO,UAAU,MAAM,0BAA0B,CAAC;AA4BlD;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B,SAAS,EAAE,SAAS,CAAC;IACrB,OAAO,EAAE,GAAG,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,mBAAmB,EAAE,qBAAqB,EAAE,CAAC;IAC7C,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,eAAe,EAAE;QAAC,UAAU,EAAE,OAAO,CAAC;QAAC,YAAY,EAAE,OAAO,CAAA;KAAC,EAAE,CAAC;IAChE,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,YAAY,GAAG,IAAI,CAAC;IAC7B,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,iBAAiB,EAAE;QACjB,UAAU,EAAE,MAAM,CAAC;QACnB,uBAAuB,EAAE,MAAM,CAAC;KACjC,CAAC;IACF,QAAQ,EAAE,OAAO,CAAC;IAClB,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAM;IACvC,mBAAmB,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAU;IAC/C,gBAAgB,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAU;IAC5C,aAAa,EAAE,+BAA+B,GAAG,IAAI,CAAQ;IAC7D,WAAW,EAAE,oBAAoB,CAW/B;IACF,gBAAgB,EAAE,KAAK,GAAG,IAAI,CAAQ;IACtC,MAAM,EAAE,gBAAgB,CAAiB;IACzC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,uBAAuB,EAAE,OAAO,CAAC;IACjC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,YAAY,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAC,CAAM;IAC3C,UAAU,EAAE,UAAU,CAAC,cAAc,CAAC,CAAoB;IAC1D,YAAY,EAAE,MAAM,EAAE,GAAG,IAAI,CAAQ;IACrC,cAAc,EAAE,cAAc,CAE5B;;IAwBF;;;;;;;;;;;;;;;;OAgBG;IACG,OAAO,CAAC,OAAO,EAAE;QACrB,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,CAAC;QACnB,WAAW,EAAE,MAAM,CAAC;QACpB,WAAW,EAAE,MAAM,CAAC;QACpB,WAAW,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAC3B,uBAAuB,CAAC,EAAE,OAAO,CAAC;QAClC,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B,GAAG,OAAO,CAAC,MAAM,CAAC;IA4EnB;;;;OAIG;YACW,oBAAoB;IA4BlC;;;;;OAKG;YACW,WAAW;IAqBzB;;;;OAIG;YACW,qBAAqB;IA2EnC;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IAgCpB;;OAEG;YACW,aAAa;IAc3B;;;OAGG;YACW,WAAW;IAsCzB;;;;;;OAMG;YACW,WAAW;IAiCzB;;;;OAIG;YACW,YAAY;IAc1B;;;;;;;OAOG;YACW,WAAW;IAiGzB;;;;;;;;;;OAUG;YACW,iBAAiB;IAiC/B;;;;;;;;;;;;;;OAcG;YACW,sBAAsB;IA2DpC;;;;;;;;;OASG;YACW,eAAe;IAiB7B;;;;;;OAMG;YACW,gBAAgB;IAoC9B;;;;;;OAMG;YACW,YAAY;IAwB1B;;;;;OAKG;YACW,aAAa;IA+D3B;;;;;;;OAOG;YACW,gBAAgB;IAwB9B;;;;;OAKG;YACW,gBAAgB;IA0B9B;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAa5B;;;;OAIG;IACH,OAAO,CAAC,qBAAqB;IAU7B;;;;;;OAMG;IACH,OAAO,CAAC,8BAA8B;IAWtC;;;OAGG;IACH,OAAO,CAAC,qCAAqC;IAyB7C;;;OAGG;YACW,iBAAiB;IAqB/B;;OAEG;YACW,oBAAoB;IAYlC;;OAEG;YACW,qBAAqB;IAiBnC;;OAEG;IACH,OAAO,CAAC,8BAA8B;IAWtC;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;YAIZ,WAAW;CAsB1B"}