js-draw 0.25.1 → 1.0.0

package/src/math/Mat33.ts

@@ -1,442 +0,0 @@
-import { Point2, Vec2 } from './Vec2';
-import Vec3 from './Vec3';
-
-export type Mat33Array = [
-	number, number, number,
-	number, number, number,
-	number, number, number,
-];
-
-/**
- * Represents a three dimensional linear transformation or
- * a two-dimensional affine transformation. (An affine transformation scales/rotates/shears
- * **and** translates while a linear transformation just scales/rotates/shears).
- */
-export default class Mat33 {
-	private readonly rows: Vec3[];
-
-	/**
-	 * Creates a matrix from inputs in the form,
-	 * ```
-	 * ⎡ a1 a2 a3 ⎤
-	 * ⎢ b1 b2 b3 ⎥
-	 * ⎣ c1 c2 c3 ⎦
-	 * ```
-	 */
-	public constructor(
-		public readonly a1: number,
-		public readonly a2: number,
-		public readonly a3: number,
-
-		public readonly b1: number,
-		public readonly b2: number,
-		public readonly b3: number,
-
-		public readonly c1: number,
-		public readonly c2: number,
-		public readonly c3: number
-	) {
-		this.rows = [
-			Vec3.of(a1, a2, a3),
-			Vec3.of(b1, b2, b3),
-			Vec3.of(c1, c2, c3),
-		];
-	}
-
-	/**
-	 * Creates a matrix from the given rows:
-	 * ```
-	 *  ⎡ r1.x r1.y r1.z ⎤
-	 *  ⎢ r2.x r2.y r2.z ⎥
-	 *  ⎣ r3.x r3.y r3.z ⎦
-	 * ```
-	 */
-	public static ofRows(r1: Vec3, r2: Vec3, r3: Vec3): Mat33 {
-		return new Mat33(
-			r1.x, r1.y, r1.z,
-			r2.x, r2.y, r2.z,
-			r3.x, r3.y, r3.z
-		);
-	}
-
-	public static identity = new Mat33(
-		1, 0, 0,
-		0, 1, 0,
-		0, 0, 1
-	);
-
-	/**
-	 * Either returns the inverse of this, or, if this matrix is singular/uninvertable,
-	 * returns Mat33.identity.
-	 *
-	 * This may cache the computed inverse and return the cached version instead of recomputing
-	 * it.
-	 */
-	public inverse(): Mat33 {
-		return this.computeInverse() ?? Mat33.identity;
-	}
-
-	public invertable(): boolean {
-		return this.computeInverse() !== null;
-	}
-
-	private cachedInverse: Mat33|undefined|null = undefined;
-	private computeInverse(): Mat33|null {
-		if (this.cachedInverse !== undefined) {
-			return this.cachedInverse;
-		}
-
-		const toIdentity = [
-			this.rows[0],
-			this.rows[1],
-			this.rows[2],
-		];
-
-		const toResult = [
-			Vec3.unitX,
-			Vec3.unitY,
-			Vec3.unitZ,
-		];
-
-		// Convert toIdentity to the identity matrix and
-		// toResult to the inverse through elementary row operations
-		for (let cursor = 0; cursor < 3; cursor++) {
-			// Select the [cursor]th diagonal entry
-			let pivot = toIdentity[cursor].at(cursor);
-
-			// Don't divide by zero (treat very small numbers as zero).
-			const minDivideBy = 1e-10;
-			if (Math.abs(pivot) < minDivideBy) {
-				let swapIndex = -1;
-				// For all other rows,
-				for (let i = 1; i <= 2; i++) {
-					const otherRowIdx = (cursor + i) % 3;
-
-					if (Math.abs(toIdentity[otherRowIdx].at(cursor)) >= minDivideBy) {
-						swapIndex = otherRowIdx;
-						break;
-					}
-				}
-
-				// Can't swap with another row?
-				if (swapIndex === -1) {
-					this.cachedInverse = null;
-					return null;
-				}
-
-				const tmpIdentityRow = toIdentity[cursor];
-				const tmpResultRow = toResult[cursor];
-
-				// Swap!
-				toIdentity[cursor] = toIdentity[swapIndex];
-				toResult[cursor] = toResult[swapIndex];
-				toIdentity[swapIndex] = tmpIdentityRow;
-				toResult[swapIndex] = tmpResultRow;
-
-				pivot = toIdentity[cursor].at(cursor);
-			}
-
-			// Make toIdentity[k = cursor] = 1
-			let scale = 1.0 / pivot;
-			toIdentity[cursor] = toIdentity[cursor].times(scale);
-			toResult[cursor] = toResult[cursor].times(scale);
-
-			const cursorToIdentityRow = toIdentity[cursor];
-			const cursorToResultRow = toResult[cursor];
-
-			// Make toIdentity[k ≠ cursor] = 0
-			for (let i = 1; i <= 2; i++) {
-				const otherRowIdx = (cursor + i) % 3;
-				scale = -toIdentity[otherRowIdx].at(cursor);
-				toIdentity[otherRowIdx] = toIdentity[otherRowIdx].plus(
-					cursorToIdentityRow.times(scale)
-				);
-				toResult[otherRowIdx] = toResult[otherRowIdx].plus(
-					cursorToResultRow.times(scale)
-				);
-			}
-		}
-
-		const inverse = Mat33.ofRows(
-			toResult[0],
-			toResult[1],
-			toResult[2]
-		);
-		this.cachedInverse = inverse;
-		return inverse;
-	}
-
-	public transposed(): Mat33 {
-		return new Mat33(
-			this.a1, this.b1, this.c1,
-			this.a2, this.b2, this.c2,
-			this.a3, this.b3, this.c3
-		);
-	}
-
-	public rightMul(other: Mat33): Mat33 {
-		other = other.transposed();
-
-		const at = (row: number, col: number): number => {
-			return this.rows[row].dot(other.rows[col]);
-		};
-
-		return new Mat33(
-			at(0, 0), at(0, 1), at(0, 2),
-			at(1, 0), at(1, 1), at(1, 2),
-			at(2, 0), at(2, 1), at(2, 2)
-		);
-	}
-
-	/**
-	 * Applies this as an **affine** transformation to the given vector.
-	 * Returns a transformed version of `other`.
-	 *
-	 * Unlike {@link transformVec3}, this **does** translate the given vector.
-	 */
-	public transformVec2(other: Vec2): Vec2 {
-		// When transforming a Vec2, we want to use the z transformation
-		// components of this for translation:
-		//  ⎡ . . tX ⎤
-		//  ⎢ . . tY ⎥
-		//  ⎣ 0 0 1  ⎦
-		// For this, we need other's z component to be 1 (so that tX and tY
-		// are scaled by 1):
-		let intermediate = Vec3.of(other.x, other.y, 1);
-		intermediate = this.transformVec3(intermediate);
-
-		// Drop the z=1 to allow magnitude to work as expected
-		return Vec2.of(intermediate.x, intermediate.y);
-	}
-
-	/**
-	 * Applies this as a linear transformation to the given vector (doesn't translate).
-	 * This is the standard way of transforming vectors in ℝ³.
-	 */
-	public transformVec3(other: Vec3): Vec3 {
-		return Vec3.of(
-			this.rows[0].dot(other),
-			this.rows[1].dot(other),
-			this.rows[2].dot(other)
-		);
-	}
-
-	/** @returns true iff this is the identity matrix. */
-	public isIdentity(): boolean {
-		if (this === Mat33.identity) {
-			return true;
-		}
-
-		return this.eq(Mat33.identity);
-	}
-
-	/** Returns true iff this = other ± fuzz */
-	public eq(other: Mat33, fuzz: number = 0): boolean {
-		for (let i = 0; i < 3; i++) {
-			if (!this.rows[i].eq(other.rows[i], fuzz)) {
-				return false;
-			}
-		}
-
-		return true;
-	}
-
-	public toString(): string {
-		let result = '';
-		const maxColumnLens = [ 0, 0, 0 ];
-
-		// Determine the longest item in each column so we can pad the others to that
-		// length.
-		for (const row of this.rows) {
-			for (let i = 0; i < 3; i++) {
-				maxColumnLens[i] = Math.max(maxColumnLens[0], `${row.at(i)}`.length);
-			}
-		}
-
-		for (let i = 0; i < 3; i++) {
-			if (i === 0) {
-				result += '⎡ ';
-			} else if (i === 1) {
-				result += '⎢ ';
-			} else {
-				result += '⎣ ';
-			}
-
-			// Add each component of the ith row (after padding it)
-			for (let j = 0; j < 3; j++) {
-				const val = this.rows[i].at(j).toString();
-
-				let padding = '';
-				for (let i = val.length; i < maxColumnLens[j]; i++) {
-					padding += ' ';
-				}
-
-				result += val + ', ' + padding;
-			}
-
-			if (i === 0) {
-				result += ' ⎤';
-			} else if (i === 1) {
-				result += ' ⎥';
-			} else {
-				result += ' ⎦';
-			}
-			result += '\n';
-		}
-
-		return result.trimEnd();
-	}
-
-	/**
-	 * ```
-	 * result[0] = top left element
-	 * result[1] = element at row zero, column 1
-	 * ...
-	 * ```
-	 */
-	public toArray(): Mat33Array {
-		return [
-			this.a1, this.a2, this.a3,
-			this.b1, this.b2, this.b3,
-			this.c1, this.c2, this.c3,
-		];
-	}
-
-	/**
-	 * Returns a new `Mat33` where each entry is the output of the function
-	 * `mapping`.
-	 *
-	 * @example
-	 * ```
-	 * new Mat33(
-	 *  1, 2, 3,
-	 *  4, 5, 6,
-	 *  7, 8, 9,
-	 * ).mapEntries(component => component - 1);
-	 * // → ⎡ 0, 1, 2 ⎤
-	 * //   ⎢ 3, 4, 5 ⎥
-	 * //   ⎣ 6, 7, 8 ⎦
-	 * ```
-	 */
-	public mapEntries(mapping: (component: number, rowcol: [number, number])=>number): Mat33 {
-		return new Mat33(
-			mapping(this.a1, [0, 0]), mapping(this.a2, [0, 1]), mapping(this.a3, [0, 2]),
-			mapping(this.b1, [1, 0]), mapping(this.b2, [1, 1]), mapping(this.b3, [1, 2]),
-			mapping(this.c1, [2, 0]), mapping(this.c2, [2, 1]), mapping(this.c3, [2, 2]),
-		);
-	}
-
-	/** Estimate the scale factor of this matrix (based on the first row). */
-	public getScaleFactor() {
-		return Math.hypot(this.a1, this.a2);
-	}
-
-	/** Constructs a 3x3 translation matrix (for translating `Vec2`s) */
-	public static translation(amount: Vec2): Mat33 {
-		// When transforming Vec2s by a 3x3 matrix, we give the input
-		// Vec2s z = 1. As such,
-		//   outVec2.x = inVec2.x * 1 + inVec2.y * 0 + 1 * amount.x
-		//   ...
-		return new Mat33(
-			1, 0, amount.x,
-			0, 1, amount.y,
-			0, 0, 1
-		);
-	}
-
-	public static zRotation(radians: number, center: Point2 = Vec2.zero): Mat33 {
-		if (radians === 0) {
-			return Mat33.identity;
-		}
-
-		const cos = Math.cos(radians);
-		const sin = Math.sin(radians);
-
-		// Translate everything so that rotation is about the origin
-		let result = Mat33.translation(center);
-
-		result = result.rightMul(new Mat33(
-			cos, -sin, 0,
-			sin, cos, 0,
-			0, 0, 1
-		));
-		return result.rightMul(Mat33.translation(center.times(-1)));
-	}
-
-	public static scaling2D(amount: number|Vec2, center: Point2 = Vec2.zero): Mat33 {
-		let result = Mat33.translation(center);
-		let xAmount, yAmount;
-
-		if (typeof amount === 'number') {
-			xAmount = amount;
-			yAmount = amount;
-		} else {
-			xAmount = amount.x;
-			yAmount = amount.y;
-		}
-
-		result = result.rightMul(new Mat33(
-			xAmount, 0, 0,
-			0, yAmount, 0,
-			0, 0, 1
-		));
-
-		// Translate such that [center] goes to (0, 0)
-		return result.rightMul(Mat33.translation(center.times(-1)));
-	}
-
-	/** @see {@link fromCSSMatrix} */
-	public toCSSMatrix(): string {
-		return `matrix(${this.a1},${this.b1},${this.a2},${this.b2},${this.a3},${this.b3})`;
-	}
-
-	/**
-	 * Converts a CSS-form `matrix(a, b, c, d, e, f)` to a Mat33.
-	 *
-	 * Note that such a matrix has the form,
-	 * ```
-	 * ⎡ a c e ⎤
-	 * ⎢ b d f ⎥
-	 * ⎣ 0 0 1 ⎦
-	 * ```
-	 */
-	public static fromCSSMatrix(cssString: string): Mat33 {
-		if (cssString === '' || cssString === 'none') {
-			return Mat33.identity;
-		}
-
-		const numberExp = '([-]?\\d*(?:\\.\\d*)?(?:[eE][-]?\\d+)?)';
-		const numberSepExp = '[, \\t\\n]';
-		const regExpSource = `^\\s*matrix\\s*\\(${
-			[
-				// According to MDN, matrix(a,b,c,d,e,f) has form:
-				// 		⎡ a c e ⎤
-				// 		⎢ b d f ⎥
-				// 		⎣ 0 0 1 ⎦
-				numberExp, numberExp, numberExp, // a, c, e
-				numberExp, numberExp, numberExp, // b, d, f
-			].join(`${numberSepExp}+`)
-		}${numberSepExp}*\\)\\s*$`;
-		const matrixExp = new RegExp(regExpSource, 'i');
-		const match = matrixExp.exec(cssString);
-
-		if (!match) {
-			throw new Error(`Unsupported transformation: ${cssString}`);
-		}
-
-		const matrixData = match.slice(1).map(entry => parseFloat(entry));
-		const a = matrixData[0];
-		const b = matrixData[1];
-		const c = matrixData[2];
-		const d = matrixData[3];
-		const e = matrixData[4];
-		const f = matrixData[5];
-
-		const transform = new Mat33(
-			a, c, e,
-			b, d, f,
-			0, 0, 1
-		);
-		return transform;
-	}
-}

package/src/math/Vec2.test.ts

@@ -1,30 +0,0 @@
-import { Vec2 } from './Vec2';
-import Vec3 from './Vec3';
-
-describe('Vec2', () => {
-	it('Magnitude', () => {
-		expect(Vec2.of(3, 4).magnitude()).toBe(5);
-	});
-
-	it('Addition', () => {
-		expect(Vec2.of(1, 2).plus(Vec2.of(3, 4))).objEq(Vec2.of(4, 6));
-	});
-
-	it('Multiplication', () => {
-		expect(Vec2.of(1, -1).times(22)).objEq(Vec2.of(22, -22));
-	});
-
-	it('More complicated expressions', () => {
-		expect((Vec2.of(1, 2).plus(Vec2.of(3, 4))).times(2)).objEq(Vec2.of(8, 12));
-	});
-
-	it('Angle', () => {
-		expect(Vec2.of(-1, 1).angle()).toBeCloseTo(3 * Math.PI / 4);
-	});
-
-	it('Perpindicular', () => {
-		const fuzz = 0.001;
-		expect(Vec2.unitX.cross(Vec3.unitZ)).objEq(Vec2.unitY.times(-1), fuzz);
-		expect(Vec2.unitX.orthog()).objEq(Vec2.unitY, fuzz);
-	});
-});

package/src/math/Vec2.ts

@@ -1,40 +0,0 @@
-import Vec3 from './Vec3';
-
-export namespace Vec2 {
-	/**
-	 * Creates a `Vec2` from an x and y coordinate.
-	 *
-	 * For example,
-	 * ```ts
-	 * const v = Vec2.of(3, 4); // x=3, y=4.
-	 * ```
-	 */
-	export const of = (x: number, y: number): Vec2 => {
-		return Vec3.of(x, y, 0);
-	};
-
-	/**
-	 * Creates a `Vec2` from an object containing x and y coordinates.
-	 *
-	 * For example,
-	 * ```ts
-	 * const v1 = Vec2.ofXY({ x: 3, y: 4.5 });
-	 * const v2 = Vec2.ofXY({ x: -123.4, y: 1 });
-	 * ```
-	 */
-	export const ofXY = ({x, y}: { x: number, y: number }): Vec2 => {
-		return Vec3.of(x, y, 0);
-	};
-
-	/** A vector of length 1 in the X direction (→). */
-	export const unitX = Vec2.of(1, 0);
-
-	/** A vector of length 1 in the Y direction (↑). */
-	export const unitY = Vec2.of(0, 1);
-
-	/** The zero vector: A vector with x=0, y=0. */
-	export const zero = Vec2.of(0, 0);
-}
-
-export type Point2 = Vec3;
-export type Vec2 = Vec3; // eslint-disable-line

package/src/math/Vec3.test.ts

@@ -1,44 +0,0 @@
-
-import Vec3 from './Vec3';
-
-describe('Vec3', () => {
-	it('.xy should contain the x and y components', () => {
-		const vec = Vec3.of(1, 2, 3);
-		expect(vec.xy).toMatchObject({
-			x: 1,
-			y: 2,
-		});
-	});
-
-	it('should be combinable with other vectors via .zip', () => {
-		const vec1 = Vec3.unitX;
-		const vec2 = Vec3.unitY;
-		expect(vec1.zip(vec2, Math.min)).objEq(Vec3.zero);
-		expect(vec1.zip(vec2, Math.max)).objEq(Vec3.of(1, 1, 0));
-	});
-
-	it('.cross should obey the right hand rule', () => {
-		const vec1 = Vec3.unitX;
-		const vec2 = Vec3.unitY;
-		expect(vec1.cross(vec2)).objEq(Vec3.unitZ);
-		expect(vec2.cross(vec1)).objEq(Vec3.unitZ.times(-1));
-	});
-
-	it('.orthog should return an orthogonal vector', () => {
-		expect(Vec3.unitZ.orthog().dot(Vec3.unitZ)).toBe(0);
-
-		// Should return some orthogonal vector, even if given the zero vector
-		expect(Vec3.zero.orthog().dot(Vec3.zero)).toBe(0);
-	});
-
-	it('.minus should return the difference between two vectors', () => {
-		expect(Vec3.of(1, 2, 3).minus(Vec3.of(4, 5, 6))).objEq(Vec3.of(1 - 4, 2 - 5, 3 - 6));
-	});
-
-	it('.orthog should return a unit vector', () => {
-		expect(Vec3.zero.orthog().magnitude()).toBe(1);
-		expect(Vec3.unitZ.orthog().magnitude()).toBe(1);
-		expect(Vec3.unitX.orthog().magnitude()).toBe(1);
-		expect(Vec3.unitY.orthog().magnitude()).toBe(1);
-	});
-});