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

package/dist/i3s-converter/helpers/node-index-document.js

@@ -0,0 +1,268 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeIndexDocument = void 0;
+const path_1 = require("path");
+const json_map_transform_1 = __importDefault(require("json-map-transform"));
+const uuid_1 = require("uuid");
+const file_utils_1 = require("../../lib/utils/file-utils");
+const node_1 = require("../json-templates/node");
+/**
+ * Wrapper for https://github.com/Esri/i3s-spec/blob/master/docs/1.7/3DNodeIndexDocument.cmn.md data
+ * The class allows working with 3DNodeIndexDocument in 2 modes:
+ * in memory: the data is stored in `data` field
+ * on disk: the data is written on disk in a file. The file can be rewritten when new childrend or neighbors have to be added
+ */
+class NodeIndexDocument {
+    get finalized() {
+        return this._finalized;
+    }
+    /**
+     * Constructor
+     * @param id - id of the node in node pages
+     * @param converter - converter instance
+     */
+    constructor(id, converter) {
+        /** 3DNodeIndexDocument data */
+        this.data = null;
+        /** children */
+        this.children = [];
+        /**
+         * Finalized property. It means that all child nodes are saved and their data
+         * is unloaded
+         */
+        this._finalized = false;
+        this.inPageId = id;
+        this.id = id === 0 ? 'root' : id.toString();
+        this.converter = converter;
+    }
+    /**
+     * Add Node3DIndexDocument data to the node
+     * @param data Node3DIndexDocument data
+     * @returns this NodeIndexDocument instance (to recurring with constructor)
+     */
+    async addData(data) {
+        if (this.converter.options.instantNodeWriting) {
+            await this.write(data);
+        }
+        else {
+            this.data = data;
+        }
+        return this;
+    }
+    /**
+     * Add child node references
+     * @param childNodes - child NodeIndexDocument instances
+     */
+    async addChildren(childNodes) {
+        const newChildren = [];
+        for (const node of childNodes) {
+            const nodeData = await node.load();
+            newChildren.push({
+                id: node.id,
+                href: `../${node.id}`,
+                obb: nodeData.obb,
+                mbs: nodeData.mbs
+            });
+        }
+        this.children = this.children.concat(childNodes);
+        let data = this.data;
+        if (this.converter.options.instantNodeWriting) {
+            data = (await this.load());
+        }
+        if (data) {
+            data.children = data.children ?? [];
+            data.children = data.children.concat(newChildren);
+        }
+        if (this.converter.options.instantNodeWriting && data) {
+            await this.write(data);
+        }
+    }
+    /**
+     * Add neighbors to child nodes of this node
+     */
+    async addNeighbors() {
+        if (this.finalized) {
+            return;
+        }
+        const nodeData = await this.load();
+        for (const childNode of this.children) {
+            const childNodeData = await childNode.load();
+            childNodeData.neighbors = childNodeData.neighbors ?? [];
+            // Don't do large amount of "neightbors" to avoid big memory consumption
+            if (Number(nodeData?.children?.length) < 1000) {
+                for (const neighbor of nodeData.children || []) {
+                    if (childNode.id === neighbor.id) {
+                        continue; // eslint-disable-line
+                    }
+                    childNodeData.neighbors.push({ ...neighbor });
+                }
+            }
+            else {
+                // eslint-disable-next-line no-console, no-undef
+                console.warn(`Node ${childNode.id}: neighbors attribute is omited because of large number of neigbors`);
+                delete childNodeData.neighbors;
+            }
+            if (this.converter.options.instantNodeWriting && childNodeData) {
+                await childNode.write(childNodeData);
+            }
+            await childNode.save();
+        }
+        // The save after adding neighbors is the last one. Finalize the the node
+        this.finalize();
+    }
+    /** Save 3DNodeIndexDocument in file on disk */
+    async save() {
+        if (this.data) {
+            await this.write(this.data);
+        }
+    }
+    /** Finalize the node */
+    finalize() {
+        this._finalized = true;
+        for (const child of this.children) {
+            child.flush();
+        }
+    }
+    /**
+     * Write 3DNodeIndexDocument https://github.com/Esri/i3s-spec/blob/master/docs/1.7/3DNodeIndexDocument.cmn.md
+     * @param node - Node3DIndexDocument object
+     */
+    async write(node) {
+        const path = (0, path_1.join)(this.converter.layers0Path, 'nodes', this.id);
+        if (this.converter.options.slpk) {
+            await this.converter.writeQueue.enqueue({
+                archiveKey: `nodes/${this.id}/3dNodeIndexDocument.json.gz`,
+                writePromise: () => (0, file_utils_1.writeFileForSlpk)(path, JSON.stringify(node), '3dNodeIndexDocument.json', true, this.converter.compressList)
+            }, true);
+        }
+        else {
+            await this.converter.writeQueue.enqueue({ writePromise: () => (0, file_utils_1.writeFile)(path, JSON.stringify(node)) }, true);
+        }
+    }
+    /**
+     * Load 3DNodeIndexDocument data from file on disk
+     * @returns 3DNodeIndexDocument object
+     */
+    async load() {
+        if (this.data) {
+            return this.data;
+        }
+        const path = this.id;
+        const parentNodePath = (0, path_1.join)(this.converter.layers0Path, 'nodes', path);
+        let parentNodeFileName = 'index.json';
+        if (this.converter.options.slpk) {
+            parentNodeFileName = '3dNodeIndexDocument.json';
+        }
+        return (await (0, file_utils_1.openJson)(parentNodePath, parentNodeFileName));
+    }
+    /**
+     * Unload the Node data
+     */
+    flush() {
+        this.data = null;
+    }
+    /**
+     * Create root node of the tree
+     * @param boundingVolumes - MBS and OOB bounding volumes data
+     * @param converter - I3SConverter instance
+     * @returns instance of NodeIndexDocument
+     */
+    static async createRootNode(boundingVolumes, converter) {
+        const rootData = NodeIndexDocument.createRootNodeIndexDocument(boundingVolumes);
+        const rootNode = await new NodeIndexDocument(0, converter).addData(rootData);
+        return rootNode;
+    }
+    /**
+     * Create NodeIndexDocument instance
+     * @param parentNode - parent NodeIndexDocument
+     * @param boundingVolumes - MBS and OOB bounding volumes data
+     * @param lodSelection - LOD metrics data
+     * @param nodeInPage - node data in node pages
+     * @param resources - resources extracted from gltf/b3dm file
+     * @param converter - I3SConverter instance
+     * @returns NodeIndexDocument instance
+     */
+    static async createNode(parentNode, boundingVolumes, lodSelection, nodeInPage, resources, converter) {
+        const data = await NodeIndexDocument.createNodeIndexDocument(parentNode, boundingVolumes, lodSelection, nodeInPage, resources);
+        const node = await new NodeIndexDocument(nodeInPage.index, converter).addData(data);
+        return node;
+    }
+    /**
+     * Form 3DNodeIndexDocument data for the root node
+     * @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
+     */
+    static createRootNodeIndexDocument(boundingVolumes) {
+        const root0data = {
+            version: `{${(0, uuid_1.v4)().toUpperCase()}}`,
+            id: 'root',
+            level: 0,
+            lodSelection: [
+                {
+                    metricType: 'maxScreenThresholdSQ',
+                    maxError: 0
+                },
+                {
+                    metricType: 'maxScreenThreshold',
+                    maxError: 0
+                }
+            ],
+            ...boundingVolumes,
+            children: []
+        };
+        return (0, json_map_transform_1.default)(root0data, (0, node_1.NODE)());
+    }
+    /**
+     * Create a new Node3DIndexDocument
+     * @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
+     */
+    static async createNodeIndexDocument(parentNode, boundingVolumes, lodSelection, nodeInPage, resources) {
+        const { texture, attributes } = resources;
+        const nodeId = nodeInPage.index;
+        const parentNodeData = await parentNode.load();
+        const nodeData = {
+            version: parentNodeData.version,
+            id: nodeId.toString(),
+            level: parentNodeData.level + 1,
+            ...boundingVolumes,
+            lodSelection,
+            parentNode: {
+                id: parentNode.id,
+                href: `../${parentNode.id}`,
+                mbs: parentNodeData.mbs,
+                obb: parentNodeData.obb
+            },
+            children: [],
+            neighbors: []
+        };
+        const node = (0, json_map_transform_1.default)(nodeData, (0, node_1.NODE)());
+        if (nodeInPage.mesh) {
+            node.geometryData = [{ href: './geometries/0' }];
+            node.sharedResource = { href: './shared' };
+            if (texture) {
+                node.textureData = [{ href: './textures/0' }, { href: './textures/1' }];
+            }
+            if (attributes &&
+                attributes.length &&
+                parentNode.converter.layers0?.attributeStorageInfo?.length) {
+                node.attributeData = [];
+                for (let index = 0; index < attributes.length; index++) {
+                    const folderName = parentNode.converter.layers0.attributeStorageInfo[index].key;
+                    node.attributeData.push({ href: `./attributes/${folderName}/0` });
+                }
+            }
+        }
+        return node;
+    }
+}
+exports.NodeIndexDocument = NodeIndexDocument;

package/dist/i3s-converter/helpers/node-pages.d.ts

@@ -1,34 +1,16 @@
-/**
- * Represents one page node
- * {@link https://github.com/Esri/i3s-spec/blob/master/docs/1.7/node.cmn.md}
- */
-export type PageNodeType = {
-  lodThreshold: number;
-  obb: any;
-  children: any[];
-  mesh?: {
-    geometry: {
-      resource?: number;
-      definition?: number;
-    };
-    material?: {
-      resource?: number;
-      definition?: number;
-    };
-  };
-};
-
+import { NodeInPage } from '@loaders.gl/i3s';
+import I3SConverter from '../i3s-converter';
 /**
  * class NodePages - wrapper of nodePages array
  *
  * @example
- * import writeFile from './helpers/write-file';
+ * import {writeFile} from './helpers/write-file';
  *
  * // create an instance of the class
  * const nodePages = new NodePages(writeFile, HARDCODED_NODES_PER_PAGE);
  * ...
  * // push root node
- * const parentId = nodePages.push({
+ * const parent = await nodePages.push({
       lodThreshold: HARDCODED_MAX_SCREEN_THRESHOLD_SQ,
       obb: coordinates.obb,
       children: []
@@ -45,100 +27,130 @@ export type PageNodeType = {
         }
       }
     };
- * const nodeId = this.nodePages.push(nodeInPage, parentId);
+ * const node = await this.nodePages.push(nodeInPage, parent.index);
  * ...
  * // save all the nodePages in the end of pushing all the nodes
  * await this.nodePages.save(layers0path);
  */
 export default class NodePages {
-  readonly nodesPerPage: number;
-  readonly nodesCounter: number;
-  readonly writeFile: any;
-  readonly nodePages: {nodes: PageNodeType[]}[];
-
-  /**
-   * @constructs
-   * Create a nodePages instance.
-   * @param writeFileFunc - function to save one nodePage into a file
-   * @param nodesPerPage - length limit for one nodePage. An additional nodePage is created when this limit is met
-   */
-  constructor(writeFileFunc, nodesPerPage);
-
-  /**
-   * Setup function to save node pages
-   * @param func - function which should be used to save node pages
-   */
-  useWriteFunction(func: Function): void;
-
-  /**
-   * Get the node by its end-to-end index
-   * @param id - end-to-end index of the node
-   * @return the node object
-   */
-  getNodeById(id: number): object;
-
-  /**
-   * Add a child id into the parent node.children array
-   * @param parentId - end-to-end parent node index
-   * @param childId - end-to-end child node index
-   */
-  addChildRelation(parentId: number, childId: number): void;
-
-  /**
-   * Update resource index in node.mesh object
-   * @param {object} node - node object
-   */
-  updateResourceInMesh(node: object): void;
-
-  /**
-   * Update material in node.mesh object by node id
-   * @param id - end-to-end index of the node
-   * @param materialId - id from scene layer materialDefinitions
-   */
-  updateMaterialByNodeId(id: number, materialId: number);
-
-  /**
-   * Update vertexCount in node.mesh.geometry object by node id
-   * @param id - end-to-end index of the node
-   * @param vertexCount - vertex count for particular node
-   */
-  updateVertexCountByNodeId(id: number, vertexCount: number);
-
-  /**
-   * Update resource in node.mesh.attribute object by node id
-   * @param id - end-to-end index of the node
-   */
-  updateNodeAttributeByNodeId(id: number);
-
-  /**
-   * Update featureCount in node.mesh.geometry object by node id
-   * @param id - end-to-end index of the node
-   * @param featureCount - features count of the node
-   */
-  updateFeatureCountByNodeId(id: number, featureCount: number);
-
-  /**
-   * Update texelCountHint in node.mesh.material object by node id
-   * @param id - end-to-end index of the node
-   * @param texelCountHint - texelCountHint of particular node
-   */
-  updateTexelCountHintByNodeId(id: number, texelCountHint: number);
-
-  /**
-   * Put new node in nodePages array
-   * @param node - node object
-   * @param parentId - index of parent node
-   * @return
-   */
-  push(node: PageNodeType, parentId?: number): number;
-
-  /**
-   * Save all the node pages
-   * Run this method when all nodes is pushed in nodePages
-   * @param {string} layers0path - path of layer
-   * @param {Object} fileMap - fileMap which keep info for slpk archive
-   * @param {boolean} slpk
-   * @return {promise}
-   */
-  save(layers0path: string, fileMap: Object, slpk: boolean): Promise<void>;
+    readonly nodesPerPage: number;
+    nodesCounter: number;
+    writeFile: (...args: any[]) => Promise<null | string>;
+    converter: I3SConverter;
+    readonly nodePages: {
+        nodes: NodeInPage[];
+    }[];
+    readonly length: number;
+    /**
+     * @constructs
+     * Create a nodePages instance.
+     * @param writeFileFunc - function to save one nodePage into a file
+     * @param nodesPerPage - length limit for one nodePage. An additional nodePage is created when this limit is met
+     */
+    constructor(writeFileFunc: any, nodesPerPage: any, converter: I3SConverter);
+    /**
+     * Setup function to save node pages
+     * @param func - function which should be used to save node pages
+     */
+    useWriteFunction(func: (...args: any[]) => Promise<null | string>): void;
+    /**
+     * Get file path and file name of the node page with the particular id
+     * @param nodePageId - node page id
+     * @returns file path and file name
+     */
+    private getNodePageFileName;
+    /**
+     * Load node page from a file on the disk
+     * @param nodePageId - node page id
+     * @returns - node page data
+     */
+    private loadNodePage;
+    /**
+     * Get nodepage id by node id
+     * @param id node id
+     * @returns node page id
+     */
+    private getPageIndexByNodeId;
+    /**
+     * Get node page data by node id
+     * @param id node id
+     * @returns node page data
+     */
+    private getPageByNodeId;
+    /**
+     * Get the node by its end-to-end index
+     * @param id - end-to-end index of the node
+     * @return the node object
+     */
+    getNodeById(id: number, nodePage?: {
+        nodes: NodeInPage[];
+    }): Promise<NodeInPage>;
+    /**
+     * Add a child id into the parent node.children array
+     * @param parentId - end-to-end parent node index
+     * @param childId - end-to-end child node index
+     */
+    private addChildRelation;
+    /**
+     * Put new node in nodePages array
+     * @param node - node object
+     * @param parentId - index of parent node
+     * @return
+     */
+    push(node: NodeInPage, parentId?: number): Promise<NodeInPage>;
+    /**
+     * Save node to the file on the disk
+     * @param node - node data
+     */
+    saveNode(node: NodeInPage): Promise<void>;
+    /**
+     * Save metadata file (for slpk only)
+     */
+    saveMetadata(): Promise<void>;
+    /**
+     * Save all the node pages
+     * Run this method when all nodes is pushed in nodePages
+     */
+    save(): Promise<void>;
+    /**
+     * Update resource index in node.mesh object
+     * @param node - node object
+     */
+    static updateResourceInMesh(node: NodeInPage): void;
+    /**
+     * Update all fields in the node excluding id
+     * @param node - node object
+     * @param data - NodeInPage data to replace original data
+     */
+    static updateAll(node: NodeInPage, data: NodeInPage): NodeInPage;
+    /**
+     * Update material in node.mesh object by node id
+     * @param id - end-to-end index of the node
+     * @param materialId - id from scene layer materialDefinitions
+     */
+    static updateMaterialByNodeId(node: NodeInPage, materialId: number): void;
+    /**
+     * Update vertexCount in node.mesh.geometry object by node id
+     * @param id - end-to-end index of the node
+     * @param vertexCount - vertex count for particular node
+     */
+    static updateVertexCountByNodeId(node: NodeInPage, vertexCount: number): void;
+    /**
+     * Update resource in node.mesh.attribute object by node id
+     * @param node - node object
+     */
+    static updateNodeAttributeByNodeId(node: NodeInPage): void;
+    /**
+     * Update featureCount in node.mesh.geometry object by node id
+     * @param node - node object
+     * @param featureCount - features count of the node
+     */
+    static updateFeatureCountByNodeId(node: NodeInPage, featureCount: number): void;
+    /**
+     * Update texelCountHint in node.mesh.material object by node id
+     * @param node - node object
+     * @param texelCountHint - texelCountHint of particular node
+     */
+    static updateTexelCountHintByNodeId(node: NodeInPage, texelCountHint: number): void;
 }
+//# sourceMappingURL=node-pages.d.ts.map

package/dist/i3s-converter/helpers/node-pages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node-pages.d.ts","sourceRoot":"","sources":["../../../src/i3s-converter/helpers/node-pages.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,UAAU,EAAC,MAAM,iBAAiB,CAAC;AAE3C,OAAO,YAAY,MAAM,kBAAkB,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,CAAC,GAAG,IAAI,OAAA,KAAK,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC,CAAC;IAC/C,SAAS,EAAE,YAAY,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE;QAAC,KAAK,EAAE,UAAU,EAAE,CAAA;KAAC,EAAE,CAAC;IAC5C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAK;IAE5B;;;;;OAKG;gBACS,aAAa,KAAA,EAAE,YAAY,KAAA,EAAE,SAAS,EAAE,YAAY;IAWhE;;;OAGG;IACH,gBAAgB,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI,OAAA,KAAK,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC,GAAG,IAAI;IAIjE;;;;OAIG;IACH,OAAO,CAAC,mBAAmB;IAa3B;;;;OAIG;YACW,YAAY;IAW1B;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IAI5B;;;;OAIG;YACW,eAAe;IAQ7B;;;;OAIG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE;QAAC,KAAK,EAAE,UAAU,EAAE,CAAA;KAAC,GAAG,OAAO,CAAC,UAAU,CAAC;IAMpF;;;;OAIG;YACW,gBAAgB;IAS9B;;;;;OAKG;IACG,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAgBpE;;;OAGG;IACG,QAAQ,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAkC/C;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAenC;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IA0B3B;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI;IAMnD;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,GAAG,UAAU;IAMhE;;;;OAIG;IACH,MAAM,CAAC,sBAAsB,CAAC,IAAI,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI;IAUzE;;;;OAIG;IACH,MAAM,CAAC,yBAAyB,CAAC,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI;IAO7E;;;OAGG;IACH,MAAM,CAAC,2BAA2B,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI;IAO1D;;;;OAIG;IACH,MAAM,CAAC,0BAA0B,CAAC,IAAI,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,GAAG,IAAI;IAO/E;;;;OAIG;IACH,MAAM,CAAC,4BAA4B,CAAC,IAAI,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,GAAG,IAAI;CAMpF"}