js-draw 0.18.1 → 0.19.0

package/dist/mjs/src/math/Rect2.mjs

@@ -0,0 +1,228 @@
+import  LineSegment2  from './LineSegment2.mjs';
+import  { Vec2 }  from './Vec2.mjs';
+// invariant: w ≥ 0, h ≥ 0.
+export default class Rect2 {
+    constructor(x, y, w, h) {
+        this.x = x;
+        this.y = y;
+        this.w = w;
+        this.h = h;
+        if (w < 0) {
+            this.x += w;
+            this.w = Math.abs(w);
+        }
+        if (h < 0) {
+            this.y += h;
+            this.h = Math.abs(h);
+        }
+        // Precompute/store vector forms.
+        this.topLeft = Vec2.of(this.x, this.y);
+        this.size = Vec2.of(this.w, this.h);
+        this.bottomRight = this.topLeft.plus(this.size);
+        this.center = this.topLeft.plus(this.size.times(0.5));
+        this.area = this.w * this.h;
+    }
+    translatedBy(vec) {
+        return new Rect2(vec.x + this.x, vec.y + this.y, this.w, this.h);
+    }
+    // Returns a copy of this with the given size (but same top-left).
+    resizedTo(size) {
+        return new Rect2(this.x, this.y, size.x, size.y);
+    }
+    containsPoint(other) {
+        return this.x <= other.x && this.y <= other.y
+            && this.x + this.w >= other.x && this.y + this.h >= other.y;
+    }
+    containsRect(other) {
+        return this.x <= other.x && this.y <= other.y
+            && this.bottomRight.x >= other.bottomRight.x
+            && this.bottomRight.y >= other.bottomRight.y;
+    }
+    intersects(other) {
+        // Project along x/y axes.
+        const thisMinX = this.x;
+        const thisMaxX = thisMinX + this.w;
+        const otherMinX = other.x;
+        const otherMaxX = other.x + other.w;
+        if (thisMaxX < otherMinX || thisMinX > otherMaxX) {
+            return false;
+        }
+        const thisMinY = this.y;
+        const thisMaxY = thisMinY + this.h;
+        const otherMinY = other.y;
+        const otherMaxY = other.y + other.h;
+        if (thisMaxY < otherMinY || thisMinY > otherMaxY) {
+            return false;
+        }
+        return true;
+    }
+    // Returns the overlap of this and [other], or null, if no such
+    //          overlap exists
+    intersection(other) {
+        if (!this.intersects(other)) {
+            return null;
+        }
+        const topLeft = this.topLeft.zip(other.topLeft, Math.max);
+        const bottomRight = this.bottomRight.zip(other.bottomRight, Math.min);
+        return Rect2.fromCorners(topLeft, bottomRight);
+    }
+    // Returns a new rectangle containing both [this] and [other].
+    union(other) {
+        const topLeft = this.topLeft.zip(other.topLeft, Math.min);
+        const bottomRight = this.bottomRight.zip(other.bottomRight, Math.max);
+        return Rect2.fromCorners(topLeft, bottomRight);
+    }
+    // Returns a the subdivision of this into [columns] columns
+    // and [rows] rows. For example,
+    //	 Rect2.unitSquare.divideIntoGrid(2, 2)
+    //		-> [ Rect2(0, 0, 0.5, 0.5), Rect2(0.5, 0, 0.5, 0.5), Rect2(0, 0.5, 0.5, 0.5), Rect2(0.5, 0.5, 0.5, 0.5) ]
+    // The rectangles are ordered in row-major order.
+    divideIntoGrid(columns, rows) {
+        const result = [];
+        if (columns <= 0 || rows <= 0) {
+            return result;
+        }
+        const eachRectWidth = this.w / columns;
+        const eachRectHeight = this.h / rows;
+        if (eachRectWidth === 0) {
+            columns = 1;
+        }
+        if (eachRectHeight === 0) {
+            rows = 1;
+        }
+        for (let j = 0; j < rows; j++) {
+            for (let i = 0; i < columns; i++) {
+                const x = eachRectWidth * i + this.x;
+                const y = eachRectHeight * j + this.y;
+                result.push(new Rect2(x, y, eachRectWidth, eachRectHeight));
+            }
+        }
+        return result;
+    }
+    // Returns a rectangle containing this and [point].
+    // [margin] is the minimum distance between the new point and the edge
+    // of the resultant rectangle.
+    grownToPoint(point, margin = 0) {
+        const otherRect = new Rect2(point.x - margin, point.y - margin, margin * 2, margin * 2);
+        return this.union(otherRect);
+    }
+    // Returns this grown by [margin] in both the x and y directions.
+    grownBy(margin) {
+        return new Rect2(this.x - margin, this.y - margin, this.w + margin * 2, this.h + margin * 2);
+    }
+    getClosestPointOnBoundaryTo(target) {
+        const closestEdgePoints = this.getEdges().map(edge => {
+            return edge.closestPointTo(target);
+        });
+        let closest = null;
+        let closestDist = null;
+        for (const point of closestEdgePoints) {
+            const dist = point.minus(target).length();
+            if (closestDist === null || dist < closestDist) {
+                closest = point;
+                closestDist = dist;
+            }
+        }
+        return closest;
+    }
+    get corners() {
+        return [
+            this.bottomRight,
+            this.topRight,
+            this.topLeft,
+            this.bottomLeft,
+        ];
+    }
+    get maxDimension() {
+        return Math.max(this.w, this.h);
+    }
+    get topRight() {
+        return this.bottomRight.plus(Vec2.of(0, -this.h));
+    }
+    get bottomLeft() {
+        return this.topLeft.plus(Vec2.of(0, this.h));
+    }
+    get width() {
+        return this.w;
+    }
+    get height() {
+        return this.h;
+    }
+    // Returns edges in the order
+    // [ rightEdge, topEdge, leftEdge, bottomEdge ]
+    getEdges() {
+        const corners = this.corners;
+        return [
+            new LineSegment2(corners[0], corners[1]),
+            new LineSegment2(corners[1], corners[2]),
+            new LineSegment2(corners[2], corners[3]),
+            new LineSegment2(corners[3], corners[0]),
+        ];
+    }
+    // [affineTransform] is a transformation matrix that both scales and **translates**.
+    // the bounding box of this' four corners after transformed by the given affine transformation.
+    transformedBoundingBox(affineTransform) {
+        return Rect2.bboxOf(this.corners.map(corner => affineTransform.transformVec2(corner)));
+    }
+    /** @return true iff this is equal to [other] ± fuzz */
+    eq(other, fuzz = 0) {
+        return this.topLeft.eq(other.topLeft, fuzz) && this.size.eq(other.size, fuzz);
+    }
+    toString() {
+        return `Rect(point(${this.x}, ${this.y}), size(${this.w}, ${this.h}))`;
+    }
+    static fromCorners(corner1, corner2) {
+        return new Rect2(Math.min(corner1.x, corner2.x), Math.min(corner1.y, corner2.y), Math.abs(corner1.x - corner2.x), Math.abs(corner1.y - corner2.y));
+    }
+    // Returns a box that contains all points in [points] with at least [margin]
+    // between each point and the edge of the box.
+    static bboxOf(points, margin = 0) {
+        let minX = 0;
+        let minY = 0;
+        let maxX = 0;
+        let maxY = 0;
+        let isFirst = true;
+        for (const point of points) {
+            if (isFirst) {
+                minX = point.x;
+                minY = point.y;
+                maxX = point.x;
+                maxY = point.y;
+                isFirst = false;
+            }
+            minX = Math.min(minX, point.x);
+            minY = Math.min(minY, point.y);
+            maxX = Math.max(maxX, point.x);
+            maxY = Math.max(maxY, point.y);
+        }
+        return Rect2.fromCorners(Vec2.of(minX - margin, minY - margin), Vec2.of(maxX + margin, maxY + margin));
+    }
+    // @returns a rectangle that contains all of the given rectangles, the bounding box
+    //     of the given rectangles.
+    static union(...rects) {
+        if (rects.length === 0) {
+            return Rect2.empty;
+        }
+        const firstRect = rects[0];
+        let minX = firstRect.topLeft.x;
+        let minY = firstRect.topLeft.y;
+        let maxX = firstRect.bottomRight.x;
+        let maxY = firstRect.bottomRight.y;
+        for (let i = 1; i < rects.length; i++) {
+            const rect = rects[i];
+            minX = Math.min(minX, rect.topLeft.x);
+            minY = Math.min(minY, rect.topLeft.y);
+            maxX = Math.max(maxX, rect.bottomRight.x);
+            maxY = Math.max(maxY, rect.bottomRight.y);
+        }
+        return new Rect2(minX, minY, maxX - minX, maxY - minY);
+    }
+    static of(template) {
+        var _a, _b, _c, _d;
+        const width = (_b = (_a = template.width) !== null && _a !== void 0 ? _a : template.w) !== null && _b !== void 0 ? _b : 0;
+        const height = (_d = (_c = template.height) !== null && _c !== void 0 ? _c : template.h) !== null && _d !== void 0 ? _d : 0;
+        return new Rect2(template.x, template.y, width, height);
+    }
+}
+Rect2.empty = new Rect2(0, 0, 0, 0);
+Rect2.unitSquare = new Rect2(0, 0, 1, 1);

package/dist/mjs/src/math/Triangle.d.ts

@@ -0,0 +1,11 @@
+import Mat33 from './Mat33';
+import Vec3 from './Vec3';
+export default class Triangle {
+    readonly vertex1: Vec3;
+    readonly vertex2: Vec3;
+    readonly vertex3: Vec3;
+    constructor(vertex1: Vec3, vertex2: Vec3, vertex3: Vec3);
+    map(mapping: (vertex: Vec3) => Vec3): Triangle;
+    transformed2DBy(affineTransform: Mat33): Triangle;
+    transformedBy(linearTransform: Mat33): Triangle;
+}

package/dist/mjs/src/math/Triangle.mjs

@@ -0,0 +1,19 @@
+export default class Triangle {
+    constructor(vertex1, vertex2, vertex3) {
+        this.vertex1 = vertex1;
+        this.vertex2 = vertex2;
+        this.vertex3 = vertex3;
+    }
+    map(mapping) {
+        return new Triangle(mapping(this.vertex1), mapping(this.vertex2), mapping(this.vertex3));
+    }
+    // Transform, treating this as composed of 2D points.
+    transformed2DBy(affineTransform) {
+        return this.map(affineTransform.transformVec2);
+    }
+    // Transforms this by a linear transform --- verticies are treated as
+    // 3D points.
+    transformedBy(linearTransform) {
+        return this.map(linearTransform.transformVec3);
+    }
+}

package/dist/mjs/src/math/Vec2.d.ts

@@ -0,0 +1,13 @@
+import Vec3 from './Vec3';
+export declare namespace Vec2 {
+    const of: (x: number, y: number) => Vec2;
+    const ofXY: ({ x, y }: {
+        x: number;
+        y: number;
+    }) => Vec2;
+    const unitX: Vec3;
+    const unitY: Vec3;
+    const zero: Vec3;
+}
+export type Point2 = Vec3;
+export type Vec2 = Vec3;

package/dist/mjs/src/math/Vec2.mjs

@@ -0,0 +1,13 @@
+import  Vec3  from './Vec3.mjs';
+export var Vec2;
+(function (Vec2) {
+    Vec2.of = (x, y) => {
+        return Vec3.of(x, y, 0);
+    };
+    Vec2.ofXY = ({ x, y }) => {
+        return Vec3.of(x, y, 0);
+    };
+    Vec2.unitX = Vec2.of(1, 0);
+    Vec2.unitY = Vec2.of(0, 1);
+    Vec2.zero = Vec2.of(0, 0);
+})(Vec2 || (Vec2 = {}));

package/dist/mjs/src/math/Vec3.d.ts

@@ -0,0 +1,106 @@
+/**
+ * A vector with three components. Can also be used to represent a two-component vector.
+ *
+ * A `Vec3` is immutable.
+ */
+export default class Vec3 {
+    readonly x: number;
+    readonly y: number;
+    readonly z: number;
+    private constructor();
+    /** Returns the x, y components of this. */
+    get xy(): {
+        x: number;
+        y: number;
+    };
+    static of(x: number, y: number, z: number): Vec3;
+    /** Returns this' `idx`th component. For example, `Vec3.of(1, 2, 3).at(1) → 2`. */
+    at(idx: number): number;
+    /** Alias for this.magnitude. */
+    length(): number;
+    magnitude(): number;
+    magnitudeSquared(): number;
+    /**
+     * Return this' angle in the XY plane (treats this as a Vec2).
+     *
+     * This is equivalent to `Math.atan2(vec.y, vec.x)`.
+     */
+    angle(): number;
+    /**
+     * Returns a unit vector in the same direction as this.
+     *
+     * If `this` has zero length, the resultant vector has `NaN` components.
+     */
+    normalized(): Vec3;
+    /** @returns A copy of `this` multiplied by a scalar. */
+    times(c: number): Vec3;
+    plus(v: Vec3): Vec3;
+    minus(v: Vec3): Vec3;
+    dot(other: Vec3): number;
+    cross(other: Vec3): Vec3;
+    /**
+     * If `other` is a `Vec3`, multiplies `this` component-wise by `other`. Otherwise,
+     * if `other is a `number`, returns the result of scalar multiplication.
+     *
+     * @example
+     * ```
+     * Vec3.of(1, 2, 3).scale(Vec3.of(2, 4, 6)); // → Vec3(2, 8, 18)
+     * ```
+     */
+    scale(other: Vec3 | number): Vec3;
+    /**
+     * Returns a vector orthogonal to this. If this is a Vec2, returns `this` rotated
+     * 90 degrees counter-clockwise.
+     */
+    orthog(): Vec3;
+    /** Returns this plus a vector of length `distance` in `direction`. */
+    extend(distance: number, direction: Vec3): Vec3;
+    /** Returns a vector `fractionTo` of the way to target from this. */
+    lerp(target: Vec3, fractionTo: number): Vec3;
+    /**
+     * `zip` Maps a component of this and a corresponding component of
+     * `other` to a component of the output vector.
+     *
+     * @example
+     * ```
+     * const a = Vec3.of(1, 2, 3);
+     * const b = Vec3.of(0.5, 2.1, 2.9);
+     *
+     * const zipped = a.zip(b, (aComponent, bComponent) => {
+     *   return Math.min(aComponent, bComponent);
+     * });
+     *
+     * console.log(zipped.toString()); // → Vec(0.5, 2, 2.9)
+     * ```
+     */
+    zip(other: Vec3, zip: (componentInThis: number, componentInOther: number) => number): Vec3;
+    /**
+     * Returns a vector with each component acted on by `fn`.
+     *
+     * @example
+     * ```
+     * console.log(Vec3.of(1, 2, 3).map(val => val + 1)); // → Vec(2, 3, 4)
+     * ```
+     */
+    map(fn: (component: number, index: number) => number): Vec3;
+    asArray(): [number, number, number];
+    /**
+     * [fuzz] The maximum difference between two components for this and [other]
+     * to be considered equal.
+     *
+     * @example
+     * ```
+     * Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 100);  // → true
+     * Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 0.1);  // → false
+     * Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 3);    // → true
+     * Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 3.01); // → true
+     * Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 2.99); // → false
+     * ```
+     */
+    eq(other: Vec3, fuzz?: number): boolean;
+    toString(): string;
+    static unitX: Vec3;
+    static unitY: Vec3;
+    static unitZ: Vec3;
+    static zero: Vec3;
+}

package/dist/mjs/src/math/Vec3.mjs

@@ -0,0 +1,174 @@
+/**
+ * A vector with three components. Can also be used to represent a two-component vector.
+ *
+ * A `Vec3` is immutable.
+ */
+export default class Vec3 {
+    constructor(x, y, z) {
+        this.x = x;
+        this.y = y;
+        this.z = z;
+    }
+    /** Returns the x, y components of this. */
+    get xy() {
+        // Useful for APIs that behave differently if .z is present.
+        return {
+            x: this.x,
+            y: this.y,
+        };
+    }
+    static of(x, y, z) {
+        return new Vec3(x, y, z);
+    }
+    /** Returns this' `idx`th component. For example, `Vec3.of(1, 2, 3).at(1) → 2`. */
+    at(idx) {
+        if (idx === 0)
+            return this.x;
+        if (idx === 1)
+            return this.y;
+        if (idx === 2)
+            return this.z;
+        throw new Error(`${idx} out of bounds!`);
+    }
+    /** Alias for this.magnitude. */
+    length() {
+        return this.magnitude();
+    }
+    magnitude() {
+        return Math.sqrt(this.dot(this));
+    }
+    magnitudeSquared() {
+        return this.dot(this);
+    }
+    /**
+     * Return this' angle in the XY plane (treats this as a Vec2).
+     *
+     * This is equivalent to `Math.atan2(vec.y, vec.x)`.
+     */
+    angle() {
+        return Math.atan2(this.y, this.x);
+    }
+    /**
+     * Returns a unit vector in the same direction as this.
+     *
+     * If `this` has zero length, the resultant vector has `NaN` components.
+     */
+    normalized() {
+        const norm = this.magnitude();
+        return Vec3.of(this.x / norm, this.y / norm, this.z / norm);
+    }
+    /** @returns A copy of `this` multiplied by a scalar. */
+    times(c) {
+        return Vec3.of(this.x * c, this.y * c, this.z * c);
+    }
+    plus(v) {
+        return Vec3.of(this.x + v.x, this.y + v.y, this.z + v.z);
+    }
+    minus(v) {
+        return Vec3.of(this.x - v.x, this.y - v.y, this.z - v.z);
+    }
+    dot(other) {
+        return this.x * other.x + this.y * other.y + this.z * other.z;
+    }
+    cross(other) {
+        // | i  j  k |
+        // | x1 y1 z1| = (i)(y1z2 - y2z1) - (j)(x1z2 - x2z1) + (k)(x1y2 - x2y1)
+        // | x2 y2 z2|
+        return Vec3.of(this.y * other.z - other.y * this.z, other.x * this.z - this.x * other.z, this.x * other.y - other.x * this.y);
+    }
+    /**
+     * If `other` is a `Vec3`, multiplies `this` component-wise by `other`. Otherwise,
+     * if `other is a `number`, returns the result of scalar multiplication.
+     *
+     * @example
+     * ```
+     * Vec3.of(1, 2, 3).scale(Vec3.of(2, 4, 6)); // → Vec3(2, 8, 18)
+     * ```
+     */
+    scale(other) {
+        if (typeof other === 'number') {
+            return this.times(other);
+        }
+        return Vec3.of(this.x * other.x, this.y * other.y, this.z * other.z);
+    }
+    /**
+     * Returns a vector orthogonal to this. If this is a Vec2, returns `this` rotated
+     * 90 degrees counter-clockwise.
+     */
+    orthog() {
+        // If parallel to the z-axis
+        if (this.dot(Vec3.unitX) === 0 && this.dot(Vec3.unitY) === 0) {
+            return this.dot(Vec3.unitX) === 0 ? Vec3.unitX : this.cross(Vec3.unitX).normalized();
+        }
+        return this.cross(Vec3.unitZ.times(-1)).normalized();
+    }
+    /** Returns this plus a vector of length `distance` in `direction`. */
+    extend(distance, direction) {
+        return this.plus(direction.normalized().times(distance));
+    }
+    /** Returns a vector `fractionTo` of the way to target from this. */
+    lerp(target, fractionTo) {
+        return this.times(1 - fractionTo).plus(target.times(fractionTo));
+    }
+    /**
+     * `zip` Maps a component of this and a corresponding component of
+     * `other` to a component of the output vector.
+     *
+     * @example
+     * ```
+     * const a = Vec3.of(1, 2, 3);
+     * const b = Vec3.of(0.5, 2.1, 2.9);
+     *
+     * const zipped = a.zip(b, (aComponent, bComponent) => {
+     *   return Math.min(aComponent, bComponent);
+     * });
+     *
+     * console.log(zipped.toString()); // → Vec(0.5, 2, 2.9)
+     * ```
+     */
+    zip(other, zip) {
+        return Vec3.of(zip(other.x, this.x), zip(other.y, this.y), zip(other.z, this.z));
+    }
+    /**
+     * Returns a vector with each component acted on by `fn`.
+     *
+     * @example
+     * ```
+     * console.log(Vec3.of(1, 2, 3).map(val => val + 1)); // → Vec(2, 3, 4)
+     * ```
+     */
+    map(fn) {
+        return Vec3.of(fn(this.x, 0), fn(this.y, 1), fn(this.z, 2));
+    }
+    asArray() {
+        return [this.x, this.y, this.z];
+    }
+    /**
+     * [fuzz] The maximum difference between two components for this and [other]
+     * to be considered equal.
+     *
+     * @example
+     * ```
+     * Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 100);  // → true
+     * Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 0.1);  // → false
+     * Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 3);    // → true
+     * Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 3.01); // → true
+     * Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 2.99); // → false
+     * ```
+     */
+    eq(other, fuzz = 1e-10) {
+        for (let i = 0; i < 3; i++) {
+            if (Math.abs(other.at(i) - this.at(i)) > fuzz) {
+                return false;
+            }
+        }
+        return true;
+    }
+    toString() {
+        return `Vec(${this.x}, ${this.y}, ${this.z})`;
+    }
+}
+Vec3.unitX = Vec3.of(1, 0, 0);
+Vec3.unitY = Vec3.of(0, 1, 0);
+Vec3.unitZ = Vec3.of(0, 0, 1);
+Vec3.zero = Vec3.of(0, 0, 0);

package/dist/mjs/src/math/lib.d.ts

@@ -0,0 +1,7 @@
+import LineSegment2 from './LineSegment2';
+import Mat33 from './Mat33';
+import Path from './Path';
+import Rect2 from './Rect2';
+import { Vec2 } from './Vec2';
+import Vec3 from './Vec3';
+export { LineSegment2, Mat33, Path, Rect2, Vec3, Vec2, };

package/dist/mjs/src/math/lib.mjs

@@ -0,0 +1,7 @@
+import  LineSegment2  from './LineSegment2.mjs';
+import  Mat33  from './Mat33.mjs';
+import  Path  from './Path.mjs';
+import  Rect2  from './Rect2.mjs';
+import  { Vec2 }  from './Vec2.mjs';
+import  Vec3  from './Vec3.mjs';
+export { LineSegment2, Mat33, Path, Rect2, Vec3, Vec2, };

package/dist/mjs/src/math/rounding.d.ts

@@ -0,0 +1,4 @@
+export declare const cleanUpNumber: (text: string) => string;
+export declare const toRoundedString: (num: number) => string;
+export declare const getLenAfterDecimal: (numberAsString: string) => number;
+export declare const toStringOfSamePrecision: (num: number, ...references: string[]) => string;