x3d-image 2.3.0 → 2.4.0

package/README.md

@@ -46,9 +46,13 @@ The color space in which color calculations take place.
 
 Wait the specified number of seconds before generating the image.
 
-### -e *[**CANNON**, HELIPAD, FOOTPRINT]*
+### -e *extension(s)* ...
 
-Add an EnvironmentLight node to scene. Useful when rendering glTF files with PhysicalMaterial nodes.
+Set output file extension(s), e.g. ".x3dv" or ".tidy.x3d". The output file will have the same basename as the input file. Use either "-e" or "-o".
+
+### -g
+
+Whether to use a logarithmic depth buffer. It may be necessary to use this if dealing with huge differences in scale in a single scene. It is automatically enabled if a GeoViewpoint is bound.
 
 ### -h
 
@@ -60,7 +64,7 @@ Set input file(s). This can be either a local file path or a URL. If there are l
 
 ### -l
 
-Whether to use a logarithmic depth buffer. It may be necessary to use this if dealing with huge differences in scale in a single scene. It is automatically enabled if a GeoViewpoint is bound.
+Log output filenames to stdout.
 
 ### -m *[**NONE**, ACES_NARKOWICZ, ACES_HILL, ACES_HILL_EXPOSURE_BOOST, KHR_PBR_NEUTRAL]*
 
@@ -94,6 +98,10 @@ Controls how Text.length and Text.maxExtent are handled. Either by adjusting cha
 
 Show version.
 
+### -w *[**CANNON**, HELIPAD, FOOTPRINT]*
+
+Add an EnvironmentLight node to scene. Useful when rendering glTF files with PhysicalMaterial nodes.
+
 ### -x *exposure*
 
 The exposure of an image describes the amount of light that is captured.
@@ -136,7 +144,7 @@ $ npx x3d-image -s 1600x900 -i file1.x3d -o file1.png -i file2.x3d -o file2.png
 Render image of glTF file with view-all and environment light.
 
 ```sh
-$ npx x3d-image -a -e CANNON -i file.gltf -o file.png
+$ npx x3d-image -a -w CANNON -i file.gltf -e .png
 ```
 
 ## See Also

package/bin/x3d-image.js

@@ -4,15 +4,16 @@
 const os = require ("os");
 const path = require ("path");
 const { spawn } = require ("child_process");
-const win = os .platform () === "win32";
-const cwd = process .cwd ();
+const dir = process .cwd ();
+const cwd = path .resolve (__dirname, "..");
 const args = process .argv .slice (2);
 
-process .chdir (path .resolve (__dirname, ".."));
+args .unshift ("start", "--silent", "--");
+args .push ("--cwd", dir);
 
-const p = win
-   ? spawn ("cmd.exe", ["/c", "npm.cmd", "start", "--silent", "--", ... args], { cwd })
-   : spawn ("npm", ["start", "--silent", "--", ... args], { cwd });
+const p = os .platform () === "win32"
+   ? spawn ("cmd.exe", ["/c", "npm.cmd", ... args], { cwd })
+   : spawn ("npm", args, { cwd });
 
 p .stdout .pipe (process .stdout);
 p .stderr .pipe (process .stderr);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "x3d-image",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Render image files from X3D",
   "main": "src/main.js",
   "bin": {

package/src/image.js

@@ -12,7 +12,7 @@ const
 
 // Redirect console messages.
 
-process .exit  = (code)  => electron .ipcRenderer .send ("exit", code);
+process .exit  = (code = 0) => { throw code };
 console .log   = (... messages) => electron .ipcRenderer .send ("log",   messages);
 console .warn  = (... messages) => electron .ipcRenderer .send ("warn",  messages);
 console .error = (... messages) => electron .ipcRenderer .send ("error", messages);
@@ -29,8 +29,15 @@ async function main (argv)
    }
    catch (error)
    {
-      console .error (error .message || error);
-      process .exit (1);
+      if (typeof error === "number")
+      {
+         electron .ipcRenderer .send ("exit", error);
+      }
+      else
+      {
+         console .error (error .message || error);
+         electron .ipcRenderer .send ("exit", 1);
+      }
    }
 }
 
@@ -63,15 +70,17 @@ async function generate (argv)
       description: `Set background to specified color. Color can be any X3D RGBA color or any CSS color. Use PNG as output image format for transparent backgrounds.`,
       array: true,
       default: [ ],
+      requiresArg: true,
    })
    .option ("colorSpace",
    {
       type: "string",
       alias: "c",
       description: `The color space in which color calculations take place.`,
-      choices: ["SRGB", "LINEAR_WHEN_PHYSICAL_MATERIAL", "LINEAR"],
       array: true,
       default: ["LINEAR_WHEN_PHYSICAL_MATERIAL"],
+      choices: ["SRGB", "LINEAR_WHEN_PHYSICAL_MATERIAL", "LINEAR"],
+      requiresArg: true,
    })
    .option ("delay",
    {
@@ -80,15 +89,25 @@ async function generate (argv)
       description: "Wait the specified number of seconds before generating the image.",
       array: true,
       default: [0],
+      requiresArg: true,
    })
-   .option ("environment-light",
+   .option ("extension",
    {
       type: "string",
       alias: "e",
-      description: `Add an EnvironmentLight node to scene. Useful when rendering glTF files with PhysicalMaterial nodes.`,
-      choices: ["CANNON", "HELIPAD", "FOOTPRINT"],
+      description: `Set output file extension(s), e.g. ".x3dv" or ".tidy.x3d". The output file will have the same basename as the input file.`,
       array: true,
-      default: [ ],
+      requiresArg: true,
+      implies: "input",
+      conflicts: "output",
+   })
+   .option ("logarithmic-depth-buffer",
+   {
+      type: "boolean",
+      alias: "g",
+      description: `Whether to use a logarithmic depth buffer. It may be necessary to use this if dealing with huge differences in scale in a single scene. It is automatically enabled if a GeoViewpoint is bound.`,
+      array: true,
+      default: [false],
    })
    .option ("input",
    {
@@ -96,25 +115,25 @@ async function generate (argv)
       alias: "i",
       description: "Set input file(s). If there are less input files than output files, the last input file is used for the remaining output files.",
       array: true,
-      default: [ ],
-      implies: "output",
+      requiresArg: true,
+      demandOption: true,
    })
-   .option ("logarithmic-depth-buffer",
+   .option ("log",
    {
       type: "boolean",
       alias: "l",
-      description: `Whether to use a logarithmic depth buffer. It may be necessary to use this if dealing with huge differences in scale in a single scene. It is automatically enabled if a GeoViewpoint is bound.`,
-      array: true,
-      default: [false],
+      description: `Log output filenames to stdout.`,
+      implies: "input",
    })
    .option ("tone-mapping",
    {
       type: "string",
       alias: "m",
       description: `Whether tone mapping should be applied.`,
-      choices: ["NONE", "ACES_NARKOWICZ", "ACES_HILL", "ACES_HILL_EXPOSURE_BOOST", "KHR_PBR_NEUTRAL"],
       array: true,
       default: ["NONE"],
+      choices: ["NONE", "ACES_NARKOWICZ", "ACES_HILL", "ACES_HILL_EXPOSURE_BOOST", "KHR_PBR_NEUTRAL"],
+      requiresArg: true,
    })
    .option ("order-independent-transparency",
    {
@@ -130,7 +149,7 @@ async function generate (argv)
       alias: "o",
       description: "Set output file(s). This can be either a *.png or *.jpg file.",
       array: true,
-      default: [ ],
+      requiresArg: true,
       implies: "input",
    })
    .option ("quality",
@@ -140,6 +159,7 @@ async function generate (argv)
       description: "A Number between 0 and 1 indicating the image quality to be used when creating images using file formats that support lossy compression (such as JPEG).",
       array: true,
       default: [1],
+      requiresArg: true,
    })
    .option ("rotation",
    {
@@ -148,6 +168,7 @@ async function generate (argv)
       description: `Creates a parent group with the model as children and sets the specified X3D rotation value.`,
       array: true,
       default: [ ],
+      requiresArg: true,
    })
    .option ("size",
    {
@@ -156,6 +177,7 @@ async function generate (argv)
       description: "Set image size in pixels.",
       array: true,
       default: ["1280x720"],
+      requiresArg: true,
    })
    .option ("text-compression",
    {
@@ -164,6 +186,18 @@ async function generate (argv)
       description: `Controls how Text.length and Text.maxExtent are handled. Either by adjusting char spacing or by scaling text letters.`,
       array: true,
       default: ["CHAR_SPACING"],
+      choices: ["CHAR_SPACING", "SCALING"],
+      requiresArg: true,
+   })
+   .option ("environment-light",
+   {
+      type: "string",
+      alias: "w",
+      description: `Add an EnvironmentLight node to scene. Useful when rendering glTF files with PhysicalMaterial nodes.`,
+      array: true,
+      default: [ ],
+      choices: ["CANNON", "HELIPAD", "FOOTPRINT"],
+      requiresArg: true,
    })
    .option ("exposure",
    {
@@ -172,6 +206,14 @@ async function generate (argv)
       description: `The exposure of an image describes the amount of light that is captured.`,
       array: true,
       default: [1],
+      requiresArg: true,
+   })
+   .check (args =>
+   {
+      if (!args .output && !args .extension)
+         throw new Error ("Missing argument output or extension.");
+
+      return true;
    })
    .example ([
       [
@@ -183,19 +225,13 @@ async function generate (argv)
          "Render two PNG images from two X3D files."
       ],
       [
-         "npx x3d-image -a -e CANNON -i file.gltf -o file.png",
+         "npx x3d-image -a -w CANNON -i file.gltf -e .png",
          "Render image of glTF file with view-all and environment light."
       ],
    ])
    .help ()
    .alias ("help", "h") .argv;
 
-   if (args .version)
-      return;
-
-   if (args .help)
-      return;
-
    const
       canvas  = document .getElementById ("browser"),
       browser = canvas .browser;
@@ -204,14 +240,37 @@ async function generate (argv)
    browser .setBrowserOption ("TextureQuality",   "HIGH");
    browser .setBrowserOption ("Mute",             true);
 
-   if (!args .input .length)
-      console .warn ("No input files specified.");
+   const argc = Math .max (args .input .length, args .output ?.length ?? args .extension ?.length);
 
-   for (const i of args .output .keys ())
+   for (let i = 0; i < argc; ++ i)
    {
+      // Create input filename.
+
+      const input = new URL (arg (args .input, i), url .pathToFileURL (path .join (process .cwd (), "/")));
+
+      // Create output filename.
+
+      let output;
+
+      if (args .output)
+      {
+         output = path .resolve (process .cwd (), arg (args .output, i));
+      }
+      else if (args .extension)
+      {
+         const
+            filename  = url .fileURLToPath (input),
+            extension = arg (args .extension, i);
+
+         output = `${filename .slice (0, -path. extname (filename) .length)}${extension}`;
+      }
+
+      if (args .log)
+         console .log (output);
+
+      // Load scene.
+
       const
-         input    = new URL (arg (args .input, i), url .pathToFileURL (path .join (process .cwd (), "/"))),
-         output   = path .resolve (process .cwd (), args .output [i]),
          mimeType = mimeTypeFromPath (output),
          size     = arg (args .size, i) .split ("x"),
          width    = parseInt (size [0]) || 1280,
@@ -259,6 +318,8 @@ async function generate (argv)
 
       await browser .nextFrame ();
 
+      // Generate image.
+
       const blob = await generateImage (canvas, mimeType, arg (args .quality, i));
 
       fs .writeFileSync (output, new DataView (await blob .arrayBuffer ()));

package/src/main.js

@@ -5,6 +5,11 @@ const
    path     = require ("path"),
    colors   = require ("colors");
 
+// Restore cwd.
+
+if (process .argv .at (-2) === "--cwd")
+   process .chdir (process .argv .at (-1));
+
 // Set env vars for Electron.
 
 process .env .ELECTRON_DISABLE_SECURITY_WARNINGS = "true";