manim-web 0.3.16 → 0.3.17

package/README.md

@@ -38,7 +38,47 @@ async function squareToCircle(scene: Scene) {
 }
 ```
 
-Or use a plain `<script>` tag — see the [examples](https://maloyan.github.io/manim-web/) for more.
+### Browser Usage
+
+Use manim-web directly in the browser with a `<script>` tag -- no bundler needed:
+
+```html
+<canvas id="canvas" width="800" height="450"></canvas>
+<script type="module">
+  import { Scene, Circle, Create } from 'https://esm.sh/manim-web@0.3.17';
+
+  const scene = new Scene({ canvasId: 'canvas' });
+  const circle = new Circle({ radius: 1.5 });
+  await scene.play(new Create(circle));
+</script>
+```
+
+Alternatively, use an [import map](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/script/type/importmap) for the self-hosted bundle:
+
+```html
+<script type="importmap">
+{
+  "imports": {
+    "three": "https://esm.sh/three@0.183.2"
+  }
+}
+</script>
+<script type="module">
+  import { Scene, Circle, Create } from './node_modules/manim-web/dist/index.js';
+  // ...
+</script>
+```
+
+Or use the self-contained browser bundle that includes Three.js (no import map needed):
+
+```html
+<script type="module">
+  import { Scene, Circle, Create } from './node_modules/manim-web/dist/manim-web.browser.js';
+  // ...
+</script>
+```
+
+See the [examples](https://maloyan.github.io/manim-web/) for more.
 
 ## What You Can Build
 

package/dist/animation/AnimationUtilities.d.ts

@@ -0,0 +1,64 @@
+import { Mobject } from '../core/Mobject';
+import { Animation, AnimationOptions } from './Animation';
+/**
+ * Type for animation override functions
+ */
+export type AnimationOverrideFunc = (mobject: Mobject, animArgs?: AnimationOptions) => Animation;
+/**
+ * overrideAnimation - Register a custom animation for a mobject method
+ *
+ * When using the `.animate` pattern, if a method has a registered override,
+ * the override animation will be used instead of the default interpolation.
+ *
+ * @param methodName The name of the method to override
+ * @param className The class name to scope the override to
+ * @param animFunc The function that creates the override animation
+ *
+ * @example
+ * ```typescript
+ * // Register a custom animation for clearContent
+ * overrideAnimation('clearContent', 'MyMobject', (mobject, args) => {
+ *   return new Uncreate(mobject, args);
+ * });
+ * ```
+ */
+export declare function overrideAnimation(methodName: string, className: string, animFunc: AnimationOverrideFunc): void;
+/**
+ * getAnimationOverride - Get registered animation override for a method
+ *
+ * @param methodName The method name to check
+ * @param className The class name to check
+ * @returns The override function if registered, undefined otherwise
+ */
+export declare function getAnimationOverride(methodName: string, className: string): AnimationOverrideFunc | undefined;
+/**
+ * hasAnimationOverride - Check if a method has an animation override
+ */
+export declare function hasAnimationOverride(methodName: string, className: string): boolean;
+/**
+ * clearAnimationOverrides - Remove all overrides for a class
+ */
+export declare function clearAnimationOverrides(className: string): void;
+/**
+ * prepareAnimation - Normalize animation input to a consistent Animation instance
+ *
+ * Accepts an Animation object, a callable that returns an Animation, or
+ * other animation-like inputs and converts them to a proper Animation instance.
+ *
+ * @param animInput An Animation instance, a function returning an Animation, or a Mobject
+ * @returns A normalized Animation instance
+ *
+ * @example
+ * ```typescript
+ * // Direct animation
+ * const anim1 = prepareAnimation(new FadeIn(circle));
+ *
+ * // Function that returns animation
+ * const anim2 = prepareAnimation(() => new FadeIn(circle));
+ *
+ * // With animation args
+ * const anim3 = prepareAnimation(new Create(square, { duration: 2 }));
+ * ```
+ */
+export declare function prepareAnimation(animInput: Animation | (() => Animation)): Animation;
+//# sourceMappingURL=AnimationUtilities.d.ts.map

package/dist/animation/AnimationUtilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnimationUtilities.d.ts","sourceRoot":"","sources":["../../src/animation/AnimationUtilities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,gBAAgB,KAAK,SAAS,CAAC;AAOjG;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,qBAAqB,GAC9B,IAAI,CAKN;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,GAChB,qBAAqB,GAAG,SAAS,CAEnC;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAEnF;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAE/D;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,CAAC,MAAM,SAAS,CAAC,GAAG,SAAS,CAgBpF"}

package/dist/animation/transform/TransformMatchingBase.d.ts

@@ -0,0 +1,64 @@
+import { VMobject } from '../../core/VMobject';
+import { Animation, AnimationOptions } from '../Animation';
+export interface TransformMatchingBaseOptions extends AnimationOptions {
+    /** Key function to extract identifier for matching */
+    keyFunc?: (vmobject: VMobject) => string;
+    /** Fade duration as fraction of total duration (0-0.5). Default: 0.25 */
+    fadeRatio?: number;
+}
+interface MatchedPart {
+    source: VMobject;
+    target: VMobject;
+    startPoints: number[][];
+    targetPoints: number[][];
+    startOpacity: number;
+    targetOpacity: number;
+}
+interface FadingPart {
+    mobject: VMobject;
+    fadeIn: boolean;
+    startOpacity: number;
+    targetOpacity: number;
+}
+export declare abstract class TransformMatchingAbstractBase extends Animation {
+    /** The target mobject to transform into */
+    readonly target: VMobject;
+    /** Optional key function for matching */
+    readonly keyFunc?: (vmobject: VMobject) => string;
+    /** Fade duration ratio */
+    readonly fadeRatio: number;
+    /** Matched parts that will transform */
+    protected _matchedParts: MatchedPart[];
+    /** Source parts that will fade out (no match in target) */
+    protected _fadeOutParts: FadingPart[];
+    /** Target parts that will fade in (no match in source) */
+    protected _fadeInParts: FadingPart[];
+    constructor(source: VMobject, target: VMobject, options?: TransformMatchingBaseOptions);
+    /**
+     * Get the submobjects/parts to match from a given VMobject.
+     * Subclasses must implement this to define how mobjects are decomposed.
+     */
+    protected abstract _getSubmobjects(vmobject: VMobject): VMobject[];
+    /**
+     * Get a matching key for a VMobject part.
+     * Parts with the same key will be matched together.
+     * Subclasses must implement this.
+     */
+    protected abstract _getKey(vmobject: VMobject): string;
+    /**
+     * Match submobjects between source and target.
+     * Uses key-based exact matching by default. Subclasses can override
+     * to add additional matching strategies (e.g., similarity-based).
+     */
+    protected _matchParts(): void;
+    /**
+     * Add a matched pair of source and target parts.
+     * Aligns their points so they can be smoothly interpolated.
+     */
+    protected _addMatchedPart(source: VMobject, target: VMobject): void;
+    begin(): void;
+    interpolate(alpha: number): void;
+    finish(): void;
+}
+export {};
+//# sourceMappingURL=TransformMatchingBase.d.ts.map

package/dist/animation/transform/TransformMatchingBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransformMatchingBase.d.ts","sourceRoot":"","sources":["../../../src/animation/transform/TransformMatchingBase.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAG3D,MAAM,WAAW,4BAA6B,SAAQ,gBAAgB;IACpE,sDAAsD;IACtD,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,MAAM,CAAC;IACzC,yEAAyE;IACzE,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,UAAU,WAAW;IACnB,MAAM,EAAE,QAAQ,CAAC;IACjB,MAAM,EAAE,QAAQ,CAAC;IACjB,WAAW,EAAE,MAAM,EAAE,EAAE,CAAC;IACxB,YAAY,EAAE,MAAM,EAAE,EAAE,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,UAAU,UAAU;IAClB,OAAO,EAAE,QAAQ,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,8BAAsB,6BAA8B,SAAQ,SAAS;IACnE,2CAA2C;IAC3C,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;IAE1B,yCAAyC;IACzC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,MAAM,CAAC;IAElD,0BAA0B;IAC1B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B,wCAAwC;IACxC,SAAS,CAAC,aAAa,EAAE,WAAW,EAAE,CAAM;IAE5C,2DAA2D;IAC3D,SAAS,CAAC,aAAa,EAAE,UAAU,EAAE,CAAM;IAE3C,0DAA0D;IAC1D,SAAS,CAAC,YAAY,EAAE,UAAU,EAAE,CAAM;gBAE9B,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAE,4BAAiC;IAO1F;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,QAAQ,EAAE;IAElE;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM;IAEtD;;;;OAIG;IACH,SAAS,CAAC,WAAW,IAAI,IAAI;IAuE7B;;;OAGG;IACH,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAG,IAAI;IAkB1D,KAAK,IAAI,IAAI;IAKtB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IA0BvB,MAAM,IAAI,IAAI;CAmBxB"}

package/dist/animation/transform/index.d.ts

@@ -3,6 +3,7 @@ export { ApplyFunction, applyFunction, type ApplyFunctionOptions, ApplyMethod, a
 export { FadeTransform, fadeTransform, type FadeTransformOptions, FadeTransformPieces, fadeTransformPieces, type FadeTransformPiecesOptions, TransformFromCopy, transformFromCopy, type TransformFromCopyOptions, } from './FadeTransforms';
 export { ClockwiseTransform, clockwiseTransform, type ClockwiseTransformOptions, CounterclockwiseTransform, counterclockwiseTransform, type CounterclockwiseTransformOptions, Swap, swap, type SwapOptions, CyclicReplace, cyclicReplace, type CyclicReplaceOptions, } from './MovementTransforms';
 export { ScaleInPlace, scaleInPlace, type ScaleInPlaceOptions, ShrinkToCenter, shrinkToCenter, type ShrinkToCenterOptions, Restore, restore, type MobjectWithSavedState, type RestoreOptions, FadeToColor, fadeToColor, type FadeToColorOptions, TransformAnimations, transformAnimations, type TransformAnimationsOptions, } from './SpecialTransforms';
+export { TransformMatchingAbstractBase, type TransformMatchingBaseOptions, } from './TransformMatchingBase';
 export { TransformMatchingShapes, transformMatchingShapes, type TransformMatchingShapesOptions, TransformMatchingTex, transformMatchingTex, type TransformMatchingTexOptions, } from './TransformMatching';
 export { ApplyPointwiseFunction, applyPointwiseFunction, type ApplyPointwiseFunctionOptions, } from './ApplyPointwiseFunction';
 export { ApplyPointwiseFunctionToCenter, applyPointwiseFunctionToCenter, type ApplyPointwiseFunctionToCenterOptions, } from './ApplyPointwiseFunctionToCenter';

package/dist/animation/transform/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/animation/transform/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,SAAS,EACT,oBAAoB,EACpB,oBAAoB,EACpB,YAAY,EACZ,YAAY,EACZ,KAAK,iBAAiB,GACvB,MAAM,aAAa,CAAC;AAErB,OAAO,EAEL,aAAa,EACb,aAAa,EACb,KAAK,oBAAoB,EAGzB,WAAW,EACX,WAAW,EACX,KAAK,kBAAkB,EAGvB,WAAW,EACX,WAAW,EACX,KAAK,kBAAkB,EAGvB,oBAAoB,EACpB,oBAAoB,EACpB,KAAK,2BAA2B,GACjC,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAEL,aAAa,EACb,aAAa,EACb,KAAK,oBAAoB,EAGzB,mBAAmB,EACnB,mBAAmB,EACnB,KAAK,0BAA0B,EAG/B,iBAAiB,EACjB,iBAAiB,EACjB,KAAK,wBAAwB,GAC9B,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAEL,kBAAkB,EAClB,kBAAkB,EAClB,KAAK,yBAAyB,EAG9B,yBAAyB,EACzB,yBAAyB,EACzB,KAAK,gCAAgC,EAGrC,IAAI,EACJ,IAAI,EACJ,KAAK,WAAW,EAGhB,aAAa,EACb,aAAa,EACb,KAAK,oBAAoB,GAC1B,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAEL,YAAY,EACZ,YAAY,EACZ,KAAK,mBAAmB,EAGxB,cAAc,EACd,cAAc,EACd,KAAK,qBAAqB,EAG1B,OAAO,EACP,OAAO,EACP,KAAK,qBAAqB,EAC1B,KAAK,cAAc,EAGnB,WAAW,EACX,WAAW,EACX,KAAK,kBAAkB,EAGvB,mBAAmB,EACnB,mBAAmB,EACnB,KAAK,0BAA0B,GAChC,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAEL,uBAAuB,EACvB,uBAAuB,EACvB,KAAK,8BAA8B,EAGnC,oBAAoB,EACpB,oBAAoB,EACpB,KAAK,2BAA2B,GACjC,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,sBAAsB,EACtB,sBAAsB,EACtB,KAAK,6BAA6B,GACnC,MAAM,0BAA0B,CAAC;AAElC,OAAO,EACL,8BAA8B,EAC9B,8BAA8B,EAC9B,KAAK,qCAAqC,GAC3C,MAAM,kCAAkC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/animation/transform/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,SAAS,EACT,oBAAoB,EACpB,oBAAoB,EACpB,YAAY,EACZ,YAAY,EACZ,KAAK,iBAAiB,GACvB,MAAM,aAAa,CAAC;AAErB,OAAO,EAEL,aAAa,EACb,aAAa,EACb,KAAK,oBAAoB,EAGzB,WAAW,EACX,WAAW,EACX,KAAK,kBAAkB,EAGvB,WAAW,EACX,WAAW,EACX,KAAK,kBAAkB,EAGvB,oBAAoB,EACpB,oBAAoB,EACpB,KAAK,2BAA2B,GACjC,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAEL,aAAa,EACb,aAAa,EACb,KAAK,oBAAoB,EAGzB,mBAAmB,EACnB,mBAAmB,EACnB,KAAK,0BAA0B,EAG/B,iBAAiB,EACjB,iBAAiB,EACjB,KAAK,wBAAwB,GAC9B,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAEL,kBAAkB,EAClB,kBAAkB,EAClB,KAAK,yBAAyB,EAG9B,yBAAyB,EACzB,yBAAyB,EACzB,KAAK,gCAAgC,EAGrC,IAAI,EACJ,IAAI,EACJ,KAAK,WAAW,EAGhB,aAAa,EACb,aAAa,EACb,KAAK,oBAAoB,GAC1B,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAEL,YAAY,EACZ,YAAY,EACZ,KAAK,mBAAmB,EAGxB,cAAc,EACd,cAAc,EACd,KAAK,qBAAqB,EAG1B,OAAO,EACP,OAAO,EACP,KAAK,qBAAqB,EAC1B,KAAK,cAAc,EAGnB,WAAW,EACX,WAAW,EACX,KAAK,kBAAkB,EAGvB,mBAAmB,EACnB,mBAAmB,EACnB,KAAK,0BAA0B,GAChC,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,6BAA6B,EAC7B,KAAK,4BAA4B,GAClC,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAEL,uBAAuB,EACvB,uBAAuB,EACvB,KAAK,8BAA8B,EAGnC,oBAAoB,EACpB,oBAAoB,EACpB,KAAK,2BAA2B,GACjC,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,sBAAsB,EACtB,sBAAsB,EACtB,KAAK,6BAA6B,GACnC,MAAM,0BAA0B,CAAC;AAElC,OAAO,EACL,8BAA8B,EAC9B,8BAA8B,EAC9B,KAAK,qCAAqC,GAC3C,MAAM,kCAAkC,CAAC"}