@js-draw/math 1.21.3 → 1.23.1

package/dist/cjs/shapes/Path.js

@@ -13,6 +13,7 @@ const PointShape2D_1 = __importDefault(require("./PointShape2D"));
 const toRoundedString_1 = __importDefault(require("../rounding/toRoundedString"));
 const toStringOfSamePrecision_1 = __importDefault(require("../rounding/toStringOfSamePrecision"));
 const convexHull2Of_1 = __importDefault(require("../utils/convexHull2Of"));
+/** Identifiers for different path commands. These commands can make up a {@link Path}. */
 var PathCommandType;
 (function (PathCommandType) {
     PathCommandType[PathCommandType["LineTo"] = 0] = "LineTo";
@@ -327,9 +328,7 @@ class Path {
         const maxRaymarchSteps = 8;
         // Start raymarching from each of these points. This allows detection of multiple
         // intersections.
-        const startPoints = [
-            line.p1, ...additionalRaymarchStartPoints, line.p2
-        ];
+        const startPoints = [line.p1, ...additionalRaymarchStartPoints, line.p2];
         // Converts a point ON THE LINE to a parameter
         const pointToParameter = (point) => {
             // Because line.direction is a unit vector, this computes the length
@@ -435,7 +434,9 @@ class Path {
             return [];
         }
         if (this.parts.length === 0) {
-            return new Path(this.startPoint, [{ kind: PathCommandType.MoveTo, point: this.startPoint }]).intersection(line, strokeRadius);
+            return new Path(this.startPoint, [
+                { kind: PathCommandType.MoveTo, point: this.startPoint },
+            ]).intersection(line, strokeRadius);
         }
         let index = 0;
         for (const part of this.geometry) {
@@ -456,7 +457,7 @@ class Path {
         const doRaymarching = strokeRadius && strokeRadius > 1e-8;
         if (doRaymarching) {
             // Starting points for raymarching (in addition to the end points of the line).
-            const startPoints = result.map(intersection => intersection.point);
+            const startPoints = result.map((intersection) => intersection.point);
             result = this.raymarchIntersectionWith(line, strokeRadius, startPoints);
         }
         return result;
@@ -509,7 +510,8 @@ class Path {
      */
     spliced(deleteFrom, deleteTo, insert, options) {
         const isBeforeOrEqual = (a, b) => {
-            return a.curveIndex < b.curveIndex || (a.curveIndex === b.curveIndex && a.parameterValue <= b.parameterValue);
+            return (a.curveIndex < b.curveIndex ||
+                (a.curveIndex === b.curveIndex && a.parameterValue <= b.parameterValue));
         };
         if (isBeforeOrEqual(deleteFrom, deleteTo)) {
             //          deleteFrom        deleteTo
@@ -547,15 +549,15 @@ class Path {
         //
         // Bounds checking & reversal.
         //
-        while (splitAt.length > 0
-            && splitAt[splitAt.length - 1].curveIndex >= this.parts.length - 1
-            && splitAt[splitAt.length - 1].parameterValue >= 1) {
+        while (splitAt.length > 0 &&
+            splitAt[splitAt.length - 1].curveIndex >= this.parts.length - 1 &&
+            splitAt[splitAt.length - 1].parameterValue >= 1) {
             splitAt.pop();
         }
         splitAt.reverse(); // .reverse() <-- We're `.pop`ing from the end
-        while (splitAt.length > 0
-            && splitAt[splitAt.length - 1].curveIndex <= 0
-            && splitAt[splitAt.length - 1].parameterValue <= 0) {
+        while (splitAt.length > 0 &&
+            splitAt[splitAt.length - 1].curveIndex <= 0 &&
+            splitAt[splitAt.length - 1].parameterValue <= 0) {
             splitAt.pop();
         }
         if (splitAt.length === 0 || this.parts.length === 0) {
@@ -746,7 +748,7 @@ class Path {
         if (affineTransfm.isIdentity()) {
             return this;
         }
-        return this.mapPoints(point => affineTransfm.transformVec2(point));
+        return this.mapPoints((point) => affineTransfm.transformVec2(point));
     }
     /**
      * @internal
@@ -835,11 +837,10 @@ class Path {
                     });
                     lastPoint = part.endPoint;
                     break;
-                default:
-                    {
-                        const exhaustivenessCheck = part;
-                        return exhaustivenessCheck;
-                    }
+                default: {
+                    const exhaustivenessCheck = part;
+                    return exhaustivenessCheck;
+                }
             }
         }
         newParts.reverse();
@@ -851,7 +852,8 @@ class Path {
             return this.startPoint;
         }
         const lastPart = this.parts[this.parts.length - 1];
-        if (lastPart.kind === PathCommandType.QuadraticBezierTo || lastPart.kind === PathCommandType.CubicBezierTo) {
+        if (lastPart.kind === PathCommandType.QuadraticBezierTo ||
+            lastPart.kind === PathCommandType.CubicBezierTo) {
             return lastPart.endPoint;
         }
         else {
@@ -960,9 +962,9 @@ class Path {
                     if (part1.kind !== part2.kind) {
                         return false;
                     }
-                    else if (!part1.controlPoint1.eq(part2.controlPoint1, tolerance)
-                        || !part1.controlPoint2.eq(part2.controlPoint2, tolerance)
-                        || !part1.endPoint.eq(part2.endPoint, tolerance)) {
+                    else if (!part1.controlPoint1.eq(part2.controlPoint1, tolerance) ||
+                        !part1.controlPoint2.eq(part2.controlPoint2, tolerance) ||
+                        !part1.endPoint.eq(part2.endPoint, tolerance)) {
                         return false;
                     }
                     break;
@@ -970,16 +972,15 @@ class Path {
                     if (part1.kind !== part2.kind) {
                         return false;
                     }
-                    else if (!part1.controlPoint.eq(part2.controlPoint, tolerance)
-                        || !part1.endPoint.eq(part2.endPoint, tolerance)) {
+                    else if (!part1.controlPoint.eq(part2.controlPoint, tolerance) ||
+                        !part1.endPoint.eq(part2.endPoint, tolerance)) {
                         return false;
                     }
                     break;
-                default:
-                    {
-                        const exhaustivenessCheck = part1;
-                        return exhaustivenessCheck;
-                    }
+                default: {
+                    const exhaustivenessCheck = part1;
+                    return exhaustivenessCheck;
+                }
             }
         }
         return true;
@@ -1001,11 +1002,7 @@ class Path {
             const cornerToEdge = Vec2_1.Vec2.of(lineWidth, lineWidth).times(0.5);
             const innerRect = Rect2_1.default.fromCorners(rect.topLeft.plus(cornerToEdge), rect.bottomRight.minus(cornerToEdge));
             const outerRect = Rect2_1.default.fromCorners(rect.topLeft.minus(cornerToEdge), rect.bottomRight.plus(cornerToEdge));
-            corners = [
-                innerRect.corners[3],
-                ...innerRect.corners,
-                ...outerRect.corners.reverse(),
-            ];
+            corners = [innerRect.corners[3], ...innerRect.corners, ...outerRect.corners.reverse()];
             startPoint = outerRect.corners[3];
         }
         else {
@@ -1188,19 +1185,23 @@ class Path {
             });
         };
         const commandArgCounts = {
-            'm': 1,
-            'l': 1,
-            'c': 3,
-            'q': 2,
-            'z': 0,
-            'h': 1,
-            'v': 1,
+            m: 1,
+            l: 1,
+            c: 3,
+            q: 2,
+            z: 0,
+            h: 1,
+            v: 1,
         };
         // Each command: Command character followed by anything that isn't a command character
-        const commandExp = /([MZLHVCSQTA])\s*([^MZLHVCSQTA]*)/ig;
+        const commandExp = /([MZLHVCSQTA])\s*([^MZLHVCSQTA]*)/gi;
         let current;
         while ((current = commandExp.exec(pathString)) !== null) {
-            const argParts = current[2].trim().split(/[^0-9Ee.-]/).filter(part => part.length > 0).reduce((accumualtor, current) => {
+            const argParts = current[2]
+                .trim()
+                .split(/[^0-9Ee.-]/)
+                .filter((part) => part.length > 0)
+                .reduce((accumualtor, current) => {
                 // As of 09/2022, iOS Safari doesn't support support lookbehind in regular
                 // expressions. As such, we need an alternative.
                 // Because '-' can be used as a path separator, unless preceeded by an 'e' (as in 1e-5),
@@ -1210,10 +1211,10 @@ class Path {
                 if (parts[0] !== '') {
                     accumualtor.push(parts[0]);
                 }
-                accumualtor.push(...parts.slice(1).map(part => `-${part}`));
+                accumualtor.push(...parts.slice(1).map((part) => `-${part}`));
                 return accumualtor;
             }, []);
-            let numericArgs = argParts.map(arg => parseFloat(arg));
+            let numericArgs = argParts.map((arg) => parseFloat(arg));
             let commandChar = current[1].toLowerCase();
             let uppercaseCommand = current[1] !== commandChar;
             // Convert commands that don't take points into commands that do.
@@ -1241,7 +1242,8 @@ class Path {
                 commandChar = 'l';
             }
             const commandArgCount = commandArgCounts[commandChar] ?? 0;
-            const allArgs = numericArgs.reduce((accumulator, current, index, parts) => {
+            const allArgs = numericArgs
+                .reduce((accumulator, current, index, parts) => {
                 if (index % 2 !== 0) {
                     const currentAsFloat = current;
                     const prevAsFloat = parts[index - 1];
@@ -1250,7 +1252,8 @@ class Path {
                 else {
                     return accumulator;
                 }
-            }, []).map((coordinate, index) => {
+            }, [])
+                .map((coordinate, index) => {
                 // Lowercase commands are relative, uppercase commands use absolute
                 // positioning
                 let newPos;

package/dist/cjs/shapes/QuadraticBezier.d.ts

@@ -2,9 +2,26 @@ import { Point2, Vec2 } from '../Vec2';
 import BezierJSWrapper from './BezierJSWrapper';
 import Rect2 from './Rect2';
 /**
- * Represents a 2D Bézier curve.
+ * Represents a 2D [Bézier curve](https://en.wikipedia.org/wiki/B%C3%A9zier_curve).
  *
- * **Note**: Many Bézier operations use `bezier-js`'s.
+ * Example:
+ * ```ts,runnable,console
+ * import { QuadraticBezier, Vec2 } from '@js-draw/math';
+ *
+ * const startPoint = Vec2.of(4, 3);
+ * const controlPoint = Vec2.of(1, 1);
+ * const endPoint = Vec2.of(1, 3);
+ *
+ * const curve = new QuadraticBezier(
+ *   startPoint,
+ *   controlPoint,
+ *   endPoint,
+ * );
+ *
+ * console.log('Curve:', curve);
+ * ```
+ *
+ * **Note**: Some Bézier operations internally use the `bezier-js` library.
  */
 export declare class QuadraticBezier extends BezierJSWrapper {
     readonly p0: Point2;

package/dist/cjs/shapes/QuadraticBezier.js

@@ -9,12 +9,35 @@ const solveQuadratic_1 = __importDefault(require("../polynomial/solveQuadratic")
 const BezierJSWrapper_1 = __importDefault(require("./BezierJSWrapper"));
 const Rect2_1 = __importDefault(require("./Rect2"));
 /**
- * Represents a 2D Bézier curve.
+ * Represents a 2D [Bézier curve](https://en.wikipedia.org/wiki/B%C3%A9zier_curve).
  *
- * **Note**: Many Bézier operations use `bezier-js`'s.
+ * Example:
+ * ```ts,runnable,console
+ * import { QuadraticBezier, Vec2 } from '@js-draw/math';
+ *
+ * const startPoint = Vec2.of(4, 3);
+ * const controlPoint = Vec2.of(1, 1);
+ * const endPoint = Vec2.of(1, 3);
+ *
+ * const curve = new QuadraticBezier(
+ *   startPoint,
+ *   controlPoint,
+ *   endPoint,
+ * );
+ *
+ * console.log('Curve:', curve);
+ * ```
+ *
+ * **Note**: Some Bézier operations internally use the `bezier-js` library.
  */
 class QuadraticBezier extends BezierJSWrapper_1.default {
-    constructor(p0, p1, p2) {
+    constructor(
+    // Start point
+    p0, 
+    // Control point
+    p1, 
+    // End point
+    p2) {
         super();
         this.p0 = p0;
         this.p1 = p1;

package/dist/cjs/shapes/Rect2.d.ts

@@ -15,6 +15,18 @@ export interface RectTemplate {
 /**
  * Represents a rectangle in 2D space, parallel to the XY axes.
  *
+ * **Example**:
+ * ```ts,runnable,console
+ * import { Rect2, Vec2 } from '@js-draw/math';
+ *
+ * const rect = Rect2.fromCorners(
+ *   Vec2.of(0, 0),
+ *   Vec2.of(10, 10),
+ * );
+ * console.log('area', rect.area);
+ * console.log('topLeft', rect.topLeft);
+ * ```
+ *
  * `invariant: w ≥ 0, h ≥ 0, immutable`
  */
 export declare class Rect2 extends Abstract2DShape {
@@ -29,6 +41,7 @@ export declare class Rect2 extends Abstract2DShape {
     translatedBy(vec: Vec2): Rect2;
     resizedTo(size: Vec2): Rect2;
     containsPoint(other: Point2): boolean;
+    /** @returns true iff `other` is completely within this `Rect2`. */
     containsRect(other: Rect2): boolean;
     /**
      * @returns true iff this and `other` overlap

package/dist/cjs/shapes/Rect2.js

@@ -10,10 +10,30 @@ const Abstract2DShape_1 = __importDefault(require("./Abstract2DShape"));
 /**
  * Represents a rectangle in 2D space, parallel to the XY axes.
  *
+ * **Example**:
+ * ```ts,runnable,console
+ * import { Rect2, Vec2 } from '@js-draw/math';
+ *
+ * const rect = Rect2.fromCorners(
+ *   Vec2.of(0, 0),
+ *   Vec2.of(10, 10),
+ * );
+ * console.log('area', rect.area);
+ * console.log('topLeft', rect.topLeft);
+ * ```
+ *
  * `invariant: w ≥ 0, h ≥ 0, immutable`
  */
 class Rect2 extends Abstract2DShape_1.default {
-    constructor(x, y, w, h) {
+    constructor(
+    // Top left x coordinate
+    x, 
+    // Top left y coordinate
+    y, 
+    // Width
+    w, 
+    // Height
+    h) {
         super();
         this.x = x;
         this.y = y;
@@ -40,13 +60,17 @@ class Rect2 extends Abstract2DShape_1.default {
         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;
+        return (this.x <= other.x &&
+            this.y <= other.y &&
+            this.x + this.w >= other.x &&
+            this.y + this.h >= other.y);
     }
+    /** @returns true iff `other` is completely within this `Rect2`. */
     containsRect(other) {
-        return this.x <= other.x && this.y <= other.y
-            && this.x + this.w >= other.x + other.w
-            && this.y + this.h >= other.y + other.h;
+        return (this.x <= other.x &&
+            this.y <= other.y &&
+            this.x + this.w >= other.x + other.w &&
+            this.y + this.h >= other.y + other.h);
     }
     /**
      * @returns true iff this and `other` overlap
@@ -131,7 +155,7 @@ class Rect2 extends Abstract2DShape_1.default {
         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 => {
+        const closestEdgePoints = this.getEdges().map((edge) => {
             return edge.closestPointTo(target);
         });
         let closest = null;
@@ -158,15 +182,10 @@ class Rect2 extends Abstract2DShape_1.default {
             return false;
         }
         const squareRadius = radius * radius;
-        return this.corners.every(corner => corner.minus(point).magnitudeSquared() < squareRadius);
+        return this.corners.every((corner) => corner.minus(point).magnitudeSquared() < squareRadius);
     }
     get corners() {
-        return [
-            this.bottomRight,
-            this.topRight,
-            this.topLeft,
-            this.bottomLeft,
-        ];
+        return [this.bottomRight, this.topRight, this.topLeft, this.bottomLeft];
     }
     get maxDimension() {
         return Math.max(this.w, this.h);
@@ -207,7 +226,7 @@ class Rect2 extends Abstract2DShape_1.default {
         const result = [];
         for (const edge of this.getEdges()) {
             const intersection = edge.intersectsLineSegment(lineSegment);
-            intersection.forEach(point => result.push(point));
+            intersection.forEach((point) => result.push(point));
         }
         return result;
     }
@@ -225,7 +244,7 @@ class Rect2 extends Abstract2DShape_1.default {
     // [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 Rect2.bboxOf(this.corners.map((corner) => affineTransform.transformVec2(corner)));
     }
     /** @return true iff this is equal to `other ± tolerance` */
     eq(other, tolerance = 0) {

package/dist/cjs/shapes/Triangle.js

@@ -44,12 +44,12 @@ class Triangle extends Abstract2DShape_1.default {
     }
     // Transform, treating this as composed of 2D points.
     transformed2DBy(affineTransform) {
-        return this.map(vertex => affineTransform.transformVec2(vertex));
+        return this.map((vertex) => affineTransform.transformVec2(vertex));
     }
     // Transforms this by a linear transform --- verticies are treated as
     // 3D points.
     transformedBy(linearTransform) {
-        return this.map(vertex => linearTransform.transformVec3(vertex));
+        return this.map((vertex) => linearTransform.transformVec3(vertex));
     }
     /**
      * Returns the sides of this triangle, as an array of `LineSegment2`s.
@@ -71,8 +71,7 @@ class Triangle extends Abstract2DShape_1.default {
     intersectsLineSegment(lineSegment) {
         const result = [];
         for (const edge of this.getEdges()) {
-            edge.intersectsLineSegment(lineSegment)
-                .forEach(point => result.push(point));
+            edge.intersectsLineSegment(lineSegment).forEach((point) => result.push(point));
         }
         return result;
     }
@@ -106,7 +105,7 @@ class Triangle extends Abstract2DShape_1.default {
      */
     signedDistance(point) {
         const sides = this.getEdges();
-        const distances = sides.map(side => side.distance(point));
+        const distances = sides.map((side) => side.distance(point));
         const distance = Math.min(...distances);
         // If the point is in this' interior, signedDistance must return a negative
         // number.

package/dist/cjs/utils/convexHull2Of.js

@@ -12,9 +12,9 @@ const convexHull2Of = (points) => {
         return [];
     }
     // 1. Start with a vertex on the hull
-    const lowestPoint = points.reduce((lowest, current) => current.y < lowest.y ? current : lowest, points[0]);
+    const lowestPoint = points.reduce((lowest, current) => (current.y < lowest.y ? current : lowest), points[0]);
     const vertices = [lowestPoint];
-    let toProcess = [...points.filter(p => !p.eq(lowestPoint))];
+    let toProcess = [...points.filter((p) => !p.eq(lowestPoint))];
     let lastBaseDirection = Vec2_1.Vec2.of(-1, 0);
     // 2. Find the point with greatest angle from the vertex:
     //
@@ -40,7 +40,7 @@ const convexHull2Of = (points) => {
                 smallestDotProductSoFar = currentDotProduct;
             }
         }
-        toProcess = toProcess.filter(p => !p.eq(furthestPointSoFar));
+        toProcess = toProcess.filter((p) => !p.eq(furthestPointSoFar));
         const newBaseDirection = furthestPointSoFar.minus(lastVertex).normalized();
         // If the last vertex is on the same edge as the current, there's no need to include
         // the previous one.

package/dist/mjs/Color4.d.ts

@@ -28,9 +28,32 @@ export declare class Color4 {
      * Each component should be in the range [0, 1].
      */
     static ofRGB(red: number, green: number, blue: number): Color4;
+    /**
+     * Creates a color from red, green, blue, and transparency components. Each component should
+     * be in the range $[0, 1]$.
+     */
     static ofRGBA(red: number, green: number, blue: number, alpha: number): Color4;
+    /**
+     * Creates a color from an RGB (or RGBA) array.
+     *
+     * This is similar to {@link ofRGB} and {@link ofRGBA}, but, by default, takes values
+     * that range from 0 to 255.
+     *
+     * If the array values instead range from 0-1, pass `maxValue` as `1`.
+     */
+    static fromRGBArray(array: Uint8Array | Uint8ClampedArray | number[], maxValue?: number): Color4;
+    /**
+     * Creates a `Color4` from a three or four-component hexadecimal
+     * [color string](https://en.wikipedia.org/wiki/Web_colors#Hex_triplet).
+     *
+     * Example:
+     * ```ts,runnable,console
+     * import { Color4 } from '@js-draw/math';
+     * console.log(Color4.fromHex('#ff0'));
+     * ```
+     */
     static fromHex(hexString: string): Color4;
-    /** Like fromHex, but can handle additional colors if an `HTMLCanvasElement` is available. */
+    /** Like {@link fromHex}, but can handle additional colors if an `HTMLCanvasElement` is available. */
     static fromString(text: string): Color4;
     /** @returns true if `this` and `other` are approximately equal. */
     eq(other: Color4 | null | undefined): boolean;

package/dist/mjs/Color4.mjs

@@ -36,6 +36,10 @@ export class Color4 {
     static ofRGB(red, green, blue) {
         return Color4.ofRGBA(red, green, blue, 1.0);
     }
+    /**
+     * Creates a color from red, green, blue, and transparency components. Each component should
+     * be in the range $[0, 1]$.
+     */
     static ofRGBA(red, green, blue, alpha) {
         red = Math.max(0, Math.min(red, 1));
         green = Math.max(0, Math.min(green, 1));
@@ -43,6 +47,34 @@ export class Color4 {
         alpha = Math.max(0, Math.min(alpha, 1));
         return new Color4(red, green, blue, alpha);
     }
+    /**
+     * Creates a color from an RGB (or RGBA) array.
+     *
+     * This is similar to {@link ofRGB} and {@link ofRGBA}, but, by default, takes values
+     * that range from 0 to 255.
+     *
+     * If the array values instead range from 0-1, pass `maxValue` as `1`.
+     */
+    static fromRGBArray(array, maxValue = 255) {
+        const red = array[0];
+        const green = array[1] ?? red;
+        const blue = array[2] ?? red;
+        let alpha = 255;
+        if (3 < array.length) {
+            alpha = array[3];
+        }
+        return Color4.ofRGBA(red / maxValue, green / maxValue, blue / maxValue, alpha / maxValue);
+    }
+    /**
+     * Creates a `Color4` from a three or four-component hexadecimal
+     * [color string](https://en.wikipedia.org/wiki/Web_colors#Hex_triplet).
+     *
+     * Example:
+     * ```ts,runnable,console
+     * import { Color4 } from '@js-draw/math';
+     * console.log(Color4.fromHex('#ff0'));
+     * ```
+     */
     static fromHex(hexString) {
         // Remove starting '#' (if present)
         hexString = (hexString.match(/^[#]?(.*)$/) ?? [])[1];
@@ -55,7 +87,7 @@ export class Color4 {
             // Each character is a component
             const components = hexString.split('');
             // Convert to RRGGBBAA or RRGGBB format
-            hexString = components.map(component => `${component}0`).join('');
+            hexString = components.map((component) => `${component}0`).join('');
         }
         if (hexString.length === 6) {
             // Alpha component
@@ -71,7 +103,7 @@ export class Color4 {
         }
         return Color4.ofRGBA(components[0], components[1], components[2], components[3]);
     }
-    /** Like fromHex, but can handle additional colors if an `HTMLCanvasElement` is available. */
+    /** Like {@link fromHex}, but can handle additional colors if an `HTMLCanvasElement` is available. */
     static fromString(text) {
         if (text.startsWith('#')) {
             return Color4.fromHex(text);
@@ -165,7 +197,7 @@ export class Color4 {
         // - https://www.w3.org/TR/2008/REC-WCAG20-20081211/#relativeluminancedef
         // - https://stackoverflow.com/a/9733420
         // Normalize the components, as per above
-        const components = [this.r, this.g, this.b].map(component => {
+        const components = [this.r, this.g, this.b].map((component) => {
             if (component < 0.03928) {
                 return component / 12.92;
             }

package/dist/mjs/Mat33.d.ts

@@ -3,17 +3,7 @@ import Vec3 from './Vec3';
 /**
  * See {@link Mat33.toArray}.
  */
-export type Mat33Array = [
-    number,
-    number,
-    number,
-    number,
-    number,
-    number,
-    number,
-    number,
-    number
-];
+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
@@ -216,6 +206,26 @@ export declare class Mat33 {
      * $$
      */
     static translation(amount: Vec2): Mat33;
+    /**
+     * Creates a matrix for rotating `Vec2`s about `center` by some number of `radians`.
+     *
+     * For this function, {@link Vec2}s are considered to be points in 2D space.
+     *
+     * For example,
+     * ```ts,runnable,console
+     * import { Mat33, Vec2 } from '@js-draw/math';
+     *
+     * const halfCircle = Math.PI; // PI radians = 180 degrees = 1/2 circle
+     * const center = Vec2.of(1, 1); // The point (1,1)
+     * const rotationMatrix = Mat33.zRotation(halfCircle, center);
+     *
+     * console.log(
+     *   'Rotating (0,0) 180deg about', center, 'results in',
+     *   // Rotates (0,0)
+     *   rotationMatrix.transformVec2(Vec2.zero),
+     * );
+     * ```
+     */
     static zRotation(radians: number, center?: Point2): Mat33;
     static scaling2D(amount: number | Vec2, center?: Point2): Mat33;
     /**