sunrize 1.6.1 → 1.6.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "sunrize",
   "productName": "Sunrize X3D Editor",
-  "version": "1.6.1",
+  "version": "1.6.3",
   "description": "A Multi-Platform X3D Editor",
   "main": "src/main.js",
   "bin": {
@@ -93,14 +93,13 @@
     "material-symbols": "^0.16.0",
     "md5": "^2.3.0",
     "monaco-editor": "^0.47.0",
-    "node-clipboardy": "^1.0.3",
     "node-localstorage": "^3.0.5",
     "qtip2": "^3.0.3",
     "spectrum-colorpicker2": "^2.0.10",
     "string-similarity": "^4.0.4",
     "tweakpane": "^3.1.10",
     "update-electron-app": "^3.0.0",
-    "x_ite": "^9.3.1"
+    "x_ite": "^9.3.2"
   },
   "config": {
     "forge": {

package/src/Application/Application.js

@@ -3,7 +3,6 @@
 const
    electron     = require ("electron"),
    prompt       = require ("electron-prompt"),
-   clipboardy   = require ("node-clipboardy"),
    url          = require ("url"),
    path         = require ("path"),
    fs           = require ("fs"),
@@ -17,11 +16,11 @@ const localStorage = new LocalStorage (path .join (electron .app .getPath ("user
 
 module .exports = class Application
 {
-   config        = new DataStorage (localStorage, "Sunrize.Application.");
-   receivedFiles = [ ];
-   mainMenu      = [ ];
-   openURLValue  = "";
-   exportPath    = new Map ();
+   config            = new DataStorage (localStorage, "Sunrize.Application.");
+   receivedFiles     = [ ];
+   mainMenu          = [ ];
+   openLocationValue = "";
+   exportPath        = new Map ();
 
    static run ()
    {
@@ -63,7 +62,7 @@ module .exports = class Application
          size: [1100, 680],
          maximized: false,
          fullscreen: false,
-         autoSave: false,
+         autoSave: true,
          expandExternProtoDeclarations: true,
          expandPrototypeInstances: true,
          expandInlineNodes: true,
@@ -87,7 +86,7 @@ module .exports = class Application
       electron .ipcMain .on ("title",               (event, title)       => this .title = title);
       electron .ipcMain .on ("current-file",        (event, currentFile) => this .currentFile = currentFile);
       electron .ipcMain .on ("add-recent-document", (event, filePath)    => this .addRecentDocument (filePath));
-      electron .ipcMain .on ("update-menu",         (event, object)      => this .updateMenu (object));
+      electron .ipcMain .on ("update-menu",         (event, options)     => this .updateMenu (options));
       electron .ipcMain .on ("context-menu",        (event, id, menu)    => this .contextMenu (id, menu));
 
       electron .ipcMain .handle ("open-files", async (event, urls) => this .openFiles (urls));
@@ -153,17 +152,22 @@ module .exports = class Application
       electron .Menu .setApplicationMenu (this .mainMenu .at (-1));
    }
 
-   updateMenu (object = { })
+   updateMenu (options = { })
    {
-      Object .assign (this .menuOptions, object);
+      Object .assign (this .menuOptions, options);
 
       const exportPath = this .exportPath .get (this .currentFile);
 
       const menu = electron .Menu .buildFromTemplate (this .filterSeparators ([
-         {
-            role: "appMenu",
-            label: electron .app .getName (),
-         },
+         ... process .platform === "darwin" ?
+         [
+            {
+               role: "appMenu",
+               label: electron .app .getName (),
+            },
+         ]
+         :
+         [ ],
          {
             role: "fileMenu",
             submenu: [
@@ -194,27 +198,22 @@ module .exports = class Application
                   accelerator: "Shift+CmdOrCtrl+O",
                   click: async () =>
                   {
-                     const clipboard = await this .clipboard ();
+                     const clipboard = electron .clipboard .readText ();
 
-                     this .pushMenu (electron .Menu .buildFromTemplate ([
-                        {
-                           role: "appMenu",
-                           label: electron .app .getName (),
-                        },
-                        { role: "editMenu" },
-                     ]));
+                     this .pushMenu (this .createDialogMenu ());
 
                      const response = await prompt ({
-                        title: "Open URL...",
-                        label: "Enter URL for opening in new tab:",
+                        title: _("Open Location..."),
+                        label: _("Enter a URL to open in a new tab:"),
                         type: "input",
-                        value: clipboard .match (/^(?:https?|file|ftp|smb):\/\/.+/) ? clipboard : this .openURLValue,
+                        value: clipboard .match (/^(?:https?|file|ftp|smb):\/\/.+/) ? clipboard : this .openLocationValue,
                         inputAttrs: {
                            type: "url",
                            placeholder: "https://example.org",
                         },
                         width: 500,
                         customStylesheet: path .join (__dirname, "../assets/themes/prompt.css"),
+                        showWhenReady: true,
                      },
                      this .mainWindow);
 
@@ -223,7 +222,7 @@ module .exports = class Application
                      if (response === null)
                         return;
 
-                     this .openFiles ([this .openURLValue = response]);
+                     this .openFiles ([this .openLocationValue = response]);
                   },
                },
                {
@@ -307,14 +306,14 @@ module .exports = class Application
                   {
                      label: util .format (_("Export As %s"), path .basename (exportPath)),
                      accelerator: "CmdOrCtrl+E",
-                     click: async () =>
+                     click: () =>
                      {
-                        const exportPath = this .exportPath .get (this .currentFile);
-
                         this .mainWindow .webContents .send ("export-as", exportPath);
                      },
                   }
-               ] : [ ],
+               ]
+               :
+               [ ],
                {
                   label: _("Export As..."),
                   accelerator: "Shift+CmdOrCtrl+E",
@@ -352,9 +351,64 @@ module .exports = class Application
                      this .mainWindow .webContents .send ("close");
                   },
                },
+               ... process .platform === "darwin" ?
+               [ ]
+               :
+               [{ role: "quit" }],
             ],
          },
-         this .menuOptions .defaultEditMenu ? { role: "editMenu" } :
+         this .menuOptions .defaultEditMenu ?
+         {
+            role: "editMenu",
+            submenu: [
+               { role: "undo" },
+               { role: "redo" },
+               { type: "separator" },
+               { role: "cut" },
+               { role: "copy" },
+               { role: "paste" },
+               ... process .platform === "darwin" ?
+               [
+                  { role: "pasteAndMatchStyle" },
+                  { role: "delete" },
+                  { role: "selectAll" },
+                  { type: "separator" },
+                  {
+                     label: _("Speech"),
+                     submenu: [
+                        { role: "startSpeaking" },
+                        { role: "stopSpeaking" },
+                     ]
+                  },
+               ]
+               :
+               [
+                  { role: "delete" },
+                  { type: "separator" },
+                  { role: "selectAll" },
+               ],
+               { type: "separator" },
+               {
+                  label: _("Toggle Line Comment"),
+                  accelerator: process .platform === "darwin" ? "CmdOrCtrl+Shift+7" : "CmdOrCtrl+#",
+                  enabled: this .menuOptions .monacoEditor,
+                  click: () =>
+                  {
+                     this .mainWindow .webContents .send ("script-editor", "runAction", "editor.action.commentLine");
+                  },
+               },
+               {
+                  label: _("Toggle Block Comment"),
+                  accelerator: "Alt+Shift+A",
+                  enabled: this .menuOptions .monacoEditor,
+                  click: () =>
+                  {
+                     this .mainWindow .webContents .send ("script-editor", "runAction", "editor.action.blockComment");
+                  },
+               },
+            ]
+         }
+         :
          {
             role: "editMenu",
             submenu: [
@@ -463,7 +517,7 @@ module .exports = class Application
                   visible: process .env .SUNRISE_ENVIRONMENT === "DEVELOPMENT",
                },
                {
-                  label: "Reload Tab",
+                  label: _("Reload Tab"),
                   visible: process .env .SUNRISE_ENVIRONMENT === "DEVELOPMENT",
                   click: () =>
                   {
@@ -471,7 +525,7 @@ module .exports = class Application
                   },
                },
                {
-                  label: "Toggle Tab Developer Tools",
+                  label: _("Toggle Tab Developer Tools"),
                   visible: process .env .SUNRISE_ENVIRONMENT === "DEVELOPMENT",
                   click: () =>
                   {
@@ -613,7 +667,7 @@ module .exports = class Application
             ],
          },
          {
-            label: "Layout",
+            label: _("Layout"),
             submenu: [
                {
                   label: _("Browser Frame..."),
@@ -707,22 +761,52 @@ module .exports = class Application
             ],
          },
          ... process .platform === "darwin" ?
-         [{
-            role: "window",
-            submenu: [ ],
-         }]
+         [
+            {
+               role: "window",
+               submenu: [ ],
+            },
+         ]
          :
-         [],
+         [ ],
          {
             role: "help",
             submenu: [
                {
-                  label: "Learn More",
+                  label: _("Learn More"),
                   click: () =>
                   {
                      electron .shell .openExternal ("https://create3000.github.io/sunrize/");
                   },
                },
+               {
+                  label: _("A Quick Look at the User Interface"),
+                  click: () =>
+                  {
+                     electron .shell .openExternal ("https://create3000.github.io/sunrize/documentation/a-quick-look-at-the-user-interface/");
+                  },
+               },
+               {
+                  label: _("How to Navigate in a Scene"),
+                  click: () =>
+                  {
+                     electron .shell .openExternal ("https://create3000.github.io/x_ite/tutorials/how-to-navigate-in-a-scene/");
+                  },
+               },
+               {
+                  label: _("Using the Outline Editor"),
+                  click: () =>
+                  {
+                     electron .shell .openExternal ("https://create3000.github.io/sunrize/documentation/using-the-outline-editor/");
+                  },
+               },
+               {
+                  label: _("Using the Script Editor"),
+                  click: () =>
+                  {
+                     electron .shell .openExternal ("https://create3000.github.io/sunrize/documentation/using-the-script-editor/");
+                  },
+               },
             ],
          },
       ]));
@@ -733,10 +817,29 @@ module .exports = class Application
          electron .Menu .setApplicationMenu (menu);
    }
 
-   async createWindow ()
+   createDialogMenu ()
    {
-      this .appIcon = new electron .Tray (path .join (__dirname, "../assets/images/icon.png"));
+      return electron .Menu .buildFromTemplate ([
+         ... process .platform === "darwin" ?
+         [
+            {
+               role: "appMenu",
+               label: electron .app .getName (),
+            },
+         ]
+         :
+         [
+            {
+               role: "fileMenu",
+               submenu: [{ role: "quit" }],
+            }
+         ],
+         { role: "editMenu" },
+      ]);
+   }
 
+   async createWindow ()
+   {
       const window = new electron .BrowserWindow ({
          icon: path .join (__dirname, "../assets/images/icon.png"),
          x: this .config .position [0],
@@ -787,25 +890,21 @@ module .exports = class Application
 
    contextMenu (id, menu)
    {
-      electron .Menu .buildFromTemplate (this .createMenuTemplate (id, menu))
+      electron .Menu .buildFromTemplate (this .addMenuItemHandlers (id, this .filterSeparators (menu)))
          .popup ({ window: this .mainWindow });
    }
 
-   createMenuTemplate (id, menu)
+   addMenuItemHandlers (id, menu)
    {
-      const template = [ ];
-
-      for (const menuItem of this .filterSeparators (menu))
+      for (const menuItem of menu)
       {
          if (menuItem .submenu)
-            menuItem .submenu = this .createMenuTemplate (id, menuItem .submenu);
+            this .addMenuItemHandlers (id, menuItem .submenu);
          else
             menuItem .click = () => this .mainWindow .webContents .send (id, ... menuItem .args);
-
-         template .push (menuItem);
       }
 
-      return template;
+      return menu;
    }
 
    filterSeparators (menu)
@@ -875,13 +974,7 @@ module .exports = class Application
 
    async showOpenDialog (defaultPath, filters)
    {
-      this .pushMenu (electron .Menu .buildFromTemplate ([
-         {
-            role: "appMenu",
-            label: electron .app .getName (),
-         },
-         { role: "editMenu" },
-      ]));
+      this .pushMenu (this .createDialogMenu ());
 
       const response = await electron .dialog .showOpenDialog ({
          defaultPath: defaultPath,
@@ -906,13 +999,7 @@ module .exports = class Application
 
    async showSaveDialog (defaultPath)
    {
-      this .pushMenu (electron .Menu .buildFromTemplate ([
-         {
-            role: "appMenu",
-            label: electron .app .getName (),
-         },
-         { role: "editMenu" },
-      ]));
+      this .pushMenu (this .createDialogMenu ());
 
       const response = await electron .dialog .showSaveDialog ({
          defaultPath: defaultPath,
@@ -934,13 +1021,7 @@ module .exports = class Application
 
    async showExportDialog (defaultPath)
    {
-      this .pushMenu (electron .Menu .buildFromTemplate ([
-         {
-            role: "appMenu",
-            label: electron .app .getName (),
-         },
-         { role: "editMenu" },
-      ]));
+      this .pushMenu (this .createDialogMenu ());
 
       const response = await electron .dialog .showSaveDialog ({
          defaultPath: defaultPath,
@@ -999,18 +1080,6 @@ module .exports = class Application
       }
    }
 
-   async clipboard ()
-   {
-      try
-      {
-         return await clipboardy .read ();
-      }
-      catch
-      {
-         return "";
-      }
-   }
-
    quit ()
    {
       if (!this .applicationShouldQuitAfterLastWindowClosed)

package/src/Application/Dashboard.js

@@ -20,6 +20,8 @@ module .exports = class Dashboard extends Interface
 
    async initialize ()
    {
+      this .browser .getLive () .addInterest ("updatePlay", this);
+
       this .handButton = $("<span></span>")
          .addClass (["image-icon", "hand"])
          .attr ("title", _("Switch to browser mode."))
@@ -75,7 +77,7 @@ module .exports = class Dashboard extends Interface
       });
 
       this [this .config .file .pointer] ();
-      this .play (this .config .file .play);
+      this .play (this .config .file .play && !this .isInitialScene);
       this .straighten (this .browser .getBrowserOption ("StraightenHorizon"));
 
       if (this .config .file .panel)
@@ -113,15 +115,17 @@ module .exports = class Dashboard extends Interface
       this .config .file .play = value;
 
       if (value)
-      {
-         this .playButton .addClass ("active");
          this .browser .beginUpdate ();
-      }
       else
-      {
-         this .playButton .removeClass ("active");
          this .browser .endUpdate ();
-      }
+   }
+
+   updatePlay ()
+   {
+      if (this .browser .isLive ())
+         this .playButton .addClass ("active");
+      else
+         this .playButton .removeClass ("active");
    }
 
    viewAll ()

package/src/Application/DataStorage.js

@@ -1,80 +1,79 @@
-// Cannot use strict.
-//"use strict"
+"use strict";
 
 const
    storages   = new WeakMap (),
    namespaces = new WeakMap (),
-   defaults   = new WeakMap ()
+   defaults   = new WeakMap ();
 
 const handler =
 {
    get (target, key)
    {
-      const property = target [key]
+      const property = target [key];
 
       if (property !== undefined)
-         return property
+         return property;
 
       const
          storage   = target .getStorage (),
          namespace = target .getNameSpace (),
-         value     = storage [namespace + key]
+         value     = storage [namespace + key];
 
-      if (value === undefined || value === "undefined" || value === null)
-         return target .getDefaultValue (key)
+      if (String (value) .match (/^(?:undefined|null)$/))
+         return target .getDefaultValue (key);
 
       // Update timestamp.
-      storage [namespace + key + ".#timeStamp"] = JSON .stringify (Date .now ())
+      storage [namespace + key + ".#timeStamp"] = JSON .stringify (Date .now ());
 
-      return JSON .parse (value)
+      return JSON .parse (value);
    },
    set (target, key, value)
    {
       const
          storage   = target .getStorage (),
-         namespace = target .getNameSpace ()
+         namespace = target .getNameSpace ();
 
       if (value === undefined)
       {
-         storage .removeItem (namespace + key + ".#timeStamp")
-         storage .removeItem (namespace + key)
+         storage .removeItem (namespace + key + ".#timeStamp");
+         storage .removeItem (namespace + key);
       }
       else
       {
-         storage [namespace + key + ".#timeStamp"] = JSON .stringify (Date .now ())
-         storage [namespace + key]                 = JSON .stringify (value)
+         storage [namespace + key + ".#timeStamp"] = JSON .stringify (Date .now ());
+         storage [namespace + key]                 = JSON .stringify (value);
       }
 
-      return true
+      return true;
    },
    has (target, key)
    {
-      const value = target .getStorage () [target .getNameSpace () + key]
+      const value = target .getStorage () [target .getNameSpace () + key];
 
-      return !(value === undefined || value === "undefined" || value === null)
+      return !(value === undefined || value === "undefined" || value === null);
    },
    ownKeys (target)
    {
       const
          storage   = target .getStorage (),
          namespace = target .getNameSpace (),
-         ownKeys   = [ ]
+         ownKeys   = [ ];
 
       for (const key of Object .keys (storage))
       {
          if (key .startsWith (namespace) && !key .endsWith (".#timeStamp"))
-            ownKeys .push (key .substring (namespace .length))
+            ownKeys .push (key .substring (namespace .length));
       }
 
-      return ownKeys
+      return ownKeys;
    },
    getOwnPropertyDescriptor (target, key)
    {
       const
          storage   = target .getStorage (),
-         namespace = target .getNameSpace ()
+         namespace = target .getNameSpace ();
 
-      return Object .getOwnPropertyDescriptor (storage, namespace + key)
+      return Object .getOwnPropertyDescriptor (storage, namespace + key);
    },
 }
 
@@ -82,13 +81,13 @@ module .exports = class DataStorage
 {
    constructor (storage, namespace)
    {
-      this .target = this
+      this .target = this;
 
-      storages   .set (this, storage)
-      namespaces .set (this, namespace)
-      defaults   .set (this, { })
+      storages   .set (this, storage);
+      namespaces .set (this, namespace);
+      defaults   .set (this, { });
 
-      return new Proxy (this, handler)
+      return new Proxy (this, handler);
    }
 
    /**
@@ -97,7 +96,7 @@ module .exports = class DataStorage
     */
    getStorage ()
    {
-      return storages .get (this .target)
+      return storages .get (this .target);
    }
 
    /**
@@ -106,7 +105,7 @@ module .exports = class DataStorage
     */
    getNameSpace ()
    {
-      return namespaces .get (this .target)
+      return namespaces .get (this .target);
    }
 
    /**
@@ -116,7 +115,7 @@ module .exports = class DataStorage
     */
    addNameSpace (namespace)
    {
-      return new DataStorage (this .getStorage (), this .getNameSpace () + namespace)
+      return new DataStorage (this .getStorage (), this .getNameSpace () + namespace);
    }
 
    /**
@@ -125,7 +124,7 @@ module .exports = class DataStorage
     */
    setDefaultValues (object)
    {
-      Object .assign (defaults .get (this .target), object)
+      Object .assign (defaults .get (this .target), object);
    }
 
    /**
@@ -134,7 +133,7 @@ module .exports = class DataStorage
     */
    getDefaultValues ()
    {
-      return Object .assign ({ }, defaults .get (this .target))
+      return Object .assign ({ }, defaults .get (this .target));
    }
 
    /**
@@ -144,9 +143,9 @@ module .exports = class DataStorage
     */
    getDefaultValue (key)
    {
-      const value = defaults .get (this .target) [key]
+      const value = defaults .get (this .target) [key];
 
-      return value === undefined ? undefined : JSON .parse (JSON .stringify (value))
+      return value === undefined ? undefined : JSON .parse (JSON .stringify (value));
    }
 
    /**
@@ -157,18 +156,18 @@ module .exports = class DataStorage
    {
       const
          storage   = this .getStorage (),
-         namespace = this .getNameSpace ()
+         namespace = this .getNameSpace ();
 
       for (const key of Object .keys (storage))
       {
          if (key .startsWith (namespace) && !key .endsWith (".#timeStamp"))
          {
-            const timeStamp = JSON .parse (storage [key + ".#timeStamp"])
+            const timeStamp = JSON .parse (storage [key + ".#timeStamp"]);
 
             if (timeStamp < before)
             {
-               storage .removeItem (key + ".#timeStamp")
-               storage .removeItem (key)
+               storage .removeItem (key + ".#timeStamp");
+               storage .removeItem (key);
             }
          }
       }
@@ -178,12 +177,12 @@ module .exports = class DataStorage
    {
       const
          storage   = this .getStorage (),
-         namespace = this .getNameSpace ()
+         namespace = this .getNameSpace ();
 
       for (const key of Object .keys (storage))
       {
          if (key .startsWith (namespace))
-            storage .removeItem (key)
+            storage .removeItem (key);
       }
    }
-}
+};