@loaders.gl/tile-converter 3.1.0-beta.7 → 3.1.0

package/src/i3s-converter/json-templates/{layers.js → layers.ts}

@@ -1,7 +1,7 @@
 import transform from 'json-map-transform';
 import {STORE} from './store';
 
-const PLAIN_GEOMETRY_DEFINITION = {
+const PLAIN_GEOMETRY_DEFINITION = () => ({
   offset: 8,
   position: {
     type: 'Float32',
@@ -29,9 +29,9 @@ const PLAIN_GEOMETRY_DEFINITION = {
     type: 'UInt32',
     component: 2
   }
-};
+});
 
-const PLAIN_GEOMETRY_DEFINITION_WITHOUT_UV0 = {
+const PLAIN_GEOMETRY_DEFINITION_WITHOUT_UV0 = () => ({
   offset: 8,
   position: {
     type: 'Float32',
@@ -55,23 +55,23 @@ const PLAIN_GEOMETRY_DEFINITION_WITHOUT_UV0 = {
     type: 'UInt32',
     component: 2
   }
-};
+});
 
-const COMPRESSED_GEOMETRY_DEFINITION = {
+const COMPRESSED_GEOMETRY_DEFINITION = () => ({
   compressedAttributes: {
     encoding: 'draco',
     attributes: ['position', 'normal', 'uv0', 'color', 'feature-index']
   }
-};
+});
 
-const COMPRESSED_GEOMETRY_DEFINITION_WITHOUT_UV0 = {
+const COMPRESSED_GEOMETRY_DEFINITION_WITHOUT_UV0 = () => ({
   compressedAttributes: {
     encoding: 'draco',
     attributes: ['position', 'normal', 'color', 'feature-index']
   }
-};
+});
 
-const SPATIAL_REFERENCE = {
+const SPATIAL_REFERENCE = () => ({
   wkid: {
     path: 'wkid',
     default: 4326
@@ -88,9 +88,9 @@ const SPATIAL_REFERENCE = {
     path: 'latestVcsWkid',
     default: 5773
   }
-};
+});
 
-const HEIGHT_MODEL_INFO = {
+const HEIGHT_MODEL_INFO = () => ({
   heightModel: {
     path: 'heightModel',
     default: 'gravity_related_height'
@@ -103,9 +103,9 @@ const HEIGHT_MODEL_INFO = {
     path: 'heightUnit',
     default: 'meter'
   }
-};
+});
 
-const NODE_PAGES = {
+const NODE_PAGES = () => ({
   nodesPerPage: {
     path: 'nodesPerPage'
   },
@@ -113,9 +113,9 @@ const NODE_PAGES = {
     path: 'lodSelectionMetricType',
     default: 'maxScreenThresholdSQ'
   }
-};
+});
 
-export const LAYERS = {
+export const LAYERS = () => ({
   version: {
     path: 'version',
     transform: (val) => val.toUpperCase()
@@ -137,7 +137,7 @@ export const LAYERS = {
   },
   spatialReference: {
     path: 'spatialReference',
-    transform: (val) => transform(val, SPATIAL_REFERENCE)
+    transform: (val) => transform(val, SPATIAL_REFERENCE())
   },
   capabilities: {
     path: 'capabilities',
@@ -149,11 +149,11 @@ export const LAYERS = {
   },
   heightModelInfo: {
     path: 'heightModelInfo',
-    transform: (val) => transform(val, HEIGHT_MODEL_INFO)
+    transform: (val) => transform(val, HEIGHT_MODEL_INFO())
   },
   nodePages: {
     path: 'nodePages',
-    transform: (val) => transform(val, NODE_PAGES)
+    transform: (val) => transform(val, NODE_PAGES())
   },
   materialDefinitions: {
     path: 'materialDefinitions',
@@ -166,21 +166,23 @@ export const LAYERS = {
   geometryDefinitions: {
     path: 'compressGeometry',
     transform: (val) => {
-      const result = [{}, {}];
-      result[0].geometryBuffers = [];
-      result[1].geometryBuffers = [];
+      const result = [{geometryBuffers: []}, {geometryBuffers: []}];
 
-      result[0].geometryBuffers.push(PLAIN_GEOMETRY_DEFINITION);
-      result[1].geometryBuffers.push(PLAIN_GEOMETRY_DEFINITION_WITHOUT_UV0);
+      // @ts-expect-error
+      result[0].geometryBuffers.push(PLAIN_GEOMETRY_DEFINITION());
+      // @ts-expect-error
+      result[1].geometryBuffers.push(PLAIN_GEOMETRY_DEFINITION_WITHOUT_UV0());
       if (val) {
-        result[0].geometryBuffers.push(COMPRESSED_GEOMETRY_DEFINITION);
-        result[1].geometryBuffers.push(COMPRESSED_GEOMETRY_DEFINITION_WITHOUT_UV0);
+        // @ts-expect-error
+        result[0].geometryBuffers.push(COMPRESSED_GEOMETRY_DEFINITION());
+        // @ts-expect-error
+        result[1].geometryBuffers.push(COMPRESSED_GEOMETRY_DEFINITION_WITHOUT_UV0());
       }
       return result;
     },
     default: [
       {
-        geometryBuffers: [PLAIN_GEOMETRY_DEFINITION, PLAIN_GEOMETRY_DEFINITION_WITHOUT_UV0]
+        geometryBuffers: [PLAIN_GEOMETRY_DEFINITION(), PLAIN_GEOMETRY_DEFINITION_WITHOUT_UV0()]
       }
     ]
   },
@@ -196,4 +198,4 @@ export const LAYERS = {
     path: 'popupInfo',
     default: null
   }
-};
+});

package/src/i3s-converter/json-templates/{metadata.js → metadata.ts}

@@ -1,4 +1,4 @@
-export const METADATA = {
+export const METADATA = () => ({
   folderPattern: {
     path: 'folderPattern',
     default: 'BASIC'
@@ -18,4 +18,4 @@ export const METADATA = {
   nodeCount: {
     path: 'nodeCount'
   }
-};
+});

package/src/i3s-converter/json-templates/{node.js → node.ts}

@@ -1,29 +1,29 @@
 import transform from 'json-map-transform';
 
-const COORDINATES = {
+const COORDINATES = () => ({
   mbs: {
     path: 'mbs'
   },
   obb: {
     path: 'obb'
   }
-};
+});
 
-const _href = {
+const HREF = () => ({
   href: {
     path: 'href'
   }
-};
+});
 
-const PARENT_NODE = {
+const PARENT_NODE = () => ({
   id: {
     path: 'id'
   },
-  ..._href,
-  ...COORDINATES
-};
+  ...HREF(),
+  ...COORDINATES()
+});
 
-export const NODE = {
+export const NODE = () => ({
   version: {
     path: 'version'
   },
@@ -36,7 +36,7 @@ export const NODE = {
   level: {
     path: 'level'
   },
-  ...COORDINATES,
+  ...COORDINATES(),
   lodSelection: {
     path: 'lodSelection',
     default: [
@@ -60,7 +60,7 @@ export const NODE = {
   },
   parentNode: {
     path: 'parentNode',
-    transform: (val) => transform(val, PARENT_NODE),
+    transform: (val) => transform(val, PARENT_NODE()),
     default: null
   },
   sharedResource: {
@@ -83,4 +83,4 @@ export const NODE = {
     path: 'attributeData',
     default: null
   }
-};
+});

package/src/i3s-converter/json-templates/{scene-server.js → scene-server.ts}

@@ -1,4 +1,4 @@
-export const SCENE_SERVER_TEMPLATE = {
+export const SCENE_SERVER = () => ({
   serviceItemId: {
     path: 'serviceItemId'
   },
@@ -24,4 +24,4 @@ export const SCENE_SERVER_TEMPLATE = {
     path: 'layers0',
     transform: (layers0) => [layers0]
   }
-};
+});

package/src/i3s-converter/json-templates/{shared-resources.js → shared-resources.ts}

@@ -1,6 +1,6 @@
 import transform from 'json-map-transform';
 
-const MATERIAL_DEFINITION_INFO_PARAMS = {
+const MATERIAL_DEFINITION_INFO_PARAMS = () => ({
   renderMode: {
     path: 'renderMode',
     default: 'solid'
@@ -37,9 +37,9 @@ const MATERIAL_DEFINITION_INFO_PARAMS = {
     path: 'vertexColors',
     default: true
   }
-};
+});
 
-const MATERIAL_DEFINITION_INFO = {
+const MATERIAL_DEFINITION_INFO = () => ({
   name: {
     path: 'name',
     default: 'standard'
@@ -51,11 +51,11 @@ const MATERIAL_DEFINITION_INFO = {
   params: {
     path: 'params',
     transform: (val, thisObject, originalObject) =>
-      transform(originalObject, MATERIAL_DEFINITION_INFO_PARAMS)
+      transform(originalObject, MATERIAL_DEFINITION_INFO_PARAMS())
   }
-};
+});
 
-const TEXTURE_DEFINITION_IMAGE = {
+const TEXTURE_DEFINITION_IMAGE = () => ({
   id: {
     path: 'id'
   },
@@ -69,9 +69,9 @@ const TEXTURE_DEFINITION_IMAGE = {
   length: {
     path: 'length'
   }
-};
+});
 
-const TEXTURE_DEFINITION_INFO = {
+const TEXTURE_DEFINITION_INFO = () => ({
   encoding: {
     path: 'encoding'
   },
@@ -94,11 +94,11 @@ const TEXTURE_DEFINITION_INFO = {
   images: {
     path: 'images',
     transform: (val, thisObject, originalObject) =>
-      val.map((image) => transform(image, TEXTURE_DEFINITION_IMAGE))
+      val.map((image) => transform(image, TEXTURE_DEFINITION_IMAGE()))
   }
-};
+});
 
-export const SHARED_RESOURCES_TEMPLATE = {
+export const SHARED_RESOURCES = () => ({
   materialDefinitions: {
     path: 'materialDefinitionInfos',
     transform: transfromMaterialDefinitions
@@ -107,14 +107,14 @@ export const SHARED_RESOURCES_TEMPLATE = {
     path: 'textureDefinitionInfos',
     transform: transfromTextureDefinitions
   }
-};
+});
 
 function transfromMaterialDefinitions(materialDefinitionInfos, thisObject, originalObject) {
   const result = {};
   for (const [index, materialDefinitionInfo] of materialDefinitionInfos.entries()) {
     result[`Mat${originalObject.nodePath}${index}`] = transform(
       materialDefinitionInfo,
-      MATERIAL_DEFINITION_INFO
+      MATERIAL_DEFINITION_INFO()
     );
   }
   return result;
@@ -128,7 +128,7 @@ function transfromTextureDefinitions(textureDefinitionInfos, thisObject, origina
   for (const [index, textureDefinitionInfo] of textureDefinitionInfos.entries()) {
     const imageIndex = `${originalObject.nodePath}${index}`;
     textureDefinitionInfo.imageIndex = imageIndex;
-    result[imageIndex] = transform(textureDefinitionInfo, TEXTURE_DEFINITION_INFO);
+    result[imageIndex] = transform(textureDefinitionInfo, TEXTURE_DEFINITION_INFO());
   }
   return result;
 }

package/src/i3s-converter/types.ts

@@ -0,0 +1,14 @@
+import {BoundingVolumes, I3SMaterialDefinition, SharedResources} from '@loaders.gl/i3s';
+
+export type I3SConvertedResources = {
+  geometry: ArrayBuffer | null;
+  compressedGeometry?: ArrayBuffer | null;
+  texture: any | null;
+  sharedResources: SharedResources | null;
+  meshMaterial?: I3SMaterialDefinition | null;
+  vertexCount: number | null;
+  attributes: any | null;
+  featureCount: number | null;
+  geometryBuffer?: ArrayBuffer;
+  boundingVolumes: BoundingVolumes | null;
+};

package/src/pgm-loader.ts

@@ -4,7 +4,7 @@ import type {LoaderWithParser} from '@loaders.gl/loader-utils';
 // @ts-ignore TS2304: Cannot find name '__VERSION__'.
 const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
 
-import {parsePgm} from './lib/pgm-parser';
+import {parsePGM} from '@math.gl/geoid';
 
 /**
  * Loader for PGM - Netpbm grayscale image format
@@ -15,7 +15,7 @@ export const PGMLoader: LoaderWithParser = {
   module: 'tile-converter',
   version: VERSION,
   mimeTypes: ['image/x-portable-graymap'],
-  parse: (arrayBuffer, options) => parsePgm(new Uint8Array(arrayBuffer), options),
+  parse: async (arrayBuffer, options) => parsePGM(new Uint8Array(arrayBuffer), options),
   extensions: ['pgm'],
   options: {
     // TODO - use pgm namespace

package/dist/es5/3d-tiles-converter/helpers/b3dm-converter.d.ts

@@ -1,23 +0,0 @@
-/**
- * Converts content of an I3S node to *.b3dm's file content
- */
-export default class B3dmConverter {
-  rtcCenter: Float32Array;
-  i3sTile: any;
-
-  constructor();
-
-  /**
-   * The starter of content conversion
-   * @param i3sTile - Tile3D instance for I3S node
-   * @returns - encoded content
-   */
-  convert(i3sTile: Object, attributes?: any): ArrayBuffer;
-
-  /**
-   * Build and encode gltf
-   * @param i3sTile - Tile3D instance for I3S node
-   * @returns - encoded glb content
-   */
-  buildGltf(i3sTile): ArrayBuffer;
-}

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

@@ -1,16 +0,0 @@
-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 function i3sObbTo3dTilesObb(
-  i3SObb: {
-    center: number[];
-    halfSize: number[];
-    quaternion: number[];
-  },
-  geoidHeightModel: GeoidHeightModel
-): number[];

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

@@ -1,144 +0,0 @@
-/**
- * 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;
-    };
-  };
-};
-
-/**
- * class NodePages - wrapper of nodePages array
- *
- * @example
- * 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({
-      lodThreshold: HARDCODED_MAX_SCREEN_THRESHOLD_SQ,
-      obb: coordinates.obb,
-      children: []
-    });
- * ...
- * // push node with parent relation
- * const nodeInPage = {
-      lodThreshold: HARDCODED_MAX_SCREEN_THRESHOLD_SQ,
-      obb: coordinates.obb,
-      children: [],
-      mesh: {
-        geometry: {
-          definition: 0
-        }
-      }
-    };
- * const nodeId = this.nodePages.push(nodeInPage, parentId);
- * ...
- * // 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>;
-}

package/dist/es5/lib/geoid-height-model.d.ts

@@ -1,41 +0,0 @@
-/**
- * class GeoidHeightModel - "Gravity Height Model"
- * Calculates difference between mean see level height and WGS84 ellipsoid height
- * Input data have to be loaded from "Earth Gravity Model" *.pgm file with "PGMLoader"
- * A particular model file can be loaded on https://geographiclib.sourceforge.io/html/geoid.html
- *
- * The implementation is ported from GeographicLib-1.50.1
- */
-export class GeoidHeightModel {
-  /**
-   * @constructs
-   * Create a GeoidHeightModel instance.
-   * @param options - object which includes parameters parsed from *.pgm header
-   * @param options.data - binary buffer of *.pgm file
-   */
-  constructor(options: {
-    cubic: boolean;
-    _width: number;
-    _height: number;
-    _rlonres: number;
-    _rlatres: number;
-    _offset: number;
-    _scale: number;
-    _swidth: number;
-    _datastart: number;
-    _maxerror: number;
-    _rmserror: number;
-    _description: string;
-    _datetime: string;
-    data: Uint8Array;
-  });
-
-  /**
-   * Calculates difference between mean see level height and WGS84 ellipsoid height
-   * Code is ported from /GeographicLib-1.50.1/src/Geoid.cpp
-   * @param lat - latitude
-   * @param lon - longitude
-   * @returns height in meters
-   */
-  getHeight(lat: number, lon: number): number;
-}