@loaders.gl/tile-converter 3.1.8 → 3.2.0-alpha.3

package/src/converter-cli.ts

@@ -0,0 +1,310 @@
+/* eslint-disable no-console */
+import '@loaders.gl/polyfills';
+import {join} from 'path';
+import {I3SConverter, Tiles3DConverter} from '@loaders.gl/tile-converter';
+import {DepsInstaller} from './deps-installer/deps-installer';
+
+type TileConversionOptions = {
+  /** "I3S" - for I3S to 3DTiles conversion, "3DTILES" for 3DTiles to I3S conversion */
+  inputType?: string;
+  /** "tileset.json" file (3DTiles) / "http://..../SceneServer/layers/0" resource (I3S) */
+  tileset?: string;
+  /** Tileset name. This option is used for naming in resulting json resouces and for resulting path/*.slpk file naming */
+  name?: string;
+  /** Output folder. This folder will be created by converter if doesn't exist. It is relative to the converter path.
+   * Default: "data" folder */
+  output: string;
+  /** 3DTiles->I3S only. location of 7z.exe archiver to create slpk on Windows OS, default: "C:\Program Files\7-Zip\7z.exe" */
+  sevenZipExe: string;
+  /** location of the Earth Gravity Model (*.pgm) file to convert heights from ellipsoidal to gravity-related format,
+   * default: "./deps/egm2008-5.pgm". A model file can be loaded from GeographicLib
+   * https://geographiclib.sourceforge.io/html/geoid.html */
+  egm: string;
+  /** 3DTile->I3S only. Token for Cesium ION tileset authentication. */
+  token?: string;
+  /** 3DTiles->I3S only. Enable draco compression for geometry. Default: true */
+  draco: boolean;
+  /** Run the script for installing dependencies. Run this options separate from others. Now "*.pgm" file installation is
+   * implemented */
+  installDependencies: boolean;
+  /** 3DTile->I3S only. Enable KTX2 textures generation if only one of (JPG, PNG) texture is provided or generate JPG texture
+   * if only KTX2 is provided */
+  generateTextures: boolean;
+  /** 3DTile->I3S only. Will generate obb and mbs bounding volumes from geometry */
+  generateBoundingVolumes: boolean;
+  /** Validate the dataset during conversion. Validation messages will be posted in the console output */
+  validate: boolean;
+  /** Maximal depth of the hierarchical tiles tree traversal, default: infinite */
+  maxDepth?: number;
+  /** 3DTiles->I3S only. Whether the converter generates *.slpk (Scene Layer Package) I3S output file */
+  slpk: boolean;
+};
+
+/* During validation we check that particular options are defined so they can't be undefined */
+type ValidatedTileConversionOptions = TileConversionOptions & {
+  /** "I3S" - for I3S to 3DTiles conversion, "3DTILES" for 3DTiles to I3S conversion */
+  inputType: string;
+  /** "tileset.json" file (3DTiles) / "http://..../SceneServer/layers/0" resource (I3S) */
+  tileset: string;
+  /** Tileset name. This option is used for naming in resulting json resouces and for resulting path/*.slpk file naming */
+  name: string;
+};
+
+const TILESET_TYPE = {
+  I3S: 'I3S',
+  _3DTILES: '3DTILES'
+};
+
+/**
+ * CLI entry
+ * @returns
+ */
+async function main() {
+  const [, , ...args] = process.argv;
+
+  if (args.length === 0) {
+    printHelp();
+  }
+
+  const options: TileConversionOptions = parseOptions(args);
+
+  if (options.installDependencies) {
+    const depthInstaller = new DepsInstaller();
+    depthInstaller.install('deps');
+    return;
+  }
+
+  const validatedOptions: ValidatedTileConversionOptions = validateOptions(options);
+
+  await convert(validatedOptions);
+}
+
+main().catch((error) => {
+  console.log(error);
+  process.exit(1); // eslint-disable-line
+});
+
+/**
+ * Output for `npx tile-converter --help`
+ */
+function printHelp(): void {
+  console.log('cli: converter 3dTiles to I3S or I3S to 3dTiles...');
+  console.log(
+    '--install-dependencies [Run the script for installing dependencies. Run this options separate from others. Now "*.pgm" file installation is implemented]'
+  );
+  console.log(
+    '--max-depth [Maximal depth of hierarchical tiles tree traversal, default: infinite]'
+  );
+  console.log('--name [Tileset name]');
+  console.log('--output [Output folder, default: "data" folder]');
+  console.log('--slpk [Generate slpk (Scene Layer Packages) I3S output file]');
+  console.log(
+    '--tileset [tileset.json file (3DTiles) / http://..../SceneServer/layers/0 resource (I3S)]'
+  );
+  console.log('--input-type [tileset input type: I3S or 3DTILES]');
+  console.log(
+    '--7zExe [location of 7z.exe archiver to create slpk on Windows, default: "C:\\Program Files\\7-Zip\\7z.exe"]'
+  );
+  console.log(
+    '--egm [location of Earth Gravity Model *.pgm file to convert heights from ellipsoidal to gravity-related format. A model file can be loaded from GeographicLib https://geographiclib.sourceforge.io/html/geoid.html], default: "./deps/egm2008-5.zip"'
+  );
+  console.log('--token [Token for Cesium ION tilesets authentication]');
+  console.log('--no-draco [Disable draco compression for geometry]');
+  console.log(
+    '--generate-textures [Enable KTX2 textures generation if only one of (JPG, PNG) texture is provided or generate JPG texture if only KTX2 is provided]'
+  );
+  console.log(
+    '--generate-bounding-volumes [Will generate obb and mbs bounding volumes from geometry]'
+  );
+  console.log('--validate [Enable validation]');
+  process.exit(0); // eslint-disable-line
+}
+
+/**
+ * Run conversion process
+ * @param options validated tile-converter options
+ */
+async function convert(options: ValidatedTileConversionOptions) {
+  console.log(`------------------------------------------------`); // eslint-disable-line
+  console.log(`Starting conversion of ${options.inputType}`); // eslint-disable-line
+  console.log(`------------------------------------------------`); // eslint-disable-line
+  const inputType = options.inputType.toUpperCase();
+  switch (inputType) {
+    case TILESET_TYPE.I3S:
+      const tiles3DConverter = new Tiles3DConverter();
+      tiles3DConverter.convert({
+        inputUrl: options.tileset,
+        outputPath: options.output,
+        tilesetName: options.name,
+        maxDepth: options.maxDepth,
+        egmFilePath: options.egm
+      });
+      break;
+    case TILESET_TYPE._3DTILES:
+      const converter = new I3SConverter();
+      await converter.convert({
+        inputUrl: options.tileset,
+        outputPath: options.output,
+        tilesetName: options.name,
+        maxDepth: options.maxDepth,
+        slpk: options.slpk,
+        sevenZipExe: options.sevenZipExe,
+        egmFilePath: options.egm,
+        token: options.token,
+        draco: options.draco,
+        generateTextures: options.generateTextures,
+        generateBoundingVolumes: options.generateBoundingVolumes,
+        validate: options.validate
+      });
+      break;
+    default:
+      printHelp();
+  }
+}
+
+// OPTIONS
+/**
+ * Validate input options of the CLI command
+ * @param options - input options of the CLI command
+ * @returns validated options
+ */
+function validateOptions(options: TileConversionOptions): ValidatedTileConversionOptions {
+  const mandatoryOptionsWithExceptions: {
+    [key: string]: () => void;
+  } = {
+    name: () => console.log('Missed: --name [Tileset name]'),
+    output: () => console.log('Missed: --output [Output path name]'),
+    sevenZipExe: () => console.log('Missed: --7zExe [7z archiver executable path]'),
+    egm: () => console.log('Missed: --egm [*.pgm earth gravity model file path]'),
+    tileset: () => console.log('Missed: --tileset [tileset.json file]'),
+    inputType: () =>
+      console.log('Missed/Incorrect: --input-type [tileset input type: I3S or 3DTILES]')
+  };
+  const exceptions: (() => void)[] = [];
+  for (const mandatoryOption in mandatoryOptionsWithExceptions) {
+    const optionValue = options[mandatoryOption];
+    const isWrongInputType =
+      Boolean(optionValue) &&
+      mandatoryOption === 'inputType' &&
+      !Object.values(TILESET_TYPE).includes(optionValue.toUpperCase());
+
+    if (!optionValue || isWrongInputType) {
+      exceptions.push(mandatoryOptionsWithExceptions[mandatoryOption]);
+    }
+  }
+  if (exceptions.length) {
+    exceptions.forEach((exeption) => exeption());
+    process.exit(0); // eslint-disable-line
+  }
+  return <ValidatedTileConversionOptions>options;
+}
+
+/**
+ * Parse option from the cli arguments array
+ * @param args
+ * @returns
+ */
+function parseOptions(args: string[]): TileConversionOptions {
+  const opts: TileConversionOptions = {
+    output: 'data',
+    sevenZipExe: 'C:\\Program Files\\7-Zip\\7z.exe',
+    egm: join(process.cwd(), 'deps', 'egm2008-5.pgm'),
+    draco: true,
+    installDependencies: false,
+    generateTextures: false,
+    generateBoundingVolumes: false,
+    validate: false,
+    slpk: false
+  };
+
+  // eslint-disable-next-line complexity
+  args.forEach((arg, index) => {
+    if (arg.indexOf('--') === 0) {
+      switch (arg) {
+        case '--input-type':
+          opts.inputType = getStringValue(index, args);
+          break;
+        case '--tileset':
+          opts.tileset = getStringValue(index, args);
+          break;
+        case '--name':
+          opts.name = getStringValue(index, args);
+          break;
+        case '--output':
+          opts.output = getStringValue(index, args);
+          break;
+        case '--max-depth':
+          opts.maxDepth = getIntegerValue(index, args);
+          break;
+        case '--slpk':
+          opts.slpk = true;
+          break;
+        case '--7zExe':
+          opts.sevenZipExe = getStringValue(index, args);
+          break;
+        case '--egm':
+          opts.egm = getStringValue(index, args);
+          break;
+        case '--token':
+          opts.token = getStringValue(index, args);
+          break;
+        case '--no-draco':
+          opts.draco = false;
+          break;
+        case '--validate':
+          opts.validate = true;
+          break;
+        case '--install-dependencies':
+          opts.installDependencies = true;
+          break;
+        case '--generate-textures':
+          opts.generateTextures = true;
+          break;
+        case '--generate-bounding-volumes':
+          opts.generateBoundingVolumes = true;
+          break;
+        case '--help':
+          printHelp();
+          break;
+        default:
+          console.warn(`Unknown option ${arg}`);
+          process.exit(0); // eslint-disable-line
+      }
+    }
+  });
+  return opts;
+}
+
+/**
+ * Get string option value from cli arguments
+ * @param index - option's name index in the argument's array.
+ *                The value of the option should be next to name of the option.
+ * @param args - cli arguments array
+ * @returns - string value of the option
+ */
+function getStringValue(index: number, args: string[]): string {
+  if (index + 1 >= args.length) {
+    return '';
+  }
+  const value = args[index + 1];
+  if (value.indexOf('--') === 0) {
+    return '';
+  }
+  return value;
+}
+
+/**
+ * Get integer option value from cli arguments
+ * @param index - option's name index in the argument's array
+ *                The value of the option should be next to name of the option.
+ * @param args - cli arguments array
+ * @returns - number value of the option
+ */
+function getIntegerValue(index: number, args: string[]): number {
+  const stringValue: string = getStringValue(index, args);
+  const result: number = Number.parseInt(stringValue);
+  if (isFinite(result)) {
+    return result;
+  }
+  return NaN;
+}

package/src/deps-installer/{deps-installer.js → deps-installer.ts}

@@ -5,8 +5,18 @@ import {join} from 'path';
 
 const PGM_LINK = 'https://raw.githubusercontent.com/visgl/deck.gl-data/master/egm/egm2008-5.zip';
 
+/**
+ * Install external dependencies for converter:
+ * * PGM file (implemented);
+ * * Draco library (not implemented);
+ * * 7z archiver (not implemented);
+ */
 export class DepsInstaller {
-  async install(path = '') {
+  /**
+   * Run instalation
+   * @param path destination folder
+   */
+  async install(path: string = ''): Promise<void> {
     console.log('Installing "EGM2008-5" model...'); // eslint-disable-line no-console
     const fileMap = await load(PGM_LINK, ZipLoader, {});
 

package/src/i3s-attributes-worker.ts

@@ -0,0 +1,46 @@
+import type {WorkerObject} from '@loaders.gl/worker-utils';
+import type {ConvertedAttributes} from './i3s-converter/types';
+import type {Matrix4, Vector3} from '@math.gl/core';
+
+import {processOnWorker} from '@loaders.gl/worker-utils';
+
+// __VERSION__ is injected by babel-plugin-version-inline
+// @ts-ignore TS2304: Cannot find name '__VERSION__'.
+const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
+
+export type I3SAttributesWorkerOptions = {
+  useCartesianPositions: boolean;
+  source: string;
+};
+
+export type B3DMAttributesData = {
+  gltfMaterials?: {id: string}[];
+  nodes: any;
+  cartographicOrigin: Vector3;
+  cartesianModelMatrix: Matrix4;
+};
+
+/**
+ * I3S Attributes Worker to handle B3DM object
+ */
+export const I3SAttributesWorker = {
+  id: 'i3s-attributes',
+  name: 'I3S Attributes Worker',
+  module: 'tile-converter',
+  version: VERSION,
+  options: {
+    useCartesianPositions: false
+  }
+};
+
+/**
+ * Performs I3S attributes transformation
+ */
+export function transformI3SAttributesOnWorker(
+  attributesData: B3DMAttributesData,
+  options: I3SAttributesWorkerOptions
+): Promise<Map<string, ConvertedAttributes>> {
+  return processOnWorker(I3SAttributesWorker, attributesData, options);
+}
+
+export const _typecheckI3SAttributesWorker: WorkerObject = I3SAttributesWorker;

package/src/i3s-converter/helpers/coordinate-converter.ts

@@ -1,15 +1,15 @@
-import type {BoundingVolumes, Extent, Mbs, Obb} from '@loaders.gl/i3s';
+import type {BoundingVolumes, FullExtent, Mbs, Obb} from '@loaders.gl/i3s';
 
 import {Matrix3, Quaternion, Vector3} from '@math.gl/core';
 import {Ellipsoid} from '@math.gl/geospatial';
 import {
   OrientedBoundingBox,
   makeOrientedBoundingBoxFromPoints,
-  makeBoundingSphereFromPoints
+  makeBoundingSphereFromPoints,
+  BoundingSphere
 } from '@math.gl/culling';
 import TileHeader from '@loaders.gl/tiles/src/tileset/tile-3d';
 import {Geoid} from '@math.gl/geoid';
-import {Tileset3D} from '@loaders.gl/tiles';
 
 /**
  * Create bounding volumes object from tile and geoid height model.
@@ -101,34 +101,39 @@ export function convertPositionsToVectors(positions: Float32Array): Vector3[] {
 }
 
 /**
- * Convert common coordinate to extent coordinate
- * @param tileset
- * @returns - Extent
- * @todo why lodMetricValue is radius? need to check this function
+ * Convert common coordinate to fullExtent https://github.com/Esri/i3s-spec/blob/master/docs/1.8/fullExtent.cmn.md
+ * @param
+ * @param boundingVolume
+ * @returns - fullExtent object
  */
-export function convertCommonToI3SExtentCoordinate(tileset: Tileset3D | null): Extent | null {
-  const cartesianCenter = tileset?.cartesianCenter;
-  if (!cartesianCenter) {
-    return null;
+export function convertBoundingVolumeToI3SFullExtent(
+  boundingVolume: OrientedBoundingBox | BoundingSphere
+): FullExtent {
+  let sphere: BoundingSphere;
+  if (boundingVolume instanceof BoundingSphere) {
+    sphere = boundingVolume;
+  } else {
+    sphere = boundingVolume.getBoundingSphere();
   }
-  const radius = tileset?.lodMetricValue;
-  const rightTop = Ellipsoid.WGS84.cartesianToCartographic(
-    new Vector3(cartesianCenter[0] + radius, cartesianCenter[1] + radius, cartesianCenter[2]),
+  const center: Vector3 = sphere.center;
+  const radius: number = sphere.radius;
+  const vertexMax = Ellipsoid.WGS84.cartesianToCartographic(
+    new Vector3(center[0] + radius, center[1] + radius, center[2] + radius),
     new Vector3()
   );
-  const leftBottom = Ellipsoid.WGS84.cartesianToCartographic(
-    new Vector3(cartesianCenter[0] - radius, cartesianCenter[1] - radius, cartesianCenter[2]),
+  const vertexMin = Ellipsoid.WGS84.cartesianToCartographic(
+    new Vector3(center[0] - radius, center[1] - radius, center[2] - radius),
     new Vector3()
   );
-  const isFirstRight = rightTop[0] < leftBottom[0];
-  const isFirstTop = rightTop[1] < leftBottom[1];
 
-  return [
-    isFirstRight ? rightTop[0] : leftBottom[0],
-    isFirstTop ? rightTop[1] : leftBottom[1],
-    isFirstRight ? leftBottom[0] : rightTop[0],
-    isFirstTop ? leftBottom[1] : rightTop[1]
-  ];
+  return {
+    xmin: vertexMin[0],
+    xmax: vertexMax[0],
+    ymin: vertexMin[1],
+    ymax: vertexMax[1],
+    zmin: vertexMin[2],
+    zmax: vertexMax[2]
+  };
 }
 
 /**

package/src/i3s-converter/helpers/geometry-attributes.ts

@@ -1,4 +1,4 @@
-import type {GeometryAttributes, AttributesData, GroupedByFeatureIdAttributes} from '../types';
+import type {GeometryAttributes, ConvertedAttributes, GroupedByFeatureIdAttributes} from '../types';
 import {concatenateTypedArrays} from '@loaders.gl/loader-utils';
 
 const VALUES_PER_VERTEX = 3;
@@ -9,8 +9,9 @@ const POSITIONS_AND_NORMALS_PER_TRIANGLE = 9;
  * @param attributes
  * @returns attirbutes with featureCount, featureIds and changed faceRange.
  */
-export function generateAttributes(attributes: AttributesData): GeometryAttributes {
-  const {positions, normals, texCoords, colors, featureIndices, triangleCount} = attributes;
+export function generateAttributes(attributes: ConvertedAttributes): GeometryAttributes {
+  const {positions, normals, texCoords, colors, featureIndices} = attributes;
+  const triangleCount = positions.length / POSITIONS_AND_NORMALS_PER_TRIANGLE;
 
   if (!featureIndices.length) {
     return {