@loaders.gl/tile-converter 3.1.6 → 3.2.0-alpha.1

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

@@ -0,0 +1,321 @@
+import type { SceneLayer3D } from '@loaders.gl/i3s';
+import { Tileset3D } from '@loaders.gl/tiles';
+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/src/types';
+/**
+ * Converter from 3d-tiles tileset to i3s layer
+ */
+export default class I3SConverter {
+    nodePages: NodePages;
+    fileMap: {
+        [key: string]: string;
+    };
+    options: any;
+    layers0Path: string;
+    materialMap: Map<any, any>;
+    materialDefinitions: I3SMaterialDefinition[];
+    vertexCounter: number;
+    layers0: SceneLayer3D | null;
+    featuresHashArray: string[];
+    refinementCounter: {
+        tilesCount: number;
+        tilesWithAddRefineCount: number;
+    };
+    validate: boolean;
+    boundingVolumeWarnings?: string[];
+    conversionStartTime: [number, number];
+    refreshTokenTime: [number, number];
+    sourceTileset: Tileset3D | null;
+    geoidHeightModel: Geoid | null;
+    Loader: LoaderWithParser;
+    generateTextures: boolean;
+    generateBoundingVolumes: boolean;
+    layersHasTexture: boolean;
+    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
+     */
+    convert(options: {
+        inputUrl: string;
+        outputPath: string;
+        tilesetName: string;
+        sevenZipExe: string;
+        egmFilePath: string;
+        maxDepth?: number;
+        slpk?: boolean;
+        token?: string;
+        draco?: boolean;
+        validate?: boolean;
+        generateTextures?: boolean;
+        generateBoundingVolumes?: boolean;
+        /** @deprecated */
+        inputType?: string;
+    }): Promise<any>;
+    /**
+     * 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
+     */
+    private _formLayers0;
+    /**
+     * Convert and save the layer and embedded tiles
+     * @param boundingVolumes - mbs and obb data about node's bounding volume
+     * @return 3DNodeIndexDocument data https://github.com/Esri/i3s-spec/blob/master/docs/1.7/3DNodeIndexDocument.cmn.md
+     */
+    private _formRootNodeIndexDocument;
+    /**
+     * Form object of 3DSceneLayer https://github.com/Esri/i3s-spec/blob/master/docs/1.7/3DSceneLayer.cmn.md
+     * @param root0 - 3DNodeIndexDocument of root node https://github.com/Esri/i3s-spec/blob/master/docs/1.7/3DNodeIndexDocument.cmn.md
+     * @param sourceRootTile - Source (3DTile) tile data
+     * @param parentId - node id in node pages
+     * @param boundingVolumes - mbs and obb data about node's bounding volume
+     */
+    private _convertNodesTree;
+    /**
+     * Write 3DSceneLayer https://github.com/Esri/i3s-spec/blob/master/docs/1.7/3DSceneLayer.cmn.md in file
+     */
+    private _writeLayers0;
+    /**
+     * Write 3DNodeIndexDocument https://github.com/Esri/i3s-spec/blob/master/docs/1.7/3DNodeIndexDocument.cmn.md in file
+     */
+    private _writeNodeIndexDocument;
+    /**
+     * Pack files into *.slpk archive
+     * @param tilesetPath - Path to save file
+     */
+    private _createSlpk;
+    /**
+     * Add child nodes recursively and write them to files
+     * @param data - arguments
+     * @param data.sourceTiles - array of source child nodes
+     * @param data.parentNode - 3DNodeIndexDocument of parent node for processing child nodes
+     * @param data.parentId - id of parent node in node pages
+     * @param data.level - level of node (distanse to root node in the tree)
+     */
+    private _addChildrenWithNeighborsAndWriteFile;
+    /**
+     * Add child nodes recursively and write them to files
+     * @param data - arguments
+     * @param data.childNodes - array of target child nodes
+     * @param data.sourceTiles - array of source child nodes
+     * @param data.parentNode - 3DNodeIndexDocument of parent node for processing child nodes
+     * @param data.parentId - id of parent node in node pages
+     * @param data.level - level of node (distanse to root node in the tree)
+     */
+    private _addChildren;
+    /**
+     * Add neightbors to 3DNodeIndexDocument and write it in a file
+     * @param parentNode - arguments
+     * @param childNodes - array of target child nodes
+     */
+    private _addNeighborsAndWriteFile;
+    /**
+     * Convert tile to one or more I3S nodes
+     * @param parentTile - parent 3DNodeIndexDocument
+     * @param sourceTile - source tile (3DTile)
+     * @param parentId - id of parent node in node pages
+     * @param level - level of node (distanse to root node in the tree)
+     */
+    private _createNode;
+    /**
+     * Convert attributesStorageInfo https://github.com/Esri/i3s-spec/blob/master/docs/1.7/attributeStorageInfo.cmn.md
+     * from B3DM batch table
+     * @param sourceTileContent - tile content of 3DTile
+     * @return {void}
+     */
+    private _convertAttributeStorageInfo;
+    /**
+     * Convert tile to one or more I3S nodes
+     * @param sourceTile - source tile (3DTile)
+     * result.geometry - ArrayBuffer with geometry attributes
+     * result.compressedGeometry - ArrayBuffer with compressed (draco) geometry
+     * result.texture - texture image
+     * result.sharedResources - shared resource data object
+     * result.meshMaterial - PBR-like material object
+     * result.vertexCount - number of vertices in geometry
+     * result.attributes - feature attributes
+     * result.featureCount - number of features
+     */
+    private _convertResources;
+    /**
+     * Create a new 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
+     * @return the node object in node pages
+     */
+    private _createNodeInNodePages;
+    /**
+     * Create a new node page object in node pages
+     * @param parentNode - 3DNodeIndexDocument https://github.com/Esri/i3s-spec/blob/master/docs/1.7/3DNodeIndexDocument.cmn.md object of the parent node
+     * @param boundingVolumes - Bounding volumes
+     * @param lodSelection - Level of Details (LOD) metrics
+     * @param nodeInPage - corresponding node object in a node page
+     * @param resources - the node resources data
+     * @param resources.texture - texture image
+     * @param resources.attributes - feature attributes
+     * @return 3DNodeIndexDocument https://github.com/Esri/i3s-spec/blob/master/docs/1.7/3DNodeIndexDocument.cmn.md object
+     */
+    private _createNodeIndexDocument;
+    /**
+     * 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;
+    /**
+     * Generate storage attribute for map segmentation.
+     * @param attributeIndex - order index of attribute (f_0, f_1 ...).
+     * @param key - attribute key from batch table.\
+     * @param attributeType - attribute type.
+     * @return Updated storageAttribute.
+     */
+    private _createdStorageAttribute;
+    /**
+     * Get the attribute type for attributeStorageInfo https://github.com/Esri/i3s-spec/blob/master/docs/1.7/attributeStorageInfo.cmn.md
+     * @param key - attribute's key
+     * @param attribute - attribute's type in batchTable
+     */
+    private getAttributeType;
+    /**
+     * Setup storage attribute as string.
+     * @param storageAttribute - attribute for map segmentation.
+     */
+    private _setupStringAttribute;
+    /**
+     * Setup Id attribute for map segmentation.
+     * @param storageAttribute - attribute for map segmentation .
+     */
+    private _setupIdAttribute;
+    /**
+     * Setup double attribute for map segmentation.
+     * @param storageAttribute - attribute for map segmentation .
+     */
+    private _setupDoubleAttribute;
+    /**
+     * Setup field attribute for map segmentation.
+     * @param key - attribute for map segmentation.
+     * @param fieldAttributeType - esri attribute type ('esriFieldTypeString' or 'esriFieldTypeOID').
+     */
+    private _createFieldAttribute;
+    /**
+     * Do conversion of 3DTiles batch table to I3s node attributes.
+     * @param batchTable - Table with layer meta data.
+     */
+    private _convertBatchTableInfoToNodeAttributes;
+    /**
+     * Find and return attribute type based on key form Batch table.
+     * @param attributeType
+     */
+    private _getFieldAttributeType;
+    /**
+     * Generate popup info to show metadata on the map.
+     * @param batchTable - Batch table data with OBJECTID.
+     * @return data for correct rendering of popup.
+     */
+    private _createPopupInfo;
+    /**
+     * 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 sourceRootTile
+     * @returns
+     */
+    private isContentSupported;
+}
+//# 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":"AAGA,OAAO,KAAK,EAEV,YAAY,EAab,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAC,SAAS,EAAC,MAAM,mBAAmB,CAAC;AAE5C,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,2BAA2B,CAAC;AAmB7F;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B,SAAS,EAAE,SAAS,CAAC;IACrB,OAAO,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAC,CAAC;IACjC,OAAO,EAAE,GAAG,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC3B,mBAAmB,EAAE,qBAAqB,EAAE,CAAC;IAC7C,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,SAAS,GAAG,IAAI,CAAQ;IACvC,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;;IAsB1B;;;;;;;;;;;;;OAaG;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,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAC3B,uBAAuB,CAAC,EAAE,OAAO,CAAC;QAClC,kBAAkB;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,GAAG,CAAC;IA6ChB;;;;OAIG;YACW,qBAAqB;IA8CnC;;;OAGG;IACH,OAAO,CAAC,YAAY;IAoBpB;;;;OAIG;IACH,OAAO,CAAC,0BAA0B;IAqBlC;;;;;;OAMG;YACW,iBAAiB;IAqC/B;;OAEG;YACW,aAAa;IAY3B;;OAEG;YACW,uBAAuB;IAgBrC;;;OAGG;YACW,WAAW;IAuCzB;;;;;;;OAOG;YACW,qCAAqC;IAWnD;;;;;;;;OAQG;YACW,YAAY;IAyC1B;;;;OAIG;YACW,yBAAyB;IAiCvC;;;;;;OAMG;YACW,WAAW;IA2FzB;;;;;OAKG;IACH,OAAO,CAAC,4BAA4B;IAQpC;;;;;;;;;;;OAWG;YACW,iBAAiB;IAgB/B;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,sBAAsB;IAmD9B;;;;;;;;;;OAUG;IACH,OAAO,CAAC,wBAAwB;IA+ChC;;;;;;;;;OASG;YACW,eAAe;IAiB7B;;;;;;OAMG;YACW,gBAAgB;IAiC9B;;;;;;OAMG;YACW,YAAY;IAsB1B;;;;;OAKG;YACW,aAAa;IAqD3B;;;;;;;OAOG;YACW,gBAAgB;IAuB9B;;;;;OAKG;YACW,gBAAgB;IAyB9B;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAa5B;;;;OAIG;IACH,OAAO,CAAC,qBAAqB;IAU7B;;;;;;OAMG;IACH,OAAO,CAAC,wBAAwB;IAgChC;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAYxB;;;OAGG;IACH,OAAO,CAAC,qBAAqB;IAc7B;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAOzB;;;OAGG;IACH,OAAO,CAAC,qBAAqB;IAO7B;;;;OAIG;IACH,OAAO,CAAC,qBAAqB;IAQ7B;;;OAGG;IACH,OAAO,CAAC,sCAAsC;IAyB9C;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAe9B;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAgCxB;;;OAGG;YACW,iBAAiB;IAqB/B;;OAEG;YACW,oBAAoB;IAYlC;;OAEG;YACW,qBAAqB;IAkBnC;;OAEG;IACH,OAAO,CAAC,8BAA8B;IAUtC;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;CAG3B"}