x_ite 4.7.12 → 5.0.0

package/src/x_ite/Prototype/X3DExternProtoDeclaration.js

@@ -48,16 +48,18 @@
 
 
 define ([
-	"jquery",
-	"x_ite/Fields",
-	"x_ite/Basic/X3DFieldDefinition",
-	"x_ite/Basic/FieldDefinitionArray",
-	"x_ite/Components/Networking/X3DUrlObject",
-	"x_ite/Prototype/X3DProtoDeclarationNode",
-	"x_ite/Bits/X3DConstants",
-	"x_ite/InputOutput/Generator",
+   "jquery",
+   "x_ite/Configuration/SupportedNodes",
+   "x_ite/Fields",
+   "x_ite/Base/X3DFieldDefinition",
+   "x_ite/Base/FieldDefinitionArray",
+   "x_ite/Components/Networking/X3DUrlObject",
+   "x_ite/Prototype/X3DProtoDeclarationNode",
+   "x_ite/Base/X3DConstants",
+   "x_ite/InputOutput/Generator",
 ],
 function ($,
+          SupportedNodes,
           Fields,
           X3DFieldDefinition,
           FieldDefinitionArray,
@@ -68,293 +70,273 @@ function ($,
 {
 "use strict";
 
-	function X3DExternProtoDeclaration (executionContext)
-	{
-		X3DProtoDeclarationNode .call (this, executionContext);
-		X3DUrlObject            .call (this, executionContext);
-
-		this .addChildObjects ("url",                  new Fields .MFString (),
-		                       "autoRefresh",          new Fields .SFTime (),
-									  "autoRefreshTimeLimit", new Fields .SFTime (3600));
-
-		this .deferred = $.Deferred ();
-	}
-
-	X3DExternProtoDeclaration .prototype = Object .assign (Object .create (X3DProtoDeclarationNode .prototype),
-		X3DUrlObject .prototype,
-	{
-		constructor: X3DExternProtoDeclaration,
-		fieldDefinitions: new FieldDefinitionArray ([ ]),
-		getTypeName: function ()
-		{
-			return "EXTERNPROTO";
-		},
-		getComponentName: function ()
-		{
-			return "X_ITE";
-		},
-		getContainerField: function ()
-		{
-			return "externprotos";
-		},
-		initialize: function ()
-		{
-			X3DProtoDeclarationNode .prototype .initialize .call (this);
-			X3DUrlObject            .prototype .initialize .call (this);
-		},
-		set_live__: function ()
-		{
-			X3DUrlObject .prototype .set_live__ .call (this);
-
-			if (this .checkLoadState () !== X3DConstants .COMPLETE_STATE)
-				return;
-
-			this .scene .setLive (this .isLive () .getValue ());
-		},
-		hasUserDefinedFields: function ()
-		{
-			return true;
-		},
-		setProtoDeclaration: function (proto)
-		{
-			this .proto = proto;
-
-			if (!this .proto)
-				return
-
-			const fieldDefinitions = this .getFieldDefinitions ();
-
-			for (const protoFieldDefinition of proto .getFieldDefinitions ())
-			{
-				const fieldDefinition = fieldDefinitions .get (protoFieldDefinition .name);
-
-				if (fieldDefinition)
-					fieldDefinition .value .setValue (protoFieldDefinition .value);
-			}
-		},
-		getProtoDeclaration: function ()
-		{
-			return this .proto;
-		},
-		loadNow: function (callback)
-		{
-			// 7.73 — ExternProtoDeclaration function, added callback argument.
-			this .requestImmediateLoad (callback);
-		},
-		requestImmediateLoad: function (callback)
-		{
-			if ($.isFunction (callback))
-				this .deferred .done (callback);
-
-			if (this .checkLoadState () === X3DConstants .COMPLETE_STATE || this .checkLoadState () === X3DConstants .IN_PROGRESS_STATE)
-				return;
-
-			this .getScene () .addInitLoadCount (this);
-			this .setLoadState (X3DConstants .IN_PROGRESS_STATE);
-
-			// Don't create scene cache, due to possible default nodes in proto SFNode fields and complete scenes.
-
-			const FileLoader = require ("x_ite/InputOutput/FileLoader");
-
-			new FileLoader (this) .createX3DFromURL (this .url_, null, this .setInternalSceneAsync .bind (this));
-		},
-		setInternalSceneAsync: function (value)
-		{
-			if (value)
-				this .setInternalScene (value);
-
-			else
-				this .setError (new Error ("File could not be loaded."));
-
-			this .getScene () .removeInitLoadCount (this);
-		},
-		setInternalScene: function (value)
-		{
-			this .scene = value;
-
-			const
-				protoName = new URL (this .scene .getWorldURL ()) .hash .substr (1) || 0,
-				proto     = this .scene .protos [protoName];
-
-			if (! proto)
-				throw new Error ("PROTO not found");
-
-			this .scene .setLive (this .isLive () .getValue ());
-			this .scene .setPrivate (this .getScene () .getPrivate ());
-			this .scene .setExecutionContext (this .getExecutionContext ());
-
-			this .setLoadState (X3DConstants .COMPLETE_STATE);
-			this .setProtoDeclaration (proto);
-
-			this .deferred .resolve ();
-		},
-		getInternalScene: function ()
-		{
-			///  Returns the internal X3DScene of this extern proto, that is loaded from the url given.
-
-			return this .scene;
-		},
-		setError: function (error)
-		{
-			console .error ("Error loading extern prototype:", error);
-
-			this .scene = this .getBrowser () .getPrivateScene ();
-
-			this .setLoadState (X3DConstants .FAILED_STATE);
-			this .setProtoDeclaration (null);
-
-			this .deferred .resolve ();
-			this .deferred = $.Deferred ();
-		},
-		toStream: function (stream)
-		{
-			stream .string += Object .prototype .toString .call (this);
-		},
-		toVRMLStream: function (stream)
-		{
-			const generator = Generator .Get (stream);
-
-			stream .string += generator .Indent ();
-			stream .string += "EXTERNPROTO";
-			stream .string += " ";
-			stream .string += this .getName ();
-			stream .string += " ";
-			stream .string += "[";
-
-			const userDefinedFields = this .getUserDefinedFields ();
-
-			let
-				fieldTypeLength   = 0,
-				accessTypeLength  = 0;
-
-			if (userDefinedFields .size === 0)
-			{
-				stream .string += " ";
-			}
-			else
-			{
-				userDefinedFields .forEach (function (field)
-				{
-					fieldTypeLength  = Math .max (fieldTypeLength, field .getTypeName () .length);
-					accessTypeLength = Math .max (accessTypeLength, generator .AccessType (field .getAccessType ()) .length);
-				});
-
-				stream .string += "\n";
-
-				generator .IncIndent ();
-
-				userDefinedFields .forEach (function (field)
-				{
-					this .toVRMLStreamUserDefinedField (stream, field, fieldTypeLength, accessTypeLength);
-					stream .string += "\n";
-				},
-				this);
-
-				generator .DecIndent ();
-
-				stream .string += generator .Indent ();
-			}
-
-			stream .string += "]";
-			stream .string += "\n";
-
-			stream .string += generator .Indent ();
-
-			this .url_ .toVRMLStream (stream);
-		},
-		toVRMLStreamUserDefinedField: function (stream, field, fieldTypeLength, accessTypeLength)
-		{
-			const generator = Generator .Get (stream);
-
-			stream .string += generator .Indent ();
-			stream .string += generator .PadRight (generator .AccessType (field .getAccessType ()), accessTypeLength);
-			stream .string += " ";
-			stream .string += generator .PadRight (field .getTypeName (), fieldTypeLength);
-			stream .string += " ";
-			stream .string += field .getName ();
-		},
-		toXMLStream: function (stream)
-		{
-			const generator = Generator .Get (stream);
-
-			stream .string += generator .Indent ();
-			stream .string += "<ExternProtoDeclare";
-			stream .string += " ";
-			stream .string += "name='";
-			stream .string += generator .XMLEncode (this .getName ());
-			stream .string += "'";
-			stream .string += " ";
-			stream .string += "url='";
-
-			this .url_ .toXMLStream (stream);
-
-			stream .string += "'";
-			stream .string += ">\n";
-
-			generator .IncIndent ();
-
-			const userDefinedFields = this .getUserDefinedFields ();
-
-			userDefinedFields .forEach (function (field)
-			{
-				stream .string += generator .Indent ();
-				stream .string += "<field";
-				stream .string += " ";
-				stream .string += "accessType='";
-				stream .string += generator .AccessType (field .getAccessType ());
-				stream .string += "'";
-				stream .string += " ";
-				stream .string += "type='";
-				stream .string += field .getTypeName ();
-				stream .string += "'";
-				stream .string += " ";
-				stream .string += "name='";
-				stream .string += generator .XMLEncode (field .getName ());
-				stream .string += "'";
-				stream .string += "/>\n";
-			});
-
-			generator .DecIndent ();
-
-			stream .string += generator .Indent ();
-			stream .string += "</ExternProtoDeclare>";
-		},
-	});
-
-	Object .defineProperty (X3DExternProtoDeclaration .prototype, "name",
-	{
-		get: function () { return this .getName (); },
-		enumerable: true,
-		configurable: false
-	});
-
-	Object .defineProperty (X3DExternProtoDeclaration .prototype, "fields",
-	{
-		get: function () { return this .getFieldDefinitions (); },
-		enumerable: true,
-		configurable: false
-	});
-
-	Object .defineProperty (X3DExternProtoDeclaration .prototype, "isExternProto",
-	{
-		get: function () { return true; },
-		enumerable: true,
-		configurable: false
-	});
-
-	Object .defineProperty (X3DExternProtoDeclaration .prototype, "urls",
-	{
-		get: function () { return this .url_ .copy (); },
-		enumerable: true,
-		configurable: false
-	});
-
-	Object .defineProperty (X3DExternProtoDeclaration .prototype, "loadState",
-	{
-		get: function () { return this .checkLoadState (); },
-		enumerable: true,
-		configurable: false
-	});
-
-	return X3DExternProtoDeclaration;
+   SupportedNodes .addAbstractType ("X3DExternProtoDeclaration", X3DExternProtoDeclaration);
+
+   const
+      _proto = Symbol (),
+      _scene = Symbol ();
+
+   function X3DExternProtoDeclaration (executionContext, url)
+   {
+      X3DProtoDeclarationNode .call (this, executionContext);
+      X3DUrlObject            .call (this, executionContext);
+
+      this .addType (X3DConstants .X3DExternProtoDeclaration)
+
+      this .addChildObjects ("load",                 new Fields .SFBool (true),
+                             "url",                  url .copy (), // Must be of type MFString.
+                             "autoRefresh",          new Fields .SFTime (),
+                             "autoRefreshTimeLimit", new Fields .SFTime (3600));
+   }
+
+   X3DExternProtoDeclaration .prototype = Object .assign (Object .create (X3DProtoDeclarationNode .prototype),
+      X3DUrlObject .prototype,
+   {
+      constructor: X3DExternProtoDeclaration,
+      [Symbol .for ("X_ITE.X3DBaseNode.fieldDefinitions")]: new FieldDefinitionArray ([
+         new X3DFieldDefinition (X3DConstants .inputOutput, "metadata", new Fields .SFNode ()),
+      ]),
+      getTypeName: function ()
+      {
+         return "X3DExternProtoDeclaration";
+      },
+      initialize: function ()
+      {
+         X3DProtoDeclarationNode .prototype .initialize .call (this);
+         X3DUrlObject            .prototype .initialize .call (this);
+      },
+      set_live__: function ()
+      {
+         X3DUrlObject .prototype .set_live__ .call (this);
+
+         if (this .checkLoadState () !== X3DConstants .COMPLETE_STATE)
+            return;
+
+         this [_scene] .setLive (this .isLive () .getValue ());
+      },
+      canUserDefinedFields: function ()
+      {
+         return true;
+      },
+      setProtoDeclaration: function (proto)
+      {
+         this [_proto] = proto;
+
+         if (proto)
+         {
+            for (const field of this .getUserDefinedFields ())
+               this .removeUserDefinedField (field .getName ())
+
+            for (const field of proto .getUserDefinedFields ())
+               this .addUserDefinedField (field .getAccessType (), field .getName (), field);
+         }
+
+         this .updateInstances ();
+      },
+      getProtoDeclaration: function ()
+      {
+         return this [_proto];
+      },
+      loadNow: function ()
+      {
+         // 7.73 — ExternProtoDeclaration function
+
+         this .getScene () .addInitLoadCount (this);
+
+         const FileLoader = require ("x_ite/InputOutput/FileLoader");
+
+         new FileLoader (this) .createX3DFromURL (this ._url, null, this .setInternalSceneAsync .bind (this));
+      },
+      setInternalSceneAsync: function (value)
+      {
+         if (value)
+            this .setInternalScene (value);
+
+         else
+            this .setError (new Error ("File could not be loaded."));
+
+         this .getScene () .removeInitLoadCount (this);
+      },
+      setInternalScene: function (value)
+      {
+         this [_scene] = value;
+
+         const
+            protoName = decodeURIComponent (new URL (this [_scene] .getWorldURL ()) .hash .substr (1)),
+            proto     = protoName ? this [_scene] .protos .get (protoName) : this [_scene] .protos [0];
+
+         if (!proto)
+            throw new Error ("PROTO not found");
+
+         this [_scene] .setLive (this .isLive () .getValue ());
+         this [_scene] .setPrivate (this .getScene () .getPrivate ());
+         this [_scene] .setExecutionContext (this .getExecutionContext ());
+
+         this .setLoadState (X3DConstants .COMPLETE_STATE);
+         this .setProtoDeclaration (proto);
+      },
+      getInternalScene: function ()
+      {
+         ///  Returns the internal X3DScene of this extern proto, that is loaded from the url given.
+
+         return this [_scene];
+      },
+      setError: function (error)
+      {
+         console .error ("Error loading extern prototype:", error);
+
+         this [_scene] = this .getBrowser () .getPrivateScene ();
+
+         this .setLoadState (X3DConstants .FAILED_STATE);
+         this .setProtoDeclaration (null);
+      },
+      toVRMLStream: function (stream)
+      {
+         const generator = Generator .Get (stream);
+
+         stream .string += generator .Indent ();
+         stream .string += "EXTERNPROTO";
+         stream .string += " ";
+         stream .string += this .getName ();
+         stream .string += " ";
+         stream .string += "[";
+
+         const userDefinedFields = this .getUserDefinedFields ();
+
+         let
+            fieldTypeLength   = 0,
+            accessTypeLength  = 0;
+
+         if (userDefinedFields .length === 0)
+         {
+            stream .string += " ";
+         }
+         else
+         {
+            for (const field of userDefinedFields)
+            {
+               fieldTypeLength  = Math .max (fieldTypeLength, field .getTypeName () .length);
+               accessTypeLength = Math .max (accessTypeLength, generator .AccessType (field .getAccessType ()) .length);
+            }
+
+            stream .string += "\n";
+
+            generator .IncIndent ();
+
+            for (const field of userDefinedFields)
+            {
+               this .toVRMLStreamUserDefinedField (stream, field, fieldTypeLength, accessTypeLength);
+               stream .string += "\n";
+            }
+
+            generator .DecIndent ();
+
+            stream .string += generator .Indent ();
+         }
+
+         stream .string += "]";
+         stream .string += "\n";
+
+         stream .string += generator .Indent ();
+
+         this ._url .toVRMLStream (stream);
+      },
+      toVRMLStreamUserDefinedField: function (stream, field, fieldTypeLength, accessTypeLength)
+      {
+         const generator = Generator .Get (stream);
+
+         stream .string += generator .Indent ();
+         stream .string += generator .PadRight (generator .AccessType (field .getAccessType ()), accessTypeLength);
+         stream .string += " ";
+         stream .string += generator .PadRight (field .getTypeName (), fieldTypeLength);
+         stream .string += " ";
+         stream .string += field .getName ();
+      },
+      toXMLStream: function (stream)
+      {
+         const generator = Generator .Get (stream);
+
+         stream .string += generator .Indent ();
+         stream .string += "<ExternProtoDeclare";
+         stream .string += " ";
+         stream .string += "name='";
+         stream .string += generator .XMLEncode (this .getName ());
+         stream .string += "'";
+         stream .string += " ";
+         stream .string += "url='";
+
+         this ._url .toXMLStream (stream);
+
+         stream .string += "'";
+         stream .string += ">\n";
+
+         generator .IncIndent ();
+
+         const userDefinedFields = this .getUserDefinedFields ();
+
+         for (const field of userDefinedFields)
+         {
+            stream .string += generator .Indent ();
+            stream .string += "<field";
+            stream .string += " ";
+            stream .string += "accessType='";
+            stream .string += generator .AccessType (field .getAccessType ());
+            stream .string += "'";
+            stream .string += " ";
+            stream .string += "type='";
+            stream .string += field .getTypeName ();
+            stream .string += "'";
+            stream .string += " ";
+            stream .string += "name='";
+            stream .string += generator .XMLEncode (field .getName ());
+            stream .string += "'";
+            stream .string += "/>\n";
+         }
+
+         generator .DecIndent ();
+
+         stream .string += generator .Indent ();
+         stream .string += "</ExternProtoDeclare>";
+      },
+   });
+
+   for (const key of Reflect .ownKeys (X3DExternProtoDeclaration .prototype))
+      Object .defineProperty (X3DExternProtoDeclaration .prototype, key, { enumerable: false });
+
+   Object .defineProperty (X3DExternProtoDeclaration .prototype, "name",
+   {
+      get: function () { return this .getName (); },
+      enumerable: true,
+      configurable: false
+   });
+
+   Object .defineProperty (X3DExternProtoDeclaration .prototype, "fields",
+   {
+      get: function () { return this .getFieldDefinitions (); },
+      enumerable: true,
+      configurable: false
+   });
+
+   Object .defineProperty (X3DExternProtoDeclaration .prototype, "isExternProto",
+   {
+      get: function () { return true; },
+      enumerable: true,
+      configurable: false
+   });
+
+   Object .defineProperty (X3DExternProtoDeclaration .prototype, "urls",
+   {
+      get: function () { return this ._url; },
+      enumerable: true,
+      configurable: false
+   });
+
+   Object .defineProperty (X3DExternProtoDeclaration .prototype, "loadState",
+   {
+      get: function () { return this .checkLoadState (); },
+      enumerable: true,
+      configurable: false
+   });
+
+   return X3DExternProtoDeclaration;
 });