@inglorious/engine 0.1.0 → 0.1.1

package/src/docs/utils/math/linear-algebra/vector.mdx

@@ -1,177 +0,0 @@
-import { Meta } from '@storybook/blocks'
-
-import {
-angle,
-clamp,
-conjugate,
-divide,
-fromAngle,
-magnitude,
-mod,
-multiply,
-normalize,
-rotate,
-setAngle,
-setMagnitude,
-shift,
-toCartesian,
-toCylindrical,
-toPolar,
-toString,
-unit,
-} from '@inglorious/utils/math/linear-algebra/vector'
-import { pi, cos, sin } from '@inglorious/utils/math/trigonometry'
-
-<Meta title="Utils/Math/Linear Algebra/Vector" />
-
-# Vector
-
-Functions that deal with a single vector.
-
-## Angle
-
-Returns the angle of a vector, calculated as the `atan2` between the last and first coordinate.
-
-<code>angle([1, 1]) == {angle([1, 1]).toFixed(3)}</code> (&asymp;&pi;/4)
-
-<code>angle([1, 0, 1]) == {angle([1, 0, 1]).toFixed(3)}</code> (&asymp;&pi;/4)
-
-## Clamp
-
-Limits the magnitude of a vector to a lower and upper bound.
-
-<code>clamp([6, 8], 0, 5) == {toString(clamp([6, 8], 0, 5))}</code>&nbsp;
-
-<code>clamp([3, 4], 0, 5) == {toString(clamp([3, 4], 0, 5))}</code>&nbsp;
-
-Bounds can be specified as other vectors too.
-
-<code>clamp([6, 8], [0, 0], [3, 4]) == {toString(clamp([6, 8], [0, 0], [3, 4]))}</code>&nbsp;
-
-## Conjugate
-
-Flips the sign of all coordinates except the first one.
-
-<code>conjugate([1, 2, 3]) == {toString(conjugate([1, 2, 3]))}</code>&nbsp;
-
-## Divide
-
-Divides any vector by a scalar.
-
-<code>divide([4, 8, 12], 4) == {toString(divide([4, 8, 12], 4))}</code>&nbsp;
-
-## From Angle
-
-Creates a 3D unit vector from a given angle.
-
-<code>fromAngle(pi() / 4) == {toString(fromAngle(pi() / 4))}</code>&nbsp;
-
-## Length
-
-Alias of `magnitude`.
-
-## Magnitude
-
-Computes the magnitude of any vector (alias `length`).
-
-<code>magnitude([3, 4]) == {magnitude([3, 4])}</code>&nbsp;
-
-## Mod
-
-Applies the `mod` operator on any vector (alias `remainder`).
-
-<code>mod([10, 12, -18], 12) == {toString(mod([10, 12, -18], 12))}</code>&nbsp;
-
-## Multiply
-
-Multiplies a vector with a scalar (alias `times`).
-
-<code>multiply([1, 2, 3], 4) == {toString(multiply([1, 2, 3], 4))}</code>&nbsp;
-
-## Normalize
-
-Gives the vector unit length while maintaining its angle.
-
-<code>normalize([3, 4]) == {toString(normalize([3, 4]), 1)}</code>&nbsp;
-
-<code>normalize([-3, -4]) == {toString(normalize([-3, -4]), 1)}</code>&nbsp;
-
-## Remainder
-
-Alias of `mod`.
-
-## Rotate
-
-Adds the given angle to a 2D or 3D vector using quaternions.
-
-<code>rotate([1, 0], 0) == {toString(rotate([1, 0], 0))}</code>&nbsp;
-
-<code>rotate([1, 0], pi() / 4) == {toString(rotate([1, 0], pi() / 4), 3)}</code> (&asymp;[cos(&pi;/4), sin(&pi;/4)])
-
-<code>rotate([1, 0, 0], 0) == {toString(rotate([1, 0, 0], 0))}</code>&nbsp;
-
-<code>rotate([1, 0, 0], pi() / 4) == {toString(rotate([1, 0, 0], pi() / 4), 3)}</code> (&asymp;[cos(&pi;/4), 0, sin(&pi;/4)])
-
-<code>rotate([-1, 0, 0], pi() / 4) == {toString(rotate([-1, 0, 0], pi() / 4), 3)}</code> (&asymp;[cos(-3/4*&pi;), 0, sin(-3/4*&pi;)])
-
-## Set Angle
-
-Changes the angle of a vector.
-
-<code>setAngle([cos(pi() / 4), 0, sin(pi() / 4)], pi() / 2) == {toString(setAngle([cos(pi() / 4), 0, sin(pi() / 4)], pi() / 2))}</code>&nbsp;
-
-## Set Magnitude
-
-Changes the magnitude of any vector, keeping its angle.
-
-<code>setMagnitude([3, 4], 10) == {toString(setMagnitude([3, 4], 10))}</code>&nbsp;
-
-<code>setMagnitude([-3, -4], 10) == {toString(setMagnitude([-3, -4], 10))}</code>&nbsp;
-
-## Shift
-
-Moves coordinates around by a certain index.
-
-<code>shift([1, 2, 3, 4, 5], 2) == {toString(shift([1, 2, 3, 4, 5], 2))}</code>&nbsp;
-
-## Times
-
-Alias of `multiply`.
-
-## To Cartesian
-
-Converts a 2D polar vector into cartesian coordinates.
-
-<code>toCartesian([2 ** 0.5, pi() / 4]) == {toString(toCartesian([2 ** 0.5, pi() / 4]))}</code>&nbsp;
-
-## To Cylindrical
-
-Converts a 3D cartesian vector to cylindrical coordinates.
-
-<code>toCylindrical([1, 1, 1]) == {toString(toCylindrical([1, 1, 1]), 3)}</code>&nbsp;
-
-## To Polar
-
-Converts a 2D cartesian vector to polar coordinates.
-
-<code>toPolar([1, 1]) == {toString(toPolar([1, 1]))}</code> (&asymp;[&#8730;2, &pi;/4])
-
-## To Spherical
-
-TBD
-
-## To String
-
-Returns a string representation of any vector, up to optional decimal points.
-
-<code>toString([1, 0]) == "{toString([1, 0])}"</code>&nbsp;
-
-<code>toString([cos(pi() / 4), 0], 3) == "{toString([cos(pi() / 4), 0], 3)}"</code>&nbsp;
-
-## Unit
-
-Returns a unit 3D vector at a given optional angle.
-
-<code>unit() == {toString(unit())}</code>&nbsp;
-
-<code>unit(pi() / 2) == {toString(unit(pi() / 2))}</code>&nbsp;

package/src/docs/utils/math/linear-algebra/vectors.mdx

@@ -1,58 +0,0 @@
-import { Meta } from '@storybook/blocks'
-
-import {
-cross,
-dot,
-scalarProduct,
-subtract,
-sum,
-vectorProduct,
-} from '@inglorious/utils/math/linear-algebra/vectors'
-import { toString } from '@inglorious/utils/math/linear-algebra/vector'
-import { pi, cos, sin } from '@inglorious/utils/math/trigonometry'
-
-<Meta title="Utils/Math/Linear Algebra/Vectors" />
-
-# Vectors
-
-Functions that deal with a multiple vectors.
-
-## Cross
-
-Performs the cross product between multiple vectors (alias `vectorProduct`).
-
-<code>cross([1, 2, 3], [4, 5, 6]) == {toString(cross([1, 2, 3], [4, 5, 6]))}</code>&nbsp;
-
-<code>cross([1, 2, 3], [4, 5, 6], [7, 8, 9]) == {toString(cross([1, 2, 3], [4, 5, 6], [7, 8, 9]))}</code>&nbsp;
-
-## Dot
-
-Performs the dot product between multiple vectors (alias `scalarProduct`).
-
-<code>dot([1, 2, 3], [4, 5, 6]) == {dot([1, 2, 3], [4, 5, 6])}</code>&nbsp;
-
-<code>dot([1, 2, 3], [4, 5, 6], [7, 8, 9]) == {dot([1, 2, 3], [4, 5, 6], [7, 8, 9])}</code>&nbsp;
-
-## Scalar Product
-
-Alias of `dot`.
-
-## Subtract
-
-Subtracts all other vectors from the first one.
-
-<code>subtract([1, 2, 3], [4, 5, 6]) == {toString(subtract([1, 2, 3], [4, 5, 6]))}</code>&nbsp;
-
-<code>subtract([1, 2, 3], [4, 5, 6], [7, 8, 9]) == {toString(subtract([1, 2, 3], [4, 5, 6], [7, 8, 9]))}</code>&nbsp;
-
-## Sum
-
-Sums all coordinates together.
-
-<code>sum([1, 2, 3], [4, 5, 6]) == {toString(sum([1, 2, 3], [4, 5, 6]))}</code>&nbsp;
-
-<code>sum([1, 2, 3], [4, 5, 6], [7, 8, 9]) == {toString(sum([1, 2, 3], [4, 5, 6], [7, 8, 9]))}</code>&nbsp;
-
-## Vector Product
-
-Alias of `cross`.

package/src/docs/utils/math/numbers.mdx

@@ -1,76 +0,0 @@
-import { Meta } from '@storybook/blocks'
-
-import { toString } from '@inglorious/utils/data-structures/boolean.js'
-import { abs, clamp, isClose, mod, sign, sqrt } from '@inglorious/utils/math/numbers.js'
-
-<Meta title="Utils/Math/Numbers" />
-
-# Numbers
-
-Basic functions that deal with numbers.
-
-## Abs
-
-Returns the absolute value of any number.
-
-<code>abs(42) == {abs(42)}</code>&nbsp;
-
-<code>abs(-42) == {abs(-42)}</code>&nbsp;
-
-## Clamp
-
-Limits the given number to the specified bounds.
-
-<code>clamp(42, 0, 100) == {clamp(42, 0, 100)}</code>&nbsp;
-
-<code>clamp(-42, 0, 100) == {clamp(-42, 0, 100)}</code>&nbsp;
-
-<code>clamp(142, 0, 100) == {clamp(142, 0, 100)}</code>&nbsp;
-
-## Is Close
-
-Checks if two numbers are close to each other, given some tolerance (which is *0.1* by default).
-
-<code>isClose(42, 42.1, 0.2) == {toString(isClose(42, 42.1, 0.2))}</code>&nbsp;
-
-<code>isClose(42, 43, 0.2) == {toString(isClose(42, 43, 0.2))}</code>&nbsp;
-
-<code>isClose(42, 42.1) == {toString(isClose(42, 42.1))}</code>&nbsp;
-
-## Mod
-
-Computes the remainder of the integer division, always giving a positive value (alias `remainder`).
-
-<code>mod(2, 2) == {mod(2, 2)}</code>&nbsp;
-
-<code>mod(3, 2) == {mod(3, 2)}</code>&nbsp;
-
-<code>mod(-3, 2) == {mod(-3, 2)}</code>&nbsp;
-
-<code>mod(5 / 4, 1) == {mod(5 / 4, 1)}</code> (=1/4)&nbsp;
-
-<code>mod(5 / 4, 1) == {mod(5 / 4, 1)}</code> (=1/4)&nbsp;
-
-<code>mod(13 / 4, 1) == {mod(13 / 4, 1)}</code> (=1/4)&nbsp;
-
-<code>mod(-5 / 4, 1) == {mod(-5 / 4, 1)}</code> (=3/4)&nbsp;
-
-## Remainder
-
-Alias of `mod`.
-
-## Sign
-
-Returns +1 if the given number is positive, -1 if negative, 0 otherwise.
-
-<code>sign(42) == {sign(42)}</code>&nbsp;
-
-<code>sign(-42) == {sign(-42)}</code>&nbsp;
-
-<code>sign(0) == {sign(0)}</code>&nbsp;
-
-## Sqrt
-
-Return the square roo of the given number.
-
-<code>sqrt(9) == {sqrt(9)}</code>&nbsp;

package/src/docs/utils/math/random.mdx

@@ -1,35 +0,0 @@
-import { Meta } from '@storybook/blocks'
-
-import { random, randomBinomial } from '@inglorious/utils/math/rng'
-
-<Meta title="Utils/Math/Rng" />
-
-# Rng
-
-Random number generators.
-
-## Random
-
-Generates a random number with optional parameters that specify range and step.
-
-No parameters will generate a random number in the range `[0, 1)` (zero included, one excluded).
-
-<code>random() == {random()}</code>&nbsp;
-
-A parameter `n` means the random number will be an integer in the range `[0, n]` (zero and `n` included).
-
-<code>random(6) == {random(6)}</code>&nbsp;
-
-Two parameters `n` and `m` means the random number will be an integer in the range `[n, m]` (both numbers included).
-
-<code>random(1, 6) == {random(1, 6)}</code>&nbsp;
-
-A third parameter allows to specify the step.
-
-<code>random(2, 6, 2) == {random(2, 6, 2)}</code>&nbsp;
-
-## Random Binomial
-
-Generates a random number in the range `(-1, 1)` (minus one excluded, one excluded), with probability following the [Binomial Distribution](https://en.wikipedia.org/wiki/Binomial_distribution).
-
-<code>randomBinomial() == {randomBinomial()}</code>&nbsp;

package/src/docs/utils/math/statistics.mdx

@@ -1,38 +0,0 @@
-import { Meta } from '@storybook/blocks'
-
-import { mean, median, mode } from '@inglorious/utils/math/statistics'
-import { toString } from '@inglorious/utils/data-structures/object'
-
-<Meta title="Utils/Math/Statistics" />
-
-# Statistics
-
-Basic statistics functions.
-
-## Average
-
-Alias of `mean`.
-
-## Mean
-
-Returns the mathematical mean of a list of numbers.
-
-<code>mean(1, 3, 2) == {mean(1, 3, 2)}</code>&nbsp;
-
-## Median
-
-Returns the median value from a list of numbers.
-
-When the list has odd length, the median is whatever value sits in between:
-
-<code>median(1, 3, 2) == {median(1, 3, 2)}</code>&nbsp;
-
-When the list has an even length, the median is the average of its two values in between (in this case, 2 and 3):
-
-<code>median(1, 3, 2, 4) == {median(1, 3, 2, 4)}</code>&nbsp;
-
-## Mode
-
-Returns the most frequent item in a list of values.
-
-<code>mode("rarely", "sometimes", "sometimes", "always") == {toString(mode("rarely", "sometimes", "sometimes", "always"))}</code>&nbsp;

package/src/docs/utils/math/trigonometry.mdx

@@ -1,85 +0,0 @@
-import { Meta } from '@storybook/blocks'
-
-import { atan2, cos, cosine, pi, sin, sine, toDegrees, toRadians, toRange } from '@inglorious/utils/math/trigonometry'
-
-<Meta title="Utils/Math/Trigonometry" />
-
-# Trigonometry
-
-Basic trigonometry functions.
-
-## Atan2
-
-Returns the atan2 of y and x.
-
-<code>atan2(0, 0) == {atan2(0, 0)}</code>&nbsp;
-
-
-<code>atan2(0, pi() / 2) == {atan2(0, pi() / 2)}</code>&nbsp;
-
-
-<code>atan2(pi() / 2, 0) == {atan2(pi() / 2, 0)}</code>&nbsp;
-
-
-<code>atan2(pi() / 2, pi() / 2) == {atan2(pi() / 2, pi() / 2)}</code>&nbsp;
-
-## Cos
-
-Returns the cosine of an angle in radians (alias `cosine`).
-
-<code>cos(0) == {cos(0)}</code>&nbsp;
-
-<code>cos(pi() / 4) == {cos(pi() / 4).toFixed(3)}</code>&nbsp;
-
-<code>cos(pi() / 2) == {cos(pi() / 2)}</code> (&asymp;0)
-
-## Cosine
-
-Alias of `cos`.
-
-## Pi
-
-Returns an approximation of &pi;.
-
-<code>pi() == {pi()}</code> (&asymp;&pi;)
-
-## Sin
-
-Return the sine of an angle in degrees (alias `sine`).
-
-
-<code>sin(0) == {sin(0)}</code>&nbsp;
-
-<code>sin(pi() / 4) == {sin(pi() / 4).toFixed(3)}</code>&nbsp;
-
-<code>sin(pi() / 2) == {sin(pi() / 2)}</code>&nbsp;
-
-## Sine
-
-Alias of `sin`.
-
-## To Degrees
-
-Converts radians into degrees.
-
-<code>toDegrees(pi() / 4) == {toDegrees(pi() / 4)}</code>&nbsp;
-
-## To Radians
-
-Converts degrees into radians.
-
-<code>toRadians(45) == {toRadians(45)}</code> (&asymp;&pi;/4)
-
-## To Range
-
-Clamps any angle into the range [-&pi;, &pi;].
-
-<code>toRange(5 / 4 * pi()) == {toRange((5 / 4) * pi())}</code> (&asymp;-3/4&pi;)
-
-<code>toRange(13 / 4 * pi()) == {toRange((13 / 4) * pi())}</code> (&asymp;-3/4&pi;)
-
-<code>toRange(-5 / 4 * pi()) == {toRange((-5 / 4) * pi())}</code> (&asymp;3/4&pi;)
-
-<code>toRange(-13 / 4 * pi()) == {toRange((-13 / 4) * pi())}</code> (&asymp;3/4&pi;)
-
-<code>toRange(3 / 4 * pi()) == {toRange((3 / 4) * pi())}</code> (&asymp;3/4&pi;)

package/src/docs/utils/physics/friction.mdx

@@ -1,20 +0,0 @@
-import { Meta } from '@storybook/blocks'
-
-import { applyFriction } from '@inglorious/utils/physics/friction'
-import { toString } from '@inglorious/utils/math/linear-algebra/vector'
-
-<Meta title="Utils/Physics/Friction" />
-
-# Friction
-
-Friction is a force that resists movement. It is directly related to the body's momentum, which is mass times velocity, but for our purposes we can safely ignore mass and apply it directly to velocity.
-
-A friction that is equal to the velocity's magnitude will eventually stop the body after some time.
-
-<code>applyFriction(\{ velocity: [8, 0, 6], friction: 5 \}, \{ dt: 1 \}) == {toString(applyFriction({ velocity: [8, 0, 6], friction: 5 }, { dt: 1 }))}</code>&nbsp;
-
-<code>applyFriction(\{ velocity: [8, 0, 6], friction: 5 \}, \{ dt: 2 \}) == {toString(applyFriction({ velocity: [8, 0, 6], friction: 5 }, { dt: 2 }))}</code>&nbsp;
-
-When the body is still then no friction will be applied:
-
-<code>applyFriction(\{ velocity: [0, 0, 0], friction: 5 \}, \{ dt: 1 \}) == {toString(applyFriction({ velocity: [0, 0, 0], friction: 5 }, { dt: 1 }))}</code>&nbsp;

package/src/docs/utils/physics/gravity.mdx

@@ -1,28 +0,0 @@
-import { Meta } from '@storybook/blocks'
-
-import { applyGravity } from '@inglorious/utils/physics/gravity'
-import { toString } from '@inglorious/utils/data-structures/object'
-
-<Meta title="Utils/Physics/Gravity" />
-
-# Gravity
-
-We can consider gravity as a constant acceleration downards. [This video](https://youtu.be/hG9SzQxaCm8) shows how to calculate this acceleration based on the curve that we want our character to draw when jumping. Also, it rightfully warns to keep jump parameters separate from our world coordinates. That's why we need a specific acceleration and velocity to model our jumps, while directly integrating into the position vector.
-
-- `maxJump` is the maximum height that we want to achieve;
-- `maxLeap` is the maximum distance we want to cover with a jump;
-- `maxSpeed` is the maximum horizontal speed when running;
-- `vy` is the current jump velocity;
-- `position[Y]` is the current world height.
-
-<code>applyGravity(\{ maxJump: 10, maxLeap: 10, maxSpeed: 10, vy: 10, position: [0,10,0] \}, \{ dt: 1 \}) == {toString(applyGravity({ maxJump: 10, maxLeap: 10, maxSpeed: 10, vy: 10, position: [0,10,0] }, { dt: 1 }))}</code>&nbsp;
-
-Not specifying `maxJump` and `maxSpeed` will result in no gravity being applied:
-
-<code>applyGravity(\{ maxLeap: 10, maxSpeed: 10, vy: 10, position: [0,10,0] \}, \{ dt: 1 \}) == {toString(applyGravity({ maxLeap: 10, maxSpeed: 10, vy: 10, position: [0,10,0] }, { dt: 1 }))}</code>&nbsp;
-
-<code>applyGravity(\{ maxJump: 10, maxSpeed: 10, vy: 10, position: [0,10,0] \}, \{ dt: 1 \}) == {toString(applyGravity({ maxJump: 10, maxLeap: 10, vy: 10, position: [0,10,0] }, { dt: 1 }))}</code>&nbsp;
-
-While not specifying `maxLeap` will result in an error, since we have to divide by this quantity:
-
-<code>applyGravity(\{ maxJump: 10, maxSpeed: 10, vy: 10, position: [0,10,0] \}, \{ dt: 1 \}) == Error(['maxLeap'])</code>&nbsp;