x_ite 8.3.2 → 8.4.0

package/src/x_ite/Components/Core/X3DPrototypeInstance.js

@@ -49,7 +49,6 @@ import X3DChildObject      from "../../Base/X3DChildObject.js";
 import X3DNode             from "./X3DNode.js";
 import X3DExecutionContext from "../../Execution/X3DExecutionContext.js";
 import X3DConstants        from "../../Base/X3DConstants.js";
-import Generator           from "../../InputOutput/Generator.js";
 
 const
    _protoNode        = Symbol (),
@@ -86,6 +85,23 @@ X3DPrototypeInstance .prototype = Object .assign (Object .create (X3DNode .proto
    },
    getContainerField: function ()
    {
+      // Determine container field from proto.
+
+      // const proto = this [_protoNode];
+
+      // if (! proto .isExternProto)
+      // {
+      //    const rootNodes = proto .getBody () .getRootNodes ();
+
+      //    if (rootNodes .length)
+      //    {
+      //       const rootNode = rootNodes [0];
+
+      //       if (rootNode)
+      //          return rootNode .getValue () .getContainerField ();
+      //    }
+      // }
+
       return "children";
    },
    initialize: function ()
@@ -361,11 +377,9 @@ X3DPrototypeInstance .prototype = Object .assign (Object .create (X3DNode .proto
          }
       }
    },
-   toXMLStream: function (stream)
+   toXMLStream: function (generator)
    {
-      const
-         generator  = Generator .Get (stream),
-         sharedNode = generator .IsSharedNode (this);
+      const sharedNode = generator .IsSharedNode (this);
 
       generator .EnterScope ();
 
@@ -375,16 +389,16 @@ X3DPrototypeInstance .prototype = Object .assign (Object .create (X3DNode .proto
       {
          if (generator .ExistsNode (this))
          {
-            stream .string += generator .Indent ();
-            stream .string += "<ProtoInstance";
-            stream .string += " ";
-            stream .string += "name='";
-            stream .string += generator .XMLEncode (this .getTypeName ());
-            stream .string += "'";
-            stream .string += " ";
-            stream .string += "USE='";
-            stream .string += generator .XMLEncode (name);
-            stream .string += "'";
+            generator .string += generator .Indent ();
+            generator .string += "<ProtoInstance";
+            generator .string += generator .Space ();
+            generator .string += "name='";
+            generator .string += generator .XMLEncode (this .getTypeName ());
+            generator .string += "'";
+            generator .string += generator .Space ();
+            generator .string += "USE='";
+            generator .string += generator .XMLEncode (name);
+            generator .string += "'";
 
             const containerField = generator .ContainerField ();
 
@@ -392,35 +406,35 @@ X3DPrototypeInstance .prototype = Object .assign (Object .create (X3DNode .proto
             {
                if (containerField .getName () !== this .getContainerField ())
                {
-                  stream .string += " ";
-                  stream .string += "containerField='";
-                  stream .string += generator .XMLEncode (containerField .getName ());
-                  stream .string += "'";
+                  generator .string += generator .Space ();
+                  generator .string += "containerField='";
+                  generator .string += generator .XMLEncode (containerField .getName ());
+                  generator .string += "'";
                }
             }
 
-            stream .string += "/>";
+            generator .string += "/>";
 
             generator .LeaveScope ();
             return;
          }
       }
 
-      stream .string += generator .Indent ();
-      stream .string += "<ProtoInstance";
-      stream .string += " ";
-      stream .string += "name='";
-      stream .string += generator .XMLEncode (this .getTypeName ());
-      stream .string += "'";
+      generator .string += generator .Indent ();
+      generator .string += "<ProtoInstance";
+      generator .string += generator .Space ();
+      generator .string += "name='";
+      generator .string += generator .XMLEncode (this .getTypeName ());
+      generator .string += "'";
 
       if (name .length)
       {
          generator .AddNode (this);
 
-         stream .string += " ";
-         stream .string += "DEF='";
-         stream .string += generator .XMLEncode (name);
-         stream .string += "'";
+         generator .string += generator .Space ();
+         generator .string += "DEF='";
+         generator .string += generator .XMLEncode (name);
+         generator .string += "'";
       }
 
       const containerField = generator .ContainerField ();
@@ -429,10 +443,10 @@ X3DPrototypeInstance .prototype = Object .assign (Object .create (X3DNode .proto
       {
          if (containerField .getName () !== this .getContainerField ())
          {
-            stream .string += " ";
-            stream .string += "containerField='";
-            stream .string += generator .XMLEncode (containerField .getName ());
-            stream .string += "'";
+            generator .string += generator .Space ();
+            generator .string += "containerField='";
+            generator .string += generator .XMLEncode (containerField .getName ());
+            generator .string += "'";
          }
       }
 
@@ -440,11 +454,12 @@ X3DPrototypeInstance .prototype = Object .assign (Object .create (X3DNode .proto
 
       if (fields .length === 0)
       {
-         stream .string += "/>";
+         generator .string += "/>";
       }
       else
       {
-         stream .string += ">\n";
+         generator .string += ">";
+         generator .string += generator .TidyBreak ();
 
          generator .IncIndent ();
 
@@ -461,14 +476,7 @@ X3DPrototypeInstance .prototype = Object .assign (Object .create (X3DNode .proto
             {
                if (field .getAccessType () === X3DConstants .inputOutput && field .getReferences () .size !== 0)
                {
-                  let initializableReference = false;
-
-                  field .getReferences () .forEach (function (fieldReference)
-                  {
-                     initializableReference = initializableReference || fieldReference .isInitializable ();
-                  });
-
-                  if (!initializableReference)
+                  if (![... field .getReferences ()] .some (reference => reference .isInitializable ()))
                      mustOutputValue = !this .isDefaultValue (field);
                }
             }
@@ -485,33 +493,36 @@ X3DPrototypeInstance .prototype = Object .assign (Object .create (X3DNode .proto
                {
                   case X3DConstants .MFNode:
                   {
-                     stream .string += generator .Indent ();
-                     stream .string += "<fieldValue";
-                     stream .string += " ";
-                     stream .string += "name='";
-                     stream .string += generator .XMLEncode (field .getName ());
-                     stream .string += "'";
+                     generator .string += generator .Indent ();
+                     generator .string += "<fieldValue";
+                     generator .string += generator .Space ();
+                     generator .string += "name='";
+                     generator .string += generator .XMLEncode (field .getName ());
+                     generator .string += "'";
 
                      if (field .length === 0)
                      {
-                        stream .string += "/>\n";
+                        generator .string += "/>";
+                        generator .string += generator .TidyBreak ();
                      }
                      else
                      {
                         generator .PushContainerField (field);
 
-                        stream .string += ">\n";
+                        generator .string += ">";
+                        generator .string += generator .TidyBreak ();
 
                         generator .IncIndent ();
 
-                        field .toXMLStream (stream);
+                        field .toXMLStream (generator);
 
-                        stream .string += "\n";
+                        generator .string += generator .TidyBreak ();
 
                         generator .DecIndent ();
 
-                        stream .string += generator .Indent ();
-                        stream .string += "</fieldValue>\n";
+                        generator .string += generator .Indent ();
+                        generator .string += "</fieldValue>";
+                        generator .string += generator .TidyBreak ();
 
                         generator .PopContainerField ();
                      }
@@ -524,24 +535,26 @@ X3DPrototypeInstance .prototype = Object .assign (Object .create (X3DNode .proto
                      {
                         generator .PushContainerField (field);
 
-                        stream .string += generator .Indent ();
-                        stream .string += "<fieldValue";
-                        stream .string += " ";
-                        stream .string += "name='";
-                        stream .string += generator .XMLEncode (field .getName ());
-                        stream .string += "'";
-                        stream .string += ">\n";
+                        generator .string += generator .Indent ();
+                        generator .string += "<fieldValue";
+                        generator .string += generator .Space ();
+                        generator .string += "name='";
+                        generator .string += generator .XMLEncode (field .getName ());
+                        generator .string += "'";
+                        generator .string += ">";
+                        generator .string += generator .TidyBreak ();
 
                         generator .IncIndent ();
 
-                        field .toXMLStream (stream);
+                        field .toXMLStream (generator);
 
-                        stream .string += "\n";
+                        generator .string += generator .TidyBreak ();
 
                         generator .DecIndent ();
 
-                        stream .string += generator .Indent ();
-                        stream .string += "</fieldValue>\n";
+                        generator .string += generator .Indent ();
+                        generator .string += "</fieldValue>";
+                        generator .string += generator .TidyBreak ();
 
                         generator .PopContainerField ();
                         break;
@@ -551,19 +564,20 @@ X3DPrototypeInstance .prototype = Object .assign (Object .create (X3DNode .proto
                   }
                   default:
                   {
-                     stream .string += generator .Indent ();
-                     stream .string += "<fieldValue";
-                     stream .string += " ";
-                     stream .string += "name='";
-                     stream .string += generator .XMLEncode (field .getName ());
-                     stream .string += "'";
-                     stream .string += " ";
-                     stream .string += "value='";
-
-                     field .toXMLStream (stream);
-
-                     stream .string += "'";
-                     stream .string += "/>\n";
+                     generator .string += generator .Indent ();
+                     generator .string += "<fieldValue";
+                     generator .string += generator .Space ();
+                     generator .string += "name='";
+                     generator .string += generator .XMLEncode (field .getName ());
+                     generator .string += "'";
+                     generator .string += generator .Space ();
+                     generator .string += "value='";
+
+                     field .toXMLStream (generator);
+
+                     generator .string += "'";
+                     generator .string += "/>";
+                     generator .string += generator .TidyBreak ();
                      break;
                   }
                }
@@ -576,9 +590,9 @@ X3DPrototypeInstance .prototype = Object .assign (Object .create (X3DNode .proto
 
          if (references .length && ! sharedNode)
          {
-            stream .string += generator .Indent ();
-            stream .string += "<IS>";
-            stream .string += "\n";
+            generator .string += generator .Indent ();
+            generator .string += "<IS>";
+            generator .string += generator .TidyBreak ();
 
             generator .IncIndent ();
 
@@ -586,36 +600,406 @@ X3DPrototypeInstance .prototype = Object .assign (Object .create (X3DNode .proto
             {
                const protoFields = field .getReferences ();
 
-               protoFields .forEach (function (protoField)
+               for (const protoField of protoFields)
                {
-                  stream .string += generator .Indent ();
-                  stream .string += "<connect";
-                  stream .string += " ";
-                  stream .string += "nodeField='";
-                  stream .string += generator .XMLEncode (field .getName ());
-                  stream .string += "'";
-                  stream .string += " ";
-                  stream .string += "protoField='";
-                  stream .string += generator .XMLEncode (protoField .getName ());
-                  stream .string += "'";
-                  stream .string += "/>\n";
-               });
+                  generator .string += generator .Indent ();
+                  generator .string += "<connect";
+                  generator .string += generator .Space ();
+                  generator .string += "nodeField='";
+                  generator .string += generator .XMLEncode (field .getName ());
+                  generator .string += "'";
+                  generator .string += generator .Space ();
+                  generator .string += "protoField='";
+                  generator .string += generator .XMLEncode (protoField .getName ());
+                  generator .string += "'";
+                  generator .string += "/>";
+                  generator .string += generator .TidyBreak ();
+               }
             }
 
             generator .DecIndent ();
 
-            stream .string += generator .Indent ();
-            stream .string += "</IS>\n";
+            generator .string += generator .Indent ();
+            generator .string += "</IS>";
+            generator .string += generator .TidyBreak ();
          }
 
          generator .DecIndent ();
 
-         stream .string += generator .Indent ();
-         stream .string += "</ProtoInstance>";
+         generator .string += generator .Indent ();
+         generator .string += "</ProtoInstance>";
       }
 
       generator .LeaveScope ();
    },
+   toJSONStream: function (generator)
+   {
+      const sharedNode = generator .IsSharedNode (this);
+
+      generator .EnterScope ();
+
+      const name = generator .Name (this);
+
+      if (name .length)
+      {
+         if (generator .ExistsNode (this))
+         {
+            generator .string += '{';
+            generator .string += generator .TidySpace ();
+            generator .string += '"';
+            generator .string += "ProtoInstance";
+            generator .string += '"';
+            generator .string += ':';
+            generator .string += generator .TidyBreak ();
+            generator .string += generator .IncIndent ();
+            generator .string += generator .Indent ();
+            generator .string += '{';
+            generator .string += generator .TidyBreak ();
+            generator .string += generator .IncIndent ();
+
+            generator .string += generator .Indent ();
+            generator .string += '"';
+            generator .string += "@name";
+            generator .string += '"';
+            generator .string += ':';
+            generator .string += generator .TidySpace ();
+            generator .string += generator .JSONEncode (this .getTypeName ());
+            generator .string += ',';
+            generator .string += generator .TidyBreak ();
+
+            generator .string += generator .Indent ();
+            generator .string += '"';
+            generator .string += "@USE";
+            generator .string += '"';
+            generator .string += ':';
+            generator .string += generator .TidySpace ();
+            generator .string += generator .JSONEncode (name);
+            generator .string += generator .TidyBreak ();
+
+            generator .string += generator .DecIndent ();
+            generator .string += generator .Indent ();
+            generator .string += '}';
+            generator .string += generator .TidyBreak ();
+            generator .string += generator .DecIndent ();
+            generator .string += generator .Indent ();
+            generator .string += '}';
+
+            generator .LeaveScope ();
+            return;
+         }
+      }
+
+      // Type name
+
+      generator .string += '{';
+      generator .string += generator .TidySpace ();
+      generator .string += '"';
+      generator .string += "ProtoInstance";
+      generator .string += '"';
+      generator .string += ':';
+      generator .string += generator .TidyBreak ();
+      generator .string += generator .IncIndent ();
+      generator .string += generator .Indent ();
+      generator .string += '{';
+      generator .string += generator .TidyBreak ();
+      generator .string += generator .IncIndent ();
+
+
+      // DEF name
+
+      if (name .length)
+      {
+         generator .AddNode (this);
+
+         generator .string += generator .Indent ();
+         generator .string += '"';
+         generator .string += "@DEF";
+         generator .string += '"';
+         generator .string += ':';
+         generator .string += generator .TidySpace ();
+         generator .string += generator .JSONEncode (name);
+         generator .string += ',';
+         generator .string += generator .TidyBreak ();
+      }
+
+
+      // Type name
+
+      generator .string += generator .Indent ();
+      generator .string += '"';
+      generator .string += "@name";
+      generator .string += '"';
+      generator .string += ':';
+      generator .string += generator .TidySpace ();
+      generator .string += generator .JSONEncode (this .getTypeName ());
+      generator .string += ',';
+      generator .string += generator .TidyBreak ();
+
+
+      // Fields
+
+      const
+         fields     = this .getChangedFields (),
+         references = [ ];
+
+      if (fields .length)
+      {
+         generator .string += generator .Indent ();
+         generator .string += '"';
+         generator .string += "fieldValue";
+         generator .string += '"';
+         generator .string += ':';
+         generator .string += generator .TidySpace ();
+         generator .string += '[';
+         generator .string += generator .TidyBreak ();
+         generator .string += generator .IncIndent ();
+
+         const outputFields = [ ];
+
+         for (const field of fields)
+         {
+            // If the field is a inputOutput and we have as reference only inputOnly or outputOnly we must output the value
+            // for this field.
+
+            let mustOutputValue = false;
+
+            if (generator .ExecutionContext ())
+            {
+               if (field .getAccessType () === X3DConstants .inputOutput && field .getReferences () .size !== 0)
+               {
+                  if (![... field .getReferences ()] .some (reference => reference .isInitializable ()))
+                     mustOutputValue = !this .isDefaultValue (field);
+               }
+            }
+
+            // If we have no execution context we are not in a proto and must not generate IS references the same is true
+            // if the node is a shared node as the node does not belong to the execution context.
+
+            if (field .getReferences () .size === 0 || !generator .ExecutionContext () || sharedNode || mustOutputValue)
+            {
+               if (mustOutputValue)
+                  references .push (field);
+
+               outputFields .push (field);
+            }
+            else
+            {
+               references .push (field);
+            }
+         }
+
+         for (const field of outputFields)
+         {
+            switch (field .getType ())
+            {
+               case X3DConstants .SFNode:
+               {
+                  generator .string += generator .Indent ();
+                  generator .string += '{';
+                  generator .string += generator .TidyBreak ();
+                  generator .string += generator .IncIndent ();
+                  generator .string += generator .Indent ();
+                  generator .string += '"';
+                  generator .string += "@name";
+                  generator .string += '"';
+                  generator .string += ':';
+                  generator .string += generator .TidySpace ();
+                  generator .string += generator .JSONEncode (field .getName ());
+                  generator .string += ',';
+                  generator .string += generator .TidyBreak ();
+                  generator .string += generator .Indent ();
+                  generator .string += '"';
+                  generator .string += "-children";
+                  generator .string += '"';
+                  generator .string += ':';
+                  generator .string += generator .TidySpace ();
+                  generator .string += '[';
+                  generator .string += generator .TidyBreak ();
+                  generator .string += generator .IncIndent ();
+                  generator .string += generator .Indent ();
+
+                  field .toJSONStream (generator);
+
+                  generator .string += generator .TidyBreak ();
+                  generator .string += generator .DecIndent ();
+                  generator .string += generator .Indent ();
+                  generator .string += ']';
+                  generator .string += generator .TidyBreak ();
+                  generator .string += generator .DecIndent ();
+                  generator .string += generator .Indent ();
+                  generator .string += '}';
+                  break;
+               }
+               case X3DConstants .MFNode:
+               {
+                  generator .string += generator .Indent ();
+                  generator .string += '{';
+                  generator .string += generator .TidyBreak ();
+                  generator .string += generator .IncIndent ();
+                  generator .string += generator .Indent ();
+                  generator .string += '"';
+                  generator .string += "@name";
+                  generator .string += '"';
+                  generator .string += ':';
+                  generator .string += generator .TidySpace ();
+                  generator .string += generator .JSONEncode (field .getName ());
+                  generator .string += ',';
+                  generator .string += generator .TidyBreak ();
+                  generator .string += generator .Indent ();
+                  generator .string += '"';
+                  generator .string += "-children";
+                  generator .string += '"';
+                  generator .string += ':';
+                  generator .string += generator .TidySpace ();
+
+                  field .toJSONStream (generator);
+
+                  generator .string += generator .TidyBreak ();
+                  generator .string += generator .DecIndent ();
+                  generator .string += generator .Indent ();
+                  generator .string += '}';
+                  break;
+               }
+               default:
+               {
+                  generator .string += generator .Indent ();
+                  generator .string += '{';
+                  generator .string += generator .TidyBreak ();
+                  generator .string += generator .IncIndent ();
+                  generator .string += generator .Indent ();
+                  generator .string += '"';
+                  generator .string += "@name";
+                  generator .string += '"';
+                  generator .string += ':';
+                  generator .string += generator .TidySpace ();
+                  generator .string += generator .JSONEncode (field .getName ());
+                  generator .string += ',';
+                  generator .string += generator .TidyBreak ();
+                  generator .string += generator .Indent ();
+                  generator .string += '"';
+                  generator .string += "@value";
+                  generator .string += '"';
+                  generator .string += ':';
+                  generator .string += generator .TidySpace ();
+
+                  field .toJSONStream (generator);
+
+                  generator .string += generator .TidyBreak ();
+                  generator .string += generator .DecIndent ();
+                  generator .string += generator .Indent ();
+                  generator .string += '}';
+                  break;
+               }
+            }
+
+            if (field !== outputFields .at (-1))
+               generator .string += ',';
+
+            generator .string += generator .TidyBreak ();
+         }
+
+         generator .string += generator .DecIndent ();
+         generator .string += generator .Indent ();
+         generator .string += ']';
+         generator .string += ',';
+         generator .string += generator .TidyBreak ();
+
+
+         // IS references
+
+         if (references .length && ! sharedNode)
+         {
+            generator .string += generator .Indent ();
+            generator .string += '"';
+            generator .string += "IS";
+            generator .string += '"';
+            generator .string += ':';
+            generator .string += generator .TidySpace ();
+            generator .string += '{';
+            generator .string += generator .TidyBreak ();
+            generator .string += generator .IncIndent ();
+            generator .string += generator .Indent ();
+            generator .string += '"';
+            generator .string += "connect";
+            generator .string += '"';
+            generator .string += ':';
+            generator .string += generator .TidySpace ();
+            generator .string += '[';
+            generator .string += generator .TidyBreak ();
+            generator .string += generator .IncIndent ();
+
+            for (const field of references)
+            {
+               const protoFields = [... field .getReferences ()];
+
+               for (const protoField of protoFields)
+               {
+                  generator .string += generator .Indent ();
+                  generator .string += '{';
+                  generator .string += generator .TidyBreak ();
+                  generator .string += generator .IncIndent ();
+
+                  generator .string += generator .Indent ();
+                  generator .string += '"';
+                  generator .string += "@nodeField";
+                  generator .string += '"';
+                  generator .string += ':';
+                  generator .string += generator .TidySpace ();
+                  generator .string += generator .JSONEncode (field .getName ());
+                  generator .string += ',';
+                  generator .string += generator .TidyBreak ();
+
+                  generator .string += generator .Indent ();
+                  generator .string += '"';
+                  generator .string += "@protoField";
+                  generator .string += '"';
+                  generator .string += ':';
+                  generator .string += generator .TidySpace ();
+                  generator .string += generator .JSONEncode (protoField .getName ());
+                  generator .string += generator .TidyBreak ();
+
+                  generator .string += generator .DecIndent ();
+                  generator .string += generator .Indent ();
+                  generator .string += '}';
+
+                  if (field === references .at (-1) && protoField === protoFields .at (-1))
+                     ;
+                  else
+                  {
+                     generator .string += ',';
+                  }
+
+                  generator .string += generator .TidyBreak ();
+               }
+            }
+
+            generator .string += generator .DecIndent ();
+            generator .string += generator .Indent ();
+            generator .string += ']';
+            generator .string += generator .TidyBreak ();
+            generator .string += generator .DecIndent ();
+            generator .string += generator .Indent ();
+            generator .string += '}';
+            generator .string += ',';
+            generator .string += generator .TidyBreak ();
+         }
+      }
+
+      generator .string = generator .string .replace (/,(\s*)$/s, "$1");
+
+
+      // End
+
+      generator .string += generator .DecIndent ();
+      generator .string += generator .Indent ();
+      generator .string += '}';
+      generator .string += generator .TidyBreak ();
+      generator .string += generator .DecIndent ();
+      generator .string += generator .Indent ();
+      generator .string += '}';
+
+      generator .LeaveScope ();
+   },
    dispose: function ()
    {
       this [_protoNode] ._updateInstances .removeInterest ("construct", this);