@vpmedia/phaser 1.112.0 → 1.113.0

package/src/phaser/geom/point.ts

@@ -2,16 +2,16 @@ import { GEOM_POINT } from '../core/const.js';
 import { clone, distance, rotate } from './util/point.js';
 
 export class Point {
-  x: number;
-  y: number;
-  type: number;
+  public x: number;
+  public y: number;
+  public type: number;
 
   /**
    * Creates a new Point instance.
    * @param {number} x - The x coordinate of the point (default: 0).
    * @param {number} y - The y coordinate of the point (default: 0).
    */
-  constructor(x: number = 0, y: number = 0) {
+  public constructor(x = 0, y = 0) {
     /** @type {number} */
     this.x = x;
     /** @type {number} */
@@ -25,7 +25,7 @@ export class Point {
    * @param {Point} source - The point to copy coordinates from.
    * @returns {Point} This point instance for chaining.
    */
-  copyFrom(source: Point) {
+  public copyFrom(source: Point) {
     return this.setTo(source.x, source.y);
   }
 
@@ -33,7 +33,7 @@ export class Point {
    * Returns a new point with the x and y coordinates swapped.
    * @returns {Point} A new point instance with swapped coordinates.
    */
-  invert() {
+  public invert() {
     return this.setTo(this.y, this.x);
   }
 
@@ -43,9 +43,9 @@ export class Point {
    * @param {number} y - The new y coordinate for the point.
    * @returns {Point} This point instance for chaining.
    */
-  setTo(x: number, y?: number) {
+  public setTo(x: number, y?: number) {
     this.x = x || 0;
-    this.y = y || (y !== 0 ? this.x : 0);
+    this.y = y ?? (y !== 0 ? this.x : 0);
     return this;
   }
 
@@ -56,7 +56,7 @@ export class Point {
    * @returns {Point} This point instance for chaining.
    * @deprecated Use setTo instead.
    */
-  set(x: number, y: number) {
+  public set(x: number, y: number) {
     this.x = x || 0;
     this.y = y || (y !== 0 ? this.x : 0);
     return this;
@@ -68,7 +68,7 @@ export class Point {
    * @param {number} y - The amount to add to the y coordinate.
    * @returns {Point} This point instance for chaining.
    */
-  add(x: number, y: number) {
+  public add(x: number, y: number) {
     this.x += x;
     this.y += y;
     return this;
@@ -80,7 +80,7 @@ export class Point {
    * @param {number} y - The amount to subtract from the y coordinate.
    * @returns {Point} This point instance for chaining.
    */
-  subtract(x: number, y: number) {
+  public subtract(x: number, y: number) {
     this.x -= x;
     this.y -= y;
     return this;
@@ -92,7 +92,7 @@ export class Point {
    * @param {number} y - The amount to multiply the y coordinate by.
    * @returns {Point} This point instance for chaining.
    */
-  multiply(x: number, y: number) {
+  public multiply(x: number, y: number) {
     this.x *= x;
     this.y *= y;
     return this;
@@ -104,7 +104,7 @@ export class Point {
    * @param {number} y - The amount to divide the y coordinate by.
    * @returns {Point} This point instance for chaining.
    */
-  divide(x: number, y: number) {
+  public divide(x: number, y: number) {
     this.x /= x;
     this.y /= y;
     return this;
@@ -116,7 +116,7 @@ export class Point {
    * @param {number} max - The maximum value for the x coordinate.
    * @returns {Point} This point instance for chaining.
    */
-  clampX(min: number, max: number) {
+  public clampX(min: number, max: number) {
     this.x = Math.max(min, Math.min(max, this.x));
     return this;
   }
@@ -127,7 +127,7 @@ export class Point {
    * @param {number} max - The maximum value for the y coordinate.
    * @returns {Point} This point instance for chaining.
    */
-  clampY(min: number, max: number) {
+  public clampY(min: number, max: number) {
     this.y = Math.max(min, Math.min(max, this.y));
     return this;
   }
@@ -138,7 +138,7 @@ export class Point {
    * @param {number} max - The maximum value for both coordinates.
    * @returns {Point} This point instance for chaining.
    */
-  clamp(min: number, max: number) {
+  public clamp(min: number, max: number) {
     this.x = Math.max(min, Math.min(max, this.x));
     this.y = Math.max(min, Math.min(max, this.y));
     return this;
@@ -148,7 +148,7 @@ export class Point {
    * Creates a clone of this point.
    * @returns {Point} A new point with the same coordinates as this one.
    */
-  clone() {
+  public clone() {
     return clone(this);
   }
 
@@ -157,7 +157,7 @@ export class Point {
    * @param {Point} dest - The point to copy coordinates to.
    * @returns {Point} The destination point.
    */
-  copyTo(dest: Point) {
+  public copyTo(dest: Point) {
     dest.x = this.x;
     dest.y = this.y;
     return dest;
@@ -168,7 +168,7 @@ export class Point {
    * @param {Point} b - The other point to calculate the distance to.
    * @returns {number} The distance between the two points.
    */
-  distance(b: Point) {
+  public distance(b: Point) {
     return distance(this, b);
   }
 
@@ -177,7 +177,7 @@ export class Point {
    * @param {Point} a - The other point to compare with.
    * @returns {boolean} True if the points have the same coordinates, false otherwise.
    */
-  equals(a: Point) {
+  public equals(a: Point) {
     return a.x === this.x && a.y === this.y;
   }
 
@@ -187,7 +187,7 @@ export class Point {
    * @param {boolean} asDegrees - Whether to return the result in degrees (default: false).
    * @returns {number} The angle between the two points in radians or degrees.
    */
-  angle(a: Point, asDegrees: boolean = false) {
+  public angle(a: Point, asDegrees = false) {
     if (asDegrees) {
       return (180 / Math.PI) * Math.atan2(a.y - this.y, a.x - this.x);
     }
@@ -203,7 +203,7 @@ export class Point {
    * @param {number | null | undefined} dist - The distance to rotate from (default: null).
    * @returns {Point} This point instance for chaining.
    */
-  rotate(x: number, y: number, angle: number, asDegrees: boolean, dist: number | null | undefined = null) {
+  public rotate(x: number, y: number, angle: number, asDegrees: boolean, dist: number | null | undefined = null) {
     return rotate(this, x, y, angle, asDegrees, dist);
   }
 
@@ -211,7 +211,7 @@ export class Point {
    * Calculates the magnitude (length) of this point from the origin.
    * @returns {number} The magnitude of the point.
    */
-  getMagnitude() {
+  public getMagnitude() {
     return Math.sqrt(this.x * this.x + this.y * this.y);
   }
 
@@ -219,7 +219,7 @@ export class Point {
    * Calculates the square of the magnitude (length) of this point from the origin.
    * @returns {number} The square of the magnitude of the point.
    */
-  getMagnitudeSq() {
+  public getMagnitudeSq() {
     return this.x * this.x + this.y * this.y;
   }
 
@@ -228,7 +228,7 @@ export class Point {
    * @param {number} magnitude - The new magnitude for the point.
    * @returns {Point} This point instance for chaining.
    */
-  setMagnitude(magnitude: number) {
+  public setMagnitude(magnitude: number) {
     return this.normalize().multiply(magnitude, magnitude);
   }
 
@@ -236,7 +236,7 @@ export class Point {
    * Normalizes this point to have a magnitude of 1 while preserving its direction.
    * @returns {Point} This point instance for chaining.
    */
-  normalize() {
+  public normalize() {
     if (!this.isZero()) {
       const m = this.getMagnitude();
       this.x /= m;
@@ -249,7 +249,7 @@ export class Point {
    * Checks if this point has zero magnitude (is at the origin).
    * @returns {boolean} True if both x and y coordinates are zero, false otherwise.
    */
-  isZero() {
+  public isZero() {
     return this.x === 0 && this.y === 0;
   }
 
@@ -258,7 +258,7 @@ export class Point {
    * @param {Point} a - The other point to calculate the dot product with.
    * @returns {number} The dot product of the two points.
    */
-  dot(a: Point) {
+  public dot(a: Point) {
     return this.x * a.x + this.y * a.y;
   }
 
@@ -267,7 +267,7 @@ export class Point {
    * @param {Point} a - The other point to calculate the cross product with.
    * @returns {number} The cross product of the two points.
    */
-  cross(a: Point) {
+  public cross(a: Point) {
     return this.x * a.y - this.y * a.x;
   }
 
@@ -275,7 +275,7 @@ export class Point {
    * Returns a perpendicular point (rotated 90 degrees counter-clockwise).
    * @returns {Point} A new point that is perpendicular to this one.
    */
-  perp() {
+  public perp() {
     return this.setTo(-this.y, this.x);
   }
 
@@ -283,7 +283,7 @@ export class Point {
    * Returns a perpendicular point (rotated 90 degrees clockwise).
    * @returns {Point} A new point that is perpendicular to this one (rotated clockwise).
    */
-  rperp() {
+  public rperp() {
     return this.setTo(this.y, -this.x);
   }
 
@@ -291,7 +291,7 @@ export class Point {
    * Returns a point with the same direction as this one but with y coordinate negated.
    * @returns {Point} A new point with the same x coordinate but negated y coordinate.
    */
-  normalRightHand() {
+  public normalRightHand() {
     return this.setTo(this.y * -1, this.x);
   }
 
@@ -299,7 +299,7 @@ export class Point {
    * Returns a new point with the x and y coordinates rounded down to the nearest integer.
    * @returns {Point} A new point with floored coordinates.
    */
-  floor() {
+  public floor() {
     return this.setTo(Math.floor(this.x), Math.floor(this.y));
   }
 
@@ -307,7 +307,7 @@ export class Point {
    * Returns a new point with the x and y coordinates rounded up to the nearest integer.
    * @returns {Point} A new point with ceiled coordinates.
    */
-  ceil() {
+  public ceil() {
     return this.setTo(Math.ceil(this.x), Math.ceil(this.y));
   }
 
@@ -315,7 +315,7 @@ export class Point {
    * Returns a string representation of this point.
    * @returns {string} A string representation of the point in the format "[Point (x=value y=value)]".
    */
-  toString() {
+  public toString() {
     return `[{Point (x=${this.x} y=${this.y})}]`;
   }
 }

package/src/phaser/geom/polygon.test.ts

@@ -0,0 +1,82 @@
+import { describe, expect, it } from 'vitest';
+import { Point } from './point.js';
+import { Polygon } from './polygon.js';
+
+const square = (): Polygon => new Polygon([new Point(0, 0), new Point(10, 0), new Point(10, 10), new Point(0, 10)]);
+
+const triangle = (): Polygon => new Polygon([new Point(0, 0), new Point(10, 0), new Point(0, 10)]);
+
+describe('Polygon', () => {
+  describe('contains', () => {
+    it('accepts a point well inside a square', () => {
+      expect(square().contains(5, 5)).toBe(true);
+    });
+
+    it('rejects points outside a square on every side', () => {
+      const polygon = square();
+      expect(polygon.contains(-1, 5)).toBe(false);
+      expect(polygon.contains(11, 5)).toBe(false);
+      expect(polygon.contains(5, -1)).toBe(false);
+      expect(polygon.contains(5, 11)).toBe(false);
+    });
+
+    it('accepts a point inside a triangle and rejects one in the cut corner', () => {
+      const polygon = triangle();
+      expect(polygon.contains(2, 2)).toBe(true);
+      expect(polygon.contains(8, 8)).toBe(false);
+    });
+
+    it('agrees with itself once flattened', () => {
+      const probes: [number, number][] = [
+        [5, 5],
+        [-1, 5],
+        [11, 5],
+        [2, 2],
+        [9, 9],
+        [0.5, 9.5],
+      ];
+      const asPoints = square();
+      const asNumbers = square().flatten();
+      for (const [x, y] of probes) {
+        expect(asNumbers.contains(x, y)).toBe(asPoints.contains(x, y));
+      }
+    });
+
+    it('agrees with itself once flattened for a triangle', () => {
+      const probes: [number, number][] = [
+        [2, 2],
+        [8, 8],
+        [1, 8],
+        [9, 0.5],
+        [-5, -5],
+      ];
+      const asPoints = triangle();
+      const asNumbers = triangle().flatten();
+      for (const [x, y] of probes) {
+        expect(asNumbers.contains(x, y)).toBe(asPoints.contains(x, y));
+      }
+    });
+
+    it('reports false for a polygon with no points', () => {
+      expect(new Polygon().contains(0, 0)).toBe(false);
+    });
+  });
+
+  describe('toNumberArray', () => {
+    it('flattens points to x/y pairs', () => {
+      expect(square().toNumberArray()).toStrictEqual([0, 0, 10, 0, 10, 10, 0, 10]);
+    });
+
+    it('passes an already flattened polygon through unchanged', () => {
+      expect(square().flatten().toNumberArray()).toStrictEqual([0, 0, 10, 0, 10, 10, 0, 10]);
+    });
+  });
+
+  describe('flatten', () => {
+    it('marks the polygon flattened and swaps the point representation', () => {
+      const polygon = square().flatten();
+      expect(polygon.flattened).toBe(true);
+      expect(polygon._points.every((value) => typeof value === 'number')).toBe(true);
+    });
+  });
+});

package/src/phaser/geom/polygon.ts

@@ -3,19 +3,19 @@ import { clone } from './util/polygon.js';
 import { GEOM_POLYGON } from '../core/const.js';
 
 export class Polygon {
-  area: number;
-  _points: any[];
-  closed: boolean;
-  flattened: boolean;
-  type: number;
+  public area = 0;
+  public _points: any[];
+  public closed: boolean;
+  public flattened: boolean;
+  public type: number;
 
   /**
    * Creates a new Polygon instance.
    * @param {object[]} points - The array of points to define the polygon (optional).
    */
-  constructor(points: any[] | null = null) {
+  public constructor(points: any[] | null = null) {
     /** @type {number} */
-    this.area = 0;
+
     /** @type {Point[]} */
     this._points = [];
     /** @type {boolean} */
@@ -34,7 +34,7 @@ export class Polygon {
    * @param {number[]} output - The array to store the result in (optional).
    * @returns {number[]} An array of numbers representing the polygon's points.
    */
-  toNumberArray(output: number[] = []) {
+  public toNumberArray(output: number[] = []) {
     for (let i = 0; i < this._points.length; i += 1) {
       if (typeof this._points[i] === 'number') {
         output.push(this._points[i]);
@@ -52,7 +52,7 @@ export class Polygon {
    * Flattens the polygon's point array to a simple numeric array.
    * @returns {Polygon} This polygon instance for chaining.
    */
-  flatten() {
+  public flatten() {
     this._points = this.toNumberArray();
     this.flattened = true;
     return this;
@@ -62,7 +62,7 @@ export class Polygon {
    * Creates a clone of this polygon.
    * @returns {Polygon} A new polygon with the same values as this one.
    */
-  clone() {
+  public clone() {
     return clone(this);
   }
 
@@ -72,7 +72,7 @@ export class Polygon {
    * @param {number} y - The y coordinate of the point to check.
    * @returns {boolean} True if the point is contained within this polygon, false otherwise.
    */
-  contains(x: number, y: number) {
+  public contains(x: number, y: number) {
     //  Adapted from http://www.ecse.rpi.edu/Homepages/wrf/Research/Short_Notes/pnpoly.html by Jonas Raoni Soares Silva
     let inside = false;
     if (this.flattened) {
@@ -86,7 +86,7 @@ export class Polygon {
         }
       }
     } else {
-      for (let i = -1, j = this._points.length - 1; ++i < this._points.length; j = i) {
+      for (let i = 0, j = this._points.length - 1; i < this._points.length; j = i, i += 1) {
         const ix = this._points[i].x;
         const iy = this._points[i].y;
         const jx = this._points[j].x;
@@ -104,7 +104,7 @@ export class Polygon {
    * @param {object[]} points - The array of points to define the polygon.
    * @returns {Polygon} This polygon instance for chaining.
    */
-  setTo(points: any[]) {
+  public setTo(points: any[]) {
     this.area = 0;
     this._points = [];
     if (points) {
@@ -143,7 +143,7 @@ export class Polygon {
    * @param {number} y0 - The y coordinate of the lowest boundary (internal use).
    * @returns {number} The area of this polygon.
    */
-  calculateArea(y0: number) {
+  public calculateArea(y0: number) {
     let p1;
     let p2;
     let avgHeight;
@@ -166,14 +166,14 @@ export class Polygon {
    * Gets the points of this polygon.
    * @returns {object[]} The array of points that define this polygon.
    */
-  get points() {
+  public get points() {
     return this._points;
   }
 
   /**
    * Sets the points of this polygon.
    */
-  set points(value) {
+  public set points(value) {
     if (value !== null) {
       this.setTo(value);
     } else {

package/src/phaser/geom/rectangle.test.ts

@@ -1,4 +1,4 @@
-import { expect } from 'vitest';
+import { expect, describe, it } from 'vitest';
 import { TOP_LEFT } from '../core/const.js';
 import { Point } from './point.js';
 import { Rectangle } from './rectangle.js';
@@ -328,7 +328,7 @@ describe('Rectangle', () => {
   describe('top', () => {
     it('should get and set the top coordinate of this rectangle', () => {
       const rect = new Rectangle(0, 0, 10, 10);
-      const top = rect.top;
+      const { top } = rect;
       expect(top).toBe(rect.y);
       rect.top = 1000;
       expect(rect.top).toBe(1000);
@@ -338,7 +338,7 @@ describe('Rectangle', () => {
   describe('left', () => {
     it('should get and set the left coordinate of this rectangle', () => {
       const rect = new Rectangle(0, 0, 10, 10);
-      const left = rect.left;
+      const { left } = rect;
       expect(left).toBe(rect.x);
       rect.left = 1500;
       expect(rect.left).toBe(1500);
@@ -348,7 +348,7 @@ describe('Rectangle', () => {
   describe('right', () => {
     it('should get and set the right coordinate of this rectangle', () => {
       const rect = new Rectangle(0, 0, 10, 10);
-      const right = rect.right;
+      const { right } = rect;
       expect(right).toBe(rect.x + rect.width);
       rect.right = 1600;
       expect(rect.right).toBe(1600);
@@ -358,7 +358,7 @@ describe('Rectangle', () => {
   describe('bottom', () => {
     it('should get and set the bottom coordinate of this rectangle', () => {
       const rect = new Rectangle(0, 0, 10, 10);
-      const bottom = rect.bottom;
+      const { bottom } = rect;
       expect(bottom).toBe(rect.y + rect.height);
       rect.bottom = 1700;
       expect(rect.bottom).toBe(1700);
@@ -368,7 +368,7 @@ describe('Rectangle', () => {
   describe('topLeft', () => {
     it('should get and set the top-left coordinates of this rectangle', () => {
       const rect = new Rectangle(0, 0, 10, 10);
-      const topLeft = rect.topLeft;
+      const { topLeft } = rect;
       expect(topLeft.x).toBe(rect.left);
       expect(topLeft.y).toBe(rect.top);
       rect.topLeft = new Point(1800, 1900);
@@ -380,7 +380,7 @@ describe('Rectangle', () => {
   describe('topRight', () => {
     it('should get and set the top-right coordinates of this rectangle', () => {
       const rect = new Rectangle(0, 0, 10, 10);
-      const topRight = rect.topRight;
+      const { topRight } = rect;
       expect(topRight.x).toBe(rect.right);
       expect(topRight.y).toBe(rect.top);
       rect.topRight = new Point(2000, 2100);
@@ -392,7 +392,7 @@ describe('Rectangle', () => {
   describe('bottomLeft', () => {
     it('should get and set the bottom-left coordinates of this rectangle', () => {
       const rect = new Rectangle(0, 0, 10, 10);
-      const bottomLeft = rect.bottomLeft;
+      const { bottomLeft } = rect;
       expect(bottomLeft.x).toBe(rect.left);
       expect(bottomLeft.y).toBe(rect.bottom);
       rect.bottomLeft = new Point(2200, 2300);
@@ -404,7 +404,7 @@ describe('Rectangle', () => {
   describe('bottomRight', () => {
     it('should get and set the bottom-right coordinates of this rectangle', () => {
       const rect = new Rectangle(0, 0, 10, 10);
-      const bottomRight = rect.bottomRight;
+      const { bottomRight } = rect;
       expect(bottomRight.x).toBe(rect.right);
       expect(bottomRight.y).toBe(rect.bottom);
       rect.bottomRight = new Point(2400, 2500);
@@ -416,7 +416,7 @@ describe('Rectangle', () => {
   describe('centerX', () => {
     it('should get and set the center x coordinate of this rectangle', () => {
       const rect = new Rectangle(0, 0, 10, 10);
-      const centerX = rect.centerX;
+      const { centerX } = rect;
       expect(centerX).toBe(rect.x + rect.halfWidth);
       rect.centerX = 2600;
       expect(rect.centerX).toBe(2600);
@@ -426,7 +426,7 @@ describe('Rectangle', () => {
   describe('centerY', () => {
     it('should get and set the center y coordinate of this rectangle', () => {
       const rect = new Rectangle(0, 0, 10, 10);
-      const centerY = rect.centerY;
+      const { centerY } = rect;
       expect(centerY).toBe(rect.y + rect.halfHeight);
       rect.centerY = 2700;
       expect(rect.centerY).toBe(2700);
@@ -436,7 +436,7 @@ describe('Rectangle', () => {
   describe('randomX', () => {
     it('should return a random x coordinate within this rectangle', () => {
       const rect = new Rectangle(0, 0, 10, 10);
-      const randomX = rect.randomX;
+      const { randomX } = rect;
       expect(randomX >= rect.left && randomX <= rect.right).toBe(true);
     });
   });
@@ -444,7 +444,7 @@ describe('Rectangle', () => {
   describe('randomY', () => {
     it('should return a random y coordinate within this rectangle', () => {
       const rect = new Rectangle(0, 0, 10, 10);
-      const randomY = rect.randomY;
+      const { randomY } = rect;
       expect(randomY >= rect.top && randomY <= rect.bottom).toBe(true);
     });
   });
@@ -452,7 +452,7 @@ describe('Rectangle', () => {
   describe('empty', () => {
     it('should get and set whether this rectangle is empty or not', () => {
       const rect = new Rectangle(0, 0, 10, 10);
-      const empty = rect.empty;
+      const { empty } = rect;
       expect(empty).toBe(!rect.width || !rect.height);
       rect.empty = true;
       expect(rect.empty).toBe(true);