@newkrok/nape-js 3.5.3 → 3.6.0

package/dist/index.d.cts

@@ -72,6 +72,36 @@ declare class Vec2 {
      * const v = Vec2.fromPolar(1, Math.PI / 4); // 45-degree unit vector
      */
     static fromPolar(length: number, angle: number, weak?: boolean): Vec2;
+    /**
+     * Create a unit Vec2 pointing in the given direction (angle in radians).
+     * Equivalent to `Vec2.fromPolar(1, radians)`.
+     *
+     * @param radians - The angle in radians, measured counter-clockwise from the +x axis.
+     * @param weak - If true, the returned Vec2 is auto-disposed after one use (default false).
+     * @returns A unit Vec2 at the given angle.
+     */
+    static fromAngle(radians: number, weak?: boolean): Vec2;
+    /**
+     * Linearly interpolate between two Vec2s. Returns `a + t * (b - a)`.
+     * Disposes weak arguments after use.
+     *
+     * @param a - The start Vec2 (t = 0).
+     * @param b - The end Vec2 (t = 1).
+     * @param t - The interpolation factor (typically 0–1, but not clamped).
+     * @param weak - If true, the returned Vec2 is auto-disposed after one use (default false).
+     * @returns A new Vec2 at the interpolated position.
+     */
+    static lerp(a: Vec2, b: Vec2, t: number, weak?: boolean): Vec2;
+    /**
+     * Check whether two Vec2s are component-wise equal, within an optional epsilon tolerance.
+     * Disposes weak arguments after comparison.
+     *
+     * @param a - The first Vec2.
+     * @param b - The second Vec2.
+     * @param epsilon - Maximum allowed difference per component (default 0).
+     * @returns `true` if both components differ by at most `epsilon`.
+     */
+    static eq(a: Vec2, b: Vec2, epsilon?: number): boolean;
     /**
      * Squared Euclidean distance between two Vec2s. Avoids a square root when
      * only comparison is needed.
@@ -140,6 +170,20 @@ declare class Vec2 {
      * @returns `this` for chaining.
      */
     setxy(x: number, y: number): this;
+    /**
+     * Return a new Vec2 with the same components. Alias for `copy()`.
+     *
+     * @returns A new Vec2 with the same x and y values.
+     */
+    clone(): Vec2;
+    /**
+     * Check whether this Vec2 is component-wise equal to another, within an optional epsilon tolerance.
+     *
+     * @param other - The Vec2 to compare against.
+     * @param epsilon - Maximum allowed difference per component (default 0).
+     * @returns `true` if both components differ by at most `epsilon`.
+     */
+    equals(other: Vec2, epsilon?: number): boolean;
     /**
      * Return a new Vec2 with the same components.
      *
@@ -333,6 +377,19 @@ declare class Vec3 {
      * @returns `this` for chaining.
      */
     setxyz(x: number, y: number, z: number): this;
+    /**
+     * Check whether this Vec3 is component-wise equal to another, within an optional epsilon tolerance.
+     *
+     * @param other - The Vec3 to compare against.
+     * @param epsilon - Maximum allowed difference per component (default 0).
+     * @returns `true` if all three components differ by at most `epsilon`.
+     */
+    equals(other: Vec3, epsilon?: number): boolean;
+    /**
+     * Return a new Vec3 with the same components.
+     * @returns A copy of this vector.
+     */
+    clone(): Vec3;
     /**
      * Return the x and y components as a new Vec2.
      * @param weak - If true, the returned Vec2 is a weak (pooled) reference.
@@ -416,6 +473,19 @@ declare class Mat23 {
     set ty(v: number);
     /** The determinant of the linear 2×2 part (ad − bc). */
     get determinant(): number;
+    /**
+     * Return a new Mat23 with the same components. Alias for `copy()`.
+     * @returns A new Mat23 with the same components.
+     */
+    clone(): Mat23;
+    /**
+     * Check whether this Mat23 is component-wise equal to another, within an optional epsilon tolerance.
+     *
+     * @param other - The Mat23 to compare against.
+     * @param epsilon - Maximum allowed difference per component (default 0).
+     * @returns `true` if all six components differ by at most `epsilon`.
+     */
+    equals(other: Mat23, epsilon?: number): boolean;
     /**
      * Return a new Mat23 with the same components.
      * @returns A deep copy of this matrix.
@@ -601,6 +671,14 @@ declare class AABB {
      * @param height - The height of the box (default 0). Must be ≥ 0.
      */
     constructor(x?: number, y?: number, width?: number, height?: number);
+    /**
+     * Create the smallest AABB that contains all the given points.
+     * Disposes weak Vec2 arguments after use.
+     *
+     * @param points - An array of Vec2 points to enclose. Must contain at least one point.
+     * @returns A new AABB enclosing all the points.
+     */
+    static fromPoints(points: Vec2[]): AABB;
     /** The x position of the left edge (minx). Setting shifts the box horizontally. */
     get x(): number;
     /** The x position of the left edge (minx). Setting shifts the box horizontally. */
@@ -640,6 +718,20 @@ declare class AABB {
      * @param max - A Vec2 whose components become the new (maxx, maxy).
      */
     set max(max: any);
+    /**
+     * Return a new AABB with the same bounds. Alias for `copy()`.
+     *
+     * @returns A new AABB with the same position and dimensions.
+     */
+    clone(): AABB;
+    /**
+     * Check whether this AABB is equal to another, within an optional epsilon tolerance.
+     *
+     * @param other - The AABB to compare against.
+     * @param epsilon - Maximum allowed difference per component (default 0).
+     * @returns `true` if all four bounds (minx, miny, maxx, maxy) differ by at most `epsilon`.
+     */
+    equals(other: AABB, epsilon?: number): boolean;
     /**
      * Return a new AABB with the same bounds.
      *
@@ -686,6 +778,20 @@ declare class MatMN {
      * @returns The written value.
      */
     setx(row: number, col: number, value: number): number;
+    /**
+     * Check whether this MatMN is element-wise equal to another, within an optional epsilon tolerance.
+     * Matrices must have the same dimensions.
+     *
+     * @param other - The MatMN to compare against.
+     * @param epsilon - Maximum allowed difference per element (default 0).
+     * @returns `true` if dimensions match and all elements differ by at most `epsilon`.
+     */
+    equals(other: MatMN, epsilon?: number): boolean;
+    /**
+     * Return a new MatMN with the same dimensions and element values.
+     * @returns A deep copy of this matrix.
+     */
+    clone(): MatMN;
     /**
      * String representation with rows separated by semicolons.
      * @returns A human-readable string of the matrix elements.
@@ -777,6 +883,11 @@ declare class Ray {
      * @returns The point `origin + distance * normalised_direction`.
      */
     at(distance: number, weak?: boolean): Vec2;
+    /**
+     * Return a new Ray with the same origin, direction, and maxDistance. Alias for `copy()`.
+     * @returns A new Ray with the same properties.
+     */
+    clone(): Ray;
     /**
      * Return a new Ray with the same origin, direction, and maxDistance.
      * @returns A deep copy of this Ray.

package/dist/index.d.ts

@@ -72,6 +72,36 @@ declare class Vec2 {
      * const v = Vec2.fromPolar(1, Math.PI / 4); // 45-degree unit vector
      */
     static fromPolar(length: number, angle: number, weak?: boolean): Vec2;
+    /**
+     * Create a unit Vec2 pointing in the given direction (angle in radians).
+     * Equivalent to `Vec2.fromPolar(1, radians)`.
+     *
+     * @param radians - The angle in radians, measured counter-clockwise from the +x axis.
+     * @param weak - If true, the returned Vec2 is auto-disposed after one use (default false).
+     * @returns A unit Vec2 at the given angle.
+     */
+    static fromAngle(radians: number, weak?: boolean): Vec2;
+    /**
+     * Linearly interpolate between two Vec2s. Returns `a + t * (b - a)`.
+     * Disposes weak arguments after use.
+     *
+     * @param a - The start Vec2 (t = 0).
+     * @param b - The end Vec2 (t = 1).
+     * @param t - The interpolation factor (typically 0–1, but not clamped).
+     * @param weak - If true, the returned Vec2 is auto-disposed after one use (default false).
+     * @returns A new Vec2 at the interpolated position.
+     */
+    static lerp(a: Vec2, b: Vec2, t: number, weak?: boolean): Vec2;
+    /**
+     * Check whether two Vec2s are component-wise equal, within an optional epsilon tolerance.
+     * Disposes weak arguments after comparison.
+     *
+     * @param a - The first Vec2.
+     * @param b - The second Vec2.
+     * @param epsilon - Maximum allowed difference per component (default 0).
+     * @returns `true` if both components differ by at most `epsilon`.
+     */
+    static eq(a: Vec2, b: Vec2, epsilon?: number): boolean;
     /**
      * Squared Euclidean distance between two Vec2s. Avoids a square root when
      * only comparison is needed.
@@ -140,6 +170,20 @@ declare class Vec2 {
      * @returns `this` for chaining.
      */
     setxy(x: number, y: number): this;
+    /**
+     * Return a new Vec2 with the same components. Alias for `copy()`.
+     *
+     * @returns A new Vec2 with the same x and y values.
+     */
+    clone(): Vec2;
+    /**
+     * Check whether this Vec2 is component-wise equal to another, within an optional epsilon tolerance.
+     *
+     * @param other - The Vec2 to compare against.
+     * @param epsilon - Maximum allowed difference per component (default 0).
+     * @returns `true` if both components differ by at most `epsilon`.
+     */
+    equals(other: Vec2, epsilon?: number): boolean;
     /**
      * Return a new Vec2 with the same components.
      *
@@ -333,6 +377,19 @@ declare class Vec3 {
      * @returns `this` for chaining.
      */
     setxyz(x: number, y: number, z: number): this;
+    /**
+     * Check whether this Vec3 is component-wise equal to another, within an optional epsilon tolerance.
+     *
+     * @param other - The Vec3 to compare against.
+     * @param epsilon - Maximum allowed difference per component (default 0).
+     * @returns `true` if all three components differ by at most `epsilon`.
+     */
+    equals(other: Vec3, epsilon?: number): boolean;
+    /**
+     * Return a new Vec3 with the same components.
+     * @returns A copy of this vector.
+     */
+    clone(): Vec3;
     /**
      * Return the x and y components as a new Vec2.
      * @param weak - If true, the returned Vec2 is a weak (pooled) reference.
@@ -416,6 +473,19 @@ declare class Mat23 {
     set ty(v: number);
     /** The determinant of the linear 2×2 part (ad − bc). */
     get determinant(): number;
+    /**
+     * Return a new Mat23 with the same components. Alias for `copy()`.
+     * @returns A new Mat23 with the same components.
+     */
+    clone(): Mat23;
+    /**
+     * Check whether this Mat23 is component-wise equal to another, within an optional epsilon tolerance.
+     *
+     * @param other - The Mat23 to compare against.
+     * @param epsilon - Maximum allowed difference per component (default 0).
+     * @returns `true` if all six components differ by at most `epsilon`.
+     */
+    equals(other: Mat23, epsilon?: number): boolean;
     /**
      * Return a new Mat23 with the same components.
      * @returns A deep copy of this matrix.
@@ -601,6 +671,14 @@ declare class AABB {
      * @param height - The height of the box (default 0). Must be ≥ 0.
      */
     constructor(x?: number, y?: number, width?: number, height?: number);
+    /**
+     * Create the smallest AABB that contains all the given points.
+     * Disposes weak Vec2 arguments after use.
+     *
+     * @param points - An array of Vec2 points to enclose. Must contain at least one point.
+     * @returns A new AABB enclosing all the points.
+     */
+    static fromPoints(points: Vec2[]): AABB;
     /** The x position of the left edge (minx). Setting shifts the box horizontally. */
     get x(): number;
     /** The x position of the left edge (minx). Setting shifts the box horizontally. */
@@ -640,6 +718,20 @@ declare class AABB {
      * @param max - A Vec2 whose components become the new (maxx, maxy).
      */
     set max(max: any);
+    /**
+     * Return a new AABB with the same bounds. Alias for `copy()`.
+     *
+     * @returns A new AABB with the same position and dimensions.
+     */
+    clone(): AABB;
+    /**
+     * Check whether this AABB is equal to another, within an optional epsilon tolerance.
+     *
+     * @param other - The AABB to compare against.
+     * @param epsilon - Maximum allowed difference per component (default 0).
+     * @returns `true` if all four bounds (minx, miny, maxx, maxy) differ by at most `epsilon`.
+     */
+    equals(other: AABB, epsilon?: number): boolean;
     /**
      * Return a new AABB with the same bounds.
      *
@@ -686,6 +778,20 @@ declare class MatMN {
      * @returns The written value.
      */
     setx(row: number, col: number, value: number): number;
+    /**
+     * Check whether this MatMN is element-wise equal to another, within an optional epsilon tolerance.
+     * Matrices must have the same dimensions.
+     *
+     * @param other - The MatMN to compare against.
+     * @param epsilon - Maximum allowed difference per element (default 0).
+     * @returns `true` if dimensions match and all elements differ by at most `epsilon`.
+     */
+    equals(other: MatMN, epsilon?: number): boolean;
+    /**
+     * Return a new MatMN with the same dimensions and element values.
+     * @returns A deep copy of this matrix.
+     */
+    clone(): MatMN;
     /**
      * String representation with rows separated by semicolons.
      * @returns A human-readable string of the matrix elements.
@@ -777,6 +883,11 @@ declare class Ray {
      * @returns The point `origin + distance * normalised_direction`.
      */
     at(distance: number, weak?: boolean): Vec2;
+    /**
+     * Return a new Ray with the same origin, direction, and maxDistance. Alias for `copy()`.
+     * @returns A new Ray with the same properties.
+     */
+    clone(): Ray;
     /**
      * Return a new Ray with the same origin, direction, and maxDistance.
      * @returns A deep copy of this Ray.