manim-web 0.2.0

package/dist/mobjects/geometry/PolygonExtensions.d.ts

@@ -0,0 +1,412 @@
+import { VMobject } from '../../core/VMobject';
+import { Vector3Tuple } from '../../core/Mobject';
+/**
+ * Options for creating a RoundedRectangle
+ */
+export interface RoundedRectangleOptions {
+    /** Width of the rectangle. Default: 2 */
+    width?: number;
+    /** Height of the rectangle. Default: 1 */
+    height?: number;
+    /** Corner radius. Default: 0.25 */
+    cornerRadius?: number;
+    /** Stroke color as CSS color string. Default: Manim's blue (#58C4DD) */
+    color?: string;
+    /** Fill opacity from 0 to 1. Default: 0 */
+    fillOpacity?: number;
+    /** Stroke width in pixels. Default: 4 (Manim's default) */
+    strokeWidth?: number;
+    /** Center position. Default: [0, 0, 0] */
+    center?: Vector3Tuple;
+}
+/**
+ * RoundedRectangle - A rectangle with rounded corners
+ *
+ * Creates a rectangle with circular arcs at each corner using cubic Bezier
+ * approximation for the arcs.
+ *
+ * @example
+ * ```typescript
+ * // Create a rounded rectangle
+ * const roundedRect = new RoundedRectangle({ width: 3, height: 2, cornerRadius: 0.5 });
+ *
+ * // Create a pill shape (corner radius = half height)
+ * const pill = new RoundedRectangle({ width: 4, height: 1, cornerRadius: 0.5 });
+ * ```
+ */
+export declare class RoundedRectangle extends VMobject {
+    private _width;
+    private _height;
+    private _cornerRadius;
+    private _centerPoint;
+    constructor(options?: RoundedRectangleOptions);
+    /**
+     * Generate the rounded rectangle points
+     */
+    private _generatePoints;
+    /**
+     * Get the width of the rounded rectangle
+     */
+    getWidth(): number;
+    /**
+     * Set the width of the rounded rectangle
+     */
+    setWidth(value: number): this;
+    /**
+     * Get the height of the rounded rectangle
+     */
+    getHeight(): number;
+    /**
+     * Set the height of the rounded rectangle
+     */
+    setHeight(value: number): this;
+    /**
+     * Get the corner radius
+     */
+    getCornerRadius(): number;
+    /**
+     * Set the corner radius
+     */
+    setCornerRadius(value: number): this;
+    /**
+     * Get the center of the rounded rectangle
+     */
+    getRoundedRectCenter(): Vector3Tuple;
+    /**
+     * Set the center of the rounded rectangle
+     */
+    setRoundedRectCenter(value: Vector3Tuple): this;
+    /**
+     * Create a copy of this RoundedRectangle
+     */
+    protected _createCopy(): RoundedRectangle;
+}
+/**
+ * Options for creating a Star
+ */
+export interface StarOptions {
+    /** Number of points on the star. Default: 5 */
+    numPoints?: number;
+    /** Outer radius (to the tips). Default: 1 */
+    outerRadius?: number;
+    /** Inner radius (to the inner vertices). Default: 0.4 */
+    innerRadius?: number;
+    /** Stroke color as CSS color string. Default: Manim's blue (#58C4DD) */
+    color?: string;
+    /** Fill opacity from 0 to 1. Default: 0 */
+    fillOpacity?: number;
+    /** Stroke width in pixels. Default: 4 (Manim's default) */
+    strokeWidth?: number;
+    /** Center position. Default: [0, 0, 0] */
+    center?: Vector3Tuple;
+    /** Start angle in radians. Default: PI/2 (point up) */
+    startAngle?: number;
+}
+/**
+ * Star - A star shape with alternating outer and inner vertices
+ *
+ * Creates a star with a specified number of points, alternating between
+ * outer and inner radii.
+ *
+ * @example
+ * ```typescript
+ * // Create a 5-pointed star
+ * const star = new Star({ numPoints: 5 });
+ *
+ * // Create a 6-pointed star (Star of David style)
+ * const sixStar = new Star({ numPoints: 6, innerRadius: 0.5 });
+ * ```
+ */
+export declare class Star extends VMobject {
+    private _numPoints;
+    private _outerRadius;
+    private _innerRadius;
+    private _centerPoint;
+    private _startAngle;
+    constructor(options?: StarOptions);
+    /**
+     * Generate the star vertices and points
+     */
+    private _generatePoints;
+    /**
+     * Get the number of points
+     */
+    getNumPoints(): number;
+    /**
+     * Get the outer radius
+     */
+    getOuterRadius(): number;
+    /**
+     * Set the outer radius
+     */
+    setOuterRadius(value: number): this;
+    /**
+     * Get the inner radius
+     */
+    getInnerRadius(): number;
+    /**
+     * Set the inner radius
+     */
+    setInnerRadius(value: number): this;
+    /**
+     * Get the center of the star
+     */
+    getStarCenter(): Vector3Tuple;
+    /**
+     * Set the center of the star
+     */
+    setStarCenter(value: Vector3Tuple): this;
+    /**
+     * Create a copy of this Star
+     */
+    protected _createCopy(): Star;
+}
+/**
+ * Options for creating a RegularPolygram
+ */
+export interface RegularPolygramOptions {
+    /** Number of vertices on the circumscribed circle. Default: 5 */
+    numVertices?: number;
+    /**
+     * Density (vertex step count), i.e. how many vertices to skip when
+     * drawing each edge. Default: 2
+     *
+     * The Schlafli symbol {numVertices/density} describes the polygram.
+     * For example {5/2} is a pentagram, {7/3} is a heptagram.
+     *
+     * When gcd(numVertices, density) > 1 the polygram decomposes into
+     * multiple congruent regular polygon components. For instance {6/2}
+     * simplifies to 2{3} -- two overlapping equilateral triangles.
+     */
+    density?: number;
+    /** Radius from center to vertices. Default: 1 */
+    radius?: number;
+    /** Stroke color as CSS color string. Default: Manim's blue (#58C4DD) */
+    color?: string;
+    /** Fill opacity from 0 to 1. Default: 0 */
+    fillOpacity?: number;
+    /** Stroke width in pixels. Default: 4 (Manim's default) */
+    strokeWidth?: number;
+    /** Center position. Default: [0, 0, 0] */
+    center?: Vector3Tuple;
+    /** Start angle in radians. Default: PI/2 (first vertex up) */
+    startAngle?: number;
+}
+/**
+ * RegularPolygram - A generalized star polygon {n/k}
+ *
+ * Creates a regular star polygon by placing n vertices equally spaced on a
+ * circle and connecting every k-th vertex, where k is the density.
+ *
+ * When gcd(n, k) = 1 the result is a single continuous self-intersecting
+ * path that winds k times around the center before closing (e.g. the
+ * pentagram {5/2}).
+ *
+ * When gcd(n, k) > 1 the polygram decomposes into gcd(n,k) congruent
+ * regular polygon components, each rendered as a separate child VMobject.
+ * For example, a hexagram {6/2} becomes 2 equilateral triangles (2{3}).
+ *
+ * This matches the behavior of Python manim's RegularPolygram.
+ *
+ * @example
+ * ```typescript
+ * // Pentagram {5/2} -- single continuous star
+ * const pentagram = new RegularPolygram({ numVertices: 5, density: 2 });
+ *
+ * // Hexagram {6/2} = 2{3} -- two overlapping triangles
+ * const hexagram = new RegularPolygram({ numVertices: 6, density: 2 });
+ *
+ * // Heptagram {7/3}
+ * const heptagram = new RegularPolygram({ numVertices: 7, density: 3 });
+ *
+ * // Octagram {8/3}
+ * const octagram = new RegularPolygram({ numVertices: 8, density: 3 });
+ * ```
+ */
+export declare class RegularPolygram extends VMobject {
+    private _numVertices;
+    private _density;
+    private _radius;
+    private _centerPoint;
+    private _startAngle;
+    private _numComponents;
+    constructor(options?: RegularPolygramOptions);
+    /**
+     * Generate the polygram geometry.
+     *
+     * If gcd(n,k) = 1 the polygram is a single continuous path stored
+     * directly in this VMobject's points.
+     *
+     * If gcd(n,k) > 1 the polygram is composed of gcd(n,k) congruent
+     * regular polygon components. Each component is a child VMobject so
+     * that the rendering pipeline draws them as separate closed paths.
+     */
+    private _generatePoints;
+    /**
+     * Get the number of vertices (n in the Schlafli symbol {n/k})
+     */
+    getNumVertices(): number;
+    /**
+     * Get the density (k in the Schlafli symbol {n/k})
+     */
+    getDensity(): number;
+    /**
+     * Get the number of disconnected polygon components.
+     * Equal to gcd(numVertices, density).
+     * When this is 1 the polygram is a single continuous path.
+     */
+    getNumComponents(): number;
+    /**
+     * Get the Schlafli symbol as a string, e.g. "{5/2}"
+     */
+    getSchlafliSymbol(): string;
+    /**
+     * Get the radius
+     */
+    getRadius(): number;
+    /**
+     * Set the radius
+     */
+    setRadius(value: number): this;
+    /**
+     * Get the center of the polygram
+     */
+    getPolygramCenter(): Vector3Tuple;
+    /**
+     * Set the center of the polygram
+     */
+    setPolygramCenter(value: Vector3Tuple): this;
+    /**
+     * Create a copy of this RegularPolygram
+     */
+    protected _createCopy(): RegularPolygram;
+}
+/**
+ * Options for creating a Cutout
+ */
+export interface CutoutOptions {
+    /** The outer shape (must be a VMobject). Required. */
+    outerShape: VMobject;
+    /** The inner shape (the hole, must be a VMobject). Required. */
+    innerShape: VMobject;
+    /** Stroke color as CSS color string. Default: inherits from outer shape */
+    color?: string;
+    /** Fill opacity from 0 to 1. Default: inherits from outer shape */
+    fillOpacity?: number;
+    /** Stroke width in pixels. Default: inherits from outer shape */
+    strokeWidth?: number;
+}
+/**
+ * Cutout - A shape with a hole cut out
+ *
+ * Creates a compound path with an outer boundary and an inner hole.
+ * Uses the even-odd fill rule to create the cutout effect.
+ *
+ * @example
+ * ```typescript
+ * import { Circle, Square, Cutout } from 'manimweb';
+ *
+ * // Create a circle with a square hole
+ * const outer = new Circle({ radius: 2, fillOpacity: 0.5 });
+ * const inner = new Square({ sideLength: 1.5 });
+ * const cutout = new Cutout({ outerShape: outer, innerShape: inner });
+ * ```
+ */
+export declare class Cutout extends VMobject {
+    private _outerShape;
+    private _innerShape;
+    constructor(options: CutoutOptions);
+    /**
+     * Generate the compound path by combining outer and inner shapes
+     */
+    private _generatePoints;
+    private _subpaths;
+    /**
+     * Get subpath information
+     */
+    getSubpaths(): number[];
+    /**
+     * Get the outer shape
+     */
+    getOuterShape(): VMobject;
+    /**
+     * Get the inner shape
+     */
+    getInnerShape(): VMobject;
+    /**
+     * Create a copy of this Cutout
+     */
+    protected _createCopy(): Cutout;
+}
+/**
+ * Options for creating a ConvexHull
+ */
+export interface ConvexHullOptions {
+    /** Array of points to compute convex hull from. Required. */
+    points: Vector3Tuple[];
+    /** Stroke color as CSS color string. Default: Manim's blue (#58C4DD) */
+    color?: string;
+    /** Fill opacity from 0 to 1. Default: 0 */
+    fillOpacity?: number;
+    /** Stroke width in pixels. Default: 4 (Manim's default) */
+    strokeWidth?: number;
+}
+/**
+ * ConvexHull - Convex hull of a set of points
+ *
+ * Computes and draws the convex hull of a given set of points using
+ * the Graham scan algorithm.
+ *
+ * @example
+ * ```typescript
+ * // Create a convex hull from random points
+ * const points: Vector3Tuple[] = [
+ *   [0, 0, 0], [1, 2, 0], [2, 0, 0], [1.5, 1, 0], [0.5, 0.5, 0]
+ * ];
+ * const hull = new ConvexHull({ points });
+ *
+ * // The hull will only include the outer boundary points
+ * ```
+ */
+export declare class ConvexHull extends VMobject {
+    private _inputPoints;
+    private _hullVertices;
+    constructor(options: ConvexHullOptions);
+    /**
+     * Compute the convex hull using Graham scan algorithm
+     */
+    private _computeHull;
+    /**
+     * Generate the VMobject points from hull vertices
+     */
+    private _generatePoints;
+    /**
+     * Get the hull vertices
+     */
+    getHullVertices(): Vector3Tuple[];
+    /**
+     * Get the original input points
+     */
+    getInputPoints(): Vector3Tuple[];
+    /**
+     * Get the number of vertices in the hull
+     */
+    getHullVertexCount(): number;
+    /**
+     * Get the area of the convex hull using the Shoelace formula
+     */
+    getArea(): number;
+    /**
+     * Get the perimeter of the convex hull
+     */
+    getPerimeter(): number;
+    /**
+     * Check if a point is inside the convex hull
+     */
+    containsPoint(point: Vector3Tuple): boolean;
+    /**
+     * Create a copy of this ConvexHull
+     */
+    protected _createCopy(): ConvexHull;
+}
+//# sourceMappingURL=PolygonExtensions.d.ts.map

package/dist/mobjects/geometry/PolygonExtensions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PolygonExtensions.d.ts","sourceRoot":"","sources":["../../../src/mobjects/geometry/PolygonExtensions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAGlD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0CAA0C;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,wEAAwE;IACxE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,gBAAiB,SAAQ,QAAQ;IAC5C,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,YAAY,CAAe;gBAEvB,OAAO,GAAE,uBAA4B;IA0BjD;;OAEG;IACH,OAAO,CAAC,eAAe;IAkIvB;;OAEG;IACH,QAAQ,IAAI,MAAM;IAIlB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAO7B;;OAEG;IACH,SAAS,IAAI,MAAM;IAInB;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAO9B;;OAEG;IACH,eAAe,IAAI,MAAM;IAIzB;;OAEG;IACH,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAMpC;;OAEG;IACH,oBAAoB,IAAI,YAAY;IAIpC;;OAEG;IACH,oBAAoB,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAM/C;;OAEG;cACgB,WAAW,IAAI,gBAAgB;CAWnD;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,+CAA+C;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yDAAyD;IACzD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,wEAAwE;IACxE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,uDAAuD;IACvD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,IAAK,SAAQ,QAAQ;IAChC,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,WAAW,CAAS;gBAEhB,OAAO,GAAE,WAAgB;IA+BrC;;OAEG;IACH,OAAO,CAAC,eAAe;IAsCvB;;OAEG;IACH,YAAY,IAAI,MAAM;IAItB;;OAEG;IACH,cAAc,IAAI,MAAM;IAIxB;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAMnC;;OAEG;IACH,cAAc,IAAI,MAAM;IAIxB;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAMnC;;OAEG;IACH,aAAa,IAAI,YAAY;IAI7B;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAMxC;;OAEG;cACgB,WAAW,IAAI,IAAI;CAYvC;AAcD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,iEAAiE;IACjE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iDAAiD;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,wEAAwE;IACxE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,8DAA8D;IAC9D,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,eAAgB,SAAQ,QAAQ;IAC3C,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,cAAc,CAAS;gBAEnB,OAAO,GAAE,sBAA2B;IA6ChD;;;;;;;;;OASG;IACH,OAAO,CAAC,eAAe;IAwFvB;;OAEG;IACH,cAAc,IAAI,MAAM;IAIxB;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;;;OAIG;IACH,gBAAgB,IAAI,MAAM;IAI1B;;OAEG;IACH,iBAAiB,IAAI,MAAM;IAO3B;;OAEG;IACH,SAAS,IAAI,MAAM;IAInB;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAM9B;;OAEG;IACH,iBAAiB,IAAI,YAAY;IAIjC;;OAEG;IACH,iBAAiB,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAM5C;;OAEG;cACgB,WAAW,IAAI,eAAe;CAYlD;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,sDAAsD;IACtD,UAAU,EAAE,QAAQ,CAAC;IACrB,gEAAgE;IAChE,UAAU,EAAE,QAAQ,CAAC;IACrB,2EAA2E;IAC3E,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mEAAmE;IACnE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iEAAiE;IACjE,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,MAAO,SAAQ,QAAQ;IAClC,OAAO,CAAC,WAAW,CAAW;IAC9B,OAAO,CAAC,WAAW,CAAW;gBAElB,OAAO,EAAE,aAAa;IAqBlC;;OAEG;IACH,OAAO,CAAC,eAAe;IAmBvB,OAAO,CAAC,SAAS,CAAgB;IAEjC;;OAEG;IACH,WAAW,IAAI,MAAM,EAAE;IAIvB;;OAEG;IACH,aAAa,IAAI,QAAQ;IAIzB;;OAEG;IACH,aAAa,IAAI,QAAQ;IAIzB;;OAEG;cACgB,WAAW,IAAI,MAAM;CASzC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,6DAA6D;IAC7D,MAAM,EAAE,YAAY,EAAE,CAAC;IACvB,wEAAwE;IACxE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,UAAW,SAAQ,QAAQ;IACtC,OAAO,CAAC,YAAY,CAAiB;IACrC,OAAO,CAAC,aAAa,CAAiB;gBAE1B,OAAO,EAAE,iBAAiB;IAyBtC;;OAEG;IACH,OAAO,CAAC,YAAY;IAoEpB;;OAEG;IACH,OAAO,CAAC,eAAe;IA4BvB;;OAEG;IACH,eAAe,IAAI,YAAY,EAAE;IAIjC;;OAEG;IACH,cAAc,IAAI,YAAY,EAAE;IAIhC;;OAEG;IACH,kBAAkB,IAAI,MAAM;IAI5B;;OAEG;IACH,OAAO,IAAI,MAAM;IAiBjB;;OAEG;IACH,YAAY,IAAI,MAAM;IAmBtB;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO;IA6B3C;;OAEG;cACgB,WAAW,IAAI,UAAU;CAQ7C"}

package/dist/mobjects/geometry/Rectangle.d.ts

@@ -0,0 +1,123 @@
+import { VMobject } from '../../core/VMobject';
+import { Vector3Tuple } from '../../core/Mobject';
+/**
+ * Options for creating a Rectangle
+ */
+export interface RectangleOptions {
+    /** Width of the rectangle. Default: 2 */
+    width?: number;
+    /** Height of the rectangle. Default: 1 */
+    height?: number;
+    /** Stroke color as CSS color string. Default: Manim's blue (#58C4DD) */
+    color?: string;
+    /** Fill opacity from 0 to 1. Default: 0 */
+    fillOpacity?: number;
+    /** Stroke width in pixels. Default: 4 (Manim's default) */
+    strokeWidth?: number;
+    /** Center position. Default: [0, 0, 0] */
+    center?: Vector3Tuple;
+}
+/**
+ * Rectangle - A rectangular VMobject
+ *
+ * Creates a rectangle defined by its width and height, centered at a point.
+ *
+ * @example
+ * ```typescript
+ * // Create a 2x1 rectangle
+ * const rect = new Rectangle();
+ *
+ * // Create a square
+ * const square = new Rectangle({ width: 2, height: 2 });
+ *
+ * // Create a filled rectangle
+ * const filled = new Rectangle({ fillOpacity: 0.5, color: '#ff0000' });
+ * ```
+ */
+export declare class Rectangle extends VMobject {
+    private _width;
+    private _height;
+    private _centerPoint;
+    constructor(options?: RectangleOptions);
+    /**
+     * Generate the rectangle points as 4 line segments
+     */
+    private _generatePoints;
+    /**
+     * Get the width of the rectangle
+     */
+    getWidth(): number;
+    /**
+     * Set the width of the rectangle
+     */
+    setWidth(value: number): this;
+    /**
+     * Get the height of the rectangle
+     */
+    getHeight(): number;
+    /**
+     * Set the height of the rectangle
+     */
+    setHeight(value: number): this;
+    /**
+     * Get the center of the rectangle
+     */
+    getRectCenter(): Vector3Tuple;
+    /**
+     * Set the center of the rectangle
+     */
+    setRectCenter(value: Vector3Tuple): this;
+    /**
+     * Get the area of the rectangle
+     */
+    getArea(): number;
+    /**
+     * Get the perimeter of the rectangle
+     */
+    getPerimeter(): number;
+    /**
+     * Get a specific corner of the rectangle
+     */
+    getCorner(corner: 'topLeft' | 'topRight' | 'bottomRight' | 'bottomLeft'): Vector3Tuple;
+    /**
+     * Get the top edge center
+     */
+    getTop(): Vector3Tuple;
+    /**
+     * Get the bottom edge center
+     */
+    getBottom(): Vector3Tuple;
+    /**
+     * Get the left edge center
+     */
+    getLeft(): Vector3Tuple;
+    /**
+     * Get the right edge center
+     */
+    getRight(): Vector3Tuple;
+    /**
+     * Create a copy of this Rectangle
+     */
+    protected _createCopy(): Rectangle;
+}
+/**
+ * Square - A special case of Rectangle with equal width and height
+ */
+export declare class Square extends Rectangle {
+    constructor(options?: Omit<RectangleOptions, 'width' | 'height'> & {
+        sideLength?: number;
+    });
+    /**
+     * Get the side length of the square
+     */
+    getSideLength(): number;
+    /**
+     * Set the side length of the square
+     */
+    setSideLength(value: number): this;
+    /**
+     * Create a copy of this Square
+     */
+    protected _createCopy(): Square;
+}
+//# sourceMappingURL=Rectangle.d.ts.map

package/dist/mobjects/geometry/Rectangle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Rectangle.d.ts","sourceRoot":"","sources":["../../../src/mobjects/geometry/Rectangle.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAGlD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0CAA0C;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,wEAAwE;IACxE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,SAAU,SAAQ,QAAQ;IACrC,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,YAAY,CAAe;gBAEvB,OAAO,GAAE,gBAAqB;IAuB1C;;OAEG;IACH,OAAO,CAAC,eAAe;IA+CvB;;OAEG;IACH,QAAQ,IAAI,MAAM;IAIlB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAM7B;;OAEG;IACH,SAAS,IAAI,MAAM;IAInB;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAM9B;;OAEG;IACH,aAAa,IAAI,YAAY;IAI7B;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAMxC;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;OAEG;IACH,YAAY,IAAI,MAAM;IAItB;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,aAAa,GAAG,YAAY,GAAG,YAAY;IAiBtF;;OAEG;IACH,MAAM,IAAI,YAAY;IAItB;;OAEG;IACH,SAAS,IAAI,YAAY;IAIzB;;OAEG;IACH,OAAO,IAAI,YAAY;IAIvB;;OAEG;IACH,QAAQ,IAAI,YAAY;IAIxB;;OAEG;cACgB,WAAW,IAAI,SAAS;CAU5C;AAED;;GAEG;AACH,qBAAa,MAAO,SAAQ,SAAS;gBAEjC,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,OAAO,GAAG,QAAQ,CAAC,GAAG;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAO;IAMpF;;OAEG;IACH,aAAa,IAAI,MAAM;IAIvB;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAMlC;;OAEG;cACgB,WAAW,IAAI,MAAM;CASzC"}