x3d-image 2.0.29 → 2.0.31

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 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. The 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:
 
@@ -60,7 +60,23 @@ Set background to specified color. Color can be any X3D RGBA color or any CSS co
 
 ### -e *[**CANNON**, HELIPAD, FOOTPRINT]*
 
-Add an EnvironmentLight node to scene, default is "CANNON". Useful when rendering glTF files with PhysicalMaterial nodes.
+Add an EnvironmentLight node to scene. Useful when rendering glTF files with PhysicalMaterial nodes.
+
+### -r rotation
+
+Creates a parent group with the model as children and sets the specified X3D rotation value.
+
+### -c *[SRGB, **LINEAR_WHEN_PHYSICAL_MATERIAL**, LINEAR]*
+
+The color space in which color calculations take place.
+
+### -x *exposure*
+
+The exposure of an image describes the amount of light that is captured.
+
+### -t *[**CHAR_SPACING**, SCALING]*
+
+Controls how Text.length and Text.maxExtent are handled. Either by adjusting char spacing or by scaling text letters.
 
 ### -v
 
@@ -113,4 +129,4 @@ $ npx x3d-image -a -e CANNON -i file.gltf -o file.png
 
 ## See Also
 
-x3d-image is based on [X_ITE](https://create3000.github.io/x_ite/), so check it out.
+* [x3d-tidy](https://www.npmjs.com/package/x3d-tidy) — X3D converter, beautifier and minimizer

package/package.json

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

package/src/image.js

@@ -104,17 +104,50 @@ async function generate (argv)
       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: [""],
+      default: [ ],
    })
    .option ("environment-light",
    {
       type: "string",
       alias: "e",
-      description: `Add an EnvironmentLight node to scene, default is "CANNON". Useful when rendering glTF files with PhysicalMaterial nodes.`,
+      description: `Add an EnvironmentLight node to scene. Useful when rendering glTF files with PhysicalMaterial nodes.`,
       choices: ["CANNON", "HELIPAD", "FOOTPRINT"],
       array: true,
       default: [ ],
    })
+   .option ("rotation",
+   {
+      type: "string",
+      alias: "r",
+      description: `Creates a parent group with the model as children and sets the specified X3D rotation value.`,
+      array: true,
+      default: [ ],
+   })
+   .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"],
+   })
+   .option ("exposure",
+   {
+      type: "number",
+      alias: "x",
+      description: `The exposure of an image describes the amount of light that is captured.`,
+      array: true,
+      default: [1],
+   })
+   .option ("text-compression",
+   {
+      type: "string",
+      alias: "t",
+      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"],
+   })
    .example ([
       [
          "npx x3d-image -s 1600x900 -i file.x3d -o file.jpg",
@@ -157,31 +190,41 @@ async function generate (argv)
          mimeType = mimeTypeFromPath (output),
          size     = arg (args .size, i) .split ("x"),
          width    = parseInt (size [0]) || 1280,
-         height   = parseInt (size [1]) || 720,
-         color    = arg (args .background, i);
+         height   = parseInt (size [1]) || 720;
 
       browser .endUpdate ();
 
       await browser .resize (width, height);
       await browser .loadURL (new X3D .MFString (input)) .catch (Function .prototype);
 
-      if (color .length)
-         await addBackground (browser, browser .currentScene, color);
+      if (arg (args .background, i))
+         await addBackground (browser, browser .currentScene, arg (args .background, i));
 
       if (arg (args ["environment-light"], i))
          await addEnvironmentLight (browser, browser .currentScene, arg (args ["environment-light"], i));
 
+      if (arg (args .rotation, i))
+         await addTransform (browser, browser .currentScene, arg (args .rotation, i));
+
+      if (arg (args .colorSpace, i))
+         browser .setBrowserOption ("ColorSpace", arg (args .colorSpace, i));
+
+      if (arg (args .exposure, i))
+         browser .setBrowserOption ("Exposure", arg (args .exposure, i));
+
+      if (arg (args ["text-compression"], i))
+         browser .setBrowserOption ("TextCompression", arg (args ["text-compression"], i));
+
       if (arg (args ["view-all"], i))
-      {
          browser .viewAll (0);
-         await browser .nextFrame ();
-      }
 
       browser .beginUpdate ();
 
       if (arg (args .delay, i))
          await sleep (arg (args .delay, i) * 1000);
 
+      await browser .nextFrame ();
+
       const blob = await generateImage (canvas, mimeType, arg (args .quality, i));
 
       fs .writeFileSync (output, new DataView (await blob .arrayBuffer ()));
@@ -217,11 +260,23 @@ function mimeTypeFromPath (filename)
    }
 }
 
-const EnvironmentLights = new Map ([
-   ["CANNON",    "cannon-exterior:2"],
-   ["HELIPAD",   "helipad:1"],
-   ["FOOTPRINT", "footprint-court:1"],
-]);
+async function addTransform (browser, scene, rotation)
+{
+   scene .addComponent (browser .getComponent ("Grouping"));
+
+   await browser .loadComponents (scene);
+
+   const transform = scene .createNode ("Transform");
+
+   const r = new X3D .SFRotation ();
+
+   r .fromString (rotation, scene);
+
+   transform .children = scene .rootNodes;
+   transform .rotation = r;
+
+   scene .rootNodes = new X3D .MFNode (transform);
+}
 
 let background = null;
 
@@ -247,10 +302,14 @@ async function addBackground (browser, scene, color)
    background .transparency = 1 - c .a;
 
    scene .addRootNode (background);
-
-   await browser .nextFrame ();
 }
 
+const EnvironmentLights = new Map ([
+   ["CANNON",    "cannon-exterior:2"],
+   ["HELIPAD",   "helipad:1"],
+   ["FOOTPRINT", "footprint-court:1"],
+]);
+
 let environmentLight = null;
 
 async function addEnvironmentLight (browser, scene, name)
@@ -300,7 +359,6 @@ async function addEnvironmentLight (browser, scene, name)
    scene .addRootNode (environmentLight);
 
    await Promise .all ([
-      browser .nextFrame (),
       environmentLight .diffuseTexture  .getValue () .requestImmediateLoad (),
       environmentLight .specularTexture .getValue () .requestImmediateLoad (),
    ]);