sunrize 1.8.26 → 1.8.28

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "sunrize",
   "productName": "Sunrize X3D Editor",
-  "version": "1.8.26",
+  "version": "1.8.28",
   "description": "A Multi-Platform X3D Editor",
   "main": "src/main.js",
   "bin": {
@@ -110,7 +110,7 @@
     "string-similarity": "^4.0.4",
     "tweakpane": "^3.1.10",
     "update-electron-app": "^3.1.1",
-    "x_ite": "^12.0.3",
+    "x_ite": "^12.0.5",
     "x3d-traverse": "^1.0.13"
   }
 }

package/src/Controls/AddPrototypePopover.js

@@ -35,6 +35,10 @@ $.fn.addPrototypePopover = function (executionContext, type)
       .on ("change", () => config .selectedIndex = protoMenu .prop ("selectedIndex"))
       .appendTo (content);
 
+   $("<span></span>")
+      .text (_("Name"))
+      .appendTo (content);
+
    const nameInput = $("<input></input>")
       .attr ("placeholder", _("Enter name"))
       .appendTo (content);

package/src/Controls/EditNodePopover.js

@@ -0,0 +1,77 @@
+"use strict";
+
+const
+   X3D = require ("../X3D"),
+   $   = require ("jquery"),
+   _   = require ("../Application/GetText");
+
+require ("./Popover");
+require ("./RenameNodeInput");
+
+$.fn.editNodePopover = function (node)
+{
+   // Create content.
+
+   const content = $("<div></div>");
+
+   $("<span></span>")
+      .text (_("Name"))
+      .appendTo (content);
+
+   const nameInput = $("<input></input>")
+      .attr ("placeholder", _("Enter name"))
+      .appendTo (content);
+
+   if (node instanceof X3D .X3DProtoDeclaration)
+   {
+      $("<span></span>")
+         .text (_("Application Information"))
+         .appendTo (content);
+
+      $("<input></input>")
+         .addClass ("appinfo")
+         .attr ("placeholder", _("Enter application information"))
+         .val (node .getAppInfo ())
+         .appendTo (content);
+
+      $("<span></span>")
+         .text (_("Documentation"))
+         .appendTo (content);
+
+      $("<input></input>")
+         .addClass ("documentation")
+         .attr ("placeholder", _("Enter documentation"))
+         .val (node .getDocumentation ())
+         .appendTo (content);
+   }
+
+   // Setup input after appInfo and documentation.
+   nameInput .renameNodeInput (node);
+
+   // Create tooltip.
+
+   const tooltip = this .popover ({
+      content: content,
+      extension:
+      {
+         wide: node instanceof X3D .X3DProtoDeclaration,
+      },
+      events: {
+         show: (event, api) =>
+         {
+            content .children () .off (".editNodePopover") .on ("keydown.editNodePopover", (event) =>
+            {
+               if (event .key !== "Enter")
+                  return;
+
+               api .toggle (false);
+            })
+
+            setTimeout (() => nameInput .trigger ("select"), 1);
+         },
+      },
+   });
+
+   return this;
+};
+

package/src/Controls/EditUserDefinedFieldPopover.js

@@ -35,7 +35,7 @@ $.fn.editUserDefinedFieldPopover = function (executionContext, node, field = -1)
    const typeNameMenu = $("<select></select>")
       .appendTo (content);
 
-   const singleFields = $("<optgroup></optgroup>")
+   $("<optgroup></optgroup>")
       .attr ("label", "Single Fields")
       .append ($("<option></option>") .text ("SFBool"))
       .append ($("<option></option>") .text ("SFColor"))
@@ -60,7 +60,7 @@ $.fn.editUserDefinedFieldPopover = function (executionContext, node, field = -1)
       .append ($("<option></option>") .text ("SFVec4f"))
       .appendTo (typeNameMenu);
 
-   const multiFields = $("<optgroup></optgroup>")
+   $("<optgroup></optgroup>")
       .attr ("label", "Multi Fields")
       .append ($("<option></option>") .text ("MFBool"))
       .append ($("<option></option>") .text ("MFColor"))
@@ -92,13 +92,12 @@ $.fn.editUserDefinedFieldPopover = function (executionContext, node, field = -1)
       .append ($("<option></option>") .text ("inputOutput"))
       .appendTo (content);
 
-   const nameInput = $("<input></input>")
-      .attr ("placeholder", _("Enter name"))
+   $("<span></span>")
+      .text (_("Name"))
       .appendTo (content);
 
-   const okButton = $("<button></button>")
-      .text (_("Apply"))
-      .on ("click", confirm)
+   const nameInput = $("<input></input>")
+      .attr ("placeholder", _("Enter name"))
       .appendTo (content);
 
    if (field instanceof X3D .X3DField)
@@ -114,6 +113,26 @@ $.fn.editUserDefinedFieldPopover = function (executionContext, node, field = -1)
          .prop ("selected", true);
 
       nameInput .val (field .getName ());
+
+      $("<span></span>")
+         .text (_("Application Information"))
+         .appendTo (content);
+
+      $("<input></input>")
+         .addClass ("appinfo")
+         .attr ("placeholder", _("Enter application information"))
+         .val (field .getAppInfo ())
+         .appendTo (content);
+
+      $("<span></span>")
+         .text (_("Documentation"))
+         .appendTo (content);
+
+      $("<input></input>")
+         .addClass ("documentation")
+         .attr ("placeholder", _("Enter documentation"))
+         .val (field .getDocumentation ())
+         .appendTo (content);
    }
    else
    {
@@ -128,10 +147,19 @@ $.fn.editUserDefinedFieldPopover = function (executionContext, node, field = -1)
          .prop ("selected", true);
    }
 
+   $("<button></button>")
+      .text (_("Apply"))
+      .on ("click", confirm)
+      .appendTo (content);
+
    // Create tooltip.
 
    const tooltip = this .popover ({
       content: content,
+      extension:
+      {
+         wide: field instanceof X3D .X3DField,
+      },
       events: {
          show (event, api)
          {
@@ -140,7 +168,7 @@ $.fn.editUserDefinedFieldPopover = function (executionContext, node, field = -1)
                electron .shell .beep ();
                nameInput .highlight ();
             })
-            .on ("keydown", event =>
+            .siblings (".appinfo, .documentation") .addBack () .on ("keydown", event =>
             {
                if (event .key !== "Enter")
                   return;
@@ -181,17 +209,26 @@ $.fn.editUserDefinedFieldPopover = function (executionContext, node, field = -1)
             if (!name .length)
                return;
 
-            if (type === field .getType () && accessType == field .getAccessType () && name === field .getName ())
-               return;
-
-            // Change field.
+            // Edit field.
 
-            const fields = Array .from (node .getUserDefinedFields ());
+            const
+               fields        = Array .from (node .getUserDefinedFields ()),
+               appInfo       = content .children (".appinfo") .val (),
+               documentation = content .children (".documentation") .val ();
 
             if (type === field .getType ())
             {
                UndoManager .shared .beginUndo (_("Edit Field »%s«"), field .getName ());
-               Editor .updateUserDefinedField (executionContext, node, field, accessType, name);
+
+               if (accessType !== field .getAccessType () || name !== field .getName ())
+                  Editor .updateUserDefinedField (executionContext, node, field, accessType, name);
+
+               if (appInfo !== field .getAppInfo ())
+                  Editor .updateAppInfo (field, appInfo);
+
+               if (documentation !== field .getDocumentation ())
+                  Editor .updateDocumentation (field, documentation);
+
                UndoManager .shared .endUndo ();
             }
             else
@@ -207,6 +244,13 @@ $.fn.editUserDefinedFieldPopover = function (executionContext, node, field = -1)
                fields .splice (index, 1, newField);
 
                Editor .setUserDefinedFields (executionContext, node, fields);
+
+               if (appInfo !== field .getAppInfo ())
+                  Editor .updateAppInfo (newField, appInfo);
+
+               if (documentation !== field .getDocumentation ())
+                  Editor .updateDocumentation (newField, documentation);
+
                UndoManager .shared .endUndo ();
             }
          }

package/src/Controls/ExportNodePopover.js

@@ -15,14 +15,21 @@ $.fn.exportNodePopover = function (node, oldExportedName)
 
    const scene = node .getExecutionContext ();
 
+   const content = $("<div></div>");
+
+   $("<span></span>")
+      .text (_("Name"))
+      .appendTo (content);
+
    const nameInput = $("<input></input>")
       .attr ("placeholder", _("Enter exported name"))
-      .val (oldExportedName ?? scene .getUniqueExportName (node .getName ()));
+      .val (oldExportedName ?? scene .getUniqueExportName (node .getName ()))
+      .appendTo (content);
 
    // Create tooltip.
 
    const tooltip = this .popover ({
-      content: nameInput,
+      content: content,
       events: {
          show: (event, api) =>
          {

package/src/Controls/ImportNodePopover.js

@@ -15,14 +15,21 @@ $.fn.importNodePopover = function (inlineNode, exportedName, oldImportedName)
 
    const executionContext = inlineNode .getExecutionContext ();
 
+   const content = $("<div></div>");
+
+   $("<span></span>")
+      .text (_("Name"))
+      .appendTo (content);
+
    const nameInput = $("<input></input>")
       .attr ("placeholder", _("Enter imported name"))
-      .val (oldImportedName ?? executionContext .getUniqueImportName (exportedName));
+      .val (oldImportedName ?? executionContext .getUniqueImportName (exportedName))
+      .appendTo (content);
 
    // Create tooltip.
 
    const tooltip = this .popover ({
-      content: nameInput,
+      content: content,
       events: {
          show: (event, api) =>
          {

package/src/Controls/Popover.js

@@ -13,6 +13,11 @@ $.fn.popover = function (options)
    if (!options .preview)
       $(".show-preview.on") .removeClass ("on") .addClass ("off");
 
+   let classes = "qtip-tipsy";
+
+   if (options .extension ?.wide)
+      classes += " qtip-wide";
+
    return this .qtip ($.extend (true,
    {
       position: {
@@ -22,7 +27,7 @@ $.fn.popover = function (options)
          effect: false,
       },
       style: {
-         classes: "qtip-tipsy",
+         classes: classes,
       },
       show: {
          ready: true,

package/src/Controls/RenameNodeInput.js

@@ -13,15 +13,15 @@ require ("../Bits/Validate");
 $.fn.renameNodeInput = function (node)
 {
    this
-      .off ("keydown.renameNodeInput")
-      .val (node ? node .getName () : "");
+      .val (node ? node .getName () : "")
+      .siblings () .addBack () .off ("keydown.renameNodeInput")
 
    this .validate (Editor .Id, () =>
    {
       electron .shell .beep ();
       this .highlight ();
    })
-   .on ("keydown.renameNodeInput", (event) =>
+   .siblings () .addBack () .on ("keydown.renameNodeInput", (event) =>
    {
       if (!node)
          return;
@@ -33,9 +33,6 @@ $.fn.renameNodeInput = function (node)
 
       let name = this .val ();
 
-      if (name === node .getName ())
-         return;
-
       const executionContext = node .getExecutionContext ();
 
       if (node instanceof X3D .X3DProtoDeclarationNode)
@@ -45,12 +42,15 @@ $.fn.renameNodeInput = function (node)
 
          if (node .isExternProto)
          {
-            name = executionContext .getUniqueExternProtoName (name);
+            if (name === node .getName ())
+               return;
 
             const externproto = node;
 
             UndoManager .shared .beginUndo (_("Update Extern Proto Declaration »%s«"), name);
 
+            name = executionContext .getUniqueExternProtoName (name);
+
             Editor .updateExternProtoDeclaration (executionContext, name, externproto);
 
             if (!executionContext .protos .get (name))
@@ -65,13 +65,25 @@ $.fn.renameNodeInput = function (node)
          }
          else
          {
-            name = executionContext .getUniqueProtoName (name);
-
-            const proto = node;
+            const
+               proto         = node,
+               appInfo       = this .siblings (".appinfo") .val (),
+               documentation = this .siblings (".documentation") .val ();
 
             UndoManager .shared .beginUndo (_("Update Proto Declaration »%s«"), name);
 
-            Editor .updateProtoDeclaration (executionContext, name, proto);
+            if (name !== node .getName ())
+            {
+               name = executionContext .getUniqueProtoName (name);
+
+               Editor .updateProtoDeclaration (executionContext, name, proto);
+            }
+
+            if (appInfo !== node .getAppInfo ())
+               Editor .updateAppInfo (proto, appInfo);
+
+            if (documentation !== node .getDocumentation ())
+               Editor .updateDocumentation (proto, documentation);
 
             const available = Editor .getNextAvailableProtoNode (executionContext, proto);
 
@@ -83,6 +95,9 @@ $.fn.renameNodeInput = function (node)
       }
       else
       {
+         if (name === node .getName ())
+            return;
+
          if (name)
             Editor .updateNamedNode (executionContext, executionContext .getUniqueName (name), node);
          else

package/src/Editors/OutlineEditor.js

@@ -201,14 +201,15 @@ module .exports = class OutlineEditor extends OutlineRouteGraph
       {
          const
             parentFieldElement = element .closest (".field, .scene", this .sceneGraph),
-            parentNodeElement  = parentFieldElement .closest (".node, .proto, .scene", this .sceneGraph);
+            parentNodeElement  = parentFieldElement .closest (".node, .proto, .scene", this .sceneGraph),
+            innerNode          = $.try (() => node .getInnerNode ()) ?? node;
 
          if (node)
          {
             var menu = [
                {
-                  label: _("Rename Node..."),
-                  args: ["renameNode", element .attr ("id"), executionContext .getId (), node .getId ()],
+                  label: _("Edit Node..."),
+                  args: ["editNode", element .attr ("id"), executionContext .getId (), node .getId ()],
                },
                {
                   label: _("Export Node..."),
@@ -250,7 +251,7 @@ module .exports = class OutlineEditor extends OutlineRouteGraph
                { type: "separator" },
             ];
 
-            if (node .getType () .includes (X3D .X3DConstants .X3DChildNode))
+            if (innerNode .getType () .includes (X3D .X3DConstants .X3DChildNode))
             {
                menu .push ({
                   label: _("Add Parent Group"),
@@ -556,9 +557,9 @@ module .exports = class OutlineEditor extends OutlineRouteGraph
 
          var menu = [
             {
-               label: _("Rename Exported Node..."),
+               label: _("Edit Exported Node..."),
                visible: exportedNode .getExecutionContext () === this .executionContext,
-               args: ["renameExportedNode", element .attr ("id")],
+               args: ["editExportedNode", element .attr ("id")],
             },
             {
                label: _("Remove Exported Node"),
@@ -579,9 +580,9 @@ module .exports = class OutlineEditor extends OutlineRouteGraph
 
          var menu = [
             {
-               label: _("Rename Imported Node..."),
+               label: _("Edit Imported Node..."),
                visible: importedNode .getExecutionContext () .getLocalScene () === this .executionContext,
-               args: ["renameImportedNode", element .attr ("id")],
+               args: ["editImportedNode", element .attr ("id")],
             },
             {
                label: _("Remove Imported Node"),
@@ -604,8 +605,8 @@ module .exports = class OutlineEditor extends OutlineRouteGraph
                args: ["addPrototype", element .attr ("id"), executionContext .getId ()],
             },
             {
-               label: _("Rename Prototype..."),
-               args: ["renamePrototype", element .attr ("id"), executionContext .getId (), protoNode .getId ()],
+               label: _("Edit Prototype..."),
+               args: ["editPrototype", element .attr ("id"), executionContext .getId (), protoNode .getId ()],
             },
             {
                label: _("Delete Prototype"),
@@ -761,15 +762,15 @@ module .exports = class OutlineEditor extends OutlineRouteGraph
       field .addEvent ();
    }
 
-   renameNode (id, executionContextId, nodeId)
+   editNode (id, executionContextId, nodeId)
    {
-      require ("../Controls/RenameNodePopover");
+      require ("../Controls/EditNodePopover");
 
       const
          element = $(`#${id}`),
          node    = this .objects .get (nodeId);
 
-      element .find ("> .item") .renameNodePopover (node);
+      element .find ("> .item") .editNodePopover (node);
    }
 
    openLibrary (id, executionContextId, nodeId, fieldId)
@@ -793,7 +794,7 @@ module .exports = class OutlineEditor extends OutlineRouteGraph
       element .find ("> .item") .exportNodePopover (node);
    }
 
-   renameExportedNode (id)
+   editExportedNode (id)
    {
       require ("../Controls/ExportNodePopover");
 
@@ -825,7 +826,7 @@ module .exports = class OutlineEditor extends OutlineRouteGraph
       element .find ("> .item") .importNodePopover (inlineNode, exportedNode .getExportedName ());
    }
 
-   renameImportedNode (id)
+   editImportedNode (id)
    {
       require ("../Controls/ImportNodePopover");
 
@@ -1992,15 +1993,15 @@ module .exports = class OutlineEditor extends OutlineRouteGraph
          element .addPrototypePopover (executionContext);
    }
 
-   renamePrototype (id, executionContextId, protoNodeId)
+   editPrototype (id, executionContextId, protoNodeId)
    {
-      require ("../Controls/RenameNodePopover");
+      require ("../Controls/EditNodePopover");
 
       const
          element   = $(`#${id}`),
          protoNode = this .objects .get (protoNodeId);
 
-      element .find ("> .item") .renameNodePopover (protoNode);
+      element .find ("> .item") .editNodePopover (protoNode);
    }
 
    deletePrototype (id, executionContextId, protoNodeId, used, availableId)

package/src/Editors/OutlineView.js

@@ -284,9 +284,7 @@ module .exports = class OutlineView extends Interface
       }
 
       child .find (".externproto .name, .externproto .icon, .proto .name, .proto .icon, .node .name, .node .icon")
-         .on ("click", this .selectNode .bind (this));
-
-      child .find (".node .name")
+         .on ("click", this .selectNode .bind (this))
          .on ("mouseenter", this .updateNodeTitle .bind (this));
 
       child .find ("[action]")
@@ -1860,16 +1858,16 @@ module .exports = class OutlineView extends Interface
    {
       const
          name    = $(event .currentTarget),
-         element = $(event .currentTarget) .closest (".node, .special", this .sceneGraph),
+         element = $(event .currentTarget) .closest (".externproto, .proto, .node, .special", this .sceneGraph),
          node    = this .objects .get (parseInt (element .attr ("node-id")));
 
       // Handle NULL node element.
       if (!node)
          return;
 
-      const interfaceDefinitionElement = X3DUOM .find (`ConcreteNode[name="${node .getTypeName ()}"] InterfaceDefinition`);
+      const nodeElement = X3DUOM .find (`ConcreteNode[name="${node .getTypeName ()}"] InterfaceDefinition`);
 
-      name .attr ("title", this .getNodeTitle (interfaceDefinitionElement));
+      name .attr ("title", this .getNodeTitle (node, nodeElement));
    }
 
    updateFieldTitle (event)
@@ -1884,9 +1882,9 @@ module .exports = class OutlineView extends Interface
       name .attr ("title", this .getFieldTitle (node, field, fieldElement));
    }
 
-   getNodeTitle (interfaceDefinitionElement)
+   getNodeTitle (node, nodeElement)
    {
-      const description = interfaceDefinitionElement .attr ("appinfo");
+      const description = nodeElement .attr ("appinfo") ?? node .getAppInfo ?.();
 
       let title = "";
 
@@ -1903,7 +1901,10 @@ module .exports = class OutlineView extends Interface
          return string .length > n ? string .slice (0, n) + "..." : string;
       };
 
-      const description = fieldElement .attr ("description");
+      if (node .getType () .includes (X3D .X3DConstants .X3DPrototypeInstance))
+         field = node .getFieldDefinitions () .get (field .getName ()) .getValue ();
+
+      const description = fieldElement .attr ("description") ?? field .getAppInfo ();
 
       let title = "";
 

package/src/Editors/Panel.js

@@ -137,9 +137,9 @@ module .exports = new class Panel extends Interface
 
       // Set title.
 
-      const interfaceDefinitionElement = concreteNode .find (`InterfaceDefinition`);
+      const nodeElement = concreteNode .find (`InterfaceDefinition`);
 
-      this .container .attr ("title", this .getNodeTitle (interfaceDefinitionElement));
+      this .container .attr ("title", this .getNodeTitle (node, nodeElement));
 
       // Make first folder title draggable.
 
@@ -736,9 +736,9 @@ module .exports = new class Panel extends Interface
       }
    }
 
-   getNodeTitle (interfaceDefinitionElement)
+   getNodeTitle (node, nodeElement)
    {
-      const description = interfaceDefinitionElement .attr ("appinfo");
+      const description = nodeElement .attr ("appinfo") ?? node .getAppInfo ?.();
 
       let title = "";
 
@@ -755,7 +755,10 @@ module .exports = new class Panel extends Interface
          return string .length > n ? string .slice (0, n) + "..." : string;
       };
 
-      const description = fieldElement .attr ("description");
+      if (node .getType () .includes (X3D .X3DConstants .X3DPrototypeInstance))
+         field = node .getFieldDefinitions () .get (field .getName ()) .getValue ();
+
+      const description = fieldElement .attr ("description") ?? field .getAppInfo ();
 
       let title = "";
 

package/src/Tools/EnvironmentalSensor/X3DEnvironmentalSensorNodeTool.x3d

@@ -56,8 +56,14 @@
               <connect nodeField='scale' protoField='size'/>
               <connect nodeField='visible' protoField='selected'/>
             </IS>
-            <Group
-                bboxSize='1 1 1'/>
+            <Shape>
+                <Appearance>
+                  <UnlitMaterial
+                      transparency='1'/>
+                </Appearance>
+                <Box
+                    size='1 1 1'/>
+              </Shape>
           </Transform>
         </Collision>
         <Script DEF='Tool'

package/src/Tools/Grids/X3DGridNodeTool.js

@@ -76,7 +76,7 @@ class X3DGridNodeTool extends X3DActiveLayerNodeTool
                continue;
          }
 
-         field .assign (this .tool .getFieldDefinition (field .getName ()) .value);
+         field .assign (this .tool .getFieldDefinition (field .getName ()) .getValue ());
 
          configNode ?.getMetaData (`Sunrize/${this .tool .getNodeTypeName ()}/${field .getName ()}`, field);
       }
@@ -89,7 +89,7 @@ class X3DGridNodeTool extends X3DActiveLayerNodeTool
 
       const path = `Sunrize/${this .tool .getNodeTypeName ()}/${field .getName ()}`;
 
-      if (field .equals (this .tool .getFieldDefinition (field .getName ()) .value))
+      if (field .equals (this .tool .getFieldDefinition (field .getName ()) .getValue ()))
       {
          const configNode = Editor .getConfigNode (this .getBrowser ());
 

package/src/Tools/Grouping/X3DTransformNodeTool.x3d

@@ -718,8 +718,14 @@
                     <connect nodeField='translation' protoField='center'/>
                   </IS>
                   <ScreenGroup>
-                    <Group
-                        bboxSize='40 40 40'/>
+                    <Shape>
+                      <Appearance>
+                        <UnlitMaterial
+                            transparency='1'/>
+                      </Appearance>
+                      <Box
+                          size='40 40 40'/>
+                    </Shape>
                   </ScreenGroup>
                 </Transform>
               </Transform>