@vpmedia/phaser 1.95.0 → 1.97.0

package/src/phaser/geom/util/circle.js

@@ -3,10 +3,10 @@ import { Circle } from '../circle.js';
 import { Point } from '../point.js';
 
 /**
- * TBD.
- * @param {Circle} input - TBD.
- * @param {Circle} output - TBD.
- * @returns {Circle} TBD.
+ * Clones a circle.
+ * @param {Circle} input - The circle to clone.
+ * @param {Circle} output - Optional circle to store the result in.
+ * @returns {Circle} The cloned circle.
  */
 export const clone = (input, output = null) => {
   const result = output || new Circle();
@@ -17,11 +17,11 @@ export const clone = (input, output = null) => {
 };
 
 /**
- * TBD.
- * @param {Circle} a - TBD.
- * @param {number} x - TBD.
- * @param {number} y - TBD.
- * @returns {boolean} TBD.
+ * Checks if a point is contained within the circle.
+ * @param {Circle} a - The circle to check.
+ * @param {number} x - The x coordinate of the point.
+ * @param {number} y - The y coordinate of the point.
+ * @returns {boolean} True if the point is contained within the circle, false otherwise.
  */
 export const contains = (a, x, y) => {
   if (a.radius > 0 && x >= a.left && x <= a.right && y >= a.top && y <= a.bottom) {
@@ -33,32 +33,32 @@ export const contains = (a, x, y) => {
 };
 
 /**
- * TBD.
- * @param {Circle} a - TBD.
- * @param {Circle} b - TBD.
- * @returns {boolean} TBD.
+ * Checks if two circles are equal.
+ * @param {Circle} a - The first circle to compare.
+ * @param {Circle} b - The second circle to compare.
+ * @returns {boolean} True if the circles are equal, false otherwise.
  */
 export const equals = (a, b) => {
   return a.x === b.x && a.y === b.y && a.diameter === b.diameter;
 };
 
 /**
- * TBD.
- * @param {Circle} a - TBD.
- * @param {Circle} b - TBD.
- * @returns {boolean} TBD.
+ * Checks if two circles intersect.
+ * @param {Circle} a - The first circle to check.
+ * @param {Circle} b - The second circle to check.
+ * @returns {boolean} True if the circles intersect, false otherwise.
  */
 export const intersects = (a, b) => {
   return distance(a.x, a.y, b.x, b.y) <= a.radius + b.radius;
 };
 
 /**
- * TBD.
- * @param {Circle} a - TBD.
- * @param {number} angle - TBD.
- * @param {boolean} asDegrees - TBD.
- * @param {Point} output - TBD.
- * @returns {Point} TBD.
+ * Gets a point on the circumference of the circle at the specified angle.
+ * @param {Circle} a - The circle to get the point from.
+ * @param {number} angle - The angle in radians or degrees (depending on asDegrees).
+ * @param {boolean} asDegrees - True if the angle is in degrees, false if in radians.
+ * @param {Point} output - Optional point to store the result in.
+ * @returns {Point} The point on the circumference of the circle.
  */
 export const circumferencePoint = (a, angle, asDegrees = false, output = null) => {
   const result = output || new Point();
@@ -71,12 +71,12 @@ export const circumferencePoint = (a, angle, asDegrees = false, output = null) =
 };
 
 /**
- * TBD.
- * @param {Circle} a - TBD.
- * @param {number} angle - TBD.
- * @param {boolean} asDegrees - TBD.
- * @param {Point} output - TBD.
- * @returns {Point} TBD.
+ * Gets a point on the circumference of the circle at the specified angle.
+ * @param {Circle} a - The circle to get the point from.
+ * @param {number} angle - The angle in radians or degrees (depending on asDegrees).
+ * @param {boolean} asDegrees - True if the angle is in degrees, false if in radians.
+ * @param {Point} output - Optional point to store the result in.
+ * @returns {Point} The point on the circumference of the circle.
  */
 export const intersectsPoint = (a, angle, asDegrees = false, output = null) => {
   const result = output || new Point();
@@ -89,10 +89,10 @@ export const intersectsPoint = (a, angle, asDegrees = false, output = null) => {
 };
 
 /**
- * TBD.
- * @param {Circle} c - TBD.
- * @param {object} r - TBD.
- * @returns {boolean} TBD.
+ * Checks if a circle intersects with a rectangle.
+ * @param {Circle} c - The circle to check.
+ * @param {object} r - The rectangle to check.
+ * @returns {boolean} True if the circle intersects with the rectangle, false otherwise.
  */
 export const intersectsRectangle = (c, r) => {
   const cx = Math.abs(c.x - r.x - r.halfWidth);

package/src/phaser/geom/util/circle.test.js

@@ -1,3 +1,4 @@
+import { expect } from 'vitest';
 import { Circle } from '../circle.js';
 import { clone, contains, equals, intersects } from './circle.js';
 

package/src/phaser/geom/util/ellipse.js

@@ -1,9 +1,9 @@
 /**
- * TBD.
- * @param {import('../ellipse.js').Ellipse} a - TBD.
- * @param {number} x - TBD.
- * @param {number} y - TBD.
- * @returns {boolean} TBD.
+ * Checks if a point is contained within the ellipse.
+ * @param {import('../ellipse.js').Ellipse} a - The ellipse to check.
+ * @param {number} x - The x coordinate of the point.
+ * @param {number} y - The y coordinate of the point.
+ * @returns {boolean} True if the point is contained within the ellipse, false otherwise.
  */
 export const contains = (a, x, y) => {
   if (a.width <= 0 || a.height <= 0) {

package/src/phaser/geom/util/ellipse.test.js

@@ -1,3 +1,4 @@
+import { expect } from 'vitest';
 import { Ellipse } from '../ellipse.js';
 import { contains } from './ellipse.js';
 

package/src/phaser/geom/util/line.js

@@ -3,10 +3,10 @@ import { Point } from '../point.js';
 import { intersects as intersectsRect } from './rectangle.js';
 
 /**
- * TBD.
- * @param {Line} input - TBD.
- * @param {Line} output - TBD.
- * @returns {Line} TBD.
+ * Clones a line.
+ * @param {Line} input - The line to clone.
+ * @param {Line} output - Optional line to store the result in.
+ * @returns {Line} The cloned line.
  */
 export const clone = (input, output = null) => {
   const result = output || new Line();
@@ -18,14 +18,14 @@ export const clone = (input, output = null) => {
 };
 
 /**
- * TBD.
- * @param {object} a - TBD.
- * @param {object} b - TBD.
- * @param {object} e - TBD.
- * @param {object} f - TBD.
- * @param {boolean} asSegment - TBD.
- * @param {Point} output - TBD.
- * @returns {Point} TBD.
+ * Gets the intersection point of two lines.
+ * @param {object} a - The first line (with x1, y1, x2, y2 properties).
+ * @param {object} b - The second line (with x1, y1, x2, y2 properties).
+ * @param {object} e - The first endpoint of the first line (with x, y properties).
+ * @param {object} f - The second endpoint of the second line (with x, y properties).
+ * @param {boolean} asSegment - True if the lines are treated as segments, false if infinite lines.
+ * @param {Point} output - Optional point to store the result in.
+ * @returns {Point} The intersection point, or null if there is no intersection.
  */
 export const intersectsPoints = (a, b, e, f, asSegment = true, output = null) => {
   const result = output || new Point();
@@ -54,22 +54,22 @@ export const intersectsPoints = (a, b, e, f, asSegment = true, output = null) =>
 };
 
 /**
- * TBD.
- * @param {object} a - TBD.
- * @param {object} b - TBD.
- * @param {boolean} asSegment - TBD.
- * @param {Point} result - TBD.
- * @returns {Point} TBD.
+ * Gets the intersection point of two lines (alternative implementation).
+ * @param {object} a - The first line (with x1, y1, x2, y2 properties).
+ * @param {object} b - The second line (with x1, y1, x2, y2 properties).
+ * @param {boolean} asSegment - True if the lines are treated as segments, false if infinite lines.
+ * @param {Point} result - Optional point to store the result in.
+ * @returns {Point} The intersection point, or null if there is no intersection.
  */
 export const intersects = (a, b, asSegment, result) => {
   return intersectsPoints(a.start, a.end, b.start, b.end, asSegment, result);
 };
 
 /**
- * TBD.
- * @param {object} line - TBD.
- * @param {object} rect - TBD.
- * @returns {boolean} TBD.
+ * Checks if a line intersects with a rectangle.
+ * @param {object} line - The line to check (with x1, y1, x2, y2 properties).
+ * @param {object} rect - The rectangle to check (with x, y, width, height properties).
+ * @returns {boolean} True if the line intersects with the rectangle, false otherwise.
  */
 export const intersectsRectangle = (line, rect) => {
   //  Quick bail out of the Line and Rect bounds don't intersect
@@ -120,10 +120,10 @@ export const intersectsRectangle = (line, rect) => {
 };
 
 /**
- * TBD.
- * @param {object} a - TBD.
- * @param {object} b - TBD.
- * @returns {number} TBD.
+ * Calculates the distance between two points (line length).
+ * @param {object} a - The first point (with x, y properties).
+ * @param {object} b - The second point (with x, y properties).
+ * @returns {number} The distance between the points.
  */
 export const reflect = (a, b) => {
   return 2 * b.normalAngle - 3.141592653589793 - a.angle;

package/src/phaser/geom/util/line.test.js

@@ -1,3 +1,4 @@
+import { expect } from 'vitest';
 import { Line } from '../line.js';
 import { clone } from './line.js';
 

package/src/phaser/geom/util/matrix.js

@@ -1,10 +1,10 @@
 import { Matrix } from '../matrix.js';
 
 /**
- * TBD.
- * @param {Matrix} input - TBD.
- * @param {Matrix} output - TBD.
- * @returns {Matrix} TBD.
+ * Clones a matrix.
+ * @param {Matrix} input - The matrix to clone.
+ * @param {Matrix} output - Optional matrix to store the result in.
+ * @returns {Matrix} The cloned matrix.
  */
 export const clone = (input, output = null) => {
   const result = output || new Matrix();
@@ -18,8 +18,8 @@ export const clone = (input, output = null) => {
 };
 
 /**
- * TBD.
- * @returns {Matrix} TBD.
+ * Creates a new identity matrix.
+ * @returns {Matrix} A new identity matrix.
  */
 export const getIdentityMatrix = () => {
   if (!window.PhaserRegistry) {
@@ -32,8 +32,8 @@ export const getIdentityMatrix = () => {
 };
 
 /**
- * TBD.
- * @returns {Matrix} TBD.
+ * Creates a new matrix with the specified values.
+ * @returns {Matrix} A new matrix.
  */
 export const getTempMatrix = () => {
   if (!window.PhaserRegistry) {

package/src/phaser/geom/util/matrix.test.js

@@ -1,3 +1,4 @@
+import { expect } from 'vitest';
 import { Matrix } from '../matrix.js';
 import { clone, getIdentityMatrix, getTempMatrix } from './matrix.js';
 

package/src/phaser/geom/util/point.js

@@ -1,11 +1,11 @@
 import { Point } from '../point.js';
 
 /**
- * TBD.
- * @param {Point} a - TBD.
- * @param {Point} b - TBD.
- * @param {Point} output - TBD.
- * @returns {Point} TBD.
+ * Adds two points together.
+ * @param {Point} a - The first point to add.
+ * @param {Point} b - The second point to add.
+ * @param {Point} output - The point to store the result in (optional).
+ * @returns {Point} A new point containing the sum of the two points.
  */
 export const add = (a, b, output = null) => {
   const result = output || new Point();
@@ -15,11 +15,11 @@ export const add = (a, b, output = null) => {
 };
 
 /**
- * TBD.
- * @param {Point} a - TBD.
- * @param {Point} b - TBD.
- * @param {Point} output - TBD.
- * @returns {Point} TBD.
+ * Subtracts the second point from the first point.
+ * @param {Point} a - The first point to subtract from.
+ * @param {Point} b - The second point to subtract.
+ * @param {Point} output - The point to store the result in (optional).
+ * @returns {Point} A new point containing the difference of the two points.
  */
 export const subtract = (a, b, output = null) => {
   const result = output || new Point();
@@ -29,11 +29,11 @@ export const subtract = (a, b, output = null) => {
 };
 
 /**
- * TBD.
- * @param {Point} a - TBD.
- * @param {Point} b - TBD.
- * @param {Point} output - TBD.
- * @returns {Point} TBD.
+ * Multiplies two points together.
+ * @param {Point} a - The first point to multiply.
+ * @param {Point} b - The second point to multiply.
+ * @param {Point} output - The point to store the result in (optional).
+ * @returns {Point} A new point containing the product of the two points.
  */
 export const multiply = (a, b, output = null) => {
   const result = output || new Point();
@@ -43,11 +43,11 @@ export const multiply = (a, b, output = null) => {
 };
 
 /**
- * TBD.
- * @param {Point} a - TBD.
- * @param {Point} b - TBD.
- * @param {Point} output - TBD.
- * @returns {Point} TBD.
+ * Divides the first point by the second point.
+ * @param {Point} a - The first point to divide.
+ * @param {Point} b - The second point to divide by.
+ * @param {Point} output - The point to store the result in (optional).
+ * @returns {Point} A new point containing the quotient of the two points.
  */
 export const divide = (a, b, output = null) => {
   const result = output || new Point();
@@ -57,30 +57,30 @@ export const divide = (a, b, output = null) => {
 };
 
 /**
- * TBD.
- * @param {Point} a - TBD.
- * @param {Point} b - TBD.
- * @returns {boolean} TBD.
+ * Checks if two points are equal.
+ * @param {Point} a - The first point to compare.
+ * @param {Point} b - The second point to compare.
+ * @returns {boolean} True if the points are equal, false otherwise.
  */
 export const equals = (a, b) => {
   return a.x === b.x && a.y === b.y;
 };
 
 /**
- * TBD.
- * @param {Point} a - TBD.
- * @param {Point} b - TBD.
- * @returns {number} TBD.
+ * Calculates the angle between two points.
+ * @param {Point} a - The first point to calculate the angle from.
+ * @param {Point} b - The second point to calculate the angle to.
+ * @returns {number} The angle between the two points in radians.
  */
 export const angle = (a, b) => {
   return Math.atan2(a.y - b.y, a.x - b.x);
 };
 
 /**
- * TBD.
- * @param {Point} a - TBD.
- * @param {Point} output - TBD.
- * @returns {Point} TBD.
+ * Creates a new point with the same coordinates as the input point but with inverted signs.
+ * @param {Point} a - The point to negate.
+ * @param {Point} output - The point to store the result in (optional).
+ * @returns {Point} A new point with negated coordinates.
  */
 export const negative = (a, output = null) => {
   const result = output || new Point();
@@ -88,12 +88,12 @@ export const negative = (a, output = null) => {
 };
 
 /**
- * TBD.
- * @param {Point} a - TBD.
- * @param {Point} b - TBD.
- * @param {number} s - TBD.
- * @param {Point} output - TBD.
- * @returns {Point} TBD.
+ * Multiplies the second point by a scalar and adds it to the first point.
+ * @param {Point} a - The first point to add to.
+ * @param {Point} b - The second point to multiply by the scalar and add.
+ * @param {number} s - The scalar value to multiply the second point by.
+ * @param {Point} output - The point to store the result in (optional).
+ * @returns {Point} A new point with the result of the operation.
  */
 export const multiplyAdd = (a, b, s, output = null) => {
   const result = output || new Point();
@@ -101,12 +101,12 @@ export const multiplyAdd = (a, b, s, output = null) => {
 };
 
 /**
- * TBD.
- * @param {Point} a - TBD.
- * @param {Point} b - TBD.
- * @param {number} f - TBD.
- * @param {Point} output - TBD.
- * @returns {Point} TBD.
+ * Interpolates between two points at a given factor.
+ * @param {Point} a - The first point to interpolate from.
+ * @param {Point} b - The second point to interpolate to.
+ * @param {number} f - The interpolation factor (0-1).
+ * @param {Point} output - The point to store the result in (optional).
+ * @returns {Point} A new point interpolated between the two points.
  */
 export const interpolate = (a, b, f, output = null) => {
   const result = output || new Point();
@@ -114,10 +114,10 @@ export const interpolate = (a, b, f, output = null) => {
 };
 
 /**
- * TBD.
- * @param {Point} a - TBD.
- * @param {Point} output - TBD.
- * @returns {Point} TBD.
+ * Returns a perpendicular point (rotated 90 degrees counter-clockwise).
+ * @param {Point} a - The point to calculate the perpendicular for.
+ * @param {Point} output - The point to store the result in (optional).
+ * @returns {Point} A new point that is perpendicular to the input point.
  */
 export const perp = (a, output = null) => {
   const result = output || new Point();
@@ -125,10 +125,10 @@ export const perp = (a, output = null) => {
 };
 
 /**
- * TBD.
- * @param {Point} a - TBD.
- * @param {Point} output - TBD.
- * @returns {Point} TBD.
+ * Returns a perpendicular point (rotated 90 degrees clockwise).
+ * @param {Point} a - The point to calculate the perpendicular for.
+ * @param {Point} output - The point to store the result in (optional).
+ * @returns {Point} A new point that is perpendicular to the input point (rotated clockwise).
  */
 export const rperp = (a, output = null) => {
   const result = output || new Point();
@@ -136,11 +136,11 @@ export const rperp = (a, output = null) => {
 };
 
 /**
- * TBD.
- * @param {Point} a - TBD.
- * @param {Point} b - TBD.
- * @param {boolean} round - TBD.
- * @returns {number} TBD.
+ * Calculates the distance between two points.
+ * @param {Point} a - The first point to calculate the distance from.
+ * @param {Point} b - The second point to calculate the distance to.
+ * @param {boolean} round - Whether to round the result (default: false).
+ * @returns {number} The distance between the two points.
  */
 export const distance = (a, b, round = false) => {
   const dx = a.x - b.x;
@@ -150,11 +150,11 @@ export const distance = (a, b, round = false) => {
 };
 
 /**
- * TBD.
- * @param {Point} a - TBD.
- * @param {Point} b - TBD.
- * @param {Point} output - TBD.
- * @returns {Point} TBD.
+ * Projects the first point onto the second point.
+ * @param {Point} a - The point to project.
+ * @param {Point} b - The point to project onto.
+ * @param {Point} output - The point to store the result in (optional).
+ * @returns {Point} A new point with the projected result.
  */
 export const project = (a, b, output = null) => {
   const result = output || new Point();
@@ -166,11 +166,11 @@ export const project = (a, b, output = null) => {
 };
 
 /**
- * TBD.
- * @param {Point} a - TBD.
- * @param {Point} b - TBD.
- * @param {Point} output - TBD.
- * @returns {Point} TBD.
+ * Projects the first point onto the unit vector of the second point.
+ * @param {Point} a - The point to project.
+ * @param {Point} b - The point to project onto (unit vector).
+ * @param {Point} output - The point to store the result in (optional).
+ * @returns {Point} A new point with the projected result.
  */
 export const projectUnit = (a, b, output = null) => {
   const result = output || new Point();
@@ -182,10 +182,10 @@ export const projectUnit = (a, b, output = null) => {
 };
 
 /**
- * TBD.
- * @param {Point} a - TBD.
- * @param {Point} output - TBD.
- * @returns {Point} TBD.
+ * Returns a point with the same direction as the input point but with y coordinate negated.
+ * @param {Point} a - The point to calculate the normal for.
+ * @param {Point} output - The point to store the result in (optional).
+ * @returns {Point} A new point with the same x coordinate but negated y coordinate.
  */
 export const normalRightHand = (a, output = null) => {
   const result = output || new Point();
@@ -193,10 +193,10 @@ export const normalRightHand = (a, output = null) => {
 };
 
 /**
- * TBD.
- * @param {Point} a - TBD.
- * @param {Point} output - TBD.
- * @returns {Point} TBD.
+ * Normalizes the input point to have a magnitude of 1 while preserving its direction.
+ * @param {Point} a - The point to normalize.
+ * @param {Point} output - The point to store the result in (optional).
+ * @returns {Point} A new normalized point.
  */
 export const normalize = (a, output = null) => {
   const result = output || new Point();
@@ -208,14 +208,14 @@ export const normalize = (a, output = null) => {
 };
 
 /**
- * TBD.
- * @param {Point} a - TBD.
- * @param {number} x - TBD.
- * @param {number} y - TBD.
- * @param {number} ang - TBD.
- * @param {boolean} asDegrees - TBD.
- * @param {number | null | undefined} dist - TBD.
- * @returns {Point} TBD.
+ * Rotates a point around another point by a given angle.
+ * @param {Point} a - The point to rotate.
+ * @param {number} x - The x coordinate of the center point to rotate around.
+ * @param {number} y - The y coordinate of the center point to rotate around.
+ * @param {number} ang - The angle in radians to rotate by.
+ * @param {boolean} asDegrees - Whether the angle is provided in degrees (default: false).
+ * @param {number | null | undefined} dist - The distance to rotate from (default: null).
+ * @returns {Point} The rotated point instance for chaining.
  */
 export const rotate = (a, x, y, ang, asDegrees, dist) => {
   if (asDegrees) {
@@ -238,11 +238,11 @@ export const rotate = (a, x, y, ang, asDegrees, dist) => {
 };
 
 /**
- * TBD.
- * @param {Point[]} points - TBD.
- * @param {Point} output - TBD.
- * @returns {Point} TBD.
- * @throws {Error}
+ * Calculates the centroid (average position) of a set of points.
+ * @param {Point[]} points - The array of points to calculate the centroid for.
+ * @param {Point} output - The point to store the result in (optional).
+ * @returns {Point} A new point representing the centroid of the input points.
+ * @throws {Error} If the points array is empty.
  */
 export const centroid = (points, output = null) => {
   const result = output || new Point();
@@ -262,11 +262,11 @@ export const centroid = (points, output = null) => {
 };
 
 /**
- * TBD.
- * @param {object} obj - TBD.
- * @param {string} xProp - TBD.
- * @param {string} yProp - TBD.
- * @returns {Point} TBD.
+ * Parses an object with x and y properties into a Point.
+ * @param {object} obj - The object to parse (must have x and y properties).
+ * @param {string} xProp - The name of the property containing the x value (default: 'x').
+ * @param {string} yProp - The name of the property containing the y value (default: 'y').
+ * @returns {Point} A new point with parsed x and y values.
  */
 export const parse = (obj, xProp = 'x', yProp = 'y') => {
   const point = new Point();
@@ -280,10 +280,10 @@ export const parse = (obj, xProp = 'x', yProp = 'y') => {
 };
 
 /**
- * TBD.
- * @param {Point} input - TBD.
- * @param {Point} output - TBD.
- * @returns {Point} TBD.
+ * Creates a clone of the input point.
+ * @param {Point} input - The point to clone.
+ * @param {Point} output - The point to store the result in (optional).
+ * @returns {Point} A new point with the same coordinates as the input.
  */
 export const clone = (input, output = null) => {
   const result = output || new Point();

package/src/phaser/geom/util/point.test.js

@@ -1,3 +1,4 @@
+import { expect } from 'vitest';
 import { Point } from '../point.js';
 import { clone } from './point.js';
 

package/src/phaser/geom/util/polygon.js

@@ -1,10 +1,10 @@
 import { Polygon } from '../polygon.js';
 
 /**
- * TBD.
- * @param {Polygon} input - TBD.
- * @param {Polygon} output - TBD.
- * @returns {Polygon} TBD.
+ * Clones a polygon.
+ * @param {Polygon} input - The polygon to clone.
+ * @param {Polygon} output - Optional polygon to store the result in.
+ * @returns {Polygon} The cloned polygon.
  */
 export const clone = (input, output = null) => {
   const result = output || new Polygon();

package/src/phaser/geom/util/polygon.test.js

@@ -1,3 +1,4 @@
+import { expect } from 'vitest';
 import { Polygon } from '../polygon.js';
 import { clone } from './polygon.js';