melonjs 10.10.0 → 11.0.0

package/src/math/vector3.js

@@ -40,7 +40,6 @@ class Vector3d {
      * set the Vector x and y properties to the given values<br>
      * @name set
      * @memberof Vector3d
-     * @function
      * @param {number} x
      * @param {number} y
      * @param {number} [z=0]
@@ -56,7 +55,7 @@ class Vector3d {
         /**
          * x value of the vector
          * @public
-         * @type {number}
+         * @member {number}
          * @name x
          * @memberof Vector3d
          */
@@ -65,7 +64,7 @@ class Vector3d {
         /**
          * y value of the vector
          * @public
-         * @type {number}
+         * @member {number}
          * @name y
          * @memberof Vector3d
          */
@@ -74,7 +73,7 @@ class Vector3d {
         /**
          * z value of the vector
          * @public
-         * @type {number}
+         * @member {number}
          * @name z
          * @memberof Vector3d
          */
@@ -87,7 +86,6 @@ class Vector3d {
      * set the Vector x and y properties to 0
      * @name setZero
      * @memberof Vector3d
-     * @function
      * @returns {Vector3d} Reference to this object for method chaining
      */
     setZero() {
@@ -98,7 +96,6 @@ class Vector3d {
      * set the Vector x and y properties using the passed vector
      * @name setV
      * @memberof Vector3d
-     * @function
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -110,7 +107,6 @@ class Vector3d {
      * Add the passed vector to this vector
      * @name add
      * @memberof Vector3d
-     * @function
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -122,7 +118,6 @@ class Vector3d {
      * Substract the passed vector to this vector
      * @name sub
      * @memberof Vector3d
-     * @function
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -134,7 +129,6 @@ class Vector3d {
      * Multiply this vector values by the given scalar
      * @name scale
      * @memberof Vector3d
-     * @function
      * @param {number} x
      * @param {number} [y=x]
      * @param {number} [z=1]
@@ -149,7 +143,6 @@ class Vector3d {
      * Multiply this vector values by the passed vector
      * @name scaleV
      * @memberof Vector3d
-     * @function
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -161,7 +154,6 @@ class Vector3d {
      * Convert this vector into isometric coordinate space
      * @name toIso
      * @memberof Vector3d
-     * @function
      * @returns {Vector3d} Reference to this object for method chaining
      */
     toIso() {
@@ -172,7 +164,6 @@ class Vector3d {
      * Convert this vector into 2d coordinate space
      * @name to2d
      * @memberof Vector3d
-     * @function
      * @returns {Vector3d} Reference to this object for method chaining
      */
     to2d() {
@@ -183,7 +174,6 @@ class Vector3d {
      * Divide this vector values by the passed value
      * @name div
      * @memberof Vector3d
-     * @function
      * @param {number} n the value to divide the vector by
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -195,7 +185,6 @@ class Vector3d {
      * Update this vector values to absolute values
      * @name abs
      * @memberof Vector3d
-     * @function
      * @returns {Vector3d} Reference to this object for method chaining
      */
     abs() {
@@ -206,7 +195,6 @@ class Vector3d {
      * Clamp the vector value within the specified value range
      * @name clamp
      * @memberof Vector3d
-     * @function
      * @param {number} low
      * @param {number} high
      * @returns {Vector3d} new me.Vector3d
@@ -219,7 +207,6 @@ class Vector3d {
      * Clamp this vector value within the specified value range
      * @name clampSelf
      * @memberof Vector3d
-     * @function
      * @param {number} low
      * @param {number} high
      * @returns {Vector3d} Reference to this object for method chaining
@@ -232,7 +219,6 @@ class Vector3d {
      * Update this vector with the minimum value between this and the passed vector
      * @name minV
      * @memberof Vector3d
-     * @function
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -245,7 +231,6 @@ class Vector3d {
      * Update this vector with the maximum value between this and the passed vector
      * @name maxV
      * @memberof Vector3d
-     * @function
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -258,7 +243,6 @@ class Vector3d {
      * Floor the vector values
      * @name floor
      * @memberof Vector3d
-     * @function
      * @returns {Vector3d} new me.Vector3d
      */
     floor() {
@@ -269,7 +253,6 @@ class Vector3d {
      * Floor this vector values
      * @name floorSelf
      * @memberof Vector3d
-     * @function
      * @returns {Vector3d} Reference to this object for method chaining
      */
     floorSelf() {
@@ -280,7 +263,6 @@ class Vector3d {
      * Ceil the vector values
      * @name ceil
      * @memberof Vector3d
-     * @function
      * @returns {Vector3d} new me.Vector3d
      */
     ceil() {
@@ -291,7 +273,6 @@ class Vector3d {
      * Ceil this vector values
      * @name ceilSelf
      * @memberof Vector3d
-     * @function
      * @returns {Vector3d} Reference to this object for method chaining
      */
     ceilSelf() {
@@ -302,7 +283,6 @@ class Vector3d {
      * Negate the vector values
      * @name negate
      * @memberof Vector3d
-     * @function
      * @returns {Vector3d} new me.Vector3d
      */
     negate() {
@@ -313,7 +293,6 @@ class Vector3d {
      * Negate this vector values
      * @name negateSelf
      * @memberof Vector3d
-     * @function
      * @returns {Vector3d} Reference to this object for method chaining
      */
     negateSelf() {
@@ -324,7 +303,6 @@ class Vector3d {
      * Copy the components of the given vector into this one
      * @name copy
      * @memberof Vector3d
-     * @function
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -336,7 +314,7 @@ class Vector3d {
      * return true if the two vectors are the same
      * @name equals
      * @memberof Vector3d
-     * @function
+     * @method
      * @param {Vector2d|Vector3d} v
      * @returns {boolean}
      */
@@ -344,7 +322,6 @@ class Vector3d {
      * return true if this vector is equal to the given values
      * @name equals
      * @memberof Vector3d
-     * @function
      * @param {number} x
      * @param {number} y
      * @param {number} [z]
@@ -375,7 +352,6 @@ class Vector3d {
      * normalize this vector (scale the vector so that its magnitude is 1)
      * @name normalize
      * @memberof Vector3d
-     * @function
      * @returns {Vector3d} Reference to this object for method chaining
      */
     normalize() {
@@ -387,7 +363,6 @@ class Vector3d {
      * (Effectively rotates it 90 degrees in a clockwise direction around the z axis)
      * @name perp
      * @memberof Vector3d
-     * @function
      * @returns {Vector3d} Reference to this object for method chaining
      */
     perp() {
@@ -398,7 +373,6 @@ class Vector3d {
      * Rotate this vector (counter-clockwise) by the specified angle (in radians) around the z axis
      * @name rotate
      * @memberof Vector3d
-     * @function
      * @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
@@ -426,7 +400,6 @@ class Vector3d {
      * return the dot product of this vector and the passed one
      * @name dot
      * @memberof Vector3d
-     * @function
      * @param {Vector2d|Vector3d} v
      * @returns {number} The dot product.
      */
@@ -438,7 +411,6 @@ class Vector3d {
      * calculate the cross product of this vector and the passed one
      * @name cross
      * @memberof Vector3d
-     * @function
      * @param {Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -457,7 +429,6 @@ class Vector3d {
     * return the square length of this vector
     * @name length2
     * @memberof Vector3d
-    * @function
     * @returns {number} The length^2 of this vector.
     */
     length2() {
@@ -468,7 +439,6 @@ class Vector3d {
      * return the length (magnitude) of this vector
      * @name length
      * @memberof Vector3d
-     * @function
      * @returns {number} the length of this vector
      */
     length() {
@@ -479,7 +449,6 @@ class Vector3d {
      * Linearly interpolate between this vector and the given one.
      * @name lerp
      * @memberof Vector3d
-     * @function
      * @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
@@ -495,7 +464,6 @@ class Vector3d {
      * return the distance between this vector and the passed one
      * @name distance
      * @memberof Vector3d
-     * @function
      * @param {Vector2d|Vector3d} v
      * @returns {number}
      */
@@ -510,7 +478,6 @@ class Vector3d {
      * return the angle between this vector and the passed one
      * @name angle
      * @memberof Vector3d
-     * @function
      * @param {Vector2d|Vector3d} v
      * @returns {number} angle in radians
      */
@@ -522,7 +489,6 @@ class Vector3d {
      * project this vector on to another vector.
      * @name project
      * @memberof Vector3d
-     * @function
      * @param {Vector2d|Vector3d} v The vector to project onto.
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -536,7 +502,6 @@ class Vector3d {
      * This is slightly more efficient than `project` when dealing with unit vectors.
      * @name projectN
      * @memberof Vector3d
-     * @function
      * @param {Vector2d|Vector3d} v The unit vector to project onto.
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -549,7 +514,6 @@ class Vector3d {
      * return a clone copy of this vector
      * @name clone
      * @memberof Vector3d
-     * @function
      * @returns {Vector3d} new me.Vector3d
      */
     clone() {
@@ -560,7 +524,6 @@ class Vector3d {
      * convert the object to a string representation
      * @name toString
      * @memberof Vector3d
-     * @function
      * @returns {string}
      */
     toString() {

package/src/particles/emitter.js

@@ -8,7 +8,7 @@ import Container from "./../renderable/container.js";
  * @ignore
  */
 function createDefaultParticleTexture(w = 8, h = 8) {
-    var defaultParticleTexture = pool.pull("CanvasTexture", w, h, true);
+    var defaultParticleTexture = pool.pull("CanvasTexture", w, h, { offscreenCanvas: true });
 
     defaultParticleTexture.context.fillStyle = "#fff";
     defaultParticleTexture.context.fillRect(0, 0, w, h);

package/src/physics/body.js

@@ -13,6 +13,7 @@ import { world } from "./../game.js";
 /**
  * @classdesc
  * a Generic Physic Body Object with some physic properties and behavior functionality, to as a member of a Renderable.
+ * @see Renderable.body
  */
 class Body {
     /**
@@ -368,7 +369,6 @@ class Body {
 
     /**
      * returns the AABB bounding box for this body
-     * @function
      * @returns {Bounds} bounding box Rectangle object
      */
     getBounds() {
@@ -439,7 +439,7 @@ class Body {
 
     /**
      * the built-in function to solve the collision response
-     * @param {object} response the collision response object (see {@link collision.ResponseObject})
+     * @param {object} response the collision response object (see {@link ResponseObject})
      */
     respondToCollision(response) {
         // the overlap vector
@@ -510,6 +510,7 @@ class Body {
 
     /**
      * Returns true if the any of the shape composing the body contains the given point.
+     * @method Body#contains
      * @param {Vector2d} point
      * @returns {boolean} true if contains
      */
@@ -573,7 +574,6 @@ class Body {
      * cap the body velocity (body.maxVel property) to the specified value<br>
      * @param {number} x max velocity on x axis
      * @param {number} y max velocity on y axis
-     * @protected
      */
     setMaxVelocity(x, y) {
         this.maxVel.x = x;
@@ -584,7 +584,6 @@ class Body {
      * set the body default friction
      * @param {number} x horizontal friction
      * @param {number} y vertical friction
-     * @protected
      */
     setFriction(x = 0, y = 0) {
         this.friction.x = x;
@@ -692,7 +691,7 @@ class Body {
         pool.push(this.friction);
         pool.push(this.maxVel);
         this.shapes.forEach((shape) => {
-            pool.push(shape);
+            pool.push(shape, false);
         });
 
         // set to undefined

package/src/physics/bounds.js

@@ -34,7 +34,6 @@ class Bounds {
      * reset the bound
      * @name clear
      * @memberof Bounds
-     * @function
      */
     clear() {
         this.setMinMax(Infinity, Infinity, -Infinity, -Infinity);
@@ -45,7 +44,6 @@ class Bounds {
      * sets the bounds to the given min and max value
      * @name setMinMax
      * @memberof Bounds
-     * @function
      * @param {number} minX
      * @param {number} minY
      * @param {number} maxX
@@ -205,7 +203,6 @@ class Bounds {
      * Updates bounds using the given vertices
      * @name update
      * @memberof Bounds
-     * @function
      * @param {Vector2d[]} vertices an array of me.Vector2d points
      */
     update(vertices) {
@@ -216,7 +213,6 @@ class Bounds {
      * add the given vertices to the bounds definition.
      * @name add
      * @memberof Bounds
-     * @function
      * @param {Vector2d[]} vertices an array of me.Vector2d points
      * @param {boolean} [clear=false] either to reset the bounds before adding the new vertices
      */
@@ -237,7 +233,6 @@ class Bounds {
      * add the given bounds to the bounds definition.
      * @name addBounds
      * @memberof Bounds
-     * @function
      * @param {Bounds} bounds
      * @param {boolean} [clear=false] either to reset the bounds before adding the new vertices
      */
@@ -256,7 +251,6 @@ class Bounds {
      * add the given point to the bounds definition.
      * @name addPoint
      * @memberof Bounds
-     * @function
      * @param {Vector2d} v
      * @param {Matrix2d} [m] an optional transform to apply to the given point
      */
@@ -274,7 +268,6 @@ class Bounds {
      * add the given quad coordinates to this bound definition, multiplied by the given matrix
      * @name addFrame
      * @memberof Bounds
-     * @function
      * @param {number} x0 - left X coordinates of the quad
      * @param {number} y0 - top Y coordinates of the quad
      * @param {number} x1 - right X coordinates of the quad
@@ -282,7 +275,7 @@ class Bounds {
      * @param {Matrix2d} [m] an optional transform to apply to the given frame coordinates
      */
     addFrame(x0, y0, x1, y1, m) {
-        var v = me.pool.pull("Vector2d");
+        var v = pool.pull("Vector2d");
 
         // transform all points and add to the bound definition
         this.addPoint(v.set(x0, y0), m);
@@ -290,14 +283,14 @@ class Bounds {
         this.addPoint(v.set(x0, y1), m);
         this.addPoint(v.set(x1, y1), m);
 
-        me.pool.push(v);
+        pool.push(v);
     }
 
     /**
      * Returns true if the bounds contains the given point.
      * @name contains
      * @memberof Bounds
-     * @function
+     * @method
      * @param {Vector2d} point
      * @returns {boolean} True if the bounds contain the point, otherwise false
      */
@@ -305,7 +298,6 @@ class Bounds {
      * Returns true if the bounds contains the given point.
      * @name contains
      * @memberof Bounds
-     * @function
      * @param {number} x
      * @param {number} y
      * @returns {boolean} True if the bounds contain the point, otherwise false
@@ -339,7 +331,6 @@ class Bounds {
      * Returns true if the two bounds intersect.
      * @name overlaps
      * @memberof Bounds
-     * @function
      * @param {Bounds|Rect} bounds
      * @returns {boolean} True if the bounds overlap, otherwise false
      */
@@ -352,7 +343,6 @@ class Bounds {
      * determines whether all coordinates of this bounds are finite numbers.
      * @name isFinite
      * @memberof Bounds
-     * @function
      * @returns {boolean} false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
      */
     isFinite() {
@@ -363,14 +353,13 @@ class Bounds {
      * Translates the bounds by the given vector.
      * @name translate
      * @memberof Bounds
-     * @function
+     * @method
      * @param {Vector2d} vector
      */
     /**
      * Translates the bounds by x on the x axis, and y on the y axis
      * @name translate
      * @memberof Bounds
-     * @function
      * @param {number} x
      * @param {number} y
      */
@@ -395,14 +384,13 @@ class Bounds {
      * Shifts the bounds to the given position vector.
      * @name shift
      * @memberof Bounds
-     * @function
+     * @method
      * @param {Vector2d} position
      */
     /**
      * Shifts the bounds to the given x, y position.
      * @name shift
      * @memberof Bounds
-     * @function
      * @param {number} x
      * @param {number} y
      */
@@ -432,7 +420,6 @@ class Bounds {
      * clone this bounds
      * @name clone
      * @memberof Bounds
-     * @function
      * @returns {Bounds}
      */
     clone() {
@@ -445,7 +432,6 @@ class Bounds {
      * Returns a polygon whose edges are the same as this bounds.
      * @name toPolygon
      * @memberof Bounds
-     * @function
      * @returns {Polygon} a new Polygon that represents this bounds.
      */
     toPolygon () {

package/src/physics/collision.js

@@ -1,4 +1,4 @@
-import { rayCast, globalResponse } from "./detector.js";
+import { rayCast } from "./detector.js";
 
 /**
  * Collision detection (and projection-based collision response) of 2D shapes.<br>
@@ -91,23 +91,11 @@ var collision = {
         ALL_OBJECT          : 0xFFFFFFFF // all objects
     },
 
-
-    /**
-     * a global instance of a response object used for collision detection <br>
-     * this object will be reused amongst collision detection call if not user-defined response is specified
-     * @name response
-     * @memberof collision
-     * @public
-     * @type {collision.ResponseObject}
-     */
-    response : globalResponse,
-
     /**
      * Checks for object colliding with the given line
      * @name rayCast
      * @memberof collision
      * @public
-     * @function
      * @param {Line} line line to be tested for collision
      * @param {Array.<Renderable>} [result] a user defined array that will be populated with intersecting physic objects.
      * @returns {Array.<Renderable>} an array of intersecting physic objects

package/src/physics/detector.js

@@ -1,9 +1,10 @@
 import * as SAT from "./sat.js";
+import ResponseObject from "./response.js";
 import Vector2d from "./../math/vector2.js";
 import { world } from "./../game.js";
 
 // a dummy object when using Line for raycasting
-var dummyObj = {
+let dummyObj = {
     pos : new Vector2d(0, 0),
     ancestor : {
         _absPos : new Vector2d(0, 0),
@@ -13,13 +14,15 @@ var dummyObj = {
     }
 };
 
+// the global response object used for collisions
+let globalResponse = new ResponseObject();
+
 /**
  * a function used to determine if two objects should collide (based on both respective objects collision mask and type).<br>
  * you can redefine this function if you need any specific rules over what should collide with what.
  * @name shouldCollide
  * @memberof collision
  * @ignore
- * @function
  * @param {Renderable} a a reference to the object A.
  * @param {Renderable} b a reference to the object B.
  * @returns {boolean} true if they should collide, false otherwise
@@ -34,66 +37,14 @@ function shouldCollide(a, b) {
     );
 };
 
-/**
- * @classdesc
- * An object representing the result of an intersection.
- * @property {Renderable} a The first object participating in the intersection
- * @property {Renderable} b The second object participating in the intersection
- * @property {number} overlap Magnitude of the overlap on the shortest colliding axis
- * @property {Vector2d} overlapV The overlap vector (i.e. `overlapN.scale(overlap, overlap)`). If this vector is subtracted from the position of a, a and b will no longer be colliding
- * @property {Vector2d} overlapN The shortest colliding axis (unit-vector)
- * @property {boolean} aInB Whether the first object is entirely inside the second
- * @property {boolean} bInA Whether the second object is entirely inside the first
- * @property {number} indexShapeA The index of the colliding shape for the object a body
- * @property {number} indexShapeB The index of the colliding shape for the object b body
- * @name ResponseObject
- * @memberof collision
- * @public
- */
-class ResponseObject {
-    constructor() {
-        this.a = null;
-        this.b = null;
-        this.overlapN = new Vector2d();
-        this.overlapV = new Vector2d();
-        this.aInB = true;
-        this.bInA = true;
-        this.indexShapeA = -1;
-        this.indexShapeB = -1;
-        this.overlap = Number.MAX_VALUE;
-    }
-
-    /**
-     * Set some values of the response back to their defaults. <br>
-     * Call this between tests if you are going to reuse a single <br>
-     * Response object for multiple intersection tests <br>
-     * (recommended as it will avoid allocating extra memory) <br>
-     * @name clear
-     * @memberof collision.ResponseObject
-     * @public
-     * @function
-     * @returns {object} this object for chaining
-     */
-    clear () {
-        this.aInB = true;
-        this.bInA = true;
-        this.overlap = Number.MAX_VALUE;
-        this.indexShapeA = -1;
-        this.indexShapeB = -1;
-        return this;
-    }
-}
 
-// @ignore
-export var globalResponse = new ResponseObject();
 
 /**
  * find all the collisions for the specified object
  * @name collisionCheck
  * @ignore
- * @function
  * @param {Renderable} objA object to be tested for collision
- * @param {collision.ResponseObject} [response=collision.response] a user defined response object that will be populated if they intersect.
+ * @param {ResponseObject} [response] a user defined response object that will be populated if they intersect.
  * @returns {boolean} in case of collision, false otherwise
  */
 export function collisionCheck(objA, response = globalResponse) {
@@ -163,7 +114,6 @@ export function collisionCheck(objA, response = globalResponse) {
  * Checks for object colliding with the given line
  * @name rayCast
  * @ignore
- * @function
  * @param {Line} line line to be tested for collision
  * @param {Array.<Renderable>} [result] a user defined array that will be populated with intersecting physic objects.
  * @returns {Array.<Renderable>} an array of intersecting physic objects