@inglorious/engine 0.2.0 → 0.4.0

package/src/utils/physics/friction.js

@@ -1,28 +0,0 @@
-/**
- * @typedef {import('@inglorious/utils/math/linear-algebra/types').Vector3} Vector3
- */
-
-import {
-  magnitude,
-  setMagnitude,
-  zero,
-} from "@inglorious/utils/math/linear-algebra/vector.js"
-
-const DEFAULT_DT = 1 // Default time delta for the applyFriction function.
-const NO_FRICTION = 0 // No friction constant.
-
-/**
- * Applies friction to a given velocity vector.
- *
- * @param {Object} params - The parameters for the function.
- * @param {Vector3} params.velocity - The velocity vector. Defaults to a zero vector.
- * @param {number} params.friction - The friction coefficient. Defaults to 0.
- * @param {number} dt - The time delta for the calculation. Defaults to 1.
- * @returns {Vector3} - The updated velocity vector after applying friction.
- */
-export function applyFriction(params, dt = DEFAULT_DT) {
-  let { velocity = zero(), friction = NO_FRICTION } = params
-  const length = magnitude(velocity)
-
-  return length ? setMagnitude(velocity, length - friction * dt) : velocity
-}

package/src/utils/physics/friction.test.js

@@ -1,42 +0,0 @@
-import { expect, test } from "vitest"
-
-import { zero } from "../math/linear-algebra/vector.js"
-import { applyFriction } from "./friction.js"
-
-test("it should apply friction to some velocity", () => {
-  const velocity = [8, 0, 6]
-  const friction = 5
-  const expectedResult = [4, 0, 3]
-
-  expect(applyFriction({ velocity, friction })).toStrictEqual(expectedResult)
-})
-
-test("it should stop movement when friction is equal to velocity", () => {
-  const velocity = [8, 0, 6]
-  const friction = 5
-  const dt = 2
-
-  expect(applyFriction({ velocity, friction }, dt)).toStrictEqual(zero())
-})
-
-test("it should apply no friction on no velocity", () => {
-  const velocity = zero()
-  const friction = 5
-
-  expect(applyFriction({ velocity, friction })).toBe(velocity)
-})
-
-test("it should apply no friction if no friction is passed", () => {
-  const velocity = [8, 0, 6]
-  const friction = 0
-
-  expect(applyFriction({ velocity, friction })).toStrictEqual(velocity)
-})
-
-test("it should apply no friction if no time passed", () => {
-  const velocity = [8, 0, 6]
-  const friction = 5
-  const dt = 0
-
-  expect(applyFriction({ velocity, friction }, dt)).toStrictEqual(velocity)
-})

package/src/utils/physics/gravity.js

@@ -1,69 +0,0 @@
-/**
- * @typedef {import('@inglorious/utils/math/linear-algebra/types').Vector3} Vector3
- */
-
-/* eslint-disable no-magic-numbers */
-
-import { zero } from "@inglorious/utils/math/linear-algebra/vector.js"
-
-const DEFAULT_DT = 1 // Default delta time for the applyGravity function.
-const DEFAULT_JUMP = 0 // Default maximum jump height.
-const DEFAULT_LEAP = 0 // Default maximum leap distance.
-const DEFAULT_SPEED = 0 // Default maximum speed.
-const NO_VELOCITY = 0 // No initial velocity.
-
-/**
- * Applies gravity to an object based on its current velocity and position.
- *
- * @see https://youtu.be/hG9SzQxaCm8
- *
- * Projectile equations:
- * 1. a(t) = g
- * 2. v(t) = g*t + v_0
- * 3. y(t) = 1/2*g*t^2 + v_0*t + y_0
- *
- * Known values:
- * 1. y_0 = 0
- * 2. v(t_h) = 0 -> 2. 0 = g*t_h + v_0 -> v_0 = -g*t_h
- * 3. y_h = h -> 3. h = 1/2*g*t_h^2 (-g*t_h)*t_h = -1/2*g*t_h^2 -> g = -2*h/t_h^2
- * 4. v_0 = -g*t_h = (-2*h/t_h^2)*t_h = 2*h/t_h
- *
- * Transforming time into space:
- * 1. t_h = x_h/v_x
- * 2. v0 = 2*h/t_h = 2*h*v_x/x_h
- * 3. g = -2*h/t_h^2 = -2*h*v_x^2/x_h^2
- *
- * Euler's Integration:
- * 1. v += a * dt
- * 2. p += v * dt + 1/2 * a * dt * dt
- *
- * @param {Object} params - Parameters for gravity calculation.
- * @param {number} params.maxJump - Maximum jump height. Defaults to 0.
- * @param {number} params.maxLeap - Maximum leap distance. Defaults to 0.
- * @param {number} params.maxSpeed - Maximum speed. Defaults to 0.
- * @param {number} params.vy - Current vertical velocity. Defaults to 0.
- * @param {Vector3} params.position - Current position vector. Defaults to a zero vector.
- * @param {number} dt - Time delta for the calculation. Defaults to 1.
- * @returns {Object} Updated acceleration, velocity, and position.
- * @throws {Error} If maxLeap is not provided.
- */
-export function applyGravity(params, dt = DEFAULT_DT) {
-  let {
-    maxJump = DEFAULT_JUMP,
-    maxLeap = DEFAULT_LEAP,
-    maxSpeed = DEFAULT_SPEED,
-    vy = NO_VELOCITY,
-    position = zero(),
-  } = params
-
-  if (!maxLeap) {
-    throw new Error("Missing maxLeap")
-  }
-
-  const ay = (-2 * maxJump * maxSpeed ** 2) / maxLeap ** 2
-  vy += ay * dt
-  const [x, y, z] = position
-  const py = y + vy * dt + 0.5 * ay * dt * dt
-
-  return { ay, vy, position: [x, py, z] }
-}

package/src/utils/physics/gravity.test.js

@@ -1,77 +0,0 @@
-import { expect, test } from "vitest"
-
-import { applyGravity } from "./gravity.js"
-
-test("it should apply gravity based on input parameters", () => {
-  const params = {
-    maxJump: 10,
-    maxLeap: 10,
-    maxSpeed: 10,
-    vy: 10,
-    position: [0, 10, 0],
-  }
-
-  expect(applyGravity(params)).toStrictEqual({
-    ay: -20,
-    vy: -10,
-    position: [0, -10, 0],
-  })
-})
-
-test("it should compute no gravity when max jump height is not set", () => {
-  const params = {
-    maxLeap: 10,
-    maxSpeed: 10,
-    vy: 10,
-    position: [0, 10, 0],
-  }
-
-  expect(applyGravity(params)).toStrictEqual({
-    ay: -0,
-    vy: 10,
-    position: [0, 20, 0],
-  })
-})
-
-test("it should compute no gravity when max movement speed is not set", () => {
-  const params = {
-    maxJump: 10,
-    maxLeap: 10,
-    vy: 10,
-    position: [0, 10, 0],
-  }
-
-  expect(applyGravity(params)).toStrictEqual({
-    ay: -0,
-    vy: 10,
-    position: [0, 20, 0],
-  })
-})
-
-test("it should apply no gravity when no time has passed", () => {
-  const params = {
-    maxJump: 10,
-    maxLeap: 10,
-    maxSpeed: 10,
-    vy: 10,
-    position: [0, 10, 0],
-  }
-  const dt = 0
-
-  expect(applyGravity(params, dt)).toStrictEqual({
-    ay: -20,
-    vy: 10,
-    position: [0, 10, 0],
-  })
-})
-
-test("it should throw an error when max leap distance is not set", () => {
-  const params = {
-    maxJump: 10,
-    maxSpeed: 10,
-    vy: 10,
-    position: [0, 10, 0],
-  }
-
-  expect(() => applyGravity(params)).toThrow()
-})

package/src/utils/physics/jump.js

@@ -1,31 +0,0 @@
-/**
- * @typedef {import('@inglorious/utils/math/linear-algebra/types').Vector3} Vector3
- */
-
-/* eslint-disable no-magic-numbers */
-
-const DEFAULT_MAX_JUMP = 0 // Default maximum jump height.
-const DEFAULT_MAX_LEAP = 0 // Default maximum leap distance.
-const DEFAULT_MAX_SPEED = 0 // Default maximum speed.
-
-/**
- * Calculates the vertical velocity (vy) of a jump
- * based on the provided parameters.
- *
- * @param {Object} params - Parameters for the jump calculation.
- * @param {number} params.maxJump - Maximum jump height. Defaults to 0.
- * @param {number} params.maxLeap - Maximum leap distance. Defaults to 0.
- * @param {number} params.maxSpeed - Maximum speed. Defaults to 0.
- * @returns {number} The computed vertical velocity (vy).
- */
-export function jump(params) {
-  let {
-    maxJump = DEFAULT_MAX_JUMP,
-    maxLeap = DEFAULT_MAX_LEAP,
-    maxSpeed = DEFAULT_MAX_SPEED,
-  } = params
-
-  const vy = (2 * maxJump * maxSpeed) / maxLeap
-
-  return vy
-}

package/src/utils/physics/velocity.js

@@ -1,36 +0,0 @@
-/**
- * @typedef {import('@inglorious/utils/math/linear-algebra/types').Vector3} Vector3
- */
-
-import {
-  clamp,
-  multiply,
-  zero,
-} from "@inglorious/utils/math/linear-algebra/vector.js"
-import { sum } from "@inglorious/utils/math/linear-algebra/vectors.js"
-
-const DEFAULT_DT = 1 // Default time delta for the applyVelocity function.
-const DEFAULT_MAX_SPEED = 0 // Default maximum speed for velocity clamping.
-
-/**
- * Applies velocity to a position based on the given parameters and options.
- *
- * @param {Object} params - The parameters for velocity application.
- * @param {number} [params.maxSpeed] - The maximum speed for clamping the velocity. Defaults to 0.
- * @param {Vector3} [params.velocity] - The current velocity vector. Defaults to a zero vector.
- * @param {Vector3} [params.position] - The current position vector. Defaults to a zero vector.
- * @param {number} [dt=0] - The time delta for the calculation. Defaults to 0.
- * @returns {Object} The updated velocity and position.
- */
-export function applyVelocity(params, dt = DEFAULT_DT) {
-  let {
-    maxSpeed = DEFAULT_MAX_SPEED,
-    velocity = zero(),
-    position = zero(),
-  } = params
-
-  velocity = clamp(velocity, -maxSpeed, maxSpeed)
-
-  position = sum(position, multiply(velocity, dt))
-  return { velocity, position }
-}