@inglorious/utils 3.8.0 → 4.0.0

package/src/math/point.js

@@ -1,8 +1,9 @@
 /**
- * @typedef {import("../../types/math").Point} Point
- * @typedef {import("../../types/math").Line} Line
- * @typedef {import("../../types/math").Circle} Circle
- * @typedef {import("../../types/math").Rectangle} Rectangle
+ * @typedef {import("../../types/math/point").Point} Point
+ * @typedef {import("../../types/math/point").PointInput} PointInput
+ * @typedef {import("../../types/math/line").Line} Line
+ * @typedef {import("../../types/math/circle").Circle} Circle
+ * @typedef {import("../../types/math/rectangle").Rectangle} Rectangle
  */
 
 const SQUARED = 2
@@ -10,7 +11,7 @@ const HALF = 2
 
 import { distanceFromPoint } from "./line.js"
 import { isBetween } from "./numbers.js"
-import { isVector } from "./vector.js"
+import { isVector } from "./vectors.js"
 
 /**
  * Calculates the distance from a point to a line.
@@ -24,8 +25,8 @@ export function getDistanceFromLine(point, line) {
 
 /**
  * Checks if two points intersect.
- * @param {Point} point1 - The first point as a 3D coordinate [x, y, z].
- * @param {Point} point2 - The second point as a 3D coordinate [x, y, z].
+ * @param {PointInput} point1 - The first point as a 3D coordinate [x, y, z].
+ * @param {PointInput} point2 - The second point as a 3D coordinate [x, y, z].
  * @returns {boolean} True if the points intersect, false otherwise.
  */
 export function intersectsPoint(point1, point2) {
@@ -36,7 +37,7 @@ export function intersectsPoint(point1, point2) {
 
 /**
  * Checks if a point intersects with a circle.
- * @param {Point} point - The point as a 3D coordinate [x, y, z].
+ * @param {PointInput} point - The point as a 3D coordinate [x, y, z].
  * @param {Circle} circle - The circle with a position and radius.
  * @returns {boolean} True if the point intersects the circle, false otherwise.
  */
@@ -53,7 +54,7 @@ export function intersectsCircle(point, circle) {
 
 /**
  * Checks if a point intersects with a rectangle.
- * @param {Point} point - The point as a 3D coordinate [x, y, z].
+ * @param {PointInput} point - The point as a 3D coordinate [x, y, z].
  * @param {Rectangle} rectangle - The rectangle with a position and size.
  * @returns {boolean} True if the point intersects the rectangle, false otherwise.
  */

package/src/math/quaternions.js

@@ -1,10 +1,16 @@
 /**
- * @typedef {import("../../types/math").Quaternion} Quaternion
+ * @typedef {import("../../types/math/vectors").Vector3} Vector3
+ * @typedef {import("../../types/math/quaternions").Quaternion} Quaternion
  */
 
 import { v } from "../v.js"
-import { times } from "./vector.js"
-import { cross, dot, sum } from "./vectors.js"
+import { cos, sin } from "./trigonometry.js"
+import { cross, dot, multiply, sum } from "./vectors.js"
+
+const DEFAULT_ANGLE = 0
+const HALF = 2 // Constant representing the divisor for halving an angle.
+// eslint-disable-next-line no-magic-numbers
+const Y_AXIS = v(0, 1, 0) // Default axis of rotation (Y-axis).
 
 /**
  * Combines two quaternions using the Hamilton product.
@@ -18,6 +24,16 @@ export function combine(q1, q2) {
 
   return v(
     s1 * s2 - dot(v1, v2),
-    ...sum(times(v2, s1), times(v1, s2), cross(v1, v2)),
+    ...sum(multiply(v2, s1), multiply(v1, s2), cross(v1, v2)),
   )
 }
+
+/**
+ * Computes a quaternion representing a rotation around a given axis.
+ * @param {number} [angle=0] - The angle of rotation in radians. Defaults to 0.
+ * @param {Vector3} [axis=Y_AXIS] - The axis of rotation as a 3D vector Defaults to the Y-axis.
+ * @returns {Quaternion} The quaternion as an array [w, x, y, z].
+ */
+export function quaternion(angle = DEFAULT_ANGLE, axis = Y_AXIS) {
+  return v(cos(angle / HALF), ...axis.map((coord) => coord * sin(angle / HALF)))
+}

package/src/math/rectangle.js

@@ -1,7 +1,7 @@
 /**
- * @typedef {import("../../types/math").Circle} Circle
- * @typedef {import("../../types/math").Rectangle} Rectangle
- * @typedef {import("../../types/math").Platform} Platform
+ * @typedef {import("../../types/math/circle").Circle} Circle
+ * @typedef {import("../../types/math/point").PointInput} PointInput
+ * @typedef {import("../../types/math/rectangle").Rectangle} Rectangle
  */
 
 import { intersectsRectangle as circleIntersectsRectangle } from "./circle.js"
@@ -12,7 +12,7 @@ const HALF = 2
 /**
  * Checks if a rectangle intersects with a point.
  * @param {Rectangle} rectangle - The rectangle to check.
- * @param {Point} point - The point to check.
+ * @param {PointInput} point - The point to check.
  * @returns {boolean} True if the point intersects the circle, false otherwise.
  */
 export function intersectsPoint(rectangle, point) {

package/src/math/segment.js

@@ -1,11 +1,17 @@
 /**
- * @typedef {import("../../types/math").Segment} Segment
- * @typedef {import("../../types/math").Point} Point
- * @typedef {import("../../types/math").Circle} Circle
+ * @typedef {import("../../types/math/segment").Segment} Segment
+ * @typedef {import("../../types/math/point").Point} Point
+ * @typedef {import("../../types/math/circle").Circle} Circle
  */
 
-import { magnitude, setMagnitude } from "./vector.js"
-import { distance, dot, subtract, sum } from "./vectors.js"
+import {
+  distance,
+  dot,
+  magnitude,
+  setMagnitude,
+  subtract,
+  sum,
+} from "./vectors.js"
 
 const BEFORE_SEGMENT = 0