melonjs 17.3.0 → 18.0.0

package/src/math/vector3.js

@@ -1,460 +0,0 @@
-import {clamp} from "./math.js";
-import pool from "./../system/pooling.js";
-
-/**
- * @classdesc
- * a generic 3D Vector Object
- */
-export default class Vector3d {
-    /**
-     * @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
-     */
-    constructor(x = 0, y = 0, z = 0) {
-        this.onResetEvent(x, y, z);
-    }
-
-    /**
-     * @param {number} [x=0]
-     * @param {number} [y=0]
-     * @param {number} [z=0]
-     * @ignore
-     */
-    onResetEvent(x = 0, y = 0, z = 0) {
-        /**
-         * x value of the vector
-         * @type {number}
-         */
-        this.x = x;
-
-        /**
-         * y value of the vector
-         * @type {number}
-         */
-        this.y = y;
-
-        /**
-         * z value of the vector
-         * @type {number}
-         */
-        this.z = z;
-    }
-
-    /**
-     * @param {number} x
-     * @param {number} y
-     * @param {number} [z=0]
-     * @ignore
-     */
-    _set(x, y, z = 0) {
-        this.x = x;
-        this.y = y;
-        this.z = z;
-        return this;
-    }
-
-    /**
-     * set the Vector x and y properties to the given values
-     * @param {number} x
-     * @param {number} y
-     * @param {number} [z=0]
-     * @returns {Vector3d} Reference to this object for method chaining
-     */
-    set(x, y, z) {
-        if (x !== +x || y !== +y || (typeof z !== "undefined" && z !== +z)) {
-            throw new Error(
-                "invalid x, y, z parameters (not a number)"
-            );
-        }
-        return this._set(x, y, z);
-    }
-
-    /**
-     * set the Vector x and y properties to 0
-     * @returns {Vector3d} Reference to this object for method chaining
-     */
-    setZero() {
-        return this.set(0, 0, 0);
-    }
-
-    /**
-     * set the Vector x and y properties using the passed vector
-     * @param {Vector2d|Vector3d} v
-     * @returns {Vector3d} Reference to this object for method chaining
-     */
-    setV(v) {
-        return this._set(v.x, v.y, v.z);
-    }
-
-    /**
-     * Add the passed vector to this vector
-     * @param {Vector2d|Vector3d} v
-     * @returns {Vector3d} 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
-     * @param {Vector2d|Vector3d} v
-     * @returns {Vector3d} 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
-     * @param {number} x
-     * @param {number} [y=x]
-     * @param {number} [z=1]
-     * @returns {Vector3d} Reference to this object for method chaining
-     */
-    scale(x, y = x, z = 1) {
-        return this._set(this.x * x, this.y * y, this.z * z);
-    }
-
-    /**
-     * Multiply this vector values by the passed vector
-     * @param {Vector2d|Vector3d} v
-     * @returns {Vector3d} Reference to this object for method chaining
-     */
-    scaleV(v) {
-        return this.scale(v.x, v.y, v.z);
-    }
-
-    /**
-     * Convert this vector into isometric coordinate space
-     * @returns {Vector3d} Reference to this object for method chaining
-     */
-    toIso() {
-        return this._set(this.x - this.y, (this.x + this.y) * 0.5, this.z);
-    }
-
-    /**
-     * Convert this vector into 2d coordinate space
-     * @returns {Vector3d} Reference to this object for method chaining
-     */
-    to2d() {
-        return this._set(this.y + this.x / 2, this.y - this.x / 2, this.z);
-    }
-
-    /**
-     * Divide this vector values by the passed value
-     * @param {number} n - the value to divide the vector by
-     * @returns {Vector3d} 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
-     * @returns {Vector3d} 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
-     * @param {number} low
-     * @param {number} high
-     * @returns {Vector3d} new me.Vector3d
-     */
-    clamp(low, high) {
-        return new Vector3d(clamp(this.x, low, high), clamp(this.y, low, high), clamp(this.z, low, high));
-    }
-
-    /**
-     * Clamp this vector value within the specified value range
-     * @param {number} low
-     * @param {number} high
-     * @returns {Vector3d} 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
-     * @param {Vector2d|Vector3d} v
-     * @returns {Vector3d} Reference to this object for method chaining
-     */
-    minV(v) {
-        let _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
-     * @param {Vector2d|Vector3d} v
-     * @returns {Vector3d} Reference to this object for method chaining
-     */
-    maxV(v) {
-        let _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
-     * @returns {Vector3d} new me.Vector3d
-     */
-    floor() {
-        return new Vector3d(Math.floor(this.x), Math.floor(this.y), Math.floor(this.z));
-    }
-
-    /**
-     * Floor this vector values
-     * @returns {Vector3d} 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
-     * @returns {Vector3d} new me.Vector3d
-     */
-    ceil() {
-        return new Vector3d(Math.ceil(this.x), Math.ceil(this.y), Math.ceil(this.z));
-    }
-
-    /**
-     * Ceil this vector values
-     * @returns {Vector3d} 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
-     * @returns {Vector3d} new me.Vector3d
-     */
-    negate() {
-        return new Vector3d(-this.x, -this.y, -this.z);
-    }
-
-    /**
-     * Negate this vector values
-     * @returns {Vector3d} 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
-     * @param {Vector2d|Vector3d} v
-     * @returns {Vector3d} Reference to this object for method chaining
-     */
-    copy(v) {
-        return this._set(v.x, v.y, v.z || 0);
-    }
-
-    /**
-     * return true if this vector is equal to the given values or vector
-     * @param {number|Vector2d|ObservableVector2d|Vector3d|ObservableVector3d} x
-     * @param {number} [y]
-     * @param {number} [z]
-     * @returns {boolean}
-     */
-    equals(...args) {
-        let _x, _y, _z;
-        if (args.length >= 2) {
-            // x, y, z
-            [_x, _y, _z] = args;
-        } else {
-            // vector
-            [_x, _y, _z] = [args[0].x, args[0].y, args[0].z];
-        }
-
-        if (typeof _z === "undefined") {
-            _z = this.z;
-        }
-
-        return ((this.x === _x) && (this.y === _y) && (this.z === _z));
-    }
-
-    /**
-     * normalize this vector (scale the vector so that its magnitude is 1)
-     * @returns {Vector3d} Reference to this object for method chaining
-     */
-    normalize() {
-        return this.div(this.length() || 1);
-    }
-
-    /**
-     * change this vector to be perpendicular to what it was before.<br>
-     * (Effectively rotates it 90 degrees in a clockwise direction around the z axis)
-     * @returns {Vector3d} 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) around the z axis
-     * @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 {Vector3d} Reference to this object for method chaining
-     */
-    rotate(angle, v) {
-        let cx = 0;
-        let 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
-        let x = this.x - cx;
-        let y = this.y - cy;
-
-        let c = Math.cos(angle);
-        let 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
-     * @param {Vector2d|Vector3d} v
-     * @returns {number} The dot product.
-     */
-    dot(v) {
-        return this.x * v.x + this.y * v.y + this.z * (typeof(v.z) !== "undefined" ? v.z : this.z);
-    }
-
-    /**
-     * calculate the cross product of this vector and the passed one
-     * @param {Vector3d} v
-     * @returns {Vector3d} Reference to this object for method chaining
-     */
-    cross(v) {
-        let ax = this.x, ay = this.y, az = this.z;
-        let bx = v.x, by = v.y, bz = v.z;
-
-        this.x = ay * bz - az * by;
-        this.y = az * bx - ax * bz;
-        this.z = ax * by - ay * bx;
-
-        return this;
-    }
-
-    /**
-    * return the square length of this vector
-    * @returns {number} The length^2 of this vector.
-    */
-    length2() {
-        return this.dot(this);
-    }
-
-    /**
-     * return the length (magnitude) of this vector
-     * @returns {number} the length of this vector
-     */
-    length() {
-        return Math.sqrt(this.length2());
-    }
-
-    /**
-     * Linearly interpolate between this vector and the given one.
-     * @param {Vector3d} v
-     * @param {number} alpha - distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
-     * @returns {Vector3d} Reference to this object for method chaining
-     */
-    lerp(v, alpha) {
-        this.x += (v.x - this.x) * alpha;
-        this.y += (v.y - this.y) * alpha;
-        this.z += (v.z - this.z) * alpha;
-        return this;
-    }
-
-    /**
-     * interpolate the position of this vector on the x and y axis towards the given one by the given maximum step.
-     * @param {Vector2d|Vector3d} target
-     * @param {number} step - the maximum step per iteration (Negative values will push the vector away from the target)
-     * @returns {Vector3d} Reference to this object for method chaining
-     */
-    moveTowards(target, step) {
-        let angle = Math.atan2(target.y - this.y, target.x - this.x);
-
-        let dx = this.x - target.x;
-        let dy = this.y - target.y;
-
-        let distance = Math.sqrt(dx * dx + dy * dy);
-
-        if (distance === 0 || (step >= 0 && distance <= step * step)) {
-            return target;
-        }
-
-        this.x += Math.cos(angle) * step;
-        this.y += Math.sin(angle) * step;
-
-        return this;
-    }
-
-    /**
-     * return the distance between this vector and the passed one
-     * @param {Vector2d|Vector3d} v
-     * @returns {number}
-     */
-    distance(v) {
-        let dx = this.x - v.x;
-        let dy = this.y - v.y;
-        let dz = this.z - (v.z || 0);
-        return Math.sqrt(dx * dx + dy * dy + dz * dz);
-    }
-
-    /**
-     * return the angle between this vector and the passed one
-     * @param {Vector2d|Vector3d} v
-     * @returns {number} angle in radians
-     */
-    angle(v) {
-        return Math.acos(clamp(this.dot(v) / (this.length() * v.length()), -1, 1));
-    }
-
-    /**
-     * project this vector on to another vector.
-     * @param {Vector2d|Vector3d} v - The vector to project onto.
-     * @returns {Vector3d} Reference to this object for method chaining
-     */
-    project(v) {
-        let ratio = this.dot(v) / v.length2();
-        return this.scale(ratio, ratio, ratio);
-    }
-
-    /**
-     * Project this vector onto a vector of unit length.<br>
-     * This is slightly more efficient than `project` when dealing with unit vectors.
-     * @param {Vector2d|Vector3d} v - The unit vector to project onto.
-     * @returns {Vector3d} Reference to this object for method chaining
-     */
-    projectN(v) {
-        let ratio = this.dot(v) / v.length2();
-        return this.scale(ratio, ratio, ratio);
-    }
-
-    /**
-     * return a clone copy of this vector
-     * @returns {Vector3d} new me.Vector3d
-     */
-    clone() {
-        return pool.pull("Vector3d", this.x, this.y, this.z);
-    }
-
-    /**
-     * convert the object to a string representation
-     * @returns {string}
-     */
-    toString() {
-        return "x:" + this.x + ",y:" + this.y + ",z:" + this.z;
-    }
-}
-

package/src/particles/emitter.js

@@ -1,258 +0,0 @@
-import pool from "./../system/pooling.js";
-import ParticleEmitterSettings from "./settings.js";
-import { randomFloat } from "./../math/math.js";
-import Container from "./../renderable/container.js";
-
-
-/**
- * @ignore
- */
-function createDefaultParticleTexture(w = 8, h = 8) {
-    let defaultParticleTexture = pool.pull("CanvasRenderTarget", w, h, { offscreenCanvas: true });
-
-    defaultParticleTexture.context.fillStyle = "#fff";
-    defaultParticleTexture.context.fillRect(0, 0, w, h);
-
-    return defaultParticleTexture;
-}
-
-/**
- * @classdesc
- * Particle Emitter Object.
- * @augments Container
- */
-export default class ParticleEmitter extends Container {
-    /**
-     * @param {number} x - x position of the particle emitter
-     * @param {number} y - y position of the particle emitter
-     * @param {ParticleEmitterSettings} [settings=ParticleEmitterSettings] - the settings for the particle emitter.
-     * @example
-     * // Create a particle emitter at position 100, 100
-     * let emitter = new ParticleEmitter(100, 100, {
-     *     width: 16,
-     *     height : 16,
-     *     tint: "#f00",
-     *     totalParticles: 32,
-     *     angle: 0,
-     *     angleVariation: 6.283185307179586,
-     *     maxLife: 5,
-     *     speed: 3
-     * });
-     *
-     * // Add the emitter to the game world
-     * me.game.world.addChild(emitter);
-     *
-     * // Launch all particles one time and stop, like a explosion
-     * emitter.burstParticles();
-     *
-     * // Launch constantly the particles, like a fountain
-     * emitter.streamParticles();
-     *
-     * // At the end, remove emitter from the game world
-     * // call this in onDestroyEvent function
-     * me.game.world.removeChild(emitter);
-     */
-    constructor(x, y, settings = {}) {
-        // call the super constructor
-        super(
-            x, y,
-            settings.width | 1,
-            settings.height | 1
-        );
-
-        /**
-         * the current (active) emitter settings
-         * @public
-         * @type {ParticleEmitterSettings}
-         * @name settings
-         * @memberof ParticleEmitter
-         */
-        this.settings = {};
-
-        // center the emitter around the given coordinates
-        this.centerOn(x, y);
-
-        // Emitter is Stream, launch particles constantly
-        /** @ignore */
-        this._stream = false;
-
-        // Frequency timer (in ms) for emitter launch new particles
-        // used only in stream emitter
-        /** @ignore */
-        this._frequencyTimer = 0;
-
-        // Time of live (in ms) for emitter launch new particles
-        // used only in stream emitter
-        /** @ignore */
-        this._durationTimer = 0;
-
-        // Emitter is emitting particles
-        /** @ignore */
-        this._enabled = false;
-
-        // Emitter will always update
-        this.alwaysUpdate = true;
-
-        // don't sort the particles by z-index
-        this.autoSort = false;
-
-        // count the updates
-        this._updateCount = 0;
-
-        // internally store how much time was skipped when frames are skipped
-        this._dt = 0;
-
-        //this.anchorPoint.set(0, 0);
-
-        // Reset the emitter to defaults
-        this.reset(settings);
-    }
-
-    /**
-     * Reset the emitter with particle emitter settings.
-     * @param {ParticleEmitterSettings} settings - [optional] object with emitter settings. See {@link ParticleEmitterSettings}
-     */
-    reset(settings = {}) {
-        Object.assign(this.settings, ParticleEmitterSettings, settings);
-
-        if (typeof this.settings.image === "undefined") {
-            this._defaultParticle = createDefaultParticleTexture(settings.textureSize, settings.textureSize);
-            this.settings.image = this._defaultParticle.canvas;
-        }
-
-        this.floating = this.settings.floating;
-
-        this.isDirty = true;
-    }
-
-    /**
-     * returns a random point on the x axis within the bounds of this emitter
-     * @returns {number}
-     */
-    getRandomPointX() {
-        return randomFloat(0, this.getBounds().width);
-    }
-
-    /**
-     * returns a random point on the y axis within the bounds this emitter
-     * @returns {number}
-     */
-    getRandomPointY() {
-        return randomFloat(0, this.getBounds().height);
-    }
-
-    // Add count particles in the game world
-    /** @ignore */
-    addParticles(count) {
-        for (let i = 0; i < count; i++) {
-            // Add particle to the container
-            this.addChild(pool.pull("Particle", this), this.pos.z);
-        }
-        this.isDirty = true;
-    }
-
-    /**
-     * Emitter is of type stream and is launching particles
-     * @returns {boolean} Emitter is Stream and is launching particles
-     */
-    isRunning() {
-        return this._enabled && this._stream;
-    }
-
-    /**
-     * Launch particles from emitter constantly (e.g. for stream)
-     * @param {number} [duration] - time that the emitter releases particles in ms
-     */
-    streamParticles(duration) {
-        this._enabled = true;
-        this._stream = true;
-        this.settings.frequency = Math.max(1, this.settings.frequency);
-        this._durationTimer = (typeof duration === "number") ? duration : this.settings.duration;
-    }
-
-    /**
-     * Stop the emitter from generating new particles (used only if emitter is Stream)
-     */
-    stopStream() {
-        this._enabled = false;
-    }
-
-    /**
-     * Launch all particles from emitter and stop (e.g. for explosion)
-     * @param {number} [total] - number of particles to launch
-     */
-    burstParticles(total) {
-        this._enabled = true;
-        this._stream = false;
-        this.addParticles((typeof total === "number") ? total : this.settings.totalParticles);
-        this._enabled = false;
-    }
-
-    /**
-     * @ignore
-     */
-    update(dt) {
-        // skip frames if necessary
-        if (++this._updateCount > this.settings.framesToSkip) {
-            this._updateCount = 0;
-        }
-        if (this._updateCount > 0) {
-            this._dt += dt;
-            return this.isDirty;
-        }
-
-        // apply skipped delta time
-        dt += this._dt;
-        this._dt = 0;
-
-        // Update particles
-        this.isDirty |= super.update(dt);
-
-        // Launch new particles, if emitter is Stream
-        if ((this._enabled) && (this._stream)) {
-            // Check if the emitter has duration set
-            if (this._durationTimer !== Infinity) {
-                this._durationTimer -= dt;
-
-                if (this._durationTimer <= 0) {
-                    this.stopStream();
-                    return this.isDirty;
-                }
-            }
-
-            // Increase the emitter launcher timer
-            this._frequencyTimer += dt;
-
-            // Check for new particles launch
-            const particlesCount = this.children.length;
-            if ((particlesCount < this.settings.totalParticles) && (this._frequencyTimer >= this.settings.frequency)) {
-                if ((particlesCount + this.settings.maxParticles) <= this.settings.totalParticles) {
-                    this.addParticles(this.settings.maxParticles);
-                }
-                else {
-                    this.addParticles(this.settings.totalParticles - particlesCount);
-                }
-                this._frequencyTimer = 0;
-                this.isDirty = true;
-            }
-        }
-        return this.isDirty;
-    }
-
-    /**
-     * Destroy function
-     * @ignore
-     */
-    destroy() {
-        // call the parent destroy method
-        super.destroy(arguments);
-        // clean emitter specific Properties
-        if (typeof this._defaultParticle !== "undefined") {
-            pool.push(this._defaultParticle);
-            this._defaultParticle = undefined;
-        }
-        this.settings.image = undefined;
-        this.settings = undefined;
-    }
-}
-