@loaders.gl/tile-converter 3.2.0-alpha.2 → 3.2.0

package/dist/3d-tiles-converter/3d-tiles-converter.d.ts

@@ -29,7 +29,7 @@ export default class Tiles3DConverter {
         inputUrl: string;
         outputPath: string;
         tilesetName: string;
-        maxDepth: number;
+        maxDepth?: number;
         egmFilePath: string;
     }): Promise<any>;
     /**

package/dist/3d-tiles-converter/3d-tiles-converter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"3d-tiles-converter.d.ts","sourceRoot":"","sources":["../../src/3d-tiles-converter/3d-tiles-converter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,oBAAoB,EAAkC,MAAM,iBAAiB,CAAC;AAQ3F,OAAO,EAAC,SAAS,EAAS,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAC,KAAK,EAAC,MAAM,gBAAgB,CAAC;AAmBrC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACnC,OAAO,EAAE,GAAG,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,mBAAmB,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,gBAAgB,EAAE,KAAK,GAAG,IAAI,CAAC;IAC/B,aAAa,EAAE,SAAS,GAAG,IAAI,CAAC;IAChC,oBAAoB,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAClD,YAAY,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAC,CAAM;;IAa3C;;;;;;;;OAQG;IACU,OAAO,CAAC,OAAO,EAAE;QAC5B,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,CAAC;QACnB,WAAW,EAAE,MAAM,CAAC;QACpB,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,GAAG,CAAC;IAsDhB;;;;;OAKG;YACW,YAAY;IAgE1B;;;;;OAKG;YACW,cAAc;IAyB5B;;;;OAIG;IACH,OAAO,CAAC,qBAAqB;IAiB7B;;;;;OAKG;YACW,oBAAoB;IAsBlC;;;;;;OAMG;IACH,OAAO,CAAC,iBAAiB;IASzB;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAU5B;;;OAGG;YACW,iBAAiB;YAiBjB,WAAW;CAS1B"}
+{"version":3,"file":"3d-tiles-converter.d.ts","sourceRoot":"","sources":["../../src/3d-tiles-converter/3d-tiles-converter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,oBAAoB,EAAkC,MAAM,iBAAiB,CAAC;AAQ3F,OAAO,EAAC,SAAS,EAAS,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAC,KAAK,EAAC,MAAM,gBAAgB,CAAC;AAoBrC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACnC,OAAO,EAAE,GAAG,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,mBAAmB,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,gBAAgB,EAAE,KAAK,GAAG,IAAI,CAAC;IAC/B,aAAa,EAAE,SAAS,GAAG,IAAI,CAAC;IAChC,oBAAoB,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAClD,YAAY,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAC,CAAM;;IAa3C;;;;;;;;OAQG;IACU,OAAO,CAAC,OAAO,EAAE;QAC5B,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,CAAC;QACnB,WAAW,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,WAAW,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,GAAG,CAAC;IA0DhB;;;;;OAKG;YACW,YAAY;IAgE1B;;;;;OAKG;YACW,cAAc;IAyB5B;;;;OAIG;IACH,OAAO,CAAC,qBAAqB;IAiB7B;;;;;OAKG;YACW,oBAAoB;IAsBlC;;;;;;OAMG;IACH,OAAO,CAAC,iBAAiB;IASzB;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAU5B;;;OAGG;YACW,iBAAiB;YAiBjB,WAAW;CAS1B"}

package/dist/3d-tiles-converter/3d-tiles-converter.js

@@ -19,6 +19,7 @@ const b3dm_converter_1 = __importDefault(require("./helpers/b3dm-converter"));
 const coordinate_converter_1 = require("../i3s-converter/helpers/coordinate-converter");
 const _3d_tiles_attributes_worker_1 = require("../3d-tiles-attributes-worker");
 const worker_utils_1 = require("@loaders.gl/worker-utils");
+const constants_1 = require("../constants");
 const I3S = 'I3S';
 /**
  * Converter from i3s to 3d-tiles
@@ -45,6 +46,10 @@ class Tiles3DConverter {
      * @param options.maxDepth The max tree depth of conversion
      */
     async convert(options) {
+        if (core_1.isBrowser) {
+            console.log(constants_1.BROWSER_ERROR_MESSAGE);
+            return constants_1.BROWSER_ERROR_MESSAGE;
+        }
         const { inputUrl, outputPath, tilesetName, maxDepth, egmFilePath } = options;
         this.conversionStartTime = process_1.default.hrtime();
         this.options = { maxDepth };

package/dist/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const BROWSER_ERROR_MESSAGE = "Tile converter does not work in browser, only in node js environment";
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,qBAAqB,yEACsC,CAAC"}

package/dist/constants.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BROWSER_ERROR_MESSAGE = void 0;
+exports.BROWSER_ERROR_MESSAGE = 'Tile converter does not work in browser, only in node js environment';

package/dist/converter-cli.d.ts

@@ -0,0 +1,2 @@
+import '@loaders.gl/polyfills';
+//# sourceMappingURL=converter-cli.d.ts.map

package/dist/converter-cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"converter-cli.d.ts","sourceRoot":"","sources":["../src/converter-cli.ts"],"names":[],"mappings":"AACA,OAAO,uBAAuB,CAAC"}

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;
+}