@woosh/meep-engine 2.60.1 → 2.61.0

package/src/engine/ecs/System.js

@@ -23,9 +23,9 @@ class System {
 
     /**
      * @readonly
-     * @type {ObservedValue.<System.State>}
+     * @type {ObservedValue.<SystemState>}
      */
-    state = new ObservedValue(System.State.INITIAL);
+    state = new ObservedValue(SystemState.INITIAL);
 
     /**
      * Other components which have to be present before the system links component

package/src/engine/ecs/transform/Transform.d.ts

@@ -1,16 +1,18 @@
-import Vector3 from "../../../core/geom/Vector3";
 import Quaternion from "../../../core/geom/Quaternion";
+import Vector3 from "../../../core/geom/Vector3";
 
 export class Transform {
-    public readonly position: Vector3
-    public readonly rotation: Quaternion
-    public readonly scale: Vector3
+    readonly position: Vector3
+    readonly rotation: Quaternion
+    readonly scale: Vector3
+
+    readonly forward: Vector3
 
     flags: number
 
     public readonly matrix: ArrayLike<number>
 
-    public lookAt(target: Vector3): void
+    public lookAt(target: Vector3, up?: Vector3): void
 
     static fromJSON(json: {
         position?: { x: number, y: number, z: number },

package/src/engine/ecs/transform/Transform.js

@@ -2,15 +2,15 @@
  * Created by Alex on 02/04/2014.
  */
 
-import Vector3 from "../../../core/geom/Vector3.js";
+import {assert} from "../../../core/assert.js";
+import {compose_matrix4_array} from "../../../core/geom/3d/compose_matrix4_array.js";
+import {decompose_matrix_4_array} from "../../../core/geom/3d/decompose_matrix_4_array.js";
+import {allocate_transform_m4} from "../../../core/geom/3d/matrix/allocate_transform_m4.js";
+import {m4_multiply} from "../../../core/geom/3d/matrix/m4_multiply.js";
+import {MATRIX_4_IDENTITY} from "../../../core/geom/3d/matrix/MATRIX_4_IDENTITY.js";
 import Quaternion from "../../../core/geom/Quaternion.js";
-import { decompose_matrix_4_array } from "../../../core/geom/3d/decompose_matrix_4_array.js";
-import { compose_matrix4_array } from "../../../core/geom/3d/compose_matrix4_array.js";
-import { TransformFlags } from "./TransformFlags.js";
-import { allocate_transform_m4 } from "../../../core/geom/3d/matrix/allocate_transform_m4.js";
-import { assert } from "../../../core/assert.js";
-import { m4_multiply } from "../../../core/geom/3d/matrix/m4_multiply.js";
-import { MATRIX_4_IDENTITY } from "../../../core/geom/3d/matrix/MATRIX_4_IDENTITY.js";
+import Vector3 from "../../../core/geom/Vector3.js";
+import {TransformFlags} from "./TransformFlags.js";
 
 /**
  *
@@ -71,26 +71,39 @@ export class Transform {
      */
     constructor() {
         // watch changes
-        this.subscribeAllChanges(this.__handle_component_change, this);
+        this.subscribe(this.#handle_component_change, this);
     }
 
     /**
-     *
+     * Current "forward" direction in world-space
+     * NOTE that this vector is not live, meaning that if you modify transform, previously-obtained result will no longer be valid
+     * @returns {Vector3}
+     */
+    get forward() {
+        const result = Vector3.forward.clone();
+
+        result.applyMatrix4(this.matrix);
+
+        return result;
+    }
+
+    /**
+     * Attach change listener
      * @param {function} handler
      * @param {*} [thisArg]
      */
-    subscribeAllChanges(handler, thisArg) {
+    subscribe(handler, thisArg) {
         this.position.onChanged.add(handler, thisArg);
         this.rotation.onChanged.add(handler, thisArg);
         this.scale.onChanged.add(handler, thisArg);
     }
 
     /**
-     *
+     * Disconnect change listener
      * @param {function} handler
      * @param {*} [thisArg]
      */
-    unsubscribeAllChanges(handler, thisArg) {
+    unsubscribe(handler, thisArg) {
         this.position.onChanged.remove(handler, thisArg);
         this.rotation.onChanged.remove(handler, thisArg);
         this.scale.onChanged.remove(handler, thisArg);
@@ -100,7 +113,7 @@ export class Transform {
      *
      * @private
      */
-    __handle_component_change() {
+    #handle_component_change() {
         if (this.getFlag(TransformFlags.AutomaticChangeDetection)) {
             this.updateMatrix();
         }
@@ -156,8 +169,9 @@ export class Transform {
     /**
      *
      * @param {Vector3} target
+     * @param {Vector3} [up]
      */
-    lookAt(target) {
+    lookAt(target, up = Vector3.up) {
 
         const position = this.position;
 
@@ -172,7 +186,7 @@ export class Transform {
 
         this.rotation._lookRotation(
             delta_x, delta_y, delta_z,
-            Vector3.up.x, Vector3.up.y, Vector3.up.z
+            up.x, up.y, up.z
         );
     }
 

package/src/engine/ecs/validateSystem.js

@@ -0,0 +1,89 @@
+import {System} from "./System.js";
+
+/**
+ * Utility method for making sure that the system is properly constructed, used internally by the engine itself
+ * @param {System} system
+ * @throws if system fails validation
+ */
+export function validateSystem(system) {
+    if (system === undefined) {
+        throw new Error("System is undefined");
+    }
+
+    if (system === null) {
+        throw  new Error("System is null");
+    }
+
+    if (!(system instanceof System)) {
+        throw new TypeError("System does not inherit from \"System\" class");
+    }
+
+    if (typeof system.add === "function") {
+        throw new Error(`uses deprecated 'add' method, should use 'link' instead`);
+    }
+
+    if (typeof system.remove === "function") {
+        throw new Error(`uses deprecated 'remove' method, should use 'unlink' instead`);
+    }
+
+    // validate 'components_used' section
+    const components_used = system.components_used;
+    const components_used_count = components_used.length;
+
+    for (let i = 0; i < components_used_count; i++) {
+        const spec = components_used[i];
+
+        if (spec === undefined || spec === null || spec.isResourceAccessSpecification !== true) {
+            throw new Error(`Invalid access specification[${i}], expected an instance of ResourceAccessSpecification, but got something else`);
+        }
+
+        if (spec.resource === null) {
+            throw new Error(`No component specified for element [${i}]`);
+        }
+
+        if (spec.access === 0) {
+            throw new Error('No access modifiers specified, must have at least one (such as Read, Write, Create)');
+        }
+
+        // backtrace to make sure there are no duplicates
+        for (let j = 0; j < i - 1; j++) {
+            const spec_other = components_used[j];
+
+            if (spec_other.resource === spec.resource) {
+                throw new Error(`Duplicate specification of component [${j}] and [${i}]`);
+            }
+        }
+    }
+
+    //validate dependencies
+    const dependencies = system.dependencies;
+
+    const numDependencies = dependencies.length;
+
+    if (numDependencies < 1) {
+        throw  new Error(`A system must declare at least one dependency`);
+    }
+
+    if (numDependencies > 1) {
+        //check for duplicates
+        for (let i = 0; i < numDependencies; i++) {
+            const dependencyA = dependencies[i];
+            for (let j = i + 1; j < numDependencies; j++) {
+                if (dependencyA === dependencies[j]) {
+                    throw new Error(`Detected duplicate dependency: ${dependencyA.constructor.typeName}`);
+                }
+            }
+        }
+    }
+
+
+    const linkArgumentCount = numDependencies + 1;
+
+    if (system.link !== System.prototype.link && system.link.length !== linkArgumentCount && system.__validation_ignore_link_argument_count !== true) {
+        throw new Error(`'link' method declares ${system.link.length} instead of expected ${linkArgumentCount} based on it's ${numDependencies} dependencies`);
+    }
+
+    if (system.unlink !== System.prototype.unlink && system.unlink.length !== linkArgumentCount && system.__validation_ignore_link_argument_count !== true) {
+        throw new Error(`'unlink' method declares ${system.unlink.length} instead of expected ${linkArgumentCount} based on it's ${numDependencies} dependencies`);
+    }
+}