x_ite 8.8.7 → 8.9.0

package/docs/_posts/components/VolumeRendering/VolumeData.md

@@ -1,6 +1,6 @@
 ---
 title: VolumeData
-date: 2022-01-07
+date: 2023-01-07
 nav: components-VolumeRendering
 categories: [components, VolumeRendering]
 tags: [VolumeData, VolumeRendering]
@@ -15,7 +15,7 @@ tags: [VolumeData, VolumeRendering]
 
 VolumeData displays a simple non-segmented voxel dataset with a single RenderStyle node.
 
-The VolumeData node belongs to the **VolumeRendering** component and its default container field is *children.* It is available since X3D version 3.3 or later.
+The VolumeData node belongs to the **VolumeRendering** component and its default container field is *children.* It is available from X3D version 3.3 or higher.
 
 ## Hierarchy
 
@@ -30,20 +30,24 @@ The VolumeData node belongs to the **VolumeRendering** component and its default
 
 ### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
 
-Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.
+Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
+
+#### Hint
+
+- [X3D Architecture 7.2.4 Metadata](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/core.html#Metadata){:target="_blank"}
 
 ### SFVec3f [in, out] **dimensions** 1 1 1 <small>(0,∞)</small>
 
-Actual-size X-Y-Z dimensions of volume data in local coordinate system.
+Actual-size X-Y-Z *dimensions* of volume data in local coordinate system.
 
 ### SFBool [in, out] **visible** TRUE
 
 Whether or not renderable content within this node is visually displayed.
 
-#### Hint
+#### Hints
 
-- The visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
-- Content must be visible to be collidable and to be pickable.
+- The *visible* field has no effect on animation behaviors, event passing or other non-visual characteristics.
+- Content must be *visible* to be collidable and to be pickable.
 
 ### SFBool [in, out] **bboxDisplay** FALSE
 
@@ -57,32 +61,45 @@ Whether to display bounding box for associated geometry, aligned with world coor
 
 Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.
 
-#### Hint
+#### Hints
 
 - Can be useful for collision computations or inverse-kinematics (IK) engines.
+- Precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
+- [X3D Architecture, 10.2.2 Bounding boxes](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#BoundingBoxes){:target="_blank"}
+- [X3D Architecture, 10.3.1 X3DBoundedObject](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#X3DBoundedObject){:target="_blank"}
 
 ### SFVec3f [ ] **bboxCenter** 0 0 0 <small>(-∞,∞)</small>
 
-Bounding box center: optional hint for position offset from origin of local coordinate system.
+Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.
+
+#### Hints
+
+- Precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
+- [X3D Architecture, 10.2.2 Bounding boxes](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#BoundingBoxes){:target="_blank"}
+- [X3D Architecture, 10.3.1 X3DBoundedObject](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/grouping.html#X3DBoundedObject){:target="_blank"}
 
 ### SFNode [in, out] **renderStyle** NULL <small>[X3DVolumeRenderStyleNode]</small>
 
-Input/Output field renderStyle.
+Single contained X3DVolumeRenderStyleNode node that defines specific rendering technique for this volumetric object. If field is not defined, default is OpacityMapVolumeStyle node.
 
 ### SFNode [in, out] **voxels** NULL <small>[X3DTexture3DNode]</small>
 
-Input/Output field voxels.
+Single contained X3DTexture3DNode (ComposedTexture3D, ImageTexture3D, PixelTexture3D) that provides raw voxel information utilized by corresponding rendering styles. Any number of color components (1-4) may be defined.
 
-## Description
+## Advisories
 
 ### Hint
 
-- VolumeData can contain a single Texture3D node with containerField='voxels' and a single RenderStyle node.
+- VolumeData can contain a single Texture3D node with `containerField='voxels'` and a single RenderStyle node.
+
+### Warning
+
+- Requires X3D `profile='Full'` or else include `<component name='VolumeRendering' level='1'/>`
 
 ## Example
 
 <x3d-canvas src="https://create3000.github.io/media/examples/VolumeRendering/VolumeData/VolumeData.x3d" update="auto"></x3d-canvas>
 
-## External Links
+## See Also
 
-- [X3D Specification of VolumeData](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/volume.html#VolumeData){:target="_blank"}
+- [X3D Specification of VolumeData node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/volume.html#VolumeData){:target="_blank"}

package/docs/_posts/components/X_ITE/BlendMode.md

@@ -1,6 +1,6 @@
 ---
 title: BlendMode
-date: 2022-01-07
+date: 2023-01-07
 nav: components-X_ITE
 categories: [components, X_ITE]
 tags: [BlendMode, X_ITE]
@@ -17,6 +17,9 @@ BlendMode controls how pixels of an objects are drawn. Pixels can be drawn using
 
 The BlendMode node belongs to the **X_ITE** component and its default container field is *blendMode.* It is available in Titania and X_ITE.
 
+>**Info:** Please note that the functionality of this node is still experimental.
+{: .prompt-info }
+
 ## Hierarchy
 
 ```
@@ -30,7 +33,11 @@ The BlendMode node belongs to the **X_ITE** component and its default container
 
 ### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
 
-Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.
+Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
+
+#### Hint
+
+- [X3D Architecture 7.2.4 Metadata](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/core.html#Metadata){:target="_blank"}
 
 ### SFColorRGBA [in, out] **blendColor** 0 0 0 0 <small>[0,1]</small>
 

package/docs/_posts/getting-started.md

@@ -644,6 +644,7 @@ X_ITE can load several file formats, either directly as the source of the \<x3d-
 | glTF             | .gltf, .glb    | model/gltf+json |
 | Wavefront OBJ    | .obj           | model/obj       |
 | STL              | .stl           | model/stl       |
+| PLY              | .ply           | model/ply       |
 | SVG Document     | .svg, .svgz    | image/svg+xml   |
 
 >**Tip:** All files can be compressed using GZip compression. This saves bandwidth and speeds up download time.

package/docs/_posts/laboratory/x3d-file-converter.md

@@ -157,7 +157,7 @@ $(() =>
 
 ## Upload and Convert
 
-Convert **X3D, VRML, glTF (GLB), OBJ, STL,** and **SVG** to an X3D format of your choice.
+Convert **X3D, VRML, glTF (GLB), OBJ, STL, PLY,** and **SVG** to an X3D format of your choice.
 
 <div id="drop-zone">
    <p id="open-files" class="center">

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "x_ite",
-	"version": "8.8.7",
+	"version": "8.9.0",
 	"description": "X_ITE X3D Browser, view and manipulate X3D and VRML scenes in HTML.",
 	"homepage": "https://create3000.github.io/x_ite/",
 	"author": "Holger Seelig <holger.seelig@gmail.com>",

package/src/x_ite/Browser/Core/X3DCoreContext.js

@@ -420,11 +420,18 @@ Object .assign (X3DCoreContext .prototype,
    },
    parseUrlAttribute (urlCharacters)
    {
-      const url = new Fields .MFString ();
+      try
+      {
+         const url = new Fields .MFString ();
 
-      url .fromString ("[" + urlCharacters + "]", this .getExecutionContext ());
+         url .fromString ("[" + urlCharacters + "]", this .getExecutionContext ());
 
-      return url;
+         return url;
+      }
+      catch
+      {
+         throw new Error ("Couldn't parse url attribute.");
+      }
    },
    callBrowserEventHandler: (() =>
    {

package/src/x_ite/Browser/DOMIntegration.js

@@ -135,15 +135,17 @@ class DOMIntegration
 
 	processAttribute (mutation, element)
 	{
-		const parser = this .parser;
+		const
+			parser = this .parser,
+			node   = $.data (element, "node");
 
-		if ($.data (element, "node"))
+		if (node)
 		{
 			const
 				attributeName = mutation .attributeName,
 				attribute     = element .attributes .getNamedItem (attributeName);
 
-			parser .nodeAttribute (attribute, $.data (element, "node"));
+			parser .nodeAttribute (attribute, node);
 		}
 		else
 		{
@@ -153,11 +155,14 @@ class DOMIntegration
 				parentNode = element .parentNode,
 			 	node       = $.data (parentNode, "node");
 
-			parser .pushExecutionContext (node .getExecutionContext ());
-			parser .pushParent (node);
-			parser .childElement (element);
-			parser .popParent ();
-			parser .popExecutionContext ();
+			if (node)
+			{
+				parser .pushExecutionContext (node .getExecutionContext ());
+				parser .pushParent (node);
+				parser .childElement (element);
+				parser .popParent ();
+				parser .popExecutionContext ();
+			}
 		}
 	}
 

package/src/x_ite/Browser/VERSION.js

@@ -45,4 +45,4 @@
  *
  ******************************************************************************/
 
-export default "8.8.7";
+export default "8.9.0";

package/src/x_ite/Components/CubeMapTexturing/ComposedCubeMapTexture.js

@@ -59,7 +59,7 @@ function ComposedCubeMapTexture (executionContext)
 
    this .addType (X3DConstants .ComposedCubeMapTexture);
 
-   if (executionContext .getSpecificationVersion () < 4)
+   if (executionContext .getSpecificationVersion () < 4.0)
    {
       this .addAlias ("front",  this ._frontTexture);
       this .addAlias ("back",   this ._backTexture);

package/src/x_ite/Components/DIS/DISEntityManager.js

@@ -57,7 +57,7 @@ function DISEntityManager (executionContext)
 
    this .addType (X3DConstants .DISEntityManager);
 
-   if (executionContext .getSpecificationVersion () < 4)
+   if (executionContext .getSpecificationVersion () <= 3.3)
       this .addAlias ("mapping", this ._children);
 }
 

package/src/x_ite/Components/Grouping/Switch.js

@@ -59,7 +59,7 @@ function Switch (executionContext)
 
    this .addType (X3DConstants .Switch);
 
-   if (executionContext .getSpecificationVersion () === "2.0")
+   if (executionContext .getSpecificationVersion () == 2.0)
       this .addAlias ("choice", this ._children);
 
    this .childNode     = null;

package/src/x_ite/Components/Layering/X3DLayerNode.js

@@ -66,7 +66,7 @@ function X3DLayerNode (executionContext, defaultViewpoint, groupNode)
 
    this .addType (X3DConstants .X3DLayerNode);
 
-   if (executionContext .getSpecificationVersion () < 4.0)
+   if (executionContext .getSpecificationVersion () <= 3.3)
       this .addAlias ("isPickable", this ._pickable);
 
    this .groupNode    = groupNode;

package/src/x_ite/Components/Lighting/DirectionalLight.js

@@ -235,7 +235,7 @@ function DirectionalLight (executionContext)
 
    this .addType (X3DConstants .DirectionalLight);
 
-   if (executionContext .getSpecificationVersion () === "2.0")
+   if (executionContext .getSpecificationVersion () == 2.0)
       this ._global = true;
 }
 

package/src/x_ite/Components/Navigation/Collision.js

@@ -61,7 +61,7 @@ function Collision (executionContext)
 
    this .addType (X3DConstants .Collision);
 
-   if (executionContext .getSpecificationVersion () === "2.0")
+   if (executionContext .getSpecificationVersion () == 2.0)
       this .addAlias ("collide", this ._enabled); // VRML2
 }
 

package/src/x_ite/Components/Navigation/LOD.js

@@ -61,7 +61,7 @@ function LOD (executionContext)
 
    this .addType (X3DConstants .LOD);
 
-   if (executionContext .getSpecificationVersion () === "2.0")
+   if (executionContext .getSpecificationVersion () == 2.0)
       this .addAlias ("level", this ._children); // VRML2
 
    this ._center .setUnit ("length");

package/src/x_ite/Components/Navigation/X3DViewpointNode.js

@@ -288,7 +288,7 @@ Object .assign (Object .setPrototypeOf (X3DViewpointNode .prototype, X3DBindable
 
          // VRML behavior
 
-         if (this .getExecutionContext () .getSpecificationVersion () === "2.0")
+         if (this .getExecutionContext () .getSpecificationVersion () == 2.0)
          {
             if (this .getVRMLTransition ())
                transitionType = "LINEAR";

package/src/x_ite/Components/Networking/LoadSensor.js

@@ -58,7 +58,7 @@ function LoadSensor (executionContext)
 
    this .addType (X3DConstants .LoadSensor);
 
-   if (executionContext .getSpecificationVersion () < 4)
+   if (executionContext .getSpecificationVersion () <= 3.3)
       this .addAlias ("watchList", this ._children);
 
    this .urlObjects = [ ];

package/src/x_ite/Components/ParticleSystems/ParticleSystem.js

@@ -106,7 +106,7 @@ function ParticleSystem (executionContext)
 
    this ._particleSize .setUnit ("length");
 
-   if (executionContext .getSpecificationVersion () < 4)
+   if (executionContext .getSpecificationVersion () <= 3.3)
    {
       this .addAlias ("colorRamp",    this ._color);
       this .addAlias ("texCoordRamp", this ._texCoord);

package/src/x_ite/Components/Shape/AcousticProperties.js

@@ -74,7 +74,7 @@ Object .defineProperties (AcousticProperties,
    },
    containerField:
    {
-      value: "AcousticProperties",
+      value: "acousticProperties",
       enumerable: true,
    },
    specificationRange:

package/src/x_ite/Components/Shape/Appearance.js

@@ -438,6 +438,7 @@ Object .defineProperties (Appearance,
    {
       value: new FieldDefinitionArray ([
          new X3DFieldDefinition (X3DConstants .inputOutput, "metadata",           new Fields .SFNode ()),
+         new X3DFieldDefinition (X3DConstants .inputOutput, "acousticProperties", new Fields .SFNode ()),
          new X3DFieldDefinition (X3DConstants .inputOutput, "alphaMode",          new Fields .SFString ("AUTO")),
          new X3DFieldDefinition (X3DConstants .inputOutput, "alphaCutoff",        new Fields .SFFloat (0.5)),
          new X3DFieldDefinition (X3DConstants .inputOutput, "pointProperties",    new Fields .SFNode ()),
@@ -449,7 +450,6 @@ Object .defineProperties (Appearance,
          new X3DFieldDefinition (X3DConstants .inputOutput, "textureTransform",   new Fields .SFNode ()),
          new X3DFieldDefinition (X3DConstants .inputOutput, "shaders",            new Fields .MFNode ()),
          new X3DFieldDefinition (X3DConstants .inputOutput, "blendMode",          new Fields .SFNode ()),
-         new X3DFieldDefinition (X3DConstants .inputOutput, "acousticProperties", new Fields .SFNode ()),
       ]),
       enumerable: true,
    },

package/src/x_ite/Components/Shape/Material.js

@@ -60,7 +60,7 @@ function Material (executionContext)
 
    this .addType (X3DConstants .Material);
 
-   if (executionContext .getSpecificationVersion () < 4.0)
+   if (executionContext .getSpecificationVersion () <= 3.3)
       this .getMaterialKey = getMaterialKey;
 
    this .diffuseColor  = new Float32Array (3);

package/src/x_ite/Components/Shape/TwoSidedMaterial.js

@@ -264,7 +264,7 @@ Object .defineProperties (TwoSidedMaterial,
    },
    specificationRange:
    {
-      value: Object .freeze (["3.2", "Infinity"]),
+      value: Object .freeze (["3.2", "4.0"]),
       enumerable: true,
    },
    fieldDefinitions:

package/src/x_ite/Components/Sound/PeriodicWave.js

@@ -88,9 +88,9 @@ Object .defineProperties (PeriodicWave,
          new X3DFieldDefinition (X3DConstants .inputOutput, "metadata",      new Fields .SFNode ()),
          new X3DFieldDefinition (X3DConstants .inputOutput, "description",   new Fields .SFString ()),
          new X3DFieldDefinition (X3DConstants .inputOutput, "enabled",       new Fields .SFBool (true)),
+         new X3DFieldDefinition (X3DConstants .inputOutput, "type",          new Fields .SFString ("SQUARE")),
          new X3DFieldDefinition (X3DConstants .inputOutput, "optionsReal",   new Fields .MFFloat ()),
          new X3DFieldDefinition (X3DConstants .inputOutput, "optionsImag",   new Fields .MFFloat ()),
-         new X3DFieldDefinition (X3DConstants .inputOutput, "type",          new Fields .SFString ("SQUARE")),
       ]),
       enumerable: true,
    },

package/src/x_ite/Components/Texturing/TextureProperties.js

@@ -58,7 +58,7 @@ function TextureProperties (executionContext)
 
    this .addType (X3DConstants .TextureProperties);
 
-   if (executionContext .getSpecificationVersion () < 4.0)
+   if (executionContext .getSpecificationVersion () <= 3.3)
    {
       this ._minificationFilter  = "DEFAULT";
       this ._magnificationFilter = "DEFAULT";

package/src/x_ite/Fields/ArrayFields.js

@@ -140,7 +140,7 @@ Object .assign (Object .setPrototypeOf (MFNode .prototype, X3DObjectArrayField .
             {
                generator .string += generator .Indent ();
                array [i] .toStream (generator);
-               generator .string += generator .TidyBreak ();
+               generator .string += generator .Break ();
             }
 
             generator .DecIndent ();
@@ -188,7 +188,7 @@ Object .assign (Object .setPrototypeOf (MFNode .prototype, X3DObjectArrayField .
             {
                generator .string += generator .Indent ();
                element .toVRMLStream (generator);
-               generator .string += generator .TidyBreak ();
+               generator .string += generator .Break ();
             }
 
             generator .DecIndent ();

package/src/x_ite/Fields/SFColor.js

@@ -130,7 +130,7 @@ Object .assign (Object .setPrototypeOf (SFColor .prototype, X3DField .prototype)
       for (let i = 0; i < last; ++ i)
       {
          generator .string += generator .FloatFormat (value [i]);
-         generator .string += generator .TidySpace ();
+         generator .string += generator .Space ();
       }
 
       generator .string += generator .FloatFormat (value [last]);

package/src/x_ite/Fields/SFMatrixPrototypeTemplate.js

@@ -147,7 +147,7 @@ function SFMatrixPrototypeTemplate (Constructor, TypeName, Matrix, SFVec, double
          for (let i = 0; i < last; ++ i)
          {
             generator .string += generator [_formatter] (value [i]);
-            generator .string += generator .TidySpace ();
+            generator .string += generator .Space ();
          }
 
          generator .string += generator [_formatter] (value [last]);

package/src/x_ite/Fields/SFRotation.js

@@ -158,11 +158,11 @@ Object .assign (Object .setPrototypeOf (SFRotation .prototype, X3DField .prototy
       const { x, y, z, angle } = this .getValue ();
 
       generator .string += generator .DoubleFormat (x);
-      generator .string += generator .TidySpace ();
+      generator .string += generator .Space ();
       generator .string += generator .DoubleFormat (y);
-      generator .string += generator .TidySpace ();
+      generator .string += generator .Space ();
       generator .string += generator .DoubleFormat (z);
-      generator .string += generator .TidySpace ();
+      generator .string += generator .Space ();
       generator .string += generator .DoubleFormat (generator .ToUnit ("angle", angle));
    },
    toVRMLStream (generator)

package/src/x_ite/Fields/SFVecPrototypeTemplate.js

@@ -156,7 +156,7 @@ function SFVecPrototypeTemplate (Constructor, TypeName, Vector, double)
          for (let i = 0; i < last; ++ i)
          {
             generator .string += generator [_formatter] (generator .ToUnit (category, value [i]));
-            generator .string += generator .TidySpace ();
+            generator .string += generator .Space ();
          }
 
          generator .string += generator [_formatter] (generator .ToUnit (category, value [last]));

package/src/x_ite/Parser/GoldenGate.js

@@ -54,6 +54,8 @@ import GLB2Parser  from "./GLB2Parser.js";
 import OBJParser   from "./OBJParser.js";
 import STLAParser  from "./STLAParser.js";
 import STLBParser  from "./STLBParser.js";
+import PLYAParser  from "./PLYAParser.js";
+import PLYBParser  from "./PLYBParser.js";
 import SVGParser   from "./SVGParser.js";
 
 function GoldenGate (scene)
@@ -105,14 +107,21 @@ Object .assign (Object .setPrototypeOf (GoldenGate .prototype, X3DParser .protot
    },
    getInput (encoding, x3dSyntax)
    {
-      if (this .inputs .has (encoding))
-         return this .inputs .get (encoding);
+      if (Array .isArray (encoding))
+      {
+         return encoding .map (encoding => this .getInput (encoding));
+      }
+      else
+      {
+         if (this .inputs .has (encoding))
+            return this .inputs .get (encoding);
 
-      const input = this .createInput (encoding, x3dSyntax);
+         const input = this .createInput (encoding, x3dSyntax);
 
-      this .inputs .set (encoding, input);
+         this .inputs .set (encoding, input);
 
-      return input;
+         return input;
+      }
    },
    createInput (encoding, x3dSyntax)
    {
@@ -147,6 +156,8 @@ GoldenGate .Parser = [
    OBJParser,
    STLAParser,
    STLBParser,
+   PLYAParser,
+   PLYBParser,
 ];
 
 export default GoldenGate;