melonjs 14.0.2 → 14.1.1

package/dist/melonjs.mjs/math/observable_vector3.js

@@ -0,0 +1,559 @@
+/*!
+ * melonJS Game Engine - v14.1.1
+ * http://www.melonjs.org
+ * melonjs is licensed under the MIT License.
+ * http://www.opensource.org/licenses/mit-license
+ * @copyright (C) 2011 - 2022 Olivier Biot (AltByte Pte Ltd)
+ */
+import Vector3d from './vector3.js';
+import { clamp } from './math.js';
+import pool from '../system/pooling.js';
+
+/**
+ * @classdesc
+ * 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") {
+            throw new Error(
+                "undefined `onUpdate` callback"
+            );
+        }
+        this.setCallback(settings.onUpdate, settings.scope);
+    }
+
+    /**
+     * @ignore
+     */
+    onResetEvent(x = 0, y = 0, z = 0, settings) {
+        // init is call by the constructor and does not trigger the cb
+        this.setMuted(x, y, z);
+        if (typeof settings !== "undefined") {
+            this.setCallback(settings.onUpdate, settings.scope);
+        }
+        return this;
+    }
+
+    /**
+     * x value of the vector
+     * @public
+     * @type {number}
+     * @name x
+     * @memberof ObservableVector3d
+     */
+
+    get x() {
+        return this._x;
+    }
+
+    set x(value) {
+        var ret = this.onUpdate.call(this.scope, value, this._y, this._z, this._x, this._y, this._z);
+        if (ret && "x" in ret) {
+            this._x = ret.x;
+        } else {
+            this._x = value;
+        }
+    }
+
+    /**
+     * y value of the vector
+     * @public
+     * @type {number}
+     * @name y
+     * @memberof ObservableVector3d
+     */
+
+    get y() {
+        return this._y;
+    }
+
+    set y(value) {
+        var ret = this.onUpdate.call(this.scope, this._x, value, this._z, this._x, this._y, this._z);
+        if (ret && "y" in ret) {
+            this._y = ret.y;
+        } else {
+            this._y = value;
+        }
+    }
+
+
+    /**
+     * z value of the vector
+     * @public
+     * @type {number}
+     * @name z
+     * @memberof ObservableVector3d
+     */
+
+
+    get z() {
+        return this._z;
+    }
+
+    set z(value) {
+        var ret = this.onUpdate.call(this.scope, this._x, this._y, value, this._x, this._y, this._z);
+        if (ret && "z" in ret) {
+            this._z = ret.z;
+        } else {
+            this._z = value;
+        }
+    }
+
+    /**
+     * @ignore
+     */
+    _set(x, y, z) {
+        var ret = this.onUpdate.call(this.scope, x, y, z, this._x, this._y, this._z);
+        if (ret && "x" in ret && "y" in ret && "z" in ret) {
+            this._x = ret.x;
+            this._y = ret.y;
+            this._z = ret.z;
+        } else {
+          this._x = x;
+          this._y = y;
+          this._z = z || 0;
+        }
+        return this;
+    }
+
+    /**
+     * set the vector value without triggering the callback
+     * @name setMuted
+     * @memberof ObservableVector3d
+     * @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 {ObservableVector3d} Reference to this object for method chaining
+     */
+    setMuted(x, y, z) {
+        this._x = x;
+        this._y = y;
+        this._z = z || 0;
+        return this;
+    }
+
+    /**
+     * set the callback to be executed when the vector is changed
+     * @name setCallback
+     * @memberof ObservableVector3d
+     * @param {Function} fn - callback
+     * @param {Function} [scope=null] - scope
+     * @returns {ObservableVector3d} Reference to this object for method chaining
+     */
+    setCallback(fn, scope = null) {
+        if (typeof(fn) !== "function") {
+            throw new Error(
+                "invalid `onUpdate` callback"
+            );
+        }
+        this.onUpdate = fn;
+        this.scope = scope;
+        return this;
+    }
+
+    /**
+     * Add the passed vector to this vector
+     * @name add
+     * @memberof ObservableVector3d
+     * @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));
+    }
+
+    /**
+     * Substract the passed vector to this vector
+     * @name sub
+     * @memberof ObservableVector3d
+     * @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));
+    }
+
+    /**
+     * Multiply this vector values by the given scalar
+     * @name scale
+     * @memberof ObservableVector3d
+     * @param {number} x
+     * @param {number} [y=x]
+     * @param {number} [z=1]
+     * @returns {ObservableVector3d} Reference to this object for method chaining
+     */
+    scale(x, y, z) {
+        y = (typeof (y) !== "undefined" ? y : x);
+        return this._set(this._x * x, this._y * y, this._z * (z || 1));
+    }
+
+    /**
+     * Multiply this vector values by the passed vector
+     * @name scaleV
+     * @memberof ObservableVector3d
+     * @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));
+    }
+
+    /**
+     * Divide this vector values by the passed value
+     * @name div
+     * @memberof ObservableVector3d
+     * @param {number} n - the value to divide the vector by
+     * @returns {ObservableVector3d} Reference to this object for method chaining
+     */
+    div(n) {
+        return this._set(this._x / n, this._y / n, this._z / n);
+    }
+
+    /**
+     * Update this vector values to absolute values
+     * @name abs
+     * @memberof ObservableVector3d
+     * @returns {ObservableVector3d} Reference to this object for method chaining
+     */
+    abs() {
+        return this._set(
+            (this._x < 0) ? -this._x : this._x,
+            (this._y < 0) ? -this._y : this._y,
+            (this._Z < 0) ? -this._z : this._z
+        );
+    }
+
+    /**
+     * Clamp the vector value within the specified value range
+     * @name clamp
+     * @memberof ObservableVector3d
+     * @param {number} low
+     * @param {number} high
+     * @returns {ObservableVector3d} new me.ObservableVector3d
+     */
+    clamp(low, high) {
+        return new ObservableVector3d(
+            clamp(this._x, low, high),
+            clamp(this._y, low, high),
+            clamp(this._z, low, high),
+            {onUpdate: this.onUpdate, scope: this.scope}
+        );
+    }
+
+    /**
+     * Clamp this vector value within the specified value range
+     * @name clampSelf
+     * @memberof ObservableVector3d
+     * @param {number} low
+     * @param {number} high
+     * @returns {ObservableVector3d} Reference to this object for method chaining
+     */
+    clampSelf(low, high) {
+        return this._set(
+            clamp(this._x, low, high),
+            clamp(this._y, low, high),
+            clamp(this._z, low, high)
+        );
+    }
+
+    /**
+     * Update this vector with the minimum value between this and the passed vector
+     * @name minV
+     * @memberof ObservableVector3d
+     * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
+     * @returns {ObservableVector3d} Reference to this object for method chaining
+     */
+    minV(v) {
+        var _vz = v.z || 0;
+        return this._set(
+            (this._x < v.x) ? this._x : v.x,
+            (this._y < v.y) ? this._y : v.y,
+            (this._z < _vz) ? this._z : _vz
+        );
+    }
+
+    /**
+     * Update this vector with the maximum value between this and the passed vector
+     * @name maxV
+     * @memberof ObservableVector3d
+     * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
+     * @returns {ObservableVector3d} Reference to this object for method chaining
+     */
+    maxV(v) {
+        var _vz = v.z || 0;
+        return this._set(
+            (this._x > v.x) ? this._x : v.x,
+            (this._y > v.y) ? this._y : v.y,
+            (this._z > _vz) ? this._z : _vz
+        );
+    }
+
+    /**
+     * Floor the vector values
+     * @name floor
+     * @memberof ObservableVector3d
+     * @returns {ObservableVector3d} new me.ObservableVector3d
+     */
+    floor() {
+        return new ObservableVector3d(
+            Math.floor(this._x),
+            Math.floor(this._y),
+            Math.floor(this._z),
+            {onUpdate: this.onUpdate, scope: this.scope}
+        );
+    }
+
+    /**
+     * Floor this vector values
+     * @name floorSelf
+     * @memberof ObservableVector3d
+     * @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));
+    }
+
+    /**
+     * Ceil the vector values
+     * @name ceil
+     * @memberof ObservableVector3d
+     * @returns {ObservableVector3d} new me.ObservableVector3d
+     */
+    ceil() {
+        return new ObservableVector3d(
+            Math.ceil(this._x),
+            Math.ceil(this._y),
+            Math.ceil(this._z),
+            {onUpdate: this.onUpdate, scope: this.scope}
+        );
+    }
+
+    /**
+     * Ceil this vector values
+     * @name ceilSelf
+     * @memberof ObservableVector3d
+     * @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));
+    }
+
+    /**
+     * Negate the vector values
+     * @name negate
+     * @memberof ObservableVector3d
+     * @returns {ObservableVector3d} new me.ObservableVector3d
+     */
+    negate() {
+        return new ObservableVector3d(
+            -this._x,
+            -this._y,
+            -this._z,
+            {onUpdate: this.onUpdate, scope: this.scope}
+        );
+    }
+
+    /**
+     * Negate this vector values
+     * @name negateSelf
+     * @memberof ObservableVector3d
+     * @returns {ObservableVector3d} Reference to this object for method chaining
+     */
+    negateSelf() {
+        return this._set(-this._x, -this._y, -this._z);
+    }
+
+    /**
+     * Copy the components of the given vector into this one
+     * @name copy
+     * @memberof ObservableVector3d
+     * @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);
+    }
+
+    /**
+     * return true if the two vectors are the same
+     * @name equals
+     * @memberof ObservableVector3d
+     * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
+     * @returns {boolean}
+     */
+    equals(v) {
+        return ((this._x === v.x) && (this._y === v.y) && (this._z === (v.z || this._z)));
+    }
+
+    /**
+     * change this vector to be perpendicular to what it was before.<br>
+     * (Effectively rotates it 90 degrees in a clockwise direction)
+     * @name perp
+     * @memberof ObservableVector3d
+     * @returns {ObservableVector3d} Reference to this object for method chaining
+     */
+    perp() {
+        return this._set(this._y, -this._x, this._z);
+    }
+
+    /**
+     * Rotate this vector (counter-clockwise) by the specified angle (in radians).
+     * @name rotate
+     * @memberof ObservableVector3d
+     * @param {number} angle - The angle to rotate (in radians)
+     * @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;
+        var cy = 0;
+
+        if (typeof v === "object") {
+            cx = v.x;
+            cy = v.y;
+        }
+
+        // TODO also rotate on the z axis if the given vector is a 3d one
+        var x = this.x - cx;
+        var y = this.y - cy;
+
+        var c = Math.cos(angle);
+        var s = Math.sin(angle);
+
+        return this._set(x * c - y * s + cx, x * s + y * c + cy, this.z);
+    }
+
+    /**
+     * return the dot product of this vector and the passed one
+     * @name dot
+     * @memberof ObservableVector3d
+     * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
+     * @returns {number} The dot product.
+     */
+    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
+     * @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 ObservableVector3d
+     * @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 {ObservableVector3d} Reference to this object for method chaining
+     */
+    lerp(v, alpha) {
+        return this._set(
+            this._x + ( v.x - this._x ) * alpha,
+            this._y + ( v.y - this._y ) * alpha,
+            this._z + ( v.z - this._z ) * alpha
+        );
+    }
+
+    /**
+     * interpolate the position of this vector on the x and y axis towards the given one while ensure that the distance never exceeds the given step.
+     * @name moveTowards
+     * @memberof ObservableVector3d
+     * @param {Vector2d|ObservableVector2d|Vector3d|ObservableVector3d} target
+     * @param {number} step - the maximum step per iteration (Negative values will push the vector away from the target)
+     * @returns {ObservableVector3d} Reference to this object for method chaining
+     */
+    moveTowards(target, step) {
+        var angle = Math.atan2(target.y - this._y, target.x - this._x);
+
+        var dx = this._x - target.x;
+        var dy = this._y - target.y;
+
+        var distance = Math.sqrt(dx * dx + dy * dy);
+
+        if (distance === 0 || (step >= 0 && distance <= step * step)) {
+            return target;
+        }
+
+        return this._set(
+            this._x + Math.cos(angle) * step,
+            this._y + Math.sin(angle) * step,
+            this._z
+        );
+    }
+
+    /**
+     * return the distance between this vector and the passed one
+     * @name distance
+     * @memberof ObservableVector3d
+     * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
+     * @returns {number}
+     */
+    distance(v) {
+        var dx = this._x - v.x;
+        var dy = this._y - v.y;
+        var dz = this._z - (v.z || 0);
+        return Math.sqrt(dx * dx + dy * dy + dz * dz);
+    }
+
+    /**
+     * return a clone copy of this vector
+     * @name clone
+     * @memberof ObservableVector3d
+     * @returns {ObservableVector3d} new me.ObservableVector3d
+     */
+    clone() {
+        return pool.pull("ObservableVector3d",
+            this._x,
+            this._y,
+            this._z,
+            {onUpdate: this.onUpdate}
+        );
+    }
+
+    /**
+     * return a `me.Vector3d` copy of this `me.ObservableVector3d` object
+     * @name toVector3d
+     * @memberof ObservableVector3d
+     * @returns {Vector3d} new me.Vector3d
+     */
+    toVector3d() {
+        return pool.pull("Vector3d", this._x, this._y, this._z);
+    }
+
+    /**
+     * convert the object to a string representation
+     * @name toString
+     * @memberof ObservableVector3d
+     * @returns {string}
+     */
+    toString() {
+        return "x:" + this._x + ",y:" + this._y + ",z:" + this._z;
+    }
+}
+
+export { ObservableVector3d as default };