@woosh/meep-engine 2.92.22 → 2.92.23

package/build/meep.module.js

@@ -4709,28 +4709,25 @@ const FLAGS_DEFAULT = TransformFlags.AutomaticChangeDetection;
 class Transform {
 
     /**
-     * World-space position
      * @type {Vector3}
      * @readonly
      */
     position = new Vector3$1(0, 0, 0);
 
     /**
-     * World-space rotation
      * @type {Quaternion}
      * @readonly
      */
     rotation = new Quaternion$1(0, 0, 0, 1);
 
     /**
-     * World-space scale
      * @type {Vector3}
      * @readonly
      */
     scale = new Vector3$1(1, 1, 1);
 
     /**
-     * World-space transform matrix, position, rotation and scale must match, but shear can be different
+     * transform matrix, position, rotation and scale must match, but shear can be different
      * @readonly
      * @type {Float32Array}
      */
@@ -4738,22 +4735,18 @@ class Transform {
 
     /**
      * Various bit flags, see {@link TransformFlags}
-     * @protected
+     * This should generally be accessed through getFlag/setFlag instead of modifying the value directly
      * @type {number}
      */
     flags = FLAGS_DEFAULT;
 
-    /**
-     *
-     * @constructor
-     */
     constructor() {
         // watch changes
         this.subscribe(this.#handle_component_change, this);
     }
 
     /**
-     * Current "forward" direction in world-space
+     * Current "forward" direction
      * NOTE that this vector is not live, meaning that if you modify transform, previously-obtained result will no longer be valid
      * @returns {Vector3}
      */
@@ -4765,6 +4758,30 @@ class Transform {
         return result;
     }
 
+    /**
+     * Current "up" direction
+     * @return {Vector3}
+     */
+    get up() {
+        const result = Vector3$1.up.clone();
+
+        result.applyDirectionMatrix4(this.matrix);
+
+        return result;
+    }
+
+    /**
+     * Current "right" direction
+     * @return {Vector3}
+     */
+    get right() {
+        const result = Vector3$1.right.clone();
+
+        result.applyDirectionMatrix4(this.matrix);
+
+        return result;
+    }
+
     /**
      * Attach change listener
      * @param {function} handler
@@ -4980,6 +4997,7 @@ class Transform {
      * @param {mat4|number[]|Float32Array} m
      */
     fromMatrix4(m) {
+        // we know we are changing the matrix, so we're going to need to disable the flag that sets matrix from position/rotation/scale changes
         const ad = this.getFlag(TransformFlags.AutomaticChangeDetection);
 
         this.clearFlag(TransformFlags.AutomaticChangeDetection);
@@ -4988,6 +5006,7 @@ class Transform {
 
         decompose_matrix_4_array(m, this.position, this.rotation, this.scale);
 
+        // restore value of the flag
         this.writeFlag(TransformFlags.AutomaticChangeDetection, ad);
     }
 

package/package.json

@@ -5,7 +5,7 @@
   "description": "Fully featured ECS game engine written in JavaScript",
   "type": "module",
   "author": "Alexander Goldring",
-  "version": "2.92.22",
+  "version": "2.92.23",
   "main": "build/meep.module.js",
   "module": "build/meep.module.js",
   "exports": {

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

@@ -6,7 +6,9 @@ export class Transform {
     readonly rotation: Quaternion
     readonly scale: Vector3
 
-    readonly forward: Vector3
+    readonly forward: Readonly<Vector3>
+    readonly up: Readonly<Vector3>
+    readonly right: Readonly<Vector3>
 
     flags: number
 
@@ -15,8 +17,8 @@ export class Transform {
     public lookAt(target: Vector3, up?: Vector3): void
 
     static fromJSON(json: {
-        position?: { x: number, y: number, z: number },
-        scale?: { x: number, y: number, z: number },
+        position?: number | { x: number, y: number, z: number },
+        scale?: number | { x: number, y: number, z: number },
         rotation?: { x: number, y: number, z: number, w: number },
     }): Transform
 

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

@@ -1 +1 @@
-{"version":3,"file":"Transform.d.ts","sourceRoot":"","sources":["../../../../../src/engine/ecs/transform/Transform.js"],"names":[],"mappings":"AA0BA;;;GAGG;AACH;IAuPI;;;;OAIG;IACH,4BAFa,SAAS,CAQrB;IAhQD;;;;OAIG;IACH,mBAHU,OAAO,CAGe;IAEhC;;;;OAIG;IACH,mBAHU,UAAU,CAGkB;IAEtC;;;;OAIG;IACH,gBAHU,OAAO,CAGY;IAE7B;;;;OAIG;IACH,iBAFU,YAAY,CAEW;IAEjC;;;;OAIG;IACH,iBAFU,MAAM,CAEM;IAWtB;;;;OAIG;IACH,uBAMC;IAED;;;;OAIG;IACH,kDAIC;IAED;;;;OAIG;IACH,oDAIC;IAYD;;;;OAIG;IACH,cAHW,MAAM,GAAC,cAAc,GACnB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,cAAc,GACnB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,cAAc,SACrB,OAAO,QAQjB;IAED;;;;OAIG;IACH,cAHW,MAAM,GAAC,cAAc,GACnB,OAAO,CAInB;IAED;;OAEG;IACH,qBAEC;IAED;;;;OAIG;IACH,eAHW,OAAO,OACP,OAAO,QAmBjB;IAED,0BAwBC;IAED;;;;MAMC;IAED;;;OAGG;IACH,YAFW,SAAS,QAenB;IAED;;;OAGG;IACH,SAFa,SAAS,CAQrB;IAED;;;;OAIG;IACH,cAHW,SAAS,GACP,OAAO,CAMnB;IAED;;;OAGG;IACH,QAFa,MAAM,CAKlB;IAeD;;;;OAIG;IACH,sBAHW,SAAS,KACT,SAAS,QAMnB;IAED;;;OAGG;IACH,eAFW,OAAK,MAAM,EAAE,GAAC,YAAY,QAYpC;IAED;;;OAGG;IACH,kBAFW,MAAM,EAAE,GAAC,YAAY,QAI/B;IAED;;;;;OAKG;IACH,qBAEC;IAED,mBAEC;IASL;;;OAGG;IACH,sBAFU,OAAO,CAEc;;CAZ9B;;kBAIS,MAAM;IAWhB;;;;;OAKG;IACH,mGAMC;;oBAlWmB,+BAA+B;uBAD5B,kCAAkC;+BAE1B,qBAAqB"}
+{"version":3,"file":"Transform.d.ts","sourceRoot":"","sources":["../../../../../src/engine/ecs/transform/Transform.js"],"names":[],"mappings":"AA0BA;;;GAGG;AACH;IAwQI;;;;OAIG;IACH,4BAFa,SAAS,CAQrB;IAjRD;;;OAGG;IACH,mBAHU,OAAO,CAGe;IAEhC;;;OAGG;IACH,mBAHU,UAAU,CAGkB;IAEtC;;;OAGG;IACH,gBAHU,OAAO,CAGY;IAE7B;;;;OAIG;IACH,iBAFU,YAAY,CAEW;IAEjC;;;;OAIG;IACH,OAFU,MAAM,CAEM;IAOtB;;;;OAIG;IACH,uBAMC;IAED;;;OAGG;IACH,kBAMC;IAED;;;OAGG;IACH,qBAMC;IAED;;;;OAIG;IACH,kDAIC;IAED;;;;OAIG;IACH,oDAIC;IAYD;;;;OAIG;IACH,cAHW,MAAM,GAAC,cAAc,GACnB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,cAAc,GACnB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,cAAc,SACrB,OAAO,QAQjB;IAED;;;;OAIG;IACH,cAHW,MAAM,GAAC,cAAc,GACnB,OAAO,CAInB;IAED;;OAEG;IACH,qBAEC;IAED;;;;OAIG;IACH,eAHW,OAAO,OACP,OAAO,QAmBjB;IAED,0BAwBC;IAED;;;;MAMC;IAED;;;OAGG;IACH,YAFW,SAAS,QAenB;IAED;;;OAGG;IACH,SAFa,SAAS,CAQrB;IAED;;;;OAIG;IACH,cAHW,SAAS,GACP,OAAO,CAMnB;IAED;;;OAGG;IACH,QAFa,MAAM,CAKlB;IAeD;;;;OAIG;IACH,sBAHW,SAAS,KACT,SAAS,QAMnB;IAED;;;OAGG;IACH,eAFW,OAAK,MAAM,EAAE,GAAC,YAAY,QAcpC;IAED;;;OAGG;IACH,kBAFW,MAAM,EAAE,GAAC,YAAY,QAI/B;IAED;;;;;OAKG;IACH,qBAEC;IAED,mBAEC;IASL;;;OAGG;IACH,sBAFU,OAAO,CAEc;;CAZ9B;;kBAIS,MAAM;IAWhB;;;;;OAKG;IACH,mGAMC;;oBArXmB,+BAA+B;uBAD5B,kCAAkC;+BAE1B,qBAAqB"}

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

@@ -31,28 +31,25 @@ const FLAGS_DEFAULT = TransformFlags.AutomaticChangeDetection;
 export class Transform {
 
     /**
-     * World-space position
      * @type {Vector3}
      * @readonly
      */
     position = new Vector3(0, 0, 0);
 
     /**
-     * World-space rotation
      * @type {Quaternion}
      * @readonly
      */
     rotation = new Quaternion(0, 0, 0, 1);
 
     /**
-     * World-space scale
      * @type {Vector3}
      * @readonly
      */
     scale = new Vector3(1, 1, 1);
 
     /**
-     * World-space transform matrix, position, rotation and scale must match, but shear can be different
+     * transform matrix, position, rotation and scale must match, but shear can be different
      * @readonly
      * @type {Float32Array}
      */
@@ -60,22 +57,18 @@ export class Transform {
 
     /**
      * Various bit flags, see {@link TransformFlags}
-     * @protected
+     * This should generally be accessed through getFlag/setFlag instead of modifying the value directly
      * @type {number}
      */
     flags = FLAGS_DEFAULT;
 
-    /**
-     *
-     * @constructor
-     */
     constructor() {
         // watch changes
         this.subscribe(this.#handle_component_change, this);
     }
 
     /**
-     * Current "forward" direction in world-space
+     * Current "forward" direction
      * NOTE that this vector is not live, meaning that if you modify transform, previously-obtained result will no longer be valid
      * @returns {Vector3}
      */
@@ -87,6 +80,30 @@ export class Transform {
         return result;
     }
 
+    /**
+     * Current "up" direction
+     * @return {Vector3}
+     */
+    get up() {
+        const result = Vector3.up.clone();
+
+        result.applyDirectionMatrix4(this.matrix);
+
+        return result;
+    }
+
+    /**
+     * Current "right" direction
+     * @return {Vector3}
+     */
+    get right() {
+        const result = Vector3.right.clone();
+
+        result.applyDirectionMatrix4(this.matrix);
+
+        return result;
+    }
+
     /**
      * Attach change listener
      * @param {function} handler
@@ -304,6 +321,7 @@ export class Transform {
      * @param {mat4|number[]|Float32Array} m
      */
     fromMatrix4(m) {
+        // we know we are changing the matrix, so we're going to need to disable the flag that sets matrix from position/rotation/scale changes
         const ad = this.getFlag(TransformFlags.AutomaticChangeDetection);
 
         this.clearFlag(TransformFlags.AutomaticChangeDetection);
@@ -312,6 +330,7 @@ export class Transform {
 
         decompose_matrix_4_array(m, this.position, this.rotation, this.scale);
 
+        // restore value of the flag
         this.writeFlag(TransformFlags.AutomaticChangeDetection, ad);
     }