manim-web 0.11.0 → 0.12.0

package/dist/interaction/MovablePoint.d.ts

@@ -0,0 +1,127 @@
+import { Dot } from '../mobjects/geometry/Dot';
+import { Vector3Tuple } from '../core/Mobject';
+import { Scene } from '../core/Scene';
+import { ValueTracker } from '../mobjects/value-tracker/ValueTracker';
+import { Draggable } from './Draggable';
+/**
+ * Options for creating a {@link MovablePoint}.
+ */
+export interface MovablePointOptions {
+    /** Initial position. Default: [0, 0, 0]. */
+    point?: Vector3Tuple;
+    /** Fill color as a CSS color string. Default: YELLOW. */
+    color?: string;
+    /** Radius of the dot. Default: 0.1. */
+    radius?: number;
+    /** Called with the new position whenever the point moves. */
+    onChange?: (position: Vector3Tuple) => void;
+    /** ValueTracker that receives the point's x coordinate. */
+    xTracker?: ValueTracker;
+    /** ValueTracker that receives the point's y coordinate. */
+    yTracker?: ValueTracker;
+    /**
+     * Re-render the scene after each drag update. Default: true. Set false when
+     * a render loop (play(), wait() with updaters) is already running.
+     */
+    autoRender?: boolean;
+}
+/**
+ * MovablePoint — a draggable in-scene point whose position drives bound values.
+ *
+ * It is a {@link Dot} the reader can drag with the mouse or a finger. Each move
+ * writes the new x and y into the bound {@link ValueTracker}s and calls
+ * `onChange`, so dependent mobjects update live through the normal updater or
+ * `alwaysRedraw` path. This is the Desmos-style interactivity that drives an
+ * explorable explanation.
+ *
+ * The point can be constrained to stay on a graph (`constrainToFunction`), a
+ * parametric curve (`constrainToParametric`), an infinite line
+ * (`constrainToLine`) or a finite segment (`constrainToSegment`).
+ *
+ * @example
+ * ```typescript
+ * const xT = new ValueTracker(1);
+ * const p = new MovablePoint(scene, { point: [1, 1, 0], xTracker: xT });
+ * p.constrainToFunction((x) => Math.sin(x));
+ * scene.add(p);
+ *
+ * // A label that always reads the live x value.
+ * const label = alwaysRedraw(() => new DecimalNumber({ value: xT.getValue() }));
+ * scene.add(label);
+ * ```
+ */
+export declare class MovablePoint extends Dot {
+    private _draggable;
+    private _onChange?;
+    private _xTracker?;
+    private _yTracker?;
+    private _constraint;
+    private _parameter;
+    /**
+     * Create a MovablePoint.
+     * @param scene - The scene the point lives in (needed for pointer events).
+     * @param options - Appearance, bound trackers and the change callback.
+     */
+    constructor(scene: Scene, options?: MovablePointOptions);
+    /**
+     * Move the point to a position, applying any active constraint, syncing the
+     * bound trackers and firing `onChange`.
+     * @param point - The requested position (before constraint projection).
+     * @returns this for chaining.
+     */
+    setPoint(point: Vector3Tuple): this;
+    /**
+     * Keep the point on the graph y = f(x) while dragging.
+     * @param fn - The graph function.
+     * @returns this for chaining.
+     */
+    constrainToFunction(fn: (x: number) => number): this;
+    /**
+     * Keep the point on a parametric curve, projecting the drag to the nearest
+     * point on the curve.
+     * @param fn - Maps a parameter t to a point [x, y].
+     * @param tRange - [tMin, tMax] and an optional sample count (default 256).
+     * @returns this for chaining.
+     */
+    constrainToParametric(fn: (t: number) => [number, number], tRange: [number, number] | [number, number, number]): this;
+    /**
+     * Keep the point on the infinite line through p1 and p2.
+     * @param p1 - A point on the line.
+     * @param p2 - A second point on the line.
+     * @returns this for chaining.
+     */
+    constrainToLine(p1: Vector3Tuple, p2: Vector3Tuple): this;
+    /**
+     * Keep the point on the finite segment from p1 to p2 (clamped to the ends).
+     * @param p1 - The start of the segment.
+     * @param p2 - The end of the segment.
+     * @returns this for chaining.
+     */
+    constrainToSegment(p1: Vector3Tuple, p2: Vector3Tuple): this;
+    /**
+     * Remove any active constraint so the point drags freely again.
+     * @returns this for chaining.
+     */
+    clearConstraint(): this;
+    /**
+     * Get the current parameter t from the last parametric projection, or null
+     * when no parametric constraint is active.
+     */
+    getParameter(): number | null;
+    /** Get the underlying {@link Draggable} behavior. */
+    getDraggable(): Draggable;
+    /** Remove pointer-event listeners. Call when the point is no longer used. */
+    dispose(): void;
+    /** Apply the current constraint to the current position without firing onChange. */
+    private _reproject;
+    private _commit;
+    private _syncTrackers;
+}
+/**
+ * Factory function to create a {@link MovablePoint}.
+ * @param scene - The scene the point lives in.
+ * @param options - Appearance, bound trackers and the change callback.
+ * @returns A new MovablePoint.
+ */
+export declare function makeMovablePoint(scene: Scene, options?: MovablePointOptions): MovablePoint;
+//# sourceMappingURL=MovablePoint.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"MovablePoint.d.ts","sourceRoot":"","sources":["../../src/interaction/MovablePoint.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,0BAA0B,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAC;AAEtE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAQxC;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,4CAA4C;IAC5C,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,yDAAyD;IACzD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,YAAY,KAAK,IAAI,CAAC;IAC5C,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,YAAa,SAAQ,GAAG;IACnC,OAAO,CAAC,UAAU,CAAY;IAC9B,OAAO,CAAC,SAAS,CAAC,CAAmC;IACrD,OAAO,CAAC,SAAS,CAAC,CAAe;IACjC,OAAO,CAAC,SAAS,CAAC,CAAe;IACjC,OAAO,CAAC,WAAW,CAAgC;IACnD,OAAO,CAAC,UAAU,CAAuB;IAEzC;;;;OAIG;gBACS,KAAK,EAAE,KAAK,EAAE,OAAO,GAAE,mBAAwB;IA0B3D;;;;;OAKG;IACM,QAAQ,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAK5C;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI;IAMpD;;;;;;OAMG;IACH,qBAAqB,CACnB,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,EACnC,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,GAClD,IAAI;IAcP;;;;;OAKG;IACH,eAAe,CAAC,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,YAAY,GAAG,IAAI;IAMzD;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,YAAY,GAAG,IAAI;IAM5D;;;OAGG;IACH,eAAe,IAAI,IAAI;IAMvB;;;OAGG;IACH,YAAY,IAAI,MAAM,GAAG,IAAI;IAI7B,qDAAqD;IACrD,YAAY,IAAI,SAAS;IAIzB,6EAA6E;IAC7E,OAAO,IAAI,IAAI;IAIf,oFAAoF;IACpF,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,OAAO;IAOf,OAAO,CAAC,aAAa;CAItB;AAkED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,YAAY,CAE1F"}

package/dist/interaction/Slider.d.ts

@@ -0,0 +1,125 @@
+import { Group } from '../core/Group';
+import { Vector3Tuple } from '../core/Mobject';
+import { Scene } from '../core/Scene';
+import { Dot } from '../mobjects/geometry/Dot';
+import { Line } from '../mobjects/geometry/Line';
+import { DecimalNumber } from '../mobjects/text/DecimalNumber';
+import { ValueTracker } from '../mobjects/value-tracker/ValueTracker';
+import { Draggable } from './Draggable';
+/**
+ * Options for creating a {@link Slider}.
+ */
+export interface SliderOptions {
+    /** Minimum value at the left end of the track. Default: 0. */
+    min?: number;
+    /** Maximum value at the right end of the track. Default: 1. */
+    max?: number;
+    /** Step to snap values to. 0 means continuous. Default: 0. */
+    step?: number;
+    /** Initial value. Default: min. */
+    value?: number;
+    /** Track length in world units. Default: 4. */
+    length?: number;
+    /** World position of the track center. Default: [0, 0, 0]. */
+    center?: Vector3Tuple;
+    /** Handle color as a CSS color string. Default: BLUE. */
+    color?: string;
+    /** Track color as a CSS color string. Default: GRAY. */
+    trackColor?: string;
+    /** Handle radius. Default: 0.12. */
+    handleRadius?: number;
+    /** ValueTracker to bind the slider value to. One is created when omitted. */
+    tracker?: ValueTracker;
+    /** Show a numeric label above the handle. Default: false. */
+    showLabel?: boolean;
+    /** Decimal places for the label. Default: 2. */
+    numDecimalPlaces?: number;
+    /** Called with the new value whenever the slider moves. */
+    onChange?: (value: number) => void;
+    /**
+     * Re-render the scene after each drag update. Default: true. Set false when
+     * a render loop (play(), wait() with updaters) is already running.
+     */
+    autoRender?: boolean;
+}
+/**
+ * Slider — an in-scene slider mobject bound to a {@link ValueTracker}.
+ *
+ * Unlike the DOM `Controls.addSlider` widget, this slider is drawn from
+ * mobjects (a track {@link Line} and a draggable handle {@link Dot}), so it
+ * lives in animation world space and exports and records with the scene.
+ * Dragging the handle maps its position to a value with min, max and step,
+ * writes the value into the bound tracker and calls `onChange`, so dependent
+ * mobjects update live through the normal updater or `alwaysRedraw` path.
+ *
+ * Position the slider with the `center` option rather than by moving the
+ * group, so the drag mapping stays aligned with the track.
+ *
+ * @example
+ * ```typescript
+ * const t = new ValueTracker(0);
+ * const slider = new Slider(scene, { min: -3, max: 3, step: 0.1, tracker: t });
+ * scene.add(slider);
+ * // A curve that redraws from the live slider value.
+ * scene.add(alwaysRedraw(() => axes.plot((x) => t.getValue() * x * x)));
+ * ```
+ */
+export declare class Slider extends Group {
+    private _min;
+    private _max;
+    private _step;
+    private _length;
+    private _center;
+    private _trackY;
+    private _value;
+    private _tracker;
+    private _onChange?;
+    private _track;
+    private _handle;
+    private _label;
+    private _draggable;
+    /**
+     * Create a Slider.
+     * @param scene - The scene the slider lives in (needed for pointer events).
+     * @param options - Range, step, appearance and the bound tracker.
+     */
+    constructor(scene: Scene, options?: SliderOptions);
+    /** Get the current slider value. */
+    getValue(): number;
+    /**
+     * Set the slider value, clamping to [min, max] and snapping to the step.
+     * Updates the handle position, the bound tracker, the label and fires
+     * `onChange`.
+     * @param value - The requested value.
+     * @returns this for chaining.
+     */
+    setValue(value: number): this;
+    /** Get the bound {@link ValueTracker}. */
+    getValueTracker(): ValueTracker;
+    /** Get the track {@link Line} mobject. */
+    getTrack(): Line;
+    /** Get the draggable handle {@link Dot} mobject. */
+    getHandle(): Dot;
+    /** Get the value label, or null when `showLabel` was not set. */
+    getLabel(): DecimalNumber | null;
+    /** Get the underlying {@link Draggable} behavior for the handle. */
+    getDraggable(): Draggable;
+    /** Remove pointer-event listeners. Call when the slider is no longer used. */
+    dispose(): void;
+    private _createLabel;
+    private _positionLabel;
+    /** Map a value to the handle's x coordinate along the track. */
+    private _valueToX;
+    /** Map a handle x coordinate to a clamped, stepped value. */
+    private _xToValue;
+    /** Clamp a value to [min, max] and snap it to the step. */
+    private _clampAndStep;
+}
+/**
+ * Factory function to create a {@link Slider}.
+ * @param scene - The scene the slider lives in.
+ * @param options - Range, step, appearance and the bound tracker.
+ * @returns A new Slider.
+ */
+export declare function makeSlider(scene: Scene, options?: SliderOptions): Slider;
+//# sourceMappingURL=Slider.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Slider.d.ts","sourceRoot":"","sources":["../../src/interaction/Slider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,GAAG,EAAE,MAAM,0BAA0B,CAAC;AAC/C,OAAO,EAAE,IAAI,EAAE,MAAM,2BAA2B,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAC;AAEtE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,8DAA8D;IAC9D,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,+DAA+D;IAC/D,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,8DAA8D;IAC9D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+CAA+C;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8DAA8D;IAC9D,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,yDAAyD;IACzD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wDAAwD;IACxD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,6EAA6E;IAC7E,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,6DAA6D;IAC7D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,gDAAgD;IAChD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAKD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,MAAO,SAAQ,KAAK;IAC/B,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAe;IAC9B,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,QAAQ,CAAe;IAC/B,OAAO,CAAC,SAAS,CAAC,CAA0B;IAE5C,OAAO,CAAC,MAAM,CAAO;IACrB,OAAO,CAAC,OAAO,CAAM;IACrB,OAAO,CAAC,MAAM,CAA8B;IAC5C,OAAO,CAAC,UAAU,CAAY;IAE9B;;;;OAIG;gBACS,KAAK,EAAE,KAAK,EAAE,OAAO,GAAE,aAAkB;IAyCrD,oCAAoC;IACpC,QAAQ,IAAI,MAAM;IAIlB;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAa7B,0CAA0C;IAC1C,eAAe,IAAI,YAAY;IAI/B,0CAA0C;IAC1C,QAAQ,IAAI,IAAI;IAIhB,oDAAoD;IACpD,SAAS,IAAI,GAAG;IAIhB,iEAAiE;IACjE,QAAQ,IAAI,aAAa,GAAG,IAAI;IAIhC,oEAAoE;IACpE,YAAY,IAAI,SAAS;IAIzB,8EAA8E;IAC9E,OAAO,IAAI,IAAI;IAIf,OAAO,CAAC,YAAY;IAWpB,OAAO,CAAC,cAAc;IAMtB,gEAAgE;IAChE,OAAO,CAAC,SAAS;IAOjB,6DAA6D;IAC7D,OAAO,CAAC,SAAS;IAQjB,2DAA2D;IAC3D,OAAO,CAAC,aAAa;CAOtB;AAyCD;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,MAAM,CAExE"}

package/dist/interaction/index.d.ts

@@ -7,6 +7,8 @@ export { PlaybackControls, type PlaybackControlsOptions, type TimeUpdateCallback
 export { Draggable, makeDraggable, type DraggableOptions } from './Draggable';
 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 { 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,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,EAAE,gBAAgB,EAAE,KAAK,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAGpF,OAAO,EAAE,aAAa,EAAE,KAAK,oBAAoB,EAAE,MAAM,iBAAiB,CAAC"}