manim-web 0.13.0 → 0.14.0

package/dist/interaction/DynamicMatrix.d.ts

@@ -0,0 +1,164 @@
+import { Mobject, Vector3Tuple } from '../core/Mobject';
+/**
+ * A 2x2 linear map written row-major as `[[a, b], [c, d]]`, i.e.
+ * `| a  b |`
+ * `| c  d |`.
+ * Its columns are the images of the basis vectors: `i = (a, c)`, `j = (b, d)`.
+ */
+export type Matrix2x2 = [[number, number], [number, number]];
+/**
+ * A source of a live 2D basis vector. Either a getter that returns `[x, y]`, or
+ * any object with `getPoint()` (such as a {@link MovablePoint}) whose first two
+ * components are read.
+ */
+export type BasisVectorSource = (() => readonly [number, number]) | {
+    getPoint(): Vector3Tuple;
+};
+/**
+ * Anything that can drive {@link applyMatrixLive}: a fixed matrix, a getter that
+ * returns the current matrix, or a {@link MatrixTracker}.
+ */
+export type MatrixSource = Matrix2x2 | (() => Matrix2x2) | MatrixTracker;
+/**
+ * A mobject whose position follows the live transform, mapped from a fixed base
+ * position under the identity matrix.
+ */
+export interface DependentPoint {
+    /** The mobject to move each frame. */
+    mobject: Mobject;
+    /** Its position under the identity matrix, in the plane's coordinate space. */
+    base: Vector3Tuple;
+}
+/**
+ * Options for {@link applyMatrixLive}.
+ */
+export interface DynamicMatrixOptions {
+    /** Pivot the transform is applied about. Default `[0, 0, 0]` (the origin). */
+    aboutPoint?: Vector3Tuple;
+    /** Dependent points/vectors that follow the transform. */
+    dependents?: DependentPoint[];
+    /** Called with the current matrix after every re-map (e.g. to trigger a render). */
+    onChange?: (matrix: Matrix2x2) => void;
+}
+/**
+ * Handle returned by {@link applyMatrixLive}. Controls the live binding without
+ * re-reading the mobject.
+ */
+export interface LiveMatrixBinding {
+    /** The tracker driving the transform. */
+    readonly tracker: MatrixTracker;
+    /** The current matrix. */
+    getMatrix(): Matrix2x2;
+    /** Set the matrix and re-map immediately. */
+    setMatrix(matrix: Matrix2x2): LiveMatrixBinding;
+    /** Register a dependent point after binding. */
+    addDependentPoint(mobject: Mobject, base: Vector3Tuple): LiveMatrixBinding;
+    /** Re-map once from the current matrix (called automatically each frame). */
+    update(): LiveMatrixBinding;
+    /** Detach the per-frame updater so the geometry stops following the matrix. */
+    remove(): void;
+}
+/**
+ * MatrixTracker — holds a live 2x2 matrix, the matrix analogue of
+ * {@link ValueTracker}.
+ *
+ * It either stores a matrix directly (via the constructor or {@link setMatrix})
+ * or computes one on every read from a getter ({@link fromGetter}) or from two
+ * basis-vector sources ({@link fromBasisVectors}). Bind it to a grid with
+ * {@link applyMatrixLive}.
+ *
+ * @example
+ * ```typescript
+ * const iPoint = new MovablePoint(scene, { point: [1, 0, 0] });
+ * const jPoint = new MovablePoint(scene, { point: [0, 1, 0] });
+ * const tracker = MatrixTracker.fromBasisVectors(iPoint, jPoint);
+ * applyMatrixLive(plane, tracker, { onChange: () => scene.render() });
+ * ```
+ */
+export declare class MatrixTracker {
+    private _matrix;
+    private _compute;
+    /**
+     * Create a tracker holding a fixed matrix.
+     * @param matrix - The initial matrix. Default: the identity.
+     */
+    constructor(matrix?: Matrix2x2);
+    /**
+     * Get the current matrix as a fresh copy.
+     * @returns The current matrix.
+     */
+    getMatrix(): Matrix2x2;
+    /**
+     * Set the matrix directly, dropping any getter source.
+     * @param matrix - The new matrix.
+     * @returns this for chaining.
+     */
+    setMatrix(matrix: Matrix2x2): this;
+    /**
+     * Set the matrix from its two column basis vectors.
+     * @param i - The image of the x basis vector, `(a, c)`.
+     * @param j - The image of the y basis vector, `(b, d)`.
+     * @returns this for chaining.
+     */
+    setColumns(i: readonly [number, number], j: readonly [number, number]): this;
+    /**
+     * Get the two column basis vectors `[i, j]` of the current matrix.
+     * @returns `[i, j]` where `i = (a, c)` and `j = (b, d)`.
+     */
+    getColumns(): [[number, number], [number, number]];
+    /**
+     * Map a 2D point by the current matrix (about the origin).
+     * @param point - The point `[x, y]` to transform.
+     * @returns The transformed point `[x', y']`.
+     */
+    transformPoint(point: readonly [number, number]): [number, number];
+    /**
+     * Create a tracker whose matrix is recomputed from a getter on every read.
+     * @param getter - Returns the current matrix.
+     * @returns A new MatrixTracker.
+     */
+    static fromGetter(getter: () => Matrix2x2): MatrixTracker;
+    /**
+     * Create a tracker whose matrix is built live from two basis-vector sources.
+     * The columns follow the sources, so dragging a {@link MovablePoint} drives
+     * the matrix in real time.
+     * @param iSource - Source of the x basis vector image (first column).
+     * @param jSource - Source of the y basis vector image (second column).
+     * @returns A new MatrixTracker.
+     */
+    static fromBasisVectors(iSource: BasisVectorSource, jSource: BasisVectorSource): MatrixTracker;
+}
+/**
+ * Factory for a {@link MatrixTracker}.
+ * @param matrix - The initial matrix. Default: the identity.
+ * @returns A new MatrixTracker.
+ */
+export declare function makeMatrixTracker(matrix?: Matrix2x2): MatrixTracker;
+/**
+ * Bind a mobject to a live 2x2 matrix so it morphs continuously.
+ *
+ * Every VMobject leaf in `target`'s family is snapshotted at bind time. An
+ * updater is added to `target`; each frame it re-maps every snapshotted point
+ * by the current matrix (about `aboutPoint`) and moves any dependent points.
+ * Because the re-map always starts from the snapshot, the transform is absolute
+ * and free of per-frame drift — a collapsed (singular) matrix is just a flat
+ * grid, with full recovery on the next frame.
+ *
+ * The one-shot `applyMatrix` is untouched; this is the additive live mode.
+ *
+ * @param target - The grid/plane/mobject to morph (e.g. a `NumberPlane`).
+ * @param matrix - The driving matrix, getter, or {@link MatrixTracker}.
+ * @param options - Pivot, dependent points and an `onChange` render hook.
+ * @returns A {@link LiveMatrixBinding} controlling the binding.
+ *
+ * @example
+ * ```typescript
+ * const tracker = MatrixTracker.fromBasisVectors(iPoint, jPoint);
+ * applyMatrixLive(plane, tracker, {
+ *   dependents: [{ mobject: vector, base: [2, 1, 0] }],
+ *   onChange: () => scene.render(),
+ * });
+ * ```
+ */
+export declare function applyMatrixLive(target: Mobject, matrix: MatrixSource, options?: DynamicMatrixOptions): LiveMatrixBinding;
+//# sourceMappingURL=DynamicMatrix.d.ts.map

package/dist/interaction/DynamicMatrix.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DynamicMatrix.d.ts","sourceRoot":"","sources":["../../src/interaction/DynamicMatrix.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAAE,OAAO,EAAE,YAAY,EAAwB,MAAM,iBAAiB,CAAC;AAI9E;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAE7D;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,MAAM,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG;IAAE,QAAQ,IAAI,YAAY,CAAA;CAAE,CAAC;AAEjG;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,CAAC,MAAM,SAAS,CAAC,GAAG,aAAa,CAAC;AAEzE;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,sCAAsC;IACtC,OAAO,EAAE,OAAO,CAAC;IACjB,+EAA+E;IAC/E,IAAI,EAAE,YAAY,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,8EAA8E;IAC9E,UAAU,CAAC,EAAE,YAAY,CAAC;IAC1B,0DAA0D;IAC1D,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC;IAC9B,oFAAoF;IACpF,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,SAAS,KAAK,IAAI,CAAC;CACxC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,yCAAyC;IACzC,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;IAChC,0BAA0B;IAC1B,SAAS,IAAI,SAAS,CAAC;IACvB,6CAA6C;IAC7C,SAAS,CAAC,MAAM,EAAE,SAAS,GAAG,iBAAiB,CAAC;IAChD,gDAAgD;IAChD,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,GAAG,iBAAiB,CAAC;IAC3E,6EAA6E;IAC7E,MAAM,IAAI,iBAAiB,CAAC;IAC5B,+EAA+E;IAC/E,MAAM,IAAI,IAAI,CAAC;CAChB;AA4BD;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,OAAO,CAAY;IAC3B,OAAO,CAAC,QAAQ,CAA2B;IAE3C;;;OAGG;gBACS,MAAM,GAAE,SAA4B;IAKhD;;;OAGG;IACH,SAAS,IAAI,SAAS;IAItB;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI;IAMlC;;;;;OAKG;IACH,UAAU,CAAC,CAAC,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI;IAO5E;;;OAGG;IACH,UAAU,IAAI,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAQlD;;;;OAIG;IACH,cAAc,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;IAKlE;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,SAAS,GAAG,aAAa;IAMzD;;;;;;;OAOG;IACH,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,iBAAiB,EAAE,OAAO,EAAE,iBAAiB,GAAG,aAAa;CAU/F;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,CAAC,EAAE,SAAS,GAAG,aAAa,CAEnE;AAeD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,YAAY,EACpB,OAAO,GAAE,oBAAyB,GACjC,iBAAiB,CAoDnB"}

package/dist/interaction/index.d.ts

@@ -9,6 +9,7 @@ export { Hoverable, makeHoverable, type HoverableOptions } from './Hoverable';
 export { Clickable, makeClickable, type ClickableOptions } from './Clickable';
 export { MovablePoint, makeMovablePoint, type MovablePointOptions } from './MovablePoint';
 export { Slider, makeSlider, type SliderOptions } from './Slider';
+export { MatrixTracker, makeMatrixTracker, applyMatrixLive, type Matrix2x2, type MatrixSource, type BasisVectorSource, type DependentPoint, type DynamicMatrixOptions, type LiveMatrixBinding, } from './DynamicMatrix';
 export { SelectionManager, type SelectionManagerOptions } from './SelectionManager';
 export { OrbitControls, type OrbitControlsOptions } from './OrbitControls';
 //# sourceMappingURL=index.d.ts.map

package/dist/interaction/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/interaction/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,QAAQ,EACR,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,iBAAiB,GACvB,MAAM,YAAY,CAAC;AAEpB,OAAO,EACL,gBAAgB,EAChB,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,GACxB,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC9E,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC9E,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAG9E,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,KAAK,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAC1F,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AAGlE,OAAO,EAAE,gBAAgB,EAAE,KAAK,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAGpF,OAAO,EAAE,aAAa,EAAE,KAAK,oBAAoB,EAAE,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/interaction/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACL,QAAQ,EACR,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,iBAAiB,GACvB,MAAM,YAAY,CAAC;AAEpB,OAAO,EACL,gBAAgB,EAChB,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,GACxB,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC9E,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC9E,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAG9E,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,KAAK,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAC1F,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,aAAa,EAAE,MAAM,UAAU,CAAC;AAGlE,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,eAAe,EACf,KAAK,SAAS,EACd,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,oBAAoB,EACzB,KAAK,iBAAiB,GACvB,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EAAE,gBAAgB,EAAE,KAAK,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAGpF,OAAO,EAAE,aAAa,EAAE,KAAK,oBAAoB,EAAE,MAAM,iBAAiB,CAAC"}