manim-web 0.2.0

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

@@ -0,0 +1,425 @@
+import { Mobject, Vector3Tuple } from '../../core/Mobject';
+import { Dot } from '../geometry/Dot';
+/**
+ * Graph mobjects for network visualization in manimweb
+ *
+ * This module provides graph classes for visualizing networks with vertices
+ * and edges. Supports both undirected (Graph) and directed (DiGraph) graphs
+ * with various layout algorithms.
+ */
+import * as THREE from 'three';
+/**
+ * Unique identifier for a vertex
+ */
+export type VertexId = string | number;
+/**
+ * Edge definition as a tuple of [source, target]
+ */
+export type EdgeTuple = [VertexId, VertexId];
+/**
+ * Layout algorithm types
+ */
+export type LayoutType = 'spring' | 'circular' | 'shell' | 'tree' | 'random' | 'grid' | 'kamada_kawai' | 'spectral' | 'bipartite' | 'custom';
+/**
+ * Options for vertex styling
+ */
+export interface VertexStyleOptions {
+    /** Radius of the vertex dot. Default: 0.15 */
+    radius?: number;
+    /** Fill color of the vertex. Default: WHITE */
+    color?: string;
+    /** Fill opacity. Default: 1 */
+    fillOpacity?: number;
+    /** Stroke color for the vertex border. Default: same as color */
+    strokeColor?: string;
+    /** Stroke width. Default: 2 */
+    strokeWidth?: number;
+}
+/**
+ * Options for edge styling
+ */
+export interface EdgeStyleOptions {
+    /** Color of the edge. Default: BLUE */
+    color?: string;
+    /** Stroke width of the edge. Default: 4 */
+    strokeWidth?: number;
+    /** For directed graphs, tip length. Default: 0.2 */
+    tipLength?: number;
+    /** For directed graphs, tip width. Default: 0.12 */
+    tipWidth?: number;
+}
+/**
+ * Configuration for a single vertex
+ */
+export interface VertexConfig {
+    /** Position of the vertex (if using custom layout) */
+    position?: Vector3Tuple;
+    /** Custom styling for this vertex */
+    style?: VertexStyleOptions;
+    /** Label text to display next to the vertex */
+    label?: string;
+}
+/**
+ * Configuration for a single edge
+ */
+export interface EdgeConfig {
+    /** Custom styling for this edge */
+    style?: EdgeStyleOptions;
+    /** Label text to display on the edge */
+    label?: string;
+    /** Weight of the edge (used by some layout algorithms) */
+    weight?: number;
+}
+/**
+ * Layout configuration options
+ */
+export interface LayoutConfig {
+    /** Type of layout algorithm */
+    type: LayoutType;
+    /** Scale factor for the layout. Default: 2 */
+    scale?: number;
+    /** Center point of the layout. Default: [0, 0, 0] */
+    center?: Vector3Tuple;
+    /** Number of iterations for force-directed layouts. Default: 50 */
+    iterations?: number;
+    /** For tree layout: root vertex */
+    root?: VertexId;
+    /** For bipartite layout: partition sets */
+    partition?: [VertexId[], VertexId[]];
+    /** Custom positions map for custom layout */
+    positions?: Map<VertexId, Vector3Tuple>;
+}
+/**
+ * Options for creating a graph
+ */
+export interface GenericGraphOptions {
+    /** List of vertex identifiers */
+    vertices?: VertexId[];
+    /** List of edges as [source, target] tuples */
+    edges?: EdgeTuple[];
+    /** Layout configuration */
+    layout?: LayoutType | LayoutConfig;
+    /** Default vertex styling */
+    vertexStyle?: VertexStyleOptions;
+    /** Default edge styling */
+    edgeStyle?: EdgeStyleOptions;
+    /** Per-vertex configuration */
+    vertexConfig?: Map<VertexId, VertexConfig> | Record<string, VertexConfig>;
+    /** Per-edge configuration (key is "source-target") */
+    edgeConfig?: Map<string, EdgeConfig> | Record<string, EdgeConfig>;
+    /** Whether to show vertex labels. Default: false */
+    showLabels?: boolean;
+    /** Label font size. Default: 24 */
+    labelFontSize?: number;
+}
+/**
+ * GenericGraph - Base class for graph visualization
+ *
+ * Provides the foundation for both directed and undirected graphs.
+ * Manages vertices and edges as Mobject children for animation support.
+ */
+export declare class GenericGraph extends Mobject {
+    /** List of vertex identifiers */
+    protected _vertices: VertexId[];
+    /** List of edges as [source, target] tuples */
+    protected _edges: EdgeTuple[];
+    /** Map of vertex id to position */
+    protected _positions: Map<VertexId, Vector3Tuple>;
+    /** Map of vertex id to Dot mobject */
+    protected _vertexMobjects: Map<VertexId, Dot>;
+    /** Map of edge key to Line/Arrow mobject */
+    protected _edgeMobjects: Map<string, Mobject>;
+    /** Layout configuration */
+    protected _layoutConfig: LayoutConfig;
+    /** Default vertex style */
+    protected _vertexStyle: VertexStyleOptions;
+    /** Default edge style */
+    protected _edgeStyle: EdgeStyleOptions;
+    /** Per-vertex configuration */
+    protected _vertexConfig: Map<VertexId, VertexConfig>;
+    /** Per-edge configuration */
+    protected _edgeConfig: Map<string, EdgeConfig>;
+    /** Whether this is a directed graph */
+    protected _directed: boolean;
+    /** Three.js group for this graph */
+    protected _group: THREE.Group | null;
+    constructor(options?: GenericGraphOptions);
+    /**
+     * Get edge key from vertex pair
+     */
+    protected _getEdgeKey(source: VertexId, target: VertexId): string;
+    /**
+     * Compute vertex positions using the layout algorithm
+     */
+    protected _computeLayout(): void;
+    /**
+     * Create vertex and edge mobjects
+     */
+    protected _createMobjects(): void;
+    /**
+     * Create a single vertex mobject
+     */
+    protected _createVertexMobject(v: VertexId): void;
+    /**
+     * Create a single edge mobject
+     */
+    protected _createEdgeMobject(source: VertexId, target: VertexId): void;
+    /**
+     * Shorten an edge to not overlap with vertex circles
+     */
+    protected _shortenEdge(start: Vector3Tuple, end: Vector3Tuple, radius: number): [Vector3Tuple, Vector3Tuple];
+    /**
+     * Add a vertex to the graph
+     * @param v - Vertex identifier
+     * @param config - Optional vertex configuration
+     * @returns this for chaining
+     */
+    addVertex(v: VertexId, config?: VertexConfig): this;
+    /**
+     * Add multiple vertices to the graph
+     * @param vertices - Array of vertex identifiers
+     * @returns this for chaining
+     */
+    addVertices(...vertices: VertexId[]): this;
+    /**
+     * Remove a vertex from the graph
+     * @param v - Vertex identifier
+     * @returns this for chaining
+     */
+    removeVertex(v: VertexId): this;
+    /**
+     * Get all vertex identifiers
+     */
+    getVertices(): VertexId[];
+    /**
+     * Get the number of vertices
+     */
+    get numVertices(): number;
+    /**
+     * Check if the graph contains a vertex
+     */
+    hasVertex(v: VertexId): boolean;
+    /**
+     * Get the Dot mobject for a vertex
+     */
+    getVertexMobject(v: VertexId): Dot | undefined;
+    /**
+     * Get the position of a vertex
+     */
+    getVertexPosition(v: VertexId): Vector3Tuple | undefined;
+    /**
+     * Set the position of a vertex
+     */
+    setVertexPosition(v: VertexId, position: Vector3Tuple): this;
+    /**
+     * Get neighbors of a vertex (adjacent vertices)
+     */
+    getNeighbors(v: VertexId): VertexId[];
+    /**
+     * Get the degree of a vertex (number of edges)
+     */
+    getDegree(v: VertexId): number;
+    /**
+     * Add an edge to the graph
+     * @param source - Source vertex
+     * @param target - Target vertex
+     * @param config - Optional edge configuration
+     * @returns this for chaining
+     */
+    addEdge(source: VertexId, target: VertexId, config?: EdgeConfig): this;
+    /**
+     * Add multiple edges to the graph
+     * @param edges - Array of [source, target] tuples
+     * @returns this for chaining
+     */
+    addEdges(...edges: EdgeTuple[]): this;
+    /**
+     * Remove an edge from the graph
+     * @param source - Source vertex
+     * @param target - Target vertex
+     * @returns this for chaining
+     */
+    removeEdge(source: VertexId, target: VertexId): this;
+    /**
+     * Get all edges
+     */
+    getEdges(): EdgeTuple[];
+    /**
+     * Get the number of edges
+     */
+    get numEdges(): number;
+    /**
+     * Check if the graph contains an edge
+     */
+    hasEdge(source: VertexId, target: VertexId): boolean;
+    /**
+     * Get the Line/Arrow mobject for an edge
+     */
+    getEdgeMobject(source: VertexId, target: VertexId): Mobject | undefined;
+    /**
+     * Change the layout algorithm
+     * @param layout - Layout type or configuration
+     * @returns this for chaining
+     */
+    setLayout(layout: LayoutType | LayoutConfig): this;
+    /**
+     * Get all vertex positions
+     */
+    getPositions(): Map<VertexId, Vector3Tuple>;
+    /**
+     * Set the color of a specific vertex
+     */
+    setVertexColor(v: VertexId, color: string): this;
+    /**
+     * Set the color of a specific edge
+     */
+    setEdgeColor(source: VertexId, target: VertexId, color: string): this;
+    /**
+     * Highlight a path (sequence of vertices)
+     */
+    highlightPath(path: VertexId[], vertexColor?: string, edgeColor?: string): this;
+    /**
+     * Reset all colors to default
+     */
+    resetColors(): this;
+    /**
+     * Create the Three.js backing object
+     */
+    protected _createThreeObject(): THREE.Object3D;
+    /**
+     * Create a copy of this graph
+     */
+    protected _createCopy(): GenericGraph;
+}
+/**
+ * Graph - Undirected graph visualization
+ *
+ * Creates a graph with vertices connected by undirected edges (Lines).
+ *
+ * @example
+ * ```typescript
+ * // Create a simple triangle graph
+ * const graph = new Graph({
+ *   vertices: ['A', 'B', 'C'],
+ *   edges: [['A', 'B'], ['B', 'C'], ['C', 'A']],
+ *   layout: 'circular'
+ * });
+ *
+ * // Create a graph with custom styling
+ * const styledGraph = new Graph({
+ *   vertices: [1, 2, 3, 4],
+ *   edges: [[1, 2], [2, 3], [3, 4], [4, 1]],
+ *   layout: 'spring',
+ *   vertexStyle: { color: '#FF0000', radius: 0.2 },
+ *   edgeStyle: { color: '#00FF00', strokeWidth: 3 }
+ * });
+ * ```
+ */
+export declare class Graph extends GenericGraph {
+    constructor(options?: GenericGraphOptions);
+    /**
+     * Create a copy of this graph
+     */
+    protected _createCopy(): Graph;
+}
+/**
+ * Options for creating a directed graph
+ */
+export interface DiGraphOptions extends GenericGraphOptions {
+}
+/**
+ * DiGraph - Directed graph visualization
+ *
+ * Creates a graph with vertices connected by directed edges (Arrows).
+ *
+ * @example
+ * ```typescript
+ * // Create a directed graph
+ * const digraph = new DiGraph({
+ *   vertices: ['A', 'B', 'C'],
+ *   edges: [['A', 'B'], ['B', 'C'], ['C', 'A']],
+ *   layout: 'circular'
+ * });
+ *
+ * // Tree structure with directed edges
+ * const tree = new DiGraph({
+ *   vertices: ['root', 'left', 'right', 'leafL', 'leafR'],
+ *   edges: [
+ *     ['root', 'left'],
+ *     ['root', 'right'],
+ *     ['left', 'leafL'],
+ *     ['right', 'leafR']
+ *   ],
+ *   layout: { type: 'tree', root: 'root' }
+ * });
+ * ```
+ */
+export declare class DiGraph extends GenericGraph {
+    constructor(options?: DiGraphOptions);
+    /**
+     * Get out-neighbors (vertices this vertex points to)
+     */
+    getOutNeighbors(v: VertexId): VertexId[];
+    /**
+     * Get in-neighbors (vertices that point to this vertex)
+     */
+    getInNeighbors(v: VertexId): VertexId[];
+    /**
+     * Get out-degree (number of outgoing edges)
+     */
+    getOutDegree(v: VertexId): number;
+    /**
+     * Get in-degree (number of incoming edges)
+     */
+    getInDegree(v: VertexId): number;
+    /**
+     * Create a copy of this digraph
+     */
+    protected _createCopy(): DiGraph;
+}
+/**
+ * Create a complete graph (all vertices connected)
+ * @param n - Number of vertices
+ * @returns A complete Graph with n vertices
+ */
+export declare function completeGraph(n: number, options?: Partial<GenericGraphOptions>): Graph;
+/**
+ * Create a cycle graph (vertices in a ring)
+ * @param n - Number of vertices
+ * @returns A cycle Graph with n vertices
+ */
+export declare function cycleGraph(n: number, options?: Partial<GenericGraphOptions>): Graph;
+/**
+ * Create a path graph (linear chain)
+ * @param n - Number of vertices
+ * @returns A path Graph with n vertices
+ */
+export declare function pathGraph(n: number, options?: Partial<GenericGraphOptions>): Graph;
+/**
+ * Create a star graph (one central vertex connected to all others)
+ * @param n - Number of outer vertices (total vertices = n + 1)
+ * @returns A star Graph
+ */
+export declare function starGraph(n: number, options?: Partial<GenericGraphOptions>): Graph;
+/**
+ * Create a binary tree
+ * @param depth - Depth of the tree
+ * @returns A binary tree DiGraph
+ */
+export declare function binaryTree(depth: number, options?: Partial<GenericGraphOptions>): DiGraph;
+/**
+ * Create a grid graph
+ * @param rows - Number of rows
+ * @param cols - Number of columns
+ * @returns A grid Graph
+ */
+export declare function gridGraph(rows: number, cols: number, options?: Partial<GenericGraphOptions>): Graph;
+/**
+ * Create a bipartite graph
+ * @param n1 - Number of vertices in first partition
+ * @param n2 - Number of vertices in second partition
+ * @param edges - Edges between partitions (optional, complete if not provided)
+ * @returns A bipartite Graph
+ */
+export declare function bipartiteGraph(n1: number, n2: number, edges?: EdgeTuple[], options?: Partial<GenericGraphOptions>): Graph;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/mobjects/graph/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAStC;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;AAEvC;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,QAAQ,GACR,UAAU,GACV,OAAO,GACP,MAAM,GACN,QAAQ,GACR,MAAM,GACN,cAAc,GACd,UAAU,GACV,WAAW,GACX,QAAQ,CAAC;AAEb;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+CAA+C;IAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iEAAiE;IACjE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+BAA+B;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,uCAAuC;IACvC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oDAAoD;IACpD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,sDAAsD;IACtD,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,qCAAqC;IACrC,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,+CAA+C;IAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,mCAAmC;IACnC,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0DAA0D;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,+BAA+B;IAC/B,IAAI,EAAE,UAAU,CAAC;IACjB,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qDAAqD;IACrD,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,mEAAmE;IACnE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mCAAmC;IACnC,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,2CAA2C;IAC3C,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IACrC,6CAA6C;IAC7C,SAAS,CAAC,EAAE,GAAG,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,iCAAiC;IACjC,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC;IACtB,+CAA+C;IAC/C,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC;IACpB,2BAA2B;IAC3B,MAAM,CAAC,EAAE,UAAU,GAAG,YAAY,CAAC;IACnC,6BAA6B;IAC7B,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,2BAA2B;IAC3B,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,+BAA+B;IAC/B,YAAY,CAAC,EAAE,GAAG,CAAC,QAAQ,EAAE,YAAY,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC1E,sDAAsD;IACtD,UAAU,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAClE,oDAAoD;IACpD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,mCAAmC;IACnC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AA2fD;;;;;GAKG;AACH,qBAAa,YAAa,SAAQ,OAAO;IACvC,iCAAiC;IACjC,SAAS,CAAC,SAAS,EAAE,QAAQ,EAAE,CAAM;IAErC,+CAA+C;IAC/C,SAAS,CAAC,MAAM,EAAE,SAAS,EAAE,CAAM;IAEnC,mCAAmC;IACnC,SAAS,CAAC,UAAU,EAAE,GAAG,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAa;IAE9D,sCAAsC;IACtC,SAAS,CAAC,eAAe,EAAE,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAa;IAE1D,4CAA4C;IAC5C,SAAS,CAAC,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAa;IAE1D,2BAA2B;IAC3B,SAAS,CAAC,aAAa,EAAE,YAAY,CAAC;IAEtC,2BAA2B;IAC3B,SAAS,CAAC,YAAY,EAAE,kBAAkB,CAAC;IAE3C,yBAAyB;IACzB,SAAS,CAAC,UAAU,EAAE,gBAAgB,CAAC;IAEvC,+BAA+B;IAC/B,SAAS,CAAC,aAAa,EAAE,GAAG,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAa;IAEjE,6BAA6B;IAC7B,SAAS,CAAC,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAa;IAE3D,uCAAuC;IACvC,SAAS,CAAC,SAAS,EAAE,OAAO,CAAS;IAErC,oCAAoC;IACpC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,GAAG,IAAI,CAAQ;gBAEhC,OAAO,GAAE,mBAAwB;IAwE7C;;OAEG;IACH,SAAS,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAG,MAAM;IAUjE;;OAEG;IACH,SAAS,CAAC,cAAc,IAAI,IAAI;IAShC;;OAEG;IACH,SAAS,CAAC,eAAe,IAAI,IAAI;IAwBjC;;OAEG;IACH,SAAS,CAAC,oBAAoB,CAAC,CAAC,EAAE,QAAQ,GAAG,IAAI;IAqBjD;;OAEG;IACH,SAAS,CAAC,kBAAkB,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAG,IAAI;IAkCtE;;OAEG;IACH,SAAS,CAAC,YAAY,CACpB,KAAK,EAAE,YAAY,EACnB,GAAG,EAAE,YAAY,EACjB,MAAM,EAAE,MAAM,GACb,CAAC,YAAY,EAAE,YAAY,CAAC;IAiC/B;;;;;OAKG;IACH,SAAS,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,IAAI;IAiBnD;;;;OAIG;IACH,WAAW,CAAC,GAAG,QAAQ,EAAE,QAAQ,EAAE,GAAG,IAAI;IAa1C;;;;OAIG;IACH,YAAY,CAAC,CAAC,EAAE,QAAQ,GAAG,IAAI;IAkB/B;;OAEG;IACH,WAAW,IAAI,QAAQ,EAAE;IAIzB;;OAEG;IACH,IAAI,WAAW,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,SAAS,CAAC,CAAC,EAAE,QAAQ,GAAG,OAAO;IAI/B;;OAEG;IACH,gBAAgB,CAAC,CAAC,EAAE,QAAQ,GAAG,GAAG,GAAG,SAAS;IAI9C;;OAEG;IACH,iBAAiB,CAAC,CAAC,EAAE,QAAQ,GAAG,YAAY,GAAG,SAAS;IAIxD;;OAEG;IACH,iBAAiB,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,GAAG,IAAI;IA4B5D;;OAEG;IACH,YAAY,CAAC,CAAC,EAAE,QAAQ,GAAG,QAAQ,EAAE;IAYrC;;OAEG;IACH,SAAS,CAAC,CAAC,EAAE,QAAQ,GAAG,MAAM;IAM9B;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,UAAU,GAAG,IAAI;IA0BtE;;;;OAIG;IACH,QAAQ,CAAC,GAAG,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI;IAqBrC;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAG,IAAI;IAoBpD;;OAEG;IACH,QAAQ,IAAI,SAAS,EAAE;IAIvB;;OAEG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED;;OAEG;IACH,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAG,OAAO;IAKpD;;OAEG;IACH,cAAc,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAG,OAAO,GAAG,SAAS;IAOvE;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI;IAiClD;;OAEG;IACH,YAAY,IAAI,GAAG,CAAC,QAAQ,EAAE,YAAY,CAAC;IAM3C;;OAEG;IACH,cAAc,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAShD;;OAEG;IACH,YAAY,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IASrE;;OAEG;IACH,aAAa,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,WAAW,GAAE,MAAY,EAAE,SAAS,GAAE,MAAY,GAAG,IAAI;IAUzF;;OAEG;IACH,WAAW,IAAI,IAAI;IAmBnB;;OAEG;IACH,SAAS,CAAC,kBAAkB,IAAI,KAAK,CAAC,QAAQ;IAK9C;;OAEG;IACH,SAAS,CAAC,WAAW,IAAI,YAAY;CAStC;AAMD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,KAAM,SAAQ,YAAY;gBACzB,OAAO,GAAE,mBAAwB;IAK7C;;OAEG;cACgB,WAAW,IAAI,KAAK;CASxC;AAMD;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,mBAAmB;CAAG;AAE9D;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,OAAQ,SAAQ,YAAY;gBAC3B,OAAO,GAAE,cAAmB;IAexC;;OAEG;IACH,eAAe,CAAC,CAAC,EAAE,QAAQ,GAAG,QAAQ,EAAE;IAUxC;;OAEG;IACH,cAAc,CAAC,CAAC,EAAE,QAAQ,GAAG,QAAQ,EAAE;IAUvC;;OAEG;IACH,YAAY,CAAC,CAAC,EAAE,QAAQ,GAAG,MAAM;IAIjC;;OAEG;IACH,WAAW,CAAC,CAAC,EAAE,QAAQ,GAAG,MAAM;IAIhC;;OAEG;cACgB,WAAW,IAAI,OAAO;CAS1C;AAMD;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,GAAE,OAAO,CAAC,mBAAmB,CAAM,GAAG,KAAK,CAgB1F;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,GAAE,OAAO,CAAC,mBAAmB,CAAM,GAAG,KAAK,CAUvF;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,GAAE,OAAO,CAAC,mBAAmB,CAAM,GAAG,KAAK,CAmBtF;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,GAAE,OAAO,CAAC,mBAAmB,CAAM,GAAG,KAAK,CAWtF;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,OAAO,CAAC,mBAAmB,CAAM,GAAG,OAAO,CA4B7F;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,OAAO,CAAC,mBAAmB,CAAM,GACzC,KAAK,CA4BP;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,EAAE,EAAE,MAAM,EACV,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,EAAE,EACnB,OAAO,GAAE,OAAO,CAAC,mBAAmB,CAAM,GACzC,KAAK,CAqBP"}

package/dist/mobjects/graphing/Axes.d.ts

@@ -0,0 +1,254 @@
+import { Group } from '../../core/Group';
+import { Mobject, Vector3Tuple } from '../../core/Mobject';
+import { VMobject } from '../../core/VMobject';
+import { VGroup } from '../../core/VGroup';
+import { VDict } from '../../core/VDict';
+import { NumberLine, NumberLineOptions } from './NumberLine';
+import { FunctionGraph, FunctionGraphOptions } from './FunctionGraph';
+import { MathTex } from '../../mobjects/text/MathTex';
+import { Line } from '../../mobjects/geometry/Line';
+import { DashedLine } from '../../mobjects/geometry/DashedLine';
+/**
+ * Options for creating Axes
+ */
+export interface AxesOptions {
+    /** X-axis range as [min, max] or [min, max, step]. Default: [-5, 5, 1] */
+    xRange?: [number, number] | [number, number, number];
+    /** Y-axis range as [min, max] or [min, max, step]. Default: [-3, 3, 1] */
+    yRange?: [number, number] | [number, number, number];
+    /** Visual length of the x-axis. Default: 10 */
+    xLength?: number;
+    /** Visual length of the y-axis. Default: 6 */
+    yLength?: number;
+    /** Stroke color for axes. Default: '#ffffff' */
+    color?: string;
+    /** Common configuration for both axes */
+    axisConfig?: Partial<NumberLineOptions>;
+    /** Configuration specific to x-axis (overrides axisConfig) */
+    xAxisConfig?: Partial<NumberLineOptions>;
+    /** Configuration specific to y-axis (overrides axisConfig) */
+    yAxisConfig?: Partial<NumberLineOptions>;
+    /** Whether to include arrow tips on axes. Default: true */
+    tips?: boolean;
+    /** Length of arrow tips. Default: 0.25 */
+    tipLength?: number;
+}
+/**
+ * Axes - A coordinate system with x and y axes
+ *
+ * Creates a 2D coordinate system with configurable ranges and styling.
+ * Supports coordinate transformations between graph space and visual space.
+ *
+ * @example
+ * ```typescript
+ * // Create default axes
+ * const axes = new Axes();
+ *
+ * // Create axes with custom ranges
+ * const customAxes = new Axes({
+ *   xRange: [0, 10, 1],
+ *   yRange: [-1, 1, 0.5],
+ *   xLength: 8,
+ *   yLength: 4
+ * });
+ *
+ * // Get a point in visual coordinates
+ * const point = axes.coordsToPoint(3, 2);
+ * ```
+ */
+export declare class Axes extends Group {
+    /** The x-axis NumberLine */
+    xAxis: NumberLine;
+    /** The y-axis NumberLine */
+    yAxis: NumberLine;
+    protected _xRange: [number, number, number];
+    protected _yRange: [number, number, number];
+    protected _xLength: number;
+    protected _yLength: number;
+    protected _tips: boolean;
+    protected _tipLength: number;
+    protected _xTip: VMobject | null;
+    protected _yTip: VMobject | null;
+    constructor(options?: AxesOptions);
+    /**
+     * Add arrow tips to the axes
+     */
+    private _addTips;
+    /**
+     * Convert graph coordinates to visual point coordinates
+     * @param x - X coordinate in graph space
+     * @param y - Y coordinate in graph space
+     * @returns The visual point [x, y, z]
+     */
+    /**
+     * Alias for coordsToPoint (matches Python Manim's c2p shorthand)
+     */
+    c2p(x: number, y: number): Vector3Tuple;
+    coordsToPoint(x: number, y: number): Vector3Tuple;
+    /**
+     * Convert visual point coordinates to graph coordinates
+     * @param point - Visual point [x, y, z]
+     * @returns The graph coordinates [x, y]
+     */
+    pointToCoords(point: Vector3Tuple): [number, number];
+    /**
+     * Get the x-axis NumberLine
+     */
+    getXAxis(): NumberLine;
+    /**
+     * Get the y-axis NumberLine
+     */
+    getYAxis(): NumberLine;
+    /**
+     * Get the x range
+     */
+    getXRange(): [number, number, number];
+    /** Public accessor for x range (matches Python Manim's ax.x_range) */
+    get xRange(): [number, number, number];
+    /**
+     * Get the y range
+     */
+    getYRange(): [number, number, number];
+    /** Public accessor for y range (matches Python Manim's ax.y_range) */
+    get yRange(): [number, number, number];
+    /**
+     * Get the visual x length
+     */
+    getXLength(): number;
+    /**
+     * Get the visual y length
+     */
+    getYLength(): number;
+    /**
+     * Get the origin point in visual coordinates
+     */
+    getOrigin(): Vector3Tuple;
+    /**
+     * Convert an x coordinate to visual x position
+     */
+    c2pX(x: number): number;
+    /**
+     * Convert a y coordinate to visual y position
+     */
+    c2pY(y: number): number;
+    /**
+     * Plot a function on these axes, returning a FunctionGraph.
+     * @param func - Function y = f(x)
+     * @param options - Additional FunctionGraph options (color, strokeWidth, etc.)
+     * @returns A FunctionGraph bound to these axes
+     */
+    plot(func: (x: number) => number, options?: Partial<Omit<FunctionGraphOptions, 'func' | 'axes'>>): FunctionGraph;
+    /**
+     * Get axis labels ("x" and "y" by default).
+     * Labels can be LaTeX strings or pre-built Mobject instances (e.g. Tex, MathTex).
+     * @param xLabel - LaTeX string or Mobject for x-axis label. Default: "x"
+     * @param yLabel - LaTeX string or Mobject for y-axis label. Default: "y"
+     * @returns A Group containing the two labels
+     */
+    getAxisLabels(xLabelOrOpts?: string | Mobject | {
+        xLabel?: string | Mobject;
+        yLabel?: string | Mobject;
+    }, yLabelArg?: string | Mobject): Group;
+    /**
+     * Get a label for a graph at a specific x-value.
+     * Matches Python Manim's axes.get_graph_label() API.
+     * @param graph - The FunctionGraph to label
+     * @param label - LaTeX string for the label
+     * @param options - Positioning options
+     * @returns A MathTex label positioned near the graph
+     */
+    getGraphLabel(graph: FunctionGraph, labelOrOptions?: string | {
+        xVal?: number;
+        direction?: Vector3Tuple;
+        color?: string;
+        label?: string;
+    }, options?: {
+        xVal?: number;
+        direction?: Vector3Tuple;
+        color?: string;
+        label?: string;
+    }): MathTex;
+    /**
+     * Create a vertical line from the x-axis to a point.
+     * @param point - The target point [x, y, z] in visual coordinates
+     * @param options - Line options
+     * @returns A Line from the x-axis to the point
+     */
+    getVerticalLine(point: Vector3Tuple, options?: {
+        color?: string;
+        strokeWidth?: number;
+        lineFunc?: typeof Line | typeof DashedLine;
+    }): VMobject;
+    /**
+     * Input to graph point: convert an x value to the visual point on a graph.
+     * Shorthand for graph.getPointFromX(x).
+     * @param x - The x coordinate in graph space
+     * @param graph - The FunctionGraph
+     * @returns The visual coordinates on the graph
+     */
+    i2gp(x: number, graph: FunctionGraph): Vector3Tuple;
+    /**
+     * Alias for i2gp — convert an x value to the visual point on a graph.
+     * Matches Python Manim's axes.input_to_graph_point() API.
+     */
+    inputToGraphPoint(x: number, graph: FunctionGraph): Vector3Tuple;
+    /**
+     * Create Riemann sum rectangles under a graph.
+     * @param graph - The FunctionGraph to approximate
+     * @param options - Riemann rectangle options
+     * @returns A VGroup of filled rectangles
+     */
+    getRiemannRectangles(graph: FunctionGraph, options?: {
+        xRange?: [number, number];
+        dx?: number;
+        color?: string;
+        fillOpacity?: number;
+        strokeWidth?: number;
+        strokeColor?: string;
+    }): VGroup;
+    /**
+     * Create a filled area between a graph and either the x-axis or another graph.
+     * @param graph - The primary graph boundary
+     * @param xRange - The x interval [start, end]
+     * @param options - Area options
+     * @returns A filled VMobject representing the area
+     */
+    getArea(graph: FunctionGraph, xRange: [number, number], options?: {
+        boundedGraph?: FunctionGraph;
+        color?: string;
+        opacity?: number;
+        strokeWidth?: number;
+    }): VMobject;
+    /**
+     * Plot a line graph connecting data points with straight line segments.
+     * Returns a VDict with "line_graph" (the connecting line) and
+     * "vertex_dots" (dots at each data point).
+     *
+     * Matches Python Manim's axes.plot_line_graph() API.
+     *
+     * @param options - Line graph options
+     * @returns A VDict with "line_graph" and "vertex_dots" entries
+     */
+    plotLineGraph(options: {
+        xValues: number[];
+        yValues: number[];
+        lineColor?: string;
+        addVertexDots?: boolean;
+        vertexDotRadius?: number;
+        vertexDotStyle?: {
+            color?: string;
+            fillOpacity?: number;
+            strokeWidth?: number;
+            strokeColor?: string;
+        };
+        strokeWidth?: number;
+    }): VDict;
+    private _numberToVisualX;
+    private _numberToVisualY;
+    /**
+     * Create a copy of this Axes
+     */
+    protected _createCopy(): Axes;
+}
+export default Axes;
+//# sourceMappingURL=Axes.d.ts.map