melonjs 10.2.2 → 10.4.0

package/src/math/observable_vector3.js

@@ -3,21 +3,19 @@ import {clamp} from "./math.js";
 import pool from "./../system/pooling.js";
 
 /**
- * A Vector3d object that provide notification by executing the given callback when the vector is changed.
  * @classdesc
- * @class ObservableVector3d
- * @extends me.Vector3d
- * @memberOf me
- * @constructor
- * @param {number} [x=0] x value of the vector
- * @param {number} [y=0] y value of the vector
- * @param {number} [z=0] z value of the vector
- * @param {object} settings additional required parameters
- * @param {Function} settings.onUpdate the callback to be executed when the vector is changed
- * @param {object} [settings.scope] the value to use as this when calling onUpdate
+ * A Vector3d object that provide notification by executing the given callback when the vector is changed.
+ * @augments Vector3d
  */
 class ObservableVector3d extends Vector3d {
-
+    /**
+     * @param {number} x x value of the vector
+     * @param {number} y y value of the vector
+     * @param {number} z z value of the vector
+     * @param {object} settings additional required parameters
+     * @param {Function} settings.onUpdate the callback to be executed when the vector is changed
+     * @param {object} [settings.scope] the value to use as this when calling onUpdate
+     */
     constructor(x = 0, y = 0, z = 0, settings) {
         super(x, y, z);
         if (typeof(settings) === "undefined") {
@@ -45,7 +43,7 @@ class ObservableVector3d extends Vector3d {
      * @public
      * @type {number}
      * @name x
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      */
 
     get x() {
@@ -66,7 +64,7 @@ class ObservableVector3d extends Vector3d {
      * @public
      * @type {number}
      * @name y
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      */
 
     get y() {
@@ -88,7 +86,7 @@ class ObservableVector3d extends Vector3d {
      * @public
      * @type {number}
      * @name z
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      */
 
 
@@ -125,12 +123,12 @@ class ObservableVector3d extends Vector3d {
     /**
      * set the vector value without triggering the callback
      * @name setMuted
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
      * @param {number} x x value of the vector
      * @param {number} y y value of the vector
      * @param {number} [z=0] z value of the vector
-     * @returns {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     setMuted(x, y, z) {
         this._x = x;
@@ -142,11 +140,11 @@ class ObservableVector3d extends Vector3d {
     /**
      * set the callback to be executed when the vector is changed
      * @name setCallback
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
      * @param {Function} fn callback
      * @param {Function} [scope=null] scope
-     * @returns {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     setCallback(fn, scope = null) {
         if (typeof(fn) !== "function") {
@@ -162,10 +160,10 @@ class ObservableVector3d extends Vector3d {
     /**
      * Add the passed vector to this vector
      * @name add
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
-     * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
-     * @returns {me.ObservableVector3d} Reference to this object for method chaining
+     * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
+     * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     add(v) {
         return this._set(this._x + v.x, this._y + v.y, this._z + (v.z || 0));
@@ -174,10 +172,10 @@ class ObservableVector3d extends Vector3d {
     /**
      * Substract the passed vector to this vector
      * @name sub
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
-     * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
-     * @returns {me.ObservableVector3d} Reference to this object for method chaining
+     * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
+     * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     sub(v) {
         return this._set(this._x - v.x, this._y - v.y, this._z - (v.z || 0));
@@ -186,12 +184,12 @@ class ObservableVector3d extends Vector3d {
     /**
      * Multiply this vector values by the given scalar
      * @name scale
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
      * @param {number} x
      * @param {number} [y=x]
      * @param {number} [z=1]
-     * @returns {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     scale(x, y, z) {
         y = (typeof (y) !== "undefined" ? y : x);
@@ -201,10 +199,10 @@ class ObservableVector3d extends Vector3d {
     /**
      * Multiply this vector values by the passed vector
      * @name scaleV
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
-     * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
-     * @returns {me.ObservableVector3d} Reference to this object for method chaining
+     * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
+     * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     scaleV(v) {
         return this._set(this._x * v.x, this._y * v.y, this._z * (v.z || 1));
@@ -213,10 +211,10 @@ class ObservableVector3d extends Vector3d {
     /**
      * Divide this vector values by the passed value
      * @name div
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
      * @param {number} n the value to divide the vector by
-     * @returns {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     div(n) {
         return this._set(this._x / n, this._y / n, this._z / n);
@@ -225,9 +223,9 @@ class ObservableVector3d extends Vector3d {
     /**
      * Update this vector values to absolute values
      * @name abs
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
-     * @returns {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     abs() {
         return this._set(
@@ -240,11 +238,11 @@ class ObservableVector3d extends Vector3d {
     /**
      * Clamp the vector value within the specified value range
      * @name clamp
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
      * @param {number} low
      * @param {number} high
-     * @returns {me.ObservableVector3d} new me.ObservableVector3d
+     * @returns {ObservableVector3d} new me.ObservableVector3d
      */
     clamp(low, high) {
         return new ObservableVector3d(
@@ -258,11 +256,11 @@ class ObservableVector3d extends Vector3d {
     /**
      * Clamp this vector value within the specified value range
      * @name clampSelf
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
      * @param {number} low
      * @param {number} high
-     * @returns {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     clampSelf(low, high) {
         return this._set(
@@ -275,10 +273,10 @@ class ObservableVector3d extends Vector3d {
     /**
      * Update this vector with the minimum value between this and the passed vector
      * @name minV
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
-     * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
-     * @returns {me.ObservableVector3d} Reference to this object for method chaining
+     * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
+     * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     minV(v) {
         var _vz = v.z || 0;
@@ -292,10 +290,10 @@ class ObservableVector3d extends Vector3d {
     /**
      * Update this vector with the maximum value between this and the passed vector
      * @name maxV
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
-     * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
-     * @returns {me.ObservableVector3d} Reference to this object for method chaining
+     * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
+     * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     maxV(v) {
         var _vz = v.z || 0;
@@ -309,9 +307,9 @@ class ObservableVector3d extends Vector3d {
     /**
      * Floor the vector values
      * @name floor
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
-     * @returns {me.ObservableVector3d} new me.ObservableVector3d
+     * @returns {ObservableVector3d} new me.ObservableVector3d
      */
     floor() {
         return new ObservableVector3d(
@@ -325,9 +323,9 @@ class ObservableVector3d extends Vector3d {
     /**
      * Floor this vector values
      * @name floorSelf
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
-     * @returns {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     floorSelf() {
         return this._set(Math.floor(this._x), Math.floor(this._y), Math.floor(this._z));
@@ -336,9 +334,9 @@ class ObservableVector3d extends Vector3d {
     /**
      * Ceil the vector values
      * @name ceil
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
-     * @returns {me.ObservableVector3d} new me.ObservableVector3d
+     * @returns {ObservableVector3d} new me.ObservableVector3d
      */
     ceil() {
         return new ObservableVector3d(
@@ -352,9 +350,9 @@ class ObservableVector3d extends Vector3d {
     /**
      * Ceil this vector values
      * @name ceilSelf
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
-     * @returns {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     ceilSelf() {
         return this._set(Math.ceil(this._x), Math.ceil(this._y), Math.ceil(this._z));
@@ -363,9 +361,9 @@ class ObservableVector3d extends Vector3d {
     /**
      * Negate the vector values
      * @name negate
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
-     * @returns {me.ObservableVector3d} new me.ObservableVector3d
+     * @returns {ObservableVector3d} new me.ObservableVector3d
      */
     negate() {
         return new ObservableVector3d(
@@ -379,9 +377,9 @@ class ObservableVector3d extends Vector3d {
     /**
      * Negate this vector values
      * @name negateSelf
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
-     * @returns {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     negateSelf() {
         return this._set(-this._x, -this._y, -this._z);
@@ -390,10 +388,10 @@ class ObservableVector3d extends Vector3d {
     /**
      * Copy the components of the given vector into this one
      * @name copy
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
-     * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
-     * @returns {me.ObservableVector3d} Reference to this object for method chaining
+     * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
+     * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     copy(v) {
         return this._set(v.x, v.y, v.z || 0);
@@ -402,9 +400,9 @@ class ObservableVector3d extends Vector3d {
     /**
      * return true if the two vectors are the same
      * @name equals
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
-     * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
+     * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
      * @returns {boolean}
      */
     equals(v) {
@@ -415,9 +413,9 @@ class ObservableVector3d extends Vector3d {
      * change this vector to be perpendicular to what it was before.<br>
      * (Effectively rotates it 90 degrees in a clockwise direction)
      * @name perp
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
-     * @returns {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     perp() {
         return this._set(this._y, -this._x, this._z);
@@ -426,11 +424,11 @@ class ObservableVector3d extends Vector3d {
     /**
      * Rotate this vector (counter-clockwise) by the specified angle (in radians).
      * @name rotate
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
      * @param {number} angle The angle to rotate (in radians)
-     * @param {me.Vector2d|me.ObservableVector2d} [v] an optional point to rotate around (on the same z axis)
-     * @returns {me.ObservableVector3d} Reference to this object for method chaining
+     * @param {Vector2d|ObservableVector2d} [v] an optional point to rotate around (on the same z axis)
+     * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     rotate(angle, v) {
         var cx = 0;
@@ -453,24 +451,43 @@ class ObservableVector3d extends Vector3d {
 
     /**
      * return the dot product of this vector and the passed one
-     * @name dotProduct
-     * @memberOf me.ObservableVector3d
+     * @name dot
+     * @memberof ObservableVector3d
      * @function
-     * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
+     * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
      * @returns {number} The dot product.
      */
-    dotProduct(v) {
+    dot(v) {
         return this._x * v.x + this._y * v.y + this._z * (v.z || 1);
     }
 
+    /**
+     * calculate the cross product of this vector and the passed one
+     * @name cross
+     * @memberof ObservableVector3d
+     * @function
+     * @param {Vector3d|ObservableVector3d} v
+     * @returns {ObservableVector3d} Reference to this object for method chaining
+     */
+    cross(v) {
+        var ax = this._x, ay = this._y, az = this._z;
+        var bx = v.x, by = v.y, bz = v.z;
+
+        return this._set(
+            ay * bz - az * by,
+            az * bx - ax * bz,
+            ax * by - ay * bx
+        );
+    }
+
     /**
      * Linearly interpolate between this vector and the given one.
      * @name lerp
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
-     * @param {me.Vector3d|me.ObservableVector3d} v
+     * @param {Vector3d|ObservableVector3d} v
      * @param {number} alpha distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
-     * @returns {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     lerp(v, alpha) {
         this._x += ( v.x - this._x ) * alpha;
@@ -482,9 +499,9 @@ class ObservableVector3d extends Vector3d {
     /**
      * return the distance between this vector and the passed one
      * @name distance
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
-     * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
+     * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
      * @returns {number}
      */
     distance(v) {
@@ -497,9 +514,9 @@ class ObservableVector3d extends Vector3d {
     /**
      * return a clone copy of this vector
      * @name clone
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
-     * @returns {me.ObservableVector3d} new me.ObservableVector3d
+     * @returns {ObservableVector3d} new me.ObservableVector3d
      */
     clone() {
         return pool.pull("ObservableVector3d",
@@ -513,9 +530,9 @@ class ObservableVector3d extends Vector3d {
     /**
      * return a `me.Vector3d` copy of this `me.ObservableVector3d` object
      * @name toVector3d
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
-     * @returns {me.Vector3d} new me.Vector3d
+     * @returns {Vector3d} new me.Vector3d
      */
     toVector3d() {
         return pool.pull("Vector3d", this._x, this._y, this._z);
@@ -524,7 +541,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * convert the object to a string representation
      * @name toString
-     * @memberOf me.ObservableVector3d
+     * @memberof ObservableVector3d
      * @function
      * @returns {string}
      */