manim-web 0.2.0

package/dist/mobjects/text/TextExtensions.d.ts

@@ -0,0 +1,383 @@
+import { Mobject } from '../../core/Mobject';
+import { VMobject } from '../../core/VMobject';
+import { Text } from './Text';
+import * as THREE from 'three';
+/**
+ * Options for creating a BulletedList mobject
+ */
+export interface BulletedListOptions {
+    /** Array of text items to display */
+    items: string[];
+    /** Bullet character. Default: '•' */
+    bulletChar?: string;
+    /** Font size in pixels. Default: 48 */
+    fontSize?: number;
+    /** Font family. Default: 'sans-serif' */
+    fontFamily?: string;
+    /** Font weight. Default: 'normal' */
+    fontWeight?: string | number;
+    /** Text color as CSS color string. Default: '#ffffff' */
+    color?: string;
+    /** Fill opacity from 0 to 1. Default: 1 */
+    fillOpacity?: number;
+    /** Vertical spacing between items in world units. Default: 0.35 */
+    itemSpacing?: number;
+    /** Horizontal indent per level in world units. Default: 0.3 */
+    indentWidth?: number;
+    /** Indentation levels for each item (0 = no indent). Default: all 0 */
+    indentLevels?: number[];
+    /** Space between bullet and text in world units. Default: 0.15 */
+    bulletBuffer?: number;
+}
+/**
+ * BulletedList - A list of text items with bullet points
+ *
+ * Creates a vertically arranged list of text items, each prefixed with
+ * a bullet character. Supports multiple indentation levels for nested lists.
+ *
+ * @example
+ * ```typescript
+ * // Simple bulleted list
+ * const list = new BulletedList({
+ *   items: ['First item', 'Second item', 'Third item']
+ * });
+ *
+ * // Nested list with custom bullet
+ * const nested = new BulletedList({
+ *   items: ['Main item', 'Sub item 1', 'Sub item 2', 'Another main'],
+ *   indentLevels: [0, 1, 1, 0],
+ *   bulletChar: '-'
+ * });
+ *
+ * // Custom styling
+ * const styled = new BulletedList({
+ *   items: ['Red', 'Green', 'Blue'],
+ *   color: '#ffcc00',
+ *   fontSize: 36,
+ *   itemSpacing: 0.5
+ * });
+ * ```
+ */
+export declare class BulletedList extends VMobject {
+    protected _items: string[];
+    protected _bulletChar: string;
+    protected _fontSize: number;
+    protected _fontFamily: string;
+    protected _fontWeight: string | number;
+    protected _textColor: string;
+    protected _textFillOpacity: number;
+    protected _itemSpacing: number;
+    protected _indentWidth: number;
+    protected _indentLevels: number[];
+    protected _bulletBuffer: number;
+    /** The Text mobjects for each bullet */
+    protected _bulletMobjects: Text[];
+    /** The Text mobjects for each item */
+    protected _itemMobjects: Text[];
+    constructor(options: BulletedListOptions);
+    /**
+     * Build the bullet and item Text mobjects
+     */
+    protected _buildList(): void;
+    /**
+     * Get the items array
+     */
+    getItems(): string[];
+    /**
+     * Set new items and rebuild the list
+     * @param items - New array of text items
+     * @returns this for chaining
+     */
+    setItems(items: string[]): this;
+    /**
+     * Get a specific item Text mobject by index
+     * @param index - Item index (0-based)
+     * @returns The Text mobject for the item, or undefined if out of bounds
+     */
+    getItemMobject(index: number): Text | undefined;
+    /**
+     * Get a specific bullet Text mobject by index
+     * @param index - Item index (0-based)
+     * @returns The Text mobject for the bullet, or undefined if out of bounds
+     */
+    getBulletMobject(index: number): Text | undefined;
+    /**
+     * Get the bullet character
+     */
+    getBulletChar(): string;
+    /**
+     * Set the bullet character and rebuild
+     * @param char - New bullet character
+     * @returns this for chaining
+     */
+    setBulletChar(char: string): this;
+    /**
+     * Create the Three.js backing object
+     */
+    protected _createThreeObject(): THREE.Object3D;
+    /**
+     * Create a copy of this BulletedList
+     */
+    protected _createCopy(): BulletedList;
+}
+/**
+ * Options for creating a Title mobject
+ */
+export interface TitleOptions {
+    /** The title text to display */
+    text: string;
+    /** Font size in pixels. Default: 72 (large) */
+    fontSize?: number;
+    /** Font family. Default: 'sans-serif' */
+    fontFamily?: string;
+    /** Font weight. Default: 'bold' */
+    fontWeight?: string | number;
+    /** Text color as CSS color string. Default: '#ffffff' */
+    color?: string;
+    /** Fill opacity from 0 to 1. Default: 1 */
+    fillOpacity?: number;
+    /** Whether to include an underline. Default: false */
+    includeUnderline?: boolean;
+    /** Underline color. Default: same as text color */
+    underlineColor?: string;
+    /** Underline width in world units. Default: auto (match text width) */
+    underlineWidth?: number;
+    /** Underline stroke width. Default: 4 */
+    underlineStrokeWidth?: number;
+    /** Space between text and underline in world units. Default: 0.15 */
+    underlineBuffer?: number;
+    /** Y position from top of frame. Default: 3.5 (near top of standard 8-unit frame) */
+    yPosition?: number;
+}
+/**
+ * Title - Large, centered title text at the top of the frame
+ *
+ * Creates a prominent title positioned at the top of the frame.
+ * Optionally includes an underline for emphasis.
+ *
+ * @example
+ * ```typescript
+ * // Simple title
+ * const title = new Title({ text: 'Introduction' });
+ *
+ * // Title with underline
+ * const underlined = new Title({
+ *   text: 'Chapter 1',
+ *   includeUnderline: true
+ * });
+ *
+ * // Custom styled title
+ * const styled = new Title({
+ *   text: 'Custom Title',
+ *   fontSize: 96,
+ *   color: '#ff6600',
+ *   fontFamily: 'Georgia',
+ *   includeUnderline: true,
+ *   underlineColor: '#ffcc00'
+ * });
+ * ```
+ */
+export declare class Title extends VMobject {
+    protected _titleText: string;
+    protected _fontSize: number;
+    protected _fontFamily: string;
+    protected _fontWeight: string | number;
+    protected _textColor: string;
+    protected _textFillOpacity: number;
+    protected _includeUnderline: boolean;
+    protected _underlineColor: string;
+    protected _underlineWidth: number | null;
+    protected _underlineStrokeWidth: number;
+    protected _underlineBuffer: number;
+    protected _yPosition: number;
+    /** The Text mobject for the title */
+    protected _textMobject: Text | null;
+    /** The underline VMobject (if included) */
+    protected _underlineMobject: VMobject | null;
+    constructor(options: TitleOptions);
+    /**
+     * Build the title text and optional underline
+     */
+    protected _buildTitle(): void;
+    /**
+     * Get the title text
+     */
+    getTitleText(): string;
+    /**
+     * Set new title text and rebuild
+     * @param text - New title text
+     * @returns this for chaining
+     */
+    setTitleText(text: string): this;
+    /**
+     * Get the Text mobject for the title
+     */
+    getTextMobject(): Text | null;
+    /**
+     * Get the underline mobject (if present)
+     */
+    getUnderlineMobject(): VMobject | null;
+    /**
+     * Show or hide the underline
+     * @param show - Whether to show the underline
+     * @returns this for chaining
+     */
+    setUnderline(show: boolean): this;
+    /**
+     * Create the Three.js backing object
+     */
+    protected _createThreeObject(): THREE.Object3D;
+    /**
+     * Create a copy of this Title
+     */
+    protected _createCopy(): Title;
+}
+/**
+ * Token types for markdown parsing
+ */
+type MarkdownTokenType = 'text' | 'bold' | 'italic' | 'code' | 'header' | 'bullet';
+/**
+ * Parsed markdown token
+ */
+interface MarkdownToken {
+    type: MarkdownTokenType;
+    text: string;
+    level?: number;
+}
+/**
+ * Parsed markdown line
+ */
+interface MarkdownLine {
+    tokens: MarkdownToken[];
+    isHeader: boolean;
+    headerLevel: number;
+    isBullet: boolean;
+    bulletLevel: number;
+}
+/**
+ * Options for creating a MarkdownText mobject
+ */
+export interface MarkdownTextOptions {
+    /** The markdown text to parse and display */
+    text: string;
+    /** Base font size in pixels. Default: 48 */
+    fontSize?: number;
+    /** Font family for regular text. Default: 'sans-serif' */
+    fontFamily?: string;
+    /** Font family for code text. Default: 'monospace' */
+    codeFontFamily?: string;
+    /** Text color as CSS color string. Default: '#ffffff' */
+    color?: string;
+    /** Code text color. Default: '#88ff88' */
+    codeColor?: string;
+    /** Fill opacity from 0 to 1. Default: 1 */
+    fillOpacity?: number;
+    /** Line height multiplier. Default: 1.4 */
+    lineHeight?: number;
+    /** Bullet character. Default: '•' */
+    bulletChar?: string;
+    /** Font size multipliers for headers [h1, h2, h3]. Default: [1.5, 1.25, 1.1] */
+    headerSizes?: [number, number, number];
+}
+/**
+ * MarkdownText - Parse and render simple markdown formatting
+ *
+ * Supports basic markdown syntax:
+ * - **bold** text
+ * - *italic* text
+ * - `code` inline formatting
+ * - # Header 1, ## Header 2, ### Header 3
+ * - Bullet lists with - or *
+ *
+ * @example
+ * ```typescript
+ * // Simple formatted text
+ * const md = new MarkdownText({
+ *   text: 'This is **bold** and *italic* text'
+ * });
+ *
+ * // Document with headers and lists
+ * const doc = new MarkdownText({
+ *   text: `# Main Title
+ *
+ * Some regular text with **bold** words.
+ *
+ * ## Section
+ *
+ * - First item
+ * - Second item
+ * - Third with \`code\`
+ * `
+ * });
+ *
+ * // Custom styling
+ * const styled = new MarkdownText({
+ *   text: '# Custom Header\n\nWith **styled** text.',
+ *   color: '#ffcc00',
+ *   codeColor: '#00ffcc',
+ *   headerSizes: [2.0, 1.5, 1.2]
+ * });
+ * ```
+ */
+export declare class MarkdownText extends VMobject {
+    protected _markdownText: string;
+    protected _fontSize: number;
+    protected _fontFamily: string;
+    protected _codeFontFamily: string;
+    protected _textColor: string;
+    protected _codeColor: string;
+    protected _textFillOpacity: number;
+    protected _lineHeight: number;
+    protected _bulletChar: string;
+    protected _headerSizes: [number, number, number];
+    /** Parsed lines of markdown */
+    protected _parsedLines: MarkdownLine[];
+    /** Text mobjects for each line */
+    protected _lineMobjects: Mobject[];
+    constructor(options: MarkdownTextOptions);
+    /**
+     * Parse markdown text into tokens
+     */
+    protected _parseMarkdown(): void;
+    /**
+     * Parse a single line of markdown
+     */
+    protected _parseLine(line: string): MarkdownLine;
+    /**
+     * Parse inline formatting (bold, italic, code)
+     */
+    protected _parseInlineFormatting(text: string): MarkdownToken[];
+    /**
+     * Build the document from parsed markdown
+     */
+    protected _buildDocument(): void;
+    /**
+     * Get the markdown text
+     */
+    getMarkdownText(): string;
+    /**
+     * Set new markdown text and rebuild
+     * @param text - New markdown text
+     * @returns this for chaining
+     */
+    setMarkdownText(text: string): this;
+    /**
+     * Get all line mobjects
+     */
+    getLineMobjects(): Mobject[];
+    /**
+     * Create the Three.js backing object
+     */
+    protected _createThreeObject(): THREE.Object3D;
+    /**
+     * Create a copy of this MarkdownText
+     */
+    protected _createCopy(): MarkdownText;
+}
+declare const _default: {
+    BulletedList: typeof BulletedList;
+    Title: typeof Title;
+    MarkdownText: typeof MarkdownText;
+};
+export default _default;
+//# sourceMappingURL=TextExtensions.d.ts.map

package/dist/mobjects/text/TextExtensions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextExtensions.d.ts","sourceRoot":"","sources":["../../../src/mobjects/text/TextExtensions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAM9B;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,qCAAqC;IACrC,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,qCAAqC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,uCAAuC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yCAAyC;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qCAAqC;IACrC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7B,yDAAyD;IACzD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mEAAmE;IACnE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+DAA+D;IAC/D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uEAAuE;IACvE,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,kEAAkE;IAClE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,YAAa,SAAQ,QAAQ;IACxC,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;IAC3B,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAC5B,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;IACvC,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,gBAAgB,EAAE,MAAM,CAAC;IACnC,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC;IAC/B,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC;IAC/B,SAAS,CAAC,aAAa,EAAE,MAAM,EAAE,CAAC;IAClC,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC;IAEhC,wCAAwC;IACxC,SAAS,CAAC,eAAe,EAAE,IAAI,EAAE,CAAM;IAEvC,sCAAsC;IACtC,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,CAAM;gBAEzB,OAAO,EAAE,mBAAmB;IAmCxC;;OAEG;IACH,SAAS,CAAC,UAAU,IAAI,IAAI;IA0D5B;;OAEG;IACH,QAAQ,IAAI,MAAM,EAAE;IAIpB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI;IAS/B;;;;OAIG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAI/C;;;;OAIG;IACH,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAIjD;;OAEG;IACH,aAAa,IAAI,MAAM;IAIvB;;;;OAIG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAMjC;;OAEG;cACgB,kBAAkB,IAAI,KAAK,CAAC,QAAQ;IAMvD;;OAEG;cACgB,WAAW,IAAI,YAAY;CAe/C;AAMD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yCAAyC;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mCAAmC;IACnC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7B,yDAAyD;IACzD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sDAAsD;IACtD,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,mDAAmD;IACnD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,uEAAuE;IACvE,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,yCAAyC;IACzC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,qEAAqE;IACrE,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,qFAAqF;IACrF,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,KAAM,SAAQ,QAAQ;IACjC,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAC5B,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;IACvC,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,gBAAgB,EAAE,MAAM,CAAC;IACnC,SAAS,CAAC,iBAAiB,EAAE,OAAO,CAAC;IACrC,SAAS,CAAC,eAAe,EAAE,MAAM,CAAC;IAClC,SAAS,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,SAAS,CAAC,qBAAqB,EAAE,MAAM,CAAC;IACxC,SAAS,CAAC,gBAAgB,EAAE,MAAM,CAAC;IACnC,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;IAE7B,qCAAqC;IACrC,SAAS,CAAC,YAAY,EAAE,IAAI,GAAG,IAAI,CAAQ;IAE3C,2CAA2C;IAC3C,SAAS,CAAC,iBAAiB,EAAE,QAAQ,GAAG,IAAI,CAAQ;gBAExC,OAAO,EAAE,YAAY;IAqCjC;;OAEG;IACH,SAAS,CAAC,WAAW,IAAI,IAAI;IA+C7B;;OAEG;IACH,YAAY,IAAI,MAAM;IAItB;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAMhC;;OAEG;IACH,cAAc,IAAI,IAAI,GAAG,IAAI;IAI7B;;OAEG;IACH,mBAAmB,IAAI,QAAQ,GAAG,IAAI;IAItC;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI;IAMjC;;OAEG;cACgB,kBAAkB,IAAI,KAAK,CAAC,QAAQ;IAKvD;;OAEG;cACgB,WAAW,IAAI,KAAK;CAgBxC;AAMD;;GAEG;AACH,KAAK,iBAAiB,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEnF;;GAEG;AACH,UAAU,aAAa;IACrB,IAAI,EAAE,iBAAiB,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,UAAU,YAAY;IACpB,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0DAA0D;IAC1D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sDAAsD;IACtD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,yDAAyD;IACzD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0CAA0C;IAC1C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2CAA2C;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qCAAqC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gFAAgF;IAChF,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;CACxC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,qBAAa,YAAa,SAAQ,QAAQ;IACxC,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC;IAChC,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAC5B,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,eAAe,EAAE,MAAM,CAAC;IAClC,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,gBAAgB,EAAE,MAAM,CAAC;IACnC,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjD,+BAA+B;IAC/B,SAAS,CAAC,YAAY,EAAE,YAAY,EAAE,CAAM;IAE5C,kCAAkC;IAClC,SAAS,CAAC,aAAa,EAAE,OAAO,EAAE,CAAM;gBAE5B,OAAO,EAAE,mBAAmB;IAkCxC;;OAEG;IACH,SAAS,CAAC,cAAc,IAAI,IAAI;IAUhC;;OAEG;IACH,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY;IAiChD;;OAEG;IACH,SAAS,CAAC,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,EAAE;IAgF/D;;OAEG;IACH,SAAS,CAAC,cAAc,IAAI,IAAI;IA0GhC;;OAEG;IACH,eAAe,IAAI,MAAM;IAIzB;;;;OAIG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAOnC;;OAEG;IACH,eAAe,IAAI,OAAO,EAAE;IAI5B;;OAEG;cACgB,kBAAkB,IAAI,KAAK,CAAC,QAAQ;IAKvD;;OAEG;cACgB,WAAW,IAAI,YAAY;CAc/C;;;;;;AAED,wBAAqD"}

package/dist/mobjects/text/TextGlyphGroup.d.ts

@@ -0,0 +1,48 @@
+import { VGroup } from '../../core/VGroup';
+import { SkeletonizeOptions } from '../../utils/skeletonize';
+export interface TextGlyphGroupOptions {
+    /** The text string to render */
+    text: string;
+    /** URL to the font file (OTF/TTF) */
+    fontUrl: string;
+    /** Font size in pixels (default: 48) */
+    fontSize?: number;
+    /** Stroke color (default: '#ffffff') */
+    color?: string;
+    /** Stroke width for glyph outlines (default: 2) */
+    strokeWidth?: number;
+    /**
+     * When true, each GlyphVMobject computes its skeleton (medial axis)
+     * so the Write animation can draw along the center-line. Default: false.
+     */
+    useSkeletonStroke?: boolean;
+    /** Options forwarded to the skeletonization algorithm. */
+    skeletonOptions?: SkeletonizeOptions;
+}
+/**
+ * A VGroup that holds one GlyphVMobject per visible character in a string.
+ * Characters are positioned using the font's metric data (advance width + kerning).
+ *
+ * Usage:
+ *   const group = new TextGlyphGroup({ text: 'Hello', fontUrl: '/fonts/MyFont.otf' });
+ *   await group.waitForReady();
+ */
+export declare class TextGlyphGroup extends VGroup {
+    private _text;
+    private _fontUrl;
+    private _fontSize;
+    private _glyphStrokeWidth;
+    private _useSkeletonStroke;
+    private _skeletonOptions;
+    private _readyPromise;
+    constructor(options: TextGlyphGroupOptions);
+    /**
+     * Wait for the font to load and glyphs to be built.
+     */
+    waitForReady(): Promise<void>;
+    /**
+     * Load font and build GlyphVMobject children.
+     */
+    private _loadAndBuild;
+}
+//# sourceMappingURL=TextGlyphGroup.d.ts.map

package/dist/mobjects/text/TextGlyphGroup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextGlyphGroup.d.ts","sourceRoot":"","sources":["../../../src/mobjects/text/TextGlyphGroup.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAG3C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAElE,MAAM,WAAW,qBAAqB;IACpC,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mDAAmD;IACnD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,0DAA0D;IAC1D,eAAe,CAAC,EAAE,kBAAkB,CAAC;CACtC;AAED;;;;;;;GAOG;AACH,qBAAa,cAAe,SAAQ,MAAM;IACxC,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,kBAAkB,CAAU;IACpC,OAAO,CAAC,gBAAgB,CAAqB;IAC7C,OAAO,CAAC,aAAa,CAAgB;gBAEzB,OAAO,EAAE,qBAAqB;IAmB1C;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAInC;;OAEG;YACW,aAAa;CAiD5B"}

package/dist/mobjects/text/Variable.d.ts

@@ -0,0 +1,160 @@
+import { Mobject, Vector3Tuple } from '../../core/Mobject';
+import { DecimalNumber } from './DecimalNumber';
+import { ValueTracker } from '../value-tracker';
+import { MathTex } from './MathTex';
+/**
+ * Variable - A mobject that displays a variable name with its value
+ *
+ * Combines a label (typically a math symbol) with a DecimalNumber to show
+ * something like "x = 5" that can be animated.
+ */
+import * as THREE from 'three';
+/**
+ * Options for creating a Variable mobject
+ */
+export interface VariableOptions {
+    /** The variable name/label (rendered as LaTeX). Example: 'x', '\\theta', 'time' */
+    label: string;
+    /** Initial numeric value. Default: 0 */
+    value?: number;
+    /** Options for the decimal number display */
+    numDecimalPlaces?: number;
+    /** Whether to show ellipsis after the value. Default: false */
+    showEllipsis?: boolean;
+    /** Whether to show + sign for positive values. Default: false */
+    includeSign?: boolean;
+    /** Color for the label. Default: '#ffffff' */
+    labelColor?: string;
+    /** Color for the value. Default: '#ffffff' */
+    valueColor?: string;
+    /** Font size for the value. Default: 48 */
+    fontSize?: number;
+    /** Buffer between label and equals sign. Default: 0.1 */
+    labelBuff?: number;
+    /** Buffer between equals sign and value. Default: 0.1 */
+    valueBuff?: number;
+}
+/**
+ * Variable - Displays a labeled variable with animatable value
+ *
+ * Creates a composite mobject showing "label = value" where the value
+ * can be animated using a ValueTracker or direct setValue calls.
+ *
+ * @example
+ * ```typescript
+ * // Create a variable display
+ * const x = new Variable({ label: 'x', value: 5 });
+ *
+ * // Create with LaTeX label
+ * const theta = new Variable({
+ *   label: '\\theta',
+ *   value: Math.PI,
+ *   numDecimalPlaces: 3
+ * });
+ *
+ * // Animate value change using tracker
+ * const tracker = x.tracker;
+ * x.addUpdater(() => x.setValue(tracker.getValue()));
+ * tracker.setValue(100); // Animate to 100
+ *
+ * // Direct value change
+ * x.setValue(42);
+ * ```
+ */
+export declare class Variable extends Mobject {
+    protected _label: string;
+    protected _value: number;
+    protected _numDecimalPlaces: number;
+    protected _showEllipsis: boolean;
+    protected _includeSign: boolean;
+    protected _labelColor: string;
+    protected _valueColor: string;
+    protected _fontSize: number;
+    protected _labelBuff: number;
+    protected _valueBuff: number;
+    /** The label mobject (LaTeX rendered) */
+    protected _labelMobject: MathTex;
+    /** The equals sign mobject */
+    protected _equalsMobject: MathTex;
+    /** The value display mobject */
+    protected _numberMobject: DecimalNumber;
+    /** ValueTracker for animations */
+    protected _tracker: ValueTracker;
+    constructor(options: VariableOptions);
+    /**
+     * Arrange the label, equals sign, and value horizontally
+     */
+    protected _arrangeSubmobjects(): Promise<void>;
+    /**
+     * Get the current value
+     */
+    getValue(): number;
+    /**
+     * Set the displayed value
+     * @param value - New value to display
+     * @returns this for chaining
+     */
+    setValue(value: number): this;
+    /**
+     * Get the ValueTracker for this variable
+     * Use this with animations to smoothly change the value
+     */
+    get tracker(): ValueTracker;
+    /**
+     * Get the label mobject
+     */
+    get labelMobject(): MathTex;
+    /**
+     * Get the equals sign mobject
+     */
+    get equalsMobject(): MathTex;
+    /**
+     * Get the number mobject
+     */
+    get numberMobject(): DecimalNumber;
+    /**
+     * Set the label color
+     * @param color - CSS color string
+     * @returns this for chaining
+     */
+    setLabelColor(color: string): this;
+    /**
+     * Set the value color
+     * @param color - CSS color string
+     * @returns this for chaining
+     */
+    setValueColor(color: string): this;
+    /**
+     * Set both label and value colors
+     * @param color - CSS color string
+     * @returns this for chaining
+     */
+    setColor(color: string): this;
+    /**
+     * Sync the displayed value with the tracker
+     * Call this in an updater to animate the value
+     */
+    syncWithTracker(): this;
+    /**
+     * Create the Three.js backing object
+     */
+    protected _createThreeObject(): THREE.Object3D;
+    /**
+     * Get the center of this Variable
+     */
+    getCenter(): Vector3Tuple;
+    /**
+     * Wait for all submobjects to finish rendering
+     */
+    waitForRender(): Promise<void>;
+    /**
+     * Create a copy of this Variable
+     */
+    protected _createCopy(): Variable;
+    /**
+     * Clean up resources
+     */
+    dispose(): void;
+}
+export default Variable;
+//# sourceMappingURL=Variable.d.ts.map

package/dist/mobjects/text/Variable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Variable.d.ts","sourceRoot":"","sources":["../../../src/mobjects/text/Variable.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,mFAAmF;IACnF,KAAK,EAAE,MAAM,CAAC;IACd,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6CAA6C;IAC7C,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,+DAA+D;IAC/D,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,iEAAiE;IACjE,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,8CAA8C;IAC9C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,8CAA8C;IAC9C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yDAAyD;IACzD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,yDAAyD;IACzD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,QAAS,SAAQ,OAAO;IACnC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,iBAAiB,EAAE,MAAM,CAAC;IACpC,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC;IACjC,SAAS,CAAC,YAAY,EAAE,OAAO,CAAC;IAChC,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAC5B,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;IAC7B,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;IAE7B,yCAAyC;IACzC,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC;IAEjC,8BAA8B;IAC9B,SAAS,CAAC,cAAc,EAAE,OAAO,CAAC;IAElC,gCAAgC;IAChC,SAAS,CAAC,cAAc,EAAE,aAAa,CAAC;IAExC,kCAAkC;IAClC,SAAS,CAAC,QAAQ,EAAE,YAAY,CAAC;gBAErB,OAAO,EAAE,eAAe;IA8DpC;;OAEG;cACa,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IA8BpD;;OAEG;IACH,QAAQ,IAAI,MAAM;IAIlB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAQ7B;;;OAGG;IACH,IAAI,OAAO,IAAI,YAAY,CAE1B;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,OAAO,CAE3B;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,aAAa,CAEjC;IAED;;;;OAIG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAQlC;;;;OAIG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAOlC;;;;OAIG;IACM,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAMtC;;;OAGG;IACH,eAAe,IAAI,IAAI;IAUvB;;OAEG;IACH,SAAS,CAAC,kBAAkB,IAAI,KAAK,CAAC,QAAQ;IAW9C;;OAEG;IACM,SAAS,IAAI,YAAY;IAIlC;;OAEG;IACG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAMpC;;OAEG;IACH,SAAS,CAAC,WAAW,IAAI,QAAQ;IAejC;;OAEG;IACM,OAAO,IAAI,IAAI;CAMzB;AAED,eAAe,QAAQ,CAAC"}

package/dist/mobjects/text/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Text mobjects for manimweb
+ *
+ * This module provides text rendering capabilities using Canvas 2D textures
+ * applied to Three.js plane meshes, as well as LaTeX rendering using KaTeX.
+ */
+export { Text, type TextOptions } from './Text';
+export { GlyphVMobject, type GlyphVMobjectOptions } from './GlyphVMobject';
+export { TextGlyphGroup, type TextGlyphGroupOptions } from './TextGlyphGroup';
+export { Paragraph, type ParagraphOptions } from './Paragraph';
+export { MarkupText, type MarkupTextOptions, type StyledTextSegment } from './MarkupText';
+export { ensureKatexStyles, areKatexStylesLoaded } from './katex-styles';
+export { MathTex, type MathTexOptions, type TexRenderer } from './MathTex';
+export { renderLatexToSVG, preloadMathJax, isMathJaxLoaded, katexCanRender, type MathJaxRenderOptions, type MathJaxRenderResult, } from './MathJaxRenderer';
+export { parseSVGPathData, svgToVMobjects, type SVGToVMobjectOptions, } from './svgPathParser';
+export { Tex, type TexOptions } from './Tex';
+export { DecimalNumber, Integer, type DecimalNumberOptions, } from './DecimalNumber';
+export { Variable, type VariableOptions } from './Variable';
+export { Code, type CodeOptions, type CodeColorScheme, type Token, type TokenType, DEFAULT_COLOR_SCHEME, MONOKAI_COLOR_SCHEME, } from './Code';
+export { BulletedList, Title, MarkdownText, type BulletedListOptions, type TitleOptions, type MarkdownTextOptions, } from './TextExtensions';
+//# sourceMappingURL=index.d.ts.map

package/dist/mobjects/text/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/mobjects/text/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,IAAI,EAAE,KAAK,WAAW,EAAE,MAAM,QAAQ,CAAC;AAGhD,OAAO,EAAE,aAAa,EAAE,KAAK,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAC3E,OAAO,EAAE,cAAc,EAAE,KAAK,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAG9E,OAAO,EAAE,SAAS,EAAE,KAAK,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAG/D,OAAO,EAAE,UAAU,EAAE,KAAK,iBAAiB,EAAE,KAAK,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAG1F,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAGzE,OAAO,EAAE,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AAG3E,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,eAAe,EACf,cAAc,EACd,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,GACzB,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,KAAK,oBAAoB,GAC1B,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EAAE,GAAG,EAAE,KAAK,UAAU,EAAE,MAAM,OAAO,CAAC;AAG7C,OAAO,EACL,aAAa,EACb,OAAO,EACP,KAAK,oBAAoB,GAC1B,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EAAE,QAAQ,EAAE,KAAK,eAAe,EAAE,MAAM,YAAY,CAAC;AAG5D,OAAO,EACL,IAAI,EACJ,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,KAAK,EACV,KAAK,SAAS,EACd,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,QAAQ,CAAC;AAGhB,OAAO,EACL,YAAY,EACZ,KAAK,EACL,YAAY,EACZ,KAAK,mBAAmB,EACxB,KAAK,YAAY,EACjB,KAAK,mBAAmB,GACzB,MAAM,kBAAkB,CAAC"}

package/dist/mobjects/text/katex-styles.d.ts

@@ -0,0 +1,23 @@
+/**
+ * KaTeX CSS loader for manimweb
+ *
+ * Ensures the KaTeX stylesheet is loaded for proper LaTeX rendering.
+ */
+/**
+ * Ensure KaTeX styles are loaded in the document.
+ * This is called automatically by MathTex on first use.
+ *
+ * The stylesheet is loaded from a CDN for convenience.
+ * In production, you may want to bundle the CSS directly.
+ */
+export declare function ensureKatexStyles(): void;
+/**
+ * Wait for KaTeX CSS to finish loading.
+ * Returns a promise that resolves when the stylesheet is loaded.
+ */
+export declare function waitForKatexStyles(): Promise<void>;
+/**
+ * Check if KaTeX styles have been injected
+ */
+export declare function areKatexStylesLoaded(): boolean;
+//# sourceMappingURL=katex-styles.d.ts.map

package/dist/mobjects/text/katex-styles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"katex-styles.d.ts","sourceRoot":"","sources":["../../../src/mobjects/text/katex-styles.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH;;;;;;GAMG;AACH,wBAAgB,iBAAiB,IAAI,IAAI,CAExC;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC,CAyBlD;AAED;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAE9C"}