x3d-image 2.0.32 → 2.1.0

package/README.md

@@ -14,7 +14,7 @@ You can run *x3d-image* without installing it using **npx**:
 
 ## Overview
 
-*x3d-image* is a command-line tool based on [X_ITE](https://create3000.github.io/x_ite/) that renders image files from X3D (Extensible 3D) and other 3D file formats. It allows users to convert 3D scenes into 2D images, supporting various input formats such as X3D (XML, JSON, Classic VRML), VRML, glTF, OBJ, STL, PLY, and SVG. Output can be in PNG or JPEG formats.
+*x3d-image* is a command-line tool, based on [X_ITE](https://create3000.github.io/x_ite/), that renders image files from X3D (Extensible 3D) and other 3D file formats. It allows users to convert 3D scenes into 2D images, supporting various input formats such as X3D (XML, JSON, Classic VRML), VRML, glTF, OBJ, STL, PLY, and SVG. Output can be in PNG or JPEG formats.
 
 Key Features:
 
@@ -30,54 +30,62 @@ Key Features:
 
 **x3d-image** interprets the following options when it is invoked:
 
-### -i *file(s)* ...
-
-Set input file(s). This can be either a local file path or a URL. If there are less input files than output files, the last input file is used for the remaining output files.
-
-### -o *file(s)* ...
+### -a
 
-Set output file(s). This can be either a PNG or JPEG file.
+Modify the current view so that all objects fit in view volume.
 
-### -s WIDTHxHEIGHT
+### -b *color*
 
-Set image size in pixels, default is '1280x720'.
+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.
 
-### -q *quality*
+### -c *[SRGB, **LINEAR_WHEN_PHYSICAL_MATERIAL**, LINEAR]*
 
-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).
+The color space in which color calculations take place.
 
 ### -d *delay*
 
 Wait the specified number of seconds before generating the image.
 
-### -a
-
-Modify the current view so that all objects fit in view volume.
-
-### -b *color*
-
-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.
-
 ### -e *[**CANNON**, HELIPAD, FOOTPRINT]*
 
 Add an EnvironmentLight node to scene. Useful when rendering glTF files with PhysicalMaterial nodes.
 
-### -r rotation
+### -h
 
-Creates a parent group with the model as children and sets the specified X3D rotation value.
+Show help.
 
-### -c *[SRGB, **LINEAR_WHEN_PHYSICAL_MATERIAL**, LINEAR]*
+### -i *file(s)* ...
 
-The color space in which color calculations take place.
+Set input file(s). This can be either a local file path or a URL. If there are less input files than output files, the last input file is used for the remaining output files.
 
-### -x *exposure*
+### -l
 
-The exposure of an image describes the amount of light that is captured.
+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.
 
 ### -m *[**NONE**, ACES_NARKOWICZ, ACES_HILL, ACES_HILL_EXPOSURE_BOOST, KHR_PBR_NEUTRAL]*
 
 Whether tone mapping should be applied.
 
+### -n
+
+Whether to use order independent transparency rendering technique.
+
+### -o *file(s)* ...
+
+Set output file(s). This can be either a PNG or JPEG file.
+
+### -q *quality*
+
+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).
+
+### -r rotation
+
+Creates a parent group with the model as children and sets the specified X3D rotation value.
+
+### -s WIDTHxHEIGHT
+
+Set image size in pixels, default is '1280x720'.
+
 ### -t *[**CHAR_SPACING**, SCALING]*
 
 Controls how Text.length and Text.maxExtent are handled. Either by adjusting char spacing or by scaling text letters.
@@ -86,9 +94,9 @@ Controls how Text.length and Text.maxExtent are handled. Either by adjusting cha
 
 Show version.
 
-### -h
+### -x *exposure*
 
-Show help.
+The exposure of an image describes the amount of light that is captured.
 
 ## Supported Input File Types
 
@@ -125,7 +133,7 @@ Render two PNG images from two X3D files.
 $ 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 end environment light.
+Render image of glTF file with view-all and environment light.
 
 ```sh
 $ npx x3d-image -a -e CANNON -i file.gltf -o file.png

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "x3d-image",
-  "version": "2.0.32",
+  "version": "2.1.0",
   "description": "Render image files from X3D",
   "main": "src/main.js",
   "bin": {
@@ -53,7 +53,7 @@
   "dependencies": {
     "colors": "^1.4.0",
     "electron": "^35.2.1",
-    "x_ite": "^11.5.4",
+    "x_ite": "^11.5.5",
     "yargs": "^17.7.2"
   },
   "devDependencies": {

package/src/image.js

@@ -48,39 +48,30 @@ async function generate (argv)
       console .error (msg);
       process .exit (1);
    })
-   .option ("input",
+   .option ("view-all",
    {
-      type: "string",
-      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.",
+      type: "boolean",
+      alias: "a",
+      description: "Modify the current view so that all objects fit in view volume.",
       array: true,
-      default: [ ],
-      implies: "output",
+      default: [false],
    })
-   .option ("output",
+   .option ("background",
    {
       type: "string",
-      alias: "o",
-      description: "Set output file(s). This can be either a *.png or *.jpg file.",
+      alias: "b",
+      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: [ ],
-      implies: "input",
    })
-   .option ("size",
+   .option ("colorSpace",
    {
       type: "string",
-      alias: "s",
-      description: "Set image size in pixels.",
-      array: true,
-      default: ["1280x720"],
-   })
-   .option ("quality",
-   {
-      type: "number",
-      alias: "q",
-      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).",
+      alias: "c",
+      description: `The color space in which color calculations take place.`,
+      choices: ["SRGB", "LINEAR_WHEN_PHYSICAL_MATERIAL", "LINEAR"],
       array: true,
-      default: [1],
+      default: ["LINEAR_WHEN_PHYSICAL_MATERIAL"],
    })
    .option ("delay",
    {
@@ -90,64 +81,81 @@ async function generate (argv)
       array: true,
       default: [0],
    })
-   .option ("view-all",
+   .option ("environment-light",
    {
-      type: "boolean",
-      alias: "a",
-      description: "Modify the current view so that all objects fit in view volume.",
+      type: "string",
+      alias: "e",
+      description: `Add an EnvironmentLight node to scene. Useful when rendering glTF files with PhysicalMaterial nodes.`,
+      choices: ["CANNON", "HELIPAD", "FOOTPRINT"],
       array: true,
-      default: [false],
+      default: [ ],
    })
-   .option ("background",
+   .option ("input",
    {
       type: "string",
-      alias: "b",
-      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.`,
+      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",
    })
-   .option ("environment-light",
+   .option ("logarithmic-depth-buffer",
    {
-      type: "string",
-      alias: "e",
-      description: `Add an EnvironmentLight node to scene. Useful when rendering glTF files with PhysicalMaterial nodes.`,
-      choices: ["CANNON", "HELIPAD", "FOOTPRINT"],
+      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: [ ],
+      default: [false],
    })
-   .option ("rotation",
+   .option ("tone-mapping",
    {
       type: "string",
-      alias: "r",
-      description: `Creates a parent group with the model as children and sets the specified X3D rotation value.`,
+      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: [ ],
+      default: ["NONE"],
    })
-   .option ("colorSpace",
+   .option ("order-independent-transparency",
+   {
+      type: "boolean",
+      alias: "n",
+      description: `Whether to use order independent transparency rendering technique.`,
+      array: true,
+      default: [false],
+   })
+   .option ("output",
    {
       type: "string",
-      alias: "c",
-      description: `The color space in which color calculations take place.`,
-      choices: ["SRGB", "LINEAR_WHEN_PHYSICAL_MATERIAL", "LINEAR"],
+      alias: "o",
+      description: "Set output file(s). This can be either a *.png or *.jpg file.",
       array: true,
-      default: ["LINEAR_WHEN_PHYSICAL_MATERIAL"],
+      default: [ ],
+      implies: "input",
    })
-   .option ("exposure",
+   .option ("quality",
    {
       type: "number",
-      alias: "x",
-      description: `The exposure of an image describes the amount of light that is captured.`,
+      alias: "q",
+      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],
    })
-   .option ("tone-mapping",
+   .option ("rotation",
    {
       type: "string",
-      alias: "m",
-      description: `Whether tone mapping should be applied.`,
-      choices: ["NONE", "ACES_NARKOWICZ", "ACES_HILL", "ACES_HILL_EXPOSURE_BOOST", "KHR_PBR_NEUTRAL"],
+      alias: "r",
+      description: `Creates a parent group with the model as children and sets the specified X3D rotation value.`,
       array: true,
-      default: ["NONE"],
+      default: [ ],
+   })
+   .option ("size",
+   {
+      type: "string",
+      alias: "s",
+      description: "Set image size in pixels.",
+      array: true,
+      default: ["1280x720"],
    })
    .option ("text-compression",
    {
@@ -157,6 +165,14 @@ async function generate (argv)
       array: true,
       default: ["CHAR_SPACING"],
    })
+   .option ("exposure",
+   {
+      type: "number",
+      alias: "x",
+      description: `The exposure of an image describes the amount of light that is captured.`,
+      array: true,
+      default: [1],
+   })
    .example ([
       [
          "npx x3d-image -s 1600x900 -i file.x3d -o file.jpg",
@@ -168,7 +184,7 @@ async function generate (argv)
       ],
       [
          "npx x3d-image -a -e CANNON -i file.gltf -o file.png",
-         "Render image of glTF file with view-all end environment light."
+         "Render image of glTF file with view-all and environment light."
       ],
    ])
    .help ()
@@ -221,12 +237,18 @@ async function generate (argv)
       if (arg (args .exposure, i))
          browser .setBrowserOption ("Exposure", arg (args .exposure, i));
 
-      if (arg (args ["tone-mapping"], i))
-         browser .setBrowserOption ("ToneMapping", arg (args ["tone-mapping"], i));
+      if (arg (args ["logarithmic-depth-buffer"], i))
+         browser .setBrowserOption ("LogarithmicDepthBuffer", arg (args ["logarithmic-depth-buffer"], i));
+
+      if (arg (args ["order-independent-transparency"], i))
+         browser .setBrowserOption ("OrderIndependentTransparency", arg (args ["order-independent-transparency"], i));
 
       if (arg (args ["text-compression"], i))
          browser .setBrowserOption ("TextCompression", arg (args ["text-compression"], i));
 
+      if (arg (args ["tone-mapping"], i))
+         browser .setBrowserOption ("ToneMapping", arg (args ["tone-mapping"], i));
+
       if (arg (args ["view-all"], i))
          browser .viewAll (0);
 
@@ -282,6 +304,7 @@ async function addTransform (browser, scene, rotation)
 
    const r = new X3D .SFRotation ();
 
+   r .setName ("rotation");
    r .fromString (rotation, scene);
 
    transform .children = scene .rootNodes;
@@ -307,6 +330,7 @@ async function addBackground (browser, scene, color)
 
    const c = new X3D .SFColorRGBA ();
 
+   c .setName ("background");
    c .fromString (color, scene);
 
    background .set_bind     = true;