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

package/dist/converter-cli.js

@@ -0,0 +1,232 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable no-console */
+require("@loaders.gl/polyfills");
+const path_1 = require("path");
+const tile_converter_1 = require("@loaders.gl/tile-converter");
+const deps_installer_1 = require("./deps-installer/deps-installer");
+const TILESET_TYPE = {
+    I3S: 'I3S',
+    _3DTILES: '3DTILES'
+};
+/**
+ * CLI entry
+ * @returns
+ */
+async function main() {
+    const [, , ...args] = process.argv;
+    if (args.length === 0) {
+        printHelp();
+    }
+    const options = parseOptions(args);
+    if (options.installDependencies) {
+        const depthInstaller = new deps_installer_1.DepsInstaller();
+        depthInstaller.install('deps');
+        return;
+    }
+    const validatedOptions = 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() {
+    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) {
+    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 tile_converter_1.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 tile_converter_1.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) {
+    const mandatoryOptionsWithExceptions = {
+        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 = [];
+    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 options;
+}
+/**
+ * Parse option from the cli arguments array
+ * @param args
+ * @returns
+ */
+function parseOptions(args) {
+    const opts = {
+        output: 'data',
+        sevenZipExe: 'C:\\Program Files\\7-Zip\\7z.exe',
+        egm: (0, path_1.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, args) {
+    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, args) {
+    const stringValue = getStringValue(index, args);
+    const result = Number.parseInt(stringValue);
+    if (isFinite(result)) {
+        return result;
+    }
+    return NaN;
+}