@woosh/meep-engine 2.102.0 → 2.103.0

package/build/meep.cjs

@@ -2478,7 +2478,7 @@ let Vector3$1 = class Vector3 {
     }
 
     /**
-     * @param {number} [squaredError=0.01]
+     * @param {number} [squaredError]
      * @return {boolean}
      */
     isNormalized(squaredError = 0.01) {
@@ -47474,10 +47474,8 @@ function v2_dot(x0, y0, x1, y1) {
 class Vector2 {
     /**
      *
-     * @param {number} [x=0
+     * @param {number} [x=0]
      * @param {number} [y=0]
-     * @property {number} x
-     * @property {number} y
      * @constructor
      */
     constructor(x = 0, y = 0) {
@@ -50398,6 +50396,7 @@ class Vector1 extends Number {
      * @param {number} x
      */
     setSilent(x) {
+
         this.x = x;
     }
 
@@ -83406,7 +83405,7 @@ class ModuleRegistry {
  * @param {TaskGroup|Task} t
  * @returns {boolean}
  */
-function isGroup(t) {
+function isGroupTask(t) {
     return t.children instanceof Array;
 }
 
@@ -83414,7 +83413,12 @@ function isGroup(t) {
  * @class
  */
 class ConcurrentExecutor {
+    /**
+     * How many time-slice cycles have been executed this far. This is a monotonically increasing counter
+     * @type {number}
+     */
     #cycle_count = 0;
+
     /**
      * Handle of the last scheduled `setTimeout`
      * @type {number}
@@ -83526,7 +83530,7 @@ class ConcurrentExecutor {
                 const child = children[i];
                 child.on.completed.add(subTaskCompleted);
                 child.on.failed.add(subTaskFailed);
-                if (isGroup(child)) {
+                if (isGroupTask(child)) {
                     this.runGroup(child);
                 } else {
                     this.run(child);
@@ -83549,7 +83553,7 @@ class ConcurrentExecutor {
         for (let i = 0; i < n; i++) {
             const child = children[i];
 
-            if (isGroup(child)) {
+            if (isGroupTask(child)) {
                 this.removeGroup(child);
             } else {
                 this.removeTask(child);
@@ -83646,7 +83650,7 @@ class ConcurrentExecutor {
     }
 
     /**
-     * Go through unresolved queue and move tasks who's dependencies have been completed to ready queue or fail them
+     * Go through unresolved queue and move tasks whose dependencies have been completed to ready queue or fail them
      */
     resolveTasks() {
         const queueUnresolved = this.queueUnresolved;
@@ -83683,6 +83687,7 @@ class ConcurrentExecutor {
     /**
      *
      * @param {Task} task
+     * @returns {boolean}
      */
     contains(task) {
         if (this.queueUnresolved.indexOf(task) !== -1) {
@@ -96213,6 +96218,7 @@ const source = typeof performance === "undefined" ? Date : performance;
  * @returns {number}
  */
 function current_time_in_seconds() {
+    // time source produces value in milliseconds, we need to scale to seconds
     return source.now() * 1e-3;
 }
 
@@ -102717,50 +102723,51 @@ Notification.prototype.isNotification = true;
  */
 
 
-function NotificationLog() {
+class NotificationLog {
     /**
      * @readonly
      * @type {List<Notification>}
      */
-    this.elements = new List();
+    elements = new List();
 
     /**
      * Once number of entries in the log reaches this amount, the earliest entries will be removed to make space for new ones
      * @type {number}
      */
-    this.maxLength = 1000;
-}
+    maxLength = 1000;
 
-/**
- *
- * @param {{}} options See Notification.constructor for details
- * @returns {Notification}
- */
-NotificationLog.prototype.add = function (options) {
-    const notification = new Notification(options);
+    /**
+     *
+     * @param {{}} options See {@link Notification.constructor} for details
+     * @returns {Notification}
+     */
+    add(options) {
+        const notification = new Notification(options);
 
-    this.addNotification(notification);
+        this.addNotification(notification);
 
-    return notification;
-};
+        return notification;
+    }
 
-/**
- *
- * @param {Notification} notification
- */
-NotificationLog.prototype.addNotification = function (notification) {
+    /**
+     *
+     * @param {Notification} notification
+     */
+    addNotification(notification) {
 
-    // Crop notification log to size
-    const length = this.elements.length;
+        // Crop notification log to size
+        const length = this.elements.length;
 
-    const target = this.maxLength - 1;
+        const target = this.maxLength - 1;
 
-    if (length > target) {
-        this.elements.crop(length - target, length);
-    }
+        if (length > target) {
+            // too many elements, drop some
+            this.elements.crop(length - target, length);
+        }
 
-    this.elements.add(notification);
-};
+        this.elements.add(notification);
+    }
+}
 
 class LogDisplay {
     /**