@vpmedia/phaser 1.112.0 → 1.113.0

package/src/phaser/core/tween_easing.test.ts

@@ -0,0 +1,106 @@
+import { describe, expect, it } from 'vitest';
+import * as Easing from './tween_easing.js';
+
+const SAMPLE_POINTS = [0, 0.1, 0.25, 0.4, 0.5, 0.6, 0.75, 0.9, 1];
+
+const EXPECTED: Record<string, number[]> = {
+  BackIn: [
+    -0, -0.014314220000000002, -0.06413656250000001, -0.09935168000000003, -0.08769750000000004, -0.02902752000000009,
+    0.1825903124999999, 0.5911720199999999, 0.9999999999999998,
+  ],
+  BackInOut: [
+    -0, -0.037518552000000004, -0.09968184375, 0.0899257920000001, 0.5, 0.9100742079999999, 1.09968184375,
+    1.0375185519999999, 1,
+  ],
+  BackOut: [
+    2.220446049250313e-16, 0.4088279800000001, 0.8174096875000001, 1.02902752, 1.0876975, 1.09935168, 1.0641365625,
+    1.01431422, 1,
+  ],
+  BounceIn: [
+    0, 0.01187500000000008, 0.02734375, 0.22750000000000004, 0.234375, 0.09000000000000019, 0.52734375,
+    0.9243750000000001, 1,
+  ],
+  BounceInOut: [0, 0.030000000000000027, 0.1171875, 0.34875000000000006, 0.5, 0.6512499999999999, 0.8828125, 0.97, 1],
+  BounceOut: [
+    0, 0.07562500000000001, 0.47265625, 0.9099999999999998, 0.765625, 0.7725, 0.97265625, 0.9881249999999999, 1,
+  ],
+  CircularIn: [
+    0, 0.005012562893380035, 0.031754163448145745, 0.08348486100883201, 0.1339745962155614, 0.19999999999999996,
+    0.3385621722338523, 0.5641101056459328, 1,
+  ],
+  CircularInOut: [
+    -0, 0.010102051443364402, 0.0669872981077807, 0.20000000000000007, 0.5, 0.7999999999999999, 0.9330127018922193,
+    0.9898979485566356, 1,
+  ],
+  CircularOut: [
+    0, 0.4358898943540673, 0.6614378277661477, 0.8, 0.8660254037844386, 0.916515138991168, 0.9682458365518543,
+    0.99498743710662, 1,
+  ],
+  CubicIn: [0, 0.0010000000000000002, 0.015625, 0.06400000000000002, 0.125, 0.216, 0.421875, 0.7290000000000001, 1],
+  CubicInOut: [0, 0.004000000000000001, 0.0625, 0.25600000000000006, 0.5, 0.744, 0.9375, 0.996, 1],
+  CubicOut: [0, 0.2709999999999999, 0.578125, 0.784, 0.875, 0.9359999999999999, 0.984375, 0.999, 1],
+  ElasticIn: [
+    0, 1.1959441397923372e-18, 0.0039062499999999952, -0.015625, 1.1481063742006436e-17, 0.0625, -0.12500000000000003,
+    6.123233995736767e-17, 1,
+  ],
+  ElasticInOut: [0, 0.001953125, 5.740531871003218e-18, -0.12500000000000003, 0.5, 1.125, 1, 0.998046875, 1],
+  ElasticOut: [0, 1, 1.125, 0.9375, 1, 1.015625, 0.99609375, 1, 1],
+  ExponentialIn: [
+    0, 0.0019531249999999998, 0.005524271728019903, 0.015625000000000003, 0.03125, 0.06249999999999999,
+    0.1767766952966369, 0.5000000000000001, 1,
+  ],
+  ExponentialInOut: [0, 0.0019531249999999993, 0.015625, 0.12500000000000003, 0.5, 0.875, 0.984375, 0.998046875, 1],
+  ExponentialOut: [0, 0.5, 0.8232233047033631, 0.9375, 0.96875, 0.984375, 0.99447572827198, 0.998046875, 1],
+  LinearNone: [0, 0.1, 0.25, 0.4, 0.5, 0.6, 0.75, 0.9, 1],
+  QuadraticIn: [0, 0.010000000000000002, 0.0625, 0.16000000000000003, 0.25, 0.36, 0.5625, 0.81, 1],
+  QuadraticInOut: [0, 0.020000000000000004, 0.125, 0.32000000000000006, 0.5, 0.6799999999999999, 0.875, 0.98, 1],
+  QuadraticOut: [0, 0.19, 0.4375, 0.6400000000000001, 0.75, 0.84, 0.9375, 0.9900000000000001, 1],
+  QuarticIn: [
+    0, 0.00010000000000000003, 0.00390625, 0.025600000000000008, 0.0625, 0.1296, 0.31640625, 0.6561000000000001, 1,
+  ],
+  QuarticInOut: [0, 0.0008000000000000003, 0.03125, 0.20480000000000007, 0.5, 0.7951999999999999, 0.96875, 0.9992, 1],
+  QuarticOut: [0, 0.3438999999999999, 0.68359375, 0.8704000000000001, 0.9375, 0.9744, 0.99609375, 0.9999, 1],
+  QuinticIn: [
+    0, 0.000010000000000000004, 0.0009765625, 0.010240000000000004, 0.03125, 0.07776, 0.2373046875, 0.5904900000000002,
+    1,
+  ],
+  QuinticInOut: [
+    0, 0.00016000000000000007, 0.015625, 0.16384000000000007, 0.5, 0.8361599999999999, 0.984375, 0.99984, 1,
+  ],
+  QuinticOut: [0, 0.4095099999999998, 0.7626953125, 0.92224, 0.96875, 0.98976, 0.9990234375, 0.99999, 1],
+  SinusoidalIn: [
+    0, 0.01231165940486223, 0.07612046748871326, 0.19098300562505255, 0.2928932188134524, 0.41221474770752686,
+    0.6173165676349102, 0.843565534959769, 1,
+  ],
+  SinusoidalInOut: [
+    0, 0.024471741852423234, 0.1464466094067262, 0.3454915028125263, 0.49999999999999994, 0.6545084971874737,
+    0.8535533905932737, 0.9755282581475768, 1,
+  ],
+  SinusoidalOut: [
+    0, 0.15643446504023087, 0.3826834323650898, 0.5877852522924731, 0.7071067811865475, 0.8090169943749475,
+    0.9238795325112867, 0.9876883405951378, 1,
+  ],
+};
+
+describe('tween_easing', () => {
+  it.each(Object.keys(EXPECTED))('%s matches its reference curve', (name) => {
+    const fn = (Easing as unknown as Record<string, (k: number) => number>)[name]!;
+    const actual = SAMPLE_POINTS.map((k) => fn(k));
+    actual.forEach((value, index) => {
+      expect(value).toBeCloseTo(EXPECTED[name]![index]!, 12);
+    });
+  });
+
+  it.each(Object.keys(EXPECTED))('%s is anchored at both ends', (name) => {
+    const fn = (Easing as unknown as Record<string, (k: number) => number>)[name]!;
+    expect(fn(0)).toBeCloseTo(0, 12);
+    expect(fn(1)).toBeCloseTo(1, 12);
+  });
+
+  it.each(Object.keys(EXPECTED))('%s does not mutate beyond its return value', (name) => {
+    const fn = (Easing as unknown as Record<string, (k: number) => number>)[name]!;
+    SAMPLE_POINTS.forEach((k) => {
+      expect(fn(k)).toBe(fn(k));
+    });
+  });
+});

package/src/phaser/core/tween_easing.ts

@@ -3,36 +3,34 @@
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const LinearNone = (k: number) => {
-  return k;
-};
+export const LinearNone = (k: number): number => k;
 
 /**
  * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const QuadraticIn = (k: number) => {
-  return k * k;
-};
+export const QuadraticIn = (k: number): number => k * k;
 
 /**
  * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const QuadraticOut = (k: number) => {
-  return k * (2 - k);
-};
+export const QuadraticOut = (k: number): number => k * (2 - k);
 
 /**
  * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const QuadraticInOut = (k: number) => {
-  if ((k *= 2) < 1) return 0.5 * k * k;
-  return -0.5 * (--k * (k - 2) - 1);
+export const QuadraticInOut = (k: number): number => {
+  const t = k * 2;
+  if (t < 1) {
+    return 0.5 * t * t;
+  }
+  const u = t - 1;
+  return -0.5 * (u * (u - 2) - 1);
 };
 
 /**
@@ -40,17 +38,16 @@ export const QuadraticInOut = (k: number) => {
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const CubicIn = (k: number) => {
-  return k * k * k;
-};
+export const CubicIn = (k: number): number => k * k * k;
 
 /**
  * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const CubicOut = (k: number) => {
-  return --k * k * k + 1;
+export const CubicOut = (k: number): number => {
+  const u = k - 1;
+  return u * u * u + 1;
 };
 
 /**
@@ -58,9 +55,13 @@ export const CubicOut = (k: number) => {
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const CubicInOut = (k: number) => {
-  if ((k *= 2) < 1) return 0.5 * k * k * k;
-  return 0.5 * ((k -= 2) * k * k + 2);
+export const CubicInOut = (k: number): number => {
+  const t = k * 2;
+  if (t < 1) {
+    return 0.5 * t * t * t;
+  }
+  const u = t - 2;
+  return 0.5 * (u * u * u + 2);
 };
 
 /**
@@ -68,17 +69,16 @@ export const CubicInOut = (k: number) => {
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const QuarticIn = (k: number) => {
-  return k * k * k * k;
-};
+export const QuarticIn = (k: number): number => k * k * k * k;
 
 /**
  * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const QuarticOut = (k: number) => {
-  return 1 - --k * k * k * k;
+export const QuarticOut = (k: number): number => {
+  const u = k - 1;
+  return 1 - u * u * u * u;
 };
 
 /**
@@ -86,9 +86,13 @@ export const QuarticOut = (k: number) => {
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const QuarticInOut = (k: number) => {
-  if ((k *= 2) < 1) return 0.5 * k * k * k * k;
-  return -0.5 * ((k -= 2) * k * k * k - 2);
+export const QuarticInOut = (k: number): number => {
+  const t = k * 2;
+  if (t < 1) {
+    return 0.5 * t * t * t * t;
+  }
+  const u = t - 2;
+  return -0.5 * (u * u * u * u - 2);
 };
 
 /**
@@ -96,17 +100,16 @@ export const QuarticInOut = (k: number) => {
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const QuinticIn = (k: number) => {
-  return k * k * k * k * k;
-};
+export const QuinticIn = (k: number): number => k * k * k * k * k;
 
 /**
  * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const QuinticOut = (k: number) => {
-  return --k * k * k * k * k + 1;
+export const QuinticOut = (k: number): number => {
+  const u = k - 1;
+  return u * u * u * u * u + 1;
 };
 
 /**
@@ -114,9 +117,13 @@ export const QuinticOut = (k: number) => {
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const QuinticInOut = (k: number) => {
-  if ((k *= 2) < 1) return 0.5 * k * k * k * k * k;
-  return 0.5 * ((k -= 2) * k * k * k * k + 2);
+export const QuinticInOut = (k: number): number => {
+  const t = k * 2;
+  if (t < 1) {
+    return 0.5 * t * t * t * t * t;
+  }
+  const u = t - 2;
+  return 0.5 * (u * u * u * u * u + 2);
 };
 
 /**
@@ -124,9 +131,13 @@ export const QuinticInOut = (k: number) => {
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const SinusoidalIn = (k: number) => {
-  if (k === 0) return 0;
-  if (k === 1) return 1;
+export const SinusoidalIn = (k: number): number => {
+  if (k === 0) {
+    return 0;
+  }
+  if (k === 1) {
+    return 1;
+  }
   return 1 - Math.cos((k * Math.PI) / 2);
 };
 
@@ -135,9 +146,13 @@ export const SinusoidalIn = (k: number) => {
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const SinusoidalOut = (k: number) => {
-  if (k === 0) return 0;
-  if (k === 1) return 1;
+export const SinusoidalOut = (k: number): number => {
+  if (k === 0) {
+    return 0;
+  }
+  if (k === 1) {
+    return 1;
+  }
   return Math.sin((k * Math.PI) / 2);
 };
 
@@ -146,9 +161,13 @@ export const SinusoidalOut = (k: number) => {
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const SinusoidalInOut = (k: number) => {
-  if (k === 0) return 0;
-  if (k === 1) return 1;
+export const SinusoidalInOut = (k: number): number => {
+  if (k === 0) {
+    return 0;
+  }
+  if (k === 1) {
+    return 1;
+  }
   return 0.5 * (1 - Math.cos(Math.PI * k));
 };
 
@@ -157,29 +176,32 @@ export const SinusoidalInOut = (k: number) => {
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const ExponentialIn = (k: number) => {
-  return k === 0 ? 0 : Math.pow(1024, k - 1);
-};
+export const ExponentialIn = (k: number): number => (k === 0 ? 0 : 1024 ** (k - 1));
 
 /**
  * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const ExponentialOut = (k: number) => {
-  return k === 1 ? 1 : 1 - Math.pow(2, -10 * k);
-};
+export const ExponentialOut = (k: number): number => (k === 1 ? 1 : 1 - 2 ** (-10 * k));
 
 /**
  * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const ExponentialInOut = (k: number) => {
-  if (k === 0) return 0;
-  if (k === 1) return 1;
-  if ((k *= 2) < 1) return 0.5 * Math.pow(1024, k - 1);
-  return 0.5 * (-Math.pow(2, -10 * (k - 1)) + 2);
+export const ExponentialInOut = (k: number): number => {
+  if (k === 0) {
+    return 0;
+  }
+  if (k === 1) {
+    return 1;
+  }
+  const t = k * 2;
+  if (t < 1) {
+    return 0.5 * 1024 ** (t - 1);
+  }
+  return 0.5 * (-(2 ** (-10 * (t - 1))) + 2);
 };
 
 /**
@@ -187,17 +209,16 @@ export const ExponentialInOut = (k: number) => {
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const CircularIn = (k: number) => {
-  return 1 - Math.sqrt(1 - k * k);
-};
+export const CircularIn = (k: number): number => 1 - Math.sqrt(1 - k * k);
 
 /**
  * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const CircularOut = (k: number) => {
-  return Math.sqrt(1 - --k * k);
+export const CircularOut = (k: number): number => {
+  const u = k - 1;
+  return Math.sqrt(1 - u * u);
 };
 
 /**
@@ -205,29 +226,33 @@ export const CircularOut = (k: number) => {
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const CircularInOut = (k: number) => {
-  if ((k *= 2) < 1) return -0.5 * (Math.sqrt(1 - k * k) - 1);
-  return 0.5 * (Math.sqrt(1 - (k -= 2) * k) + 1);
+export const CircularInOut = (k: number): number => {
+  const t = k * 2;
+  if (t < 1) {
+    return -0.5 * (Math.sqrt(1 - t * t) - 1);
+  }
+  const u = t - 2;
+  return 0.5 * (Math.sqrt(1 - u * u) + 1);
 };
 
+const ELASTIC_AMPLITUDE = 1;
+const ELASTIC_PERIOD = 0.4;
+const ELASTIC_PHASE = ELASTIC_PERIOD / 4;
+
 /**
  * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const ElasticIn = (k: number) => {
-  let s;
-  let a = 0.1;
-  const p = 0.4;
-  if (k === 0) return 0;
-  if (k === 1) return 1;
-  if (!a || a < 1) {
-    a = 1;
-    s = p / 4;
-  } else {
-    s = (p * Math.asin(1 / a)) / (2 * Math.PI);
+export const ElasticIn = (k: number): number => {
+  if (k === 0) {
+    return 0;
+  }
+  if (k === 1) {
+    return 1;
   }
-  return -(a * Math.pow(2, 10 * (k -= 1)) * Math.sin(((k - s) * (2 * Math.PI)) / p));
+  const u = k - 1;
+  return -(ELASTIC_AMPLITUDE * 2 ** (10 * u) * Math.sin(((u - ELASTIC_PHASE) * (2 * Math.PI)) / ELASTIC_PERIOD));
 };
 
 /**
@@ -235,19 +260,14 @@ export const ElasticIn = (k: number) => {
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const ElasticOut = (k: number) => {
-  let s;
-  let a = 0.1;
-  const p = 0.4;
-  if (k === 0) return 0;
-  if (k === 1) return 1;
-  if (!a || a < 1) {
-    a = 1;
-    s = p / 4;
-  } else {
-    s = (p * Math.asin(1 / a)) / (2 * Math.PI);
+export const ElasticOut = (k: number): number => {
+  if (k === 0) {
+    return 0;
   }
-  return a * Math.pow(2, -10 * k) * Math.sin(((k - s) * (2 * Math.PI)) / p) + 1;
+  if (k === 1) {
+    return 1;
+  }
+  return ELASTIC_AMPLITUDE * 2 ** (-10 * k) * Math.sin(((k - ELASTIC_PHASE) * (2 * Math.PI)) / ELASTIC_PERIOD) + 1;
 };
 
 /**
@@ -255,40 +275,40 @@ export const ElasticOut = (k: number) => {
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const ElasticInOut = (k: number) => {
-  let s;
-  let a = 0.1;
-  const p = 0.4;
-  if (k === 0) return 0;
-  if (k === 1) return 1;
-  if (!a || a < 1) {
-    a = 1;
-    s = p / 4;
-  } else {
-    s = (p * Math.asin(1 / a)) / (2 * Math.PI);
+export const ElasticInOut = (k: number): number => {
+  if (k === 0) {
+    return 0;
+  }
+  if (k === 1) {
+    return 1;
   }
-  if ((k *= 2) < 1) return -0.5 * (a * Math.pow(2, 10 * (k -= 1)) * Math.sin(((k - s) * (2 * Math.PI)) / p));
-  return a * Math.pow(2, -10 * (k -= 1)) * Math.sin(((k - s) * (2 * Math.PI)) / p) * 0.5 + 1;
+  const t = k * 2;
+  const u = t - 1;
+  const oscillation = Math.sin(((u - ELASTIC_PHASE) * (2 * Math.PI)) / ELASTIC_PERIOD);
+  if (t < 1) {
+    return -0.5 * (ELASTIC_AMPLITUDE * 2 ** (10 * u) * oscillation);
+  }
+  return ELASTIC_AMPLITUDE * 2 ** (-10 * u) * oscillation * 0.5 + 1;
 };
 
+const BACK_OVERSHOOT = 1.70158;
+const BACK_OVERSHOOT_IN_OUT = BACK_OVERSHOOT * 1.525;
+
 /**
  * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const BackIn = (k: number) => {
-  const s = 1.70158;
-  return k * k * ((s + 1) * k - s);
-};
+export const BackIn = (k: number): number => k * k * ((BACK_OVERSHOOT + 1) * k - BACK_OVERSHOOT);
 
 /**
  * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const BackOut = (k: number) => {
-  const s = 1.70158;
-  return --k * k * ((s + 1) * k + s) + 1;
+export const BackOut = (k: number): number => {
+  const u = k - 1;
+  return u * u * ((BACK_OVERSHOOT + 1) * u + BACK_OVERSHOOT) + 1;
 };
 
 /**
@@ -296,10 +316,13 @@ export const BackOut = (k: number) => {
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const BackInOut = (k: number) => {
-  const s = 1.70158 * 1.525;
-  if ((k *= 2) < 1) return 0.5 * (k * k * ((s + 1) * k - s));
-  return 0.5 * ((k -= 2) * k * ((s + 1) * k + s) + 2);
+export const BackInOut = (k: number): number => {
+  const t = k * 2;
+  if (t < 1) {
+    return 0.5 * (t * t * ((BACK_OVERSHOOT_IN_OUT + 1) * t - BACK_OVERSHOOT_IN_OUT));
+  }
+  const u = t - 2;
+  return 0.5 * (u * u * ((BACK_OVERSHOOT_IN_OUT + 1) * u + BACK_OVERSHOOT_IN_OUT) + 2);
 };
 
 /**
@@ -307,15 +330,20 @@ export const BackInOut = (k: number) => {
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const BounceOut = (k: number) => {
+export const BounceOut = (k: number): number => {
   if (k < 1 / 2.75) {
     return 7.5625 * k * k;
-  } else if (k < 2 / 2.75) {
-    return 7.5625 * (k -= 1.5 / 2.75) * k + 0.75;
-  } else if (k < 2.5 / 2.75) {
-    return 7.5625 * (k -= 2.25 / 2.75) * k + 0.9375;
   }
-  return 7.5625 * (k -= 2.625 / 2.75) * k + 0.984375;
+  if (k < 2 / 2.75) {
+    const u = k - 1.5 / 2.75;
+    return 7.5625 * u * u + 0.75;
+  }
+  if (k < 2.5 / 2.75) {
+    const u = k - 2.25 / 2.75;
+    return 7.5625 * u * u + 0.9375;
+  }
+  const u = k - 2.625 / 2.75;
+  return 7.5625 * u * u + 0.984375;
 };
 
 /**
@@ -323,16 +351,16 @@ export const BounceOut = (k: number) => {
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const BounceIn = (k: number) => {
-  return 1 - BounceOut(1 - k);
-};
+export const BounceIn = (k: number): number => 1 - BounceOut(1 - k);
 
 /**
  * TBD.
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
-export const BounceInOut = (k: number) => {
-  if (k < 0.5) return BounceIn(k * 2) * 0.5;
+export const BounceInOut = (k: number): number => {
+  if (k < 0.5) {
+    return BounceIn(k * 2) * 0.5;
+  }
   return BounceOut(k * 2 - 1) * 0.5 + 0.5;
 };