Reference Docs

Manim Web Documentation

Learn the runtime from simple 2D scenes to camera-driven 3D compositions, then use the generated reference for exact signatures, methods, constants, and compatibility details.

Modules
2
Symbols
395
Methods
215
Example Tracks
18

Learning Path

Start with 2D scene composition, then add motion and camera logic. The examples library is organized so you can learn the runtime in that order.

Open Examples

Start With 2D Scene Basics

Learn object creation, placement, styling, and the `Scene` timeline model before layering on animation.

Add Motion And State

Work through `play()`, transforms, `animate`, `ValueTracker`, and `always_redraw` patterns that power most interactive scenes.

Move The Camera

Use frame motion in 2D scenes and camera orientation changes in `ThreeDScene` when layout alone is not enough.

Build 3D Scenes

Combine `ThreeDScene`, 3D primitives, overlays, and camera movement for object demos and explainer scenes.

Use The Reference

Drop into the generated module/class/method reference below when you need exact signatures or supported compatibility details.

Important Runtime Notes

2D versus 3D
Use plain Scene for flat compositions. Use ThreeDScene when camera orientation and projected z depth should affect rendering.
Camera semantics
set_camera_orientation() establishes the initial 3D view immediately, while move_camera() animates from the current camera state.
Reactive scenes
ValueTracker, add_updater(), and always_redraw() are supported for counters, graphs, and motion systems.
Text-backed objects
Text, Tex, MathTex, DecimalNumber, Code, and table cells use vector metrics so layout stays stable during animation.
Generated reference
The API reference below is generated from runtime docstrings, so signatures and inline examples stay synchronized with the actual compiler/runtime surface.
Generated Runtime Reference

Documentation built from the compiler’s generated Python API surface

This view is grouped automatically from the runtime reference data. Modules stay separate, classes are ordered from base types toward more specialized subclasses, and every constant, function, class, and method gets a stable anchor for direct linking.

Modules
2
Classes
117
Functions
131
Constants
147
Methods
215

Module Index

Generated from the available modules in the runtime bundle.

Open Examples
manim

Core Manim-compatible runtime primitives exposed to user scene code.

136 constants115 functions117 classes
numpy

Minimal NumPy-compatible helpers exposed as the ``numpy`` shim.

11 constants16 functions0 classes

Class Index

Automatically ordered from lower inheritance depth to more specialized subclasses.

AnimationProxymanim

Animation Proxy class.

BackgroundAudioBlockmanim

Context manager for syncing background audio timing

CameraFramemanim

3D camera frame wrapper exposed by ``ThreeDScene.camera.frame``.

Colormanim

Lightweight color wrapper used by compatibility properties.

Conemanim

Circular cone with a capped base.

Cubemanim

Axis-aligned cube centered at the local origin.

Cylindermanim

Circular cylinder with top and bottom caps.

Dot3Dmanim

Small filled 3D marker positioned at a single point.

Line3Dmanim

Straight 3D segment between explicit start and end points.

MathObjectmanim

Base class for drawable objects in the Manim Web runtime.

Polyhedronmanim

General 3D mesh built from explicit vertices and polygon faces.

Prismmanim

Axis-aligned rectangular prism centered at the local origin.

Scenemanim

Top-level animation container that owns the timeline and exported state.

Spheremanim

Triangulated sphere generated from latitude and longitude samples.

Surfacemanim

Sampled parametric surface over a rectangular ``(u, v)`` domain.

SurfaceMeshmanim

Wireframe mesh extracted from a sampled surface.

ThreeDAxesmanim

Three-dimensional Cartesian axes with coordinate conversion helpers.

ThreeDCameramanim

Perspective camera wrapper exposed by ``ThreeDScene.camera``.

Torusmanim

Donut-shaped surface parameterized by major and minor radii.

VoiceoverBlockmanim

Context manager for syncing animations with voiceover timing

Arcmanim

Circular arc matching Manim's Arc constructor shape semantics.

Arrowmanim

Line segment with an arrow tip oriented toward the end point.

Arrow3Dmanim

3D line segment with an arrow tip at the end point.

Axesmanim

Coordinate axes with configurable ranges and visual lengths.

Bracemanim

Brace class.

Circlemanim

Circular outline or filled shape with Manim-style defaults.

Codemanim

Shared-layout code block that preserves Manim-style constructor options.

ConvexHull3Dmanim

Convex Hull3 D class.

CubicBeziermanim

Cubic Bezier curve defined by four control points.

DecimalNumbermanim

Decimal Number class.

Dodecahedronmanim

Regular dodecahedron convenience polyhedron.

FunctionGraphmanim

Function Graph class.

Groupmanim

Container that groups child mobjects without changing their types.

Icosahedronmanim

Regular icosahedron convenience polyhedron.

ImageMobjectmanim

Raster image loaded from the user workspace or scene asset map.

ImplicitFunctionmanim

Implicit Function class.

Linemanim

Straight segment defined by explicit start and end points.

Mobjectmanim

Mobject class.

MovingCameraScenemanim

MovingCameraScene scene class.

NumberLinemanim

Number Line class.

Octahedronmanim

Regular octahedron convenience polyhedron.

ParametricFunctionmanim

Curve generated by sampling a callable or expression over ``t_range``.

ParametricSurfacemanim

Alias of :class:`Surface` kept for Manim API compatibility.

PolarPlanemanim

Polar coordinate plane with radial and angular labeling helpers.

Polygonmanim

Polygon class.

Rectanglemanim

Axis-aligned rectangle parameterized by width and height.

RegularPolygonmanim

Regular Polygon class.

Squaremanim

Square mobject sampled densely for smoother morphing.

Tetrahedronmanim

Regular tetrahedron convenience polyhedron.

Texmanim

LaTeX-like text mobject represented as a single tex string.

Textmanim

Plain text mobject rendered with the runtime text renderer.

ThreeDScenemanim

3D scene with perspective camera controls compatible with Manim-style APIs.

Trianglemanim

Triangle class.

ValueTrackermanim

Numeric container used to drive animations and redraw callbacks.

VMobjectmanim

VMobject class.

VoiceoverScenemanim

Scene subclass with reusable voiceover helpers for narrated 2D timelines.

ZoomedScenemanim

Scene variant that renders a second zoomed inset of the main camera.

Anglemanim

Angle class.

AnnularSectormanim

Annular Sector class.

ArcBetweenPointsmanim

Circular arc spanning two points using Manim's constructor rules.

ArcPolygonmanim

Arc Polygon class.

ArrowCircleFilledTipmanim

Arrow Circle Filled Tip class.

ArrowCircleTipmanim

Arrow Circle Tip class.

ArrowSquareFilledTipmanim

Arrow Square Filled Tip class.

ArrowSquareTipmanim

Arrow Square Tip class.

ArrowTriangleFilledTipmanim

Filled triangular arrow tip sized with Manim-like defaults.

BraceBetweenPointsmanim

Brace Between Points class.

ConvexHullmanim

Convex Hull class.

DashedLinemanim

Dashed Line class.

Dotmanim

Filled circular point marker.

DoubleArrowmanim

Line segment with arrow tips at both the start and end points.

Elbowmanim

Elbow class.

Ellipsemanim

Ellipse class.

Integermanim

Integer-valued number mobject with animate/set_value support.

MarkupTextmanim

Text that accepts simple inline markup tags and strips them for rendering.

MathTexmanim

Math-oriented ``Tex`` variant that accepts multiple fragments.

NumberPlanemanim

Cartesian grid plane with vector and coordinate-label helpers.

Polygrammanim

Polygram class.

RegularPolygrammanim

Regular Polygram class.

RightAnglemanim

Right Angle class.

RoundedRectanglemanim

Rectangle variant with rounded corners.

Sectormanim

Sector class.

Starmanim

Star class.

SurroundingRectanglemanim

Rectangle that surrounds a mobject - exports as 'Rectangle' type

SVGMobjectmanim

SVG-backed image mobject.

TangentLinemanim

Tangent Line class.

TracedPathmanim

Continuously trace points returned by a callback over time.

Underlinemanim

Underline class.

Vectormanim

Vector class.

Vector3Dmanim

Arrow that starts at the origin and points along a direction vector.

VGroupmanim

Group variant used for vectorized collections of mobjects.

VoiceoverThreeDScenemanim

ThreeDScene variant with the same reusable voiceover helpers as VoiceoverScene.

AnnotationDotmanim

Annotation Dot class.

Annulusmanim

Annulus class.

ArcBracemanim

Arc Brace class.

ArcPolygonFromArcsmanim

Arc Polygon From Arcs class.

ArrowTipmanim

Arrow Tip class.

ArrowTriangleTipmanim

Arrow Triangle Tip class.

BackgroundRectanglemanim

Filled rectangle sized to sit behind another mobject.

BraceLabelmanim

Brace Label class.

BulletedListmanim

Vertical stack of TeX items with bullet dots, mirroring Manim's helper.

Crossmanim

Simple diagonal cross mark used for highlights and failure indicators.

CurvedArrowmanim

Curved Arrow class.

Cutoutmanim

Cutout class.

Differencemanim

Difference class.

Exclusionmanim

Exclusion class.

Intersectionmanim

Intersection class.

LabeledDotmanim

Labeled Dot class.

Matrixmanim

Minimal matrix helper that arranges entries in rows with brackets.

Paragraphmanim

Vertical stack of text lines with alignment controls.

StealthTipmanim

Stealth Tip class.

Tablemanim

Simple table made of rectangle/text cells with ``get_rows()`` compatibility.

TangentialArcmanim

Tangential Arc class.

Titlemanim

Minimal title helper aligned to the top edge like Manim's Title.

Unionmanim

Union class.

BraceTextmanim

Brace Text class.

CurvedDoubleArrowmanim

Curved Double Arrow class.

Function Index

Direct links to generated top-level functions across the available modules.

AddTextLetterByLettermanim

Add Text Letter By Letter function.

always_redrawmanim

Creates an object that is redrawn every frame by calling func(). The returned object is tagged and given an updater that copies fresh geometry/state every frame, mirroring Manim's always_redraw behavior.

angle_of_vectormanim

Return the polar angle of a 2D vector in radians.

AnimationGroupmanim

Run multiple animations together as a grouped unit.

ApplyFunctionmanim

Animate a mobject toward the result of applying a callback to it.

ApplyMethodmanim

Apply Method animation helper.

ApplyPointwiseFunctionmanim

Apply Pointwise Function animation helper.

ApplyPointwiseFunctionToCentermanim

Apply Pointwise Function To Center animation helper.

ApplyWavemanim

Approximate a wave highlight by sliding a temporary colored copy.

arccosmanim

Arccos math helper.

Blinkmanim

Approximate a blink with a fast temporary overlay flash.

bouncemanim

Bounce easing function.

BraceBetweenPointsmanim

Create a brace between two points

ceilmanim

Ceil function.

Circumscribemanim

Draw and fade a temporary outline around a target mobject.

ClockwiseTransformmanim

Clockwise Transform animation helper.

color_gradientmanim

Interpolate a list of colors into a gradient of the requested length.

cosmanim

Cos math helper.

CounterclockwiseTransformmanim

Counterclockwise Transform animation helper.

Createmanim

Animate a mobject as if it is being drawn into the scene.

CyclicReplacemanim

Cyclic Replace animation helper.

degrees_to_radmanim

Degrees to rad math helper.

double_smoothmanim

Double smooth easing function.

ease_inmanim

Ease in easing function.

ease_in_backmanim

Ease in back easing function.

ease_in_bouncemanim

Ease in bounce easing function.

ease_in_circmanim

Ease in circ easing function.

ease_in_cubicmanim

Ease in cubic easing function.

ease_in_elasticmanim

Ease in elastic easing function.

ease_in_expomanim

Ease in expo easing function.

ease_in_outmanim

Ease in out easing function.

ease_in_out_backmanim

Ease in out back easing function.

ease_in_out_bouncemanim

Ease in out bounce easing function.

ease_in_out_circmanim

Ease in out circ easing function.

ease_in_out_cubicmanim

Ease in out cubic easing function.

ease_in_out_elasticmanim

Ease in out elastic easing function.

ease_in_out_expomanim

Ease in out expo easing function.

ease_in_out_quadmanim

Ease in out quad easing function.

ease_in_out_quartmanim

Ease in out quart easing function.

ease_in_out_quintmanim

Ease in out quint easing function.

ease_in_out_sinemanim

Ease in out sine easing function.

ease_in_quadmanim

Ease in quad easing function.

ease_in_quartmanim

Ease in quart easing function.

ease_in_quintmanim

Ease in quint easing function.

ease_in_sinemanim

Ease in sine easing function.

ease_outmanim

Ease out easing function.

ease_out_backmanim

Ease out back easing function.

ease_out_bouncemanim

Ease out bounce easing function.

ease_out_circmanim

Ease out circ easing function.

ease_out_cubicmanim

Ease out cubic easing function.

ease_out_elasticmanim

Ease out elastic easing function.

ease_out_expomanim

Ease out expo easing function.

ease_out_quadmanim

Ease out quad easing function.

ease_out_quartmanim

Ease out quart easing function.

ease_out_quintmanim

Ease out quint easing function.

ease_out_sinemanim

Ease out sine easing function.

elasticmanim

Elastic easing function.

exponential_decaymanim

Exponential decay easing function.

FadeInmanim

Animate a mobject from invisible to visible.

FadeOutmanim

Animate a mobject from visible to invisible.

Flashmanim

Approximate Manim's flash burst with a temporary star marker.

floormanim

Floor function.

FocusOnmanim

Spotlight a target with a temporary circular focus ring.

get_image_assetmanim

Get image asset function.

get_images_mapmanim

Get images map function.

GrowArrowmanim

Animate an arrow-like mobject growing into view.

GrowFromCentermanim

Grow From Center function.

GrowFromPointmanim

Grow From Point function.

Indicatemanim

Overlay a short pulse highlight on a mobject.

interpolate_colormanim

Linearly interpolate between two colors.

LaggedStartmanim

Run multiple animations with a staggered start offset.

LaggedStartMapmanim

Map an animation factory across a group and stagger the results.

linearmanim

Linear easing function.

lingeringmanim

Lingering function.

MaintainPositionRelativeTomanim

Maintain Position Relative To function.

MoveAlongPathmanim

Animate ``obj`` along sampled points from a path-like mobject.

MoveTomanim

Animate a move to a target point.

MoveToTargetmanim

Move To Target function.

not_quite_theremanim

Not quite there function.

radiansmanim

Radians math helper.

ReplacementTransformmanim

Transform one mobject into another while conceptually replacing it.

Rotatemanim

Animate a rotation transform, optionally around ``about_point``.

Rotatingmanim

Rotating function.

running_startmanim

Running start function.

rush_frommanim

Rush from easing function.

rush_intomanim

Rush into easing function.

Scalemanim

Animate a scale transform, optionally around ``about_point``.

ScaleInPlacemanim

Scale In Place function.

Shiftmanim

Animate a translation by a vector.

ShowPassingFlashmanim

Sweep a temporary highlighted copy across an existing mobject.

ShowPassingFlashAroundmanim

Sweep a temporary border around a target mobject.

ShrinkToCentermanim

Shrink To Center function.

sinmanim

Sin math helper.

slow_intomanim

Slow into easing function.

smoothmanim

Smooth easing function.

sqrtmanim

Sqrt math helper.

squish_rate_funcmanim

Squish rate func function.

Successionmanim

Succession function.

SurroundingRectangleWithBuffermanim

Surrounding Rectangle With Buffer function.

tanmanim

Tan math helper.

there_and_backmanim

There and back easing function.

there_and_back_with_pausemanim

There and back with pause function.

Transformmanim

Morph one mobject or group into another target state.

TransformFromCopymanim

Transform From Copy function.

TransformMatchingShapesmanim

Approximate Manim's shape-matching transform with a regular transform.

TransformMatchingStringsmanim

Transform Matching Strings function.

TransformMatchingTexmanim

Transform Matching Tex function.

Uncreatemanim

Uncreate function.

Unwritemanim

Unwrite function.

UpdateFromAlphaFuncmanim

Update From Alpha Func function.

UpdateFromFuncmanim

Update From Func function.

Waitmanim

Consume time inside animation groups without mutating scene objects.

wigglemanim

Wiggle easing function.

Wigglemanim

Wiggle easing function.

Writemanim

Animate text or strokes with a writing-style reveal.

abs_valuenumpy

Abs value function.

arangenumpy

Return evenly spaced values in the half-open interval ``[start, stop)``.

arctan_valuenumpy

Arctan value function.

arctan2_valuenumpy

Arctan2 value function.

aroundnumpy

Around function.

arraynumpy

Convert a value or nested sequence into a list-backed array shim.

clipnumpy

Clamp scalars or nested lists into the provided numeric range.

cos_valuenumpy

Cos value function.

expnumpy

Exp function.

linspacenumpy

Return evenly spaced scalar samples between ``start`` and ``stop``.

rollnumpy

Roll a 1D list-like sequence by ``shift`` positions.

roundnumpy

Round scalars or nested sequences to a fixed precision.

sin_valuenumpy

Sin value function.

sqrt_valuenumpy

Sqrt value function.

tan_valuenumpy

Tan value function.

uint8numpy

Uint8 function.

Module

manim

Core Manim-compatible runtime primitives exposed to user scene code. This module defines the browser-friendly Python surface used by the compiler, including mobjects, scenes, animation helpers, and graphing primitives.

Source Path
src/runtime/python_stdlib/manim/_core.py

Constants

136

BLACK

constant

manim.BLACK

"#000000"

BLACK color constant.

Examples
value = BLACK

BLUE

constant

manim.BLUE

"#58C4DD"

BLUE color constant.

Examples
value = BLUE

BLUE_A

constant

manim.BLUE_A

"#C7E9F1"

BLUE A color constant.

Examples
value = BLUE_A

BLUE_B

constant

manim.BLUE_B

"#9CDCEB"

BLUE B color constant.

Examples
value = BLUE_B

BLUE_C

constant

manim.BLUE_C

"#58C4DD"

BLUE C color constant.

Examples
value = BLUE_C

BLUE_D

constant

manim.BLUE_D

"#29ABCA"

BLUE D color constant.

Examples
value = BLUE_D

BLUE_E

constant

manim.BLUE_E

"#236B8E"

BLUE E color constant.

Examples
value = BLUE_E

BOLD

constant

manim.BOLD

"bold"

Font-weight alias matching Manim's ``BOLD`` text style constant.

Examples
value = BOLD

BOTTOM

constant

manim.BOTTOM

(0, -1, 0)

BOTTOM direction vector constant.

Examples
value = BOTTOM

config

constant

manim.config

_ConfigShim()

Mutable compatibility config shim.

Examples
value = config

CYAN

constant

manim.CYAN

"#00FFFF"

CYAN color constant.

Examples
value = CYAN

DARK_BLUE

constant

manim.DARK_BLUE

BLUE_E

DARK BLUE color constant.

Examples
value = DARK_BLUE

DARK_BROWN

constant

manim.DARK_BROWN

"#8B4513"

DARK BROWN color constant.

Examples
value = DARK_BROWN

DARK_GRAY

constant

manim.DARK_GRAY

"#444444"

DARK GRAY constant.

Examples
value = DARK_GRAY

DARK_GREY

constant

manim.DARK_GREY

DARK_GRAY

DARK GREY constant.

Examples
value = DARK_GREY

DARKER_GRAY

constant

manim.DARKER_GRAY

"#222222"

DARKER GRAY constant.

Examples
value = DARKER_GRAY

DARKER_GREY

constant

manim.DARKER_GREY

DARKER_GRAY

DARKER GREY constant.

Examples
value = DARKER_GREY

DEFAULT_ARROW_TIP_LENGTH

constant

manim.DEFAULT_ARROW_TIP_LENGTH

0.35

DEFAULT ARROW TIP LENGTH default constant.

Examples
value = DEFAULT_ARROW_TIP_LENGTH

DEFAULT_DASH_LENGTH

constant

manim.DEFAULT_DASH_LENGTH

0.05

DEFAULT DASH LENGTH default constant.

Examples
value = DEFAULT_DASH_LENGTH

DEFAULT_DOT_RADIUS

constant

manim.DEFAULT_DOT_RADIUS

0.08

DEFAULT DOT RADIUS default constant.

Examples
value = DEFAULT_DOT_RADIUS

DEFAULT_FONT_SIZE

constant

manim.DEFAULT_FONT_SIZE

48

DEFAULT FONT SIZE default constant.

Examples
value = DEFAULT_FONT_SIZE

DEFAULT_MOBJECT_TO_EDGE_BUFFER

constant

manim.DEFAULT_MOBJECT_TO_EDGE_BUFFER

MED_LARGE_BUFF

DEFAULT MOBJECT TO EDGE BUFFER spacing constant.

Examples
value = DEFAULT_MOBJECT_TO_EDGE_BUFFER

DEFAULT_MOBJECT_TO_MOBJECT_BUFFER

constant

manim.DEFAULT_MOBJECT_TO_MOBJECT_BUFFER

MED_SMALL_BUFF

DEFAULT MOBJECT TO MOBJECT BUFFER spacing constant.

Examples
value = DEFAULT_MOBJECT_TO_MOBJECT_BUFFER

DEFAULT_SMALL_DOT_RADIUS

constant

manim.DEFAULT_SMALL_DOT_RADIUS

0.04

DEFAULT SMALL DOT RADIUS default constant.

Examples
value = DEFAULT_SMALL_DOT_RADIUS

DEFAULT_STROKE_WIDTH

constant

manim.DEFAULT_STROKE_WIDTH

4

DEFAULT STROKE WIDTH default constant.

Examples
value = DEFAULT_STROKE_WIDTH

DEGREES

constant

manim.DEGREES

PI / 180

Conversion factor from degrees to radians.

Examples
value = DEGREES

DL

constant

manim.DL

(-1, -1, 0)

DL direction vector constant.

Examples
value = DL

DOWN

constant

manim.DOWN

(0, -1, 0)

Unit vector that points downward in scene coordinates.

Examples
value = DOWN

DR

constant

manim.DR

(1, -1, 0)

DR direction vector constant.

Examples
value = DR

E

constant

manim.E

2.718281828459045

Base of the natural logarithm.

Examples
value = E

GOLD

constant

manim.GOLD

"#F0AC5F"

GOLD color constant.

Examples
value = GOLD

GOLD_A

constant

manim.GOLD_A

"#F7C797"

GOLD A color constant.

Examples
value = GOLD_A

GOLD_B

constant

manim.GOLD_B

"#F9B775"

GOLD B color constant.

Examples
value = GOLD_B

GOLD_C

constant

manim.GOLD_C

"#F0AC5F"

GOLD C color constant.

Examples
value = GOLD_C

GOLD_D

constant

manim.GOLD_D

"#E1A158"

GOLD D color constant.

Examples
value = GOLD_D

GOLD_E

constant

manim.GOLD_E

"#C78D46"

GOLD E color constant.

Examples
value = GOLD_E

GRAY

constant

manim.GRAY

GREY

GRAY color constant.

Examples
value = GRAY

GRAY_A

constant

manim.GRAY_A

GREY_A

GRAY A constant.

Examples
value = GRAY_A

GRAY_B

constant

manim.GRAY_B

GREY_B

GRAY B constant.

Examples
value = GRAY_B

GRAY_BROWN

constant

manim.GRAY_BROWN

GREY_BROWN

GRAY BROWN color constant.

Examples
value = GRAY_BROWN

GRAY_C

constant

manim.GRAY_C

GREY_C

GRAY C constant.

Examples
value = GRAY_C

GRAY_D

constant

manim.GRAY_D

GREY_D

GRAY D constant.

Examples
value = GRAY_D

GRAY_E

constant

manim.GRAY_E

GREY_E

GRAY E constant.

Examples
value = GRAY_E

GREEN

constant

manim.GREEN

"#83C167"

GREEN color constant.

Examples
value = GREEN

GREEN_A

constant

manim.GREEN_A

"#C9E2AE"

GREEN A color constant.

Examples
value = GREEN_A

GREEN_B

constant

manim.GREEN_B

"#A6CF8C"

GREEN B color constant.

Examples
value = GREEN_B

GREEN_C

constant

manim.GREEN_C

"#83C167"

GREEN C color constant.

Examples
value = GREEN_C

GREEN_D

constant

manim.GREEN_D

"#77B05D"

GREEN D color constant.

Examples
value = GREEN_D

GREEN_E

constant

manim.GREEN_E

"#699C52"

GREEN E color constant.

Examples
value = GREEN_E

GREEN_SCREEN

constant

manim.GREEN_SCREEN

PURE_GREEN

GREEN SCREEN color constant.

Examples
value = GREEN_SCREEN

GREY

constant

manim.GREY

"#888888"

GREY color constant.

Examples
value = GREY

GREY_A

constant

manim.GREY_A

"#DDDDDD"

GREY A constant.

Examples
value = GREY_A

GREY_B

constant

manim.GREY_B

"#BBBBBB"

GREY B constant.

Examples
value = GREY_B

GREY_BROWN

constant

manim.GREY_BROWN

"#736357"

GREY BROWN color constant.

Examples
value = GREY_BROWN

GREY_C

constant

manim.GREY_C

"#888888"

GREY C constant.

Examples
value = GREY_C

GREY_D

constant

manim.GREY_D

"#444444"

GREY D constant.

Examples
value = GREY_D

GREY_E

constant

manim.GREY_E

"#222222"

GREY E constant.

Examples
value = GREY_E

IN

constant

manim.IN

(0, 0, -1)

IN direction vector constant.

Examples
value = IN

ITALIC

constant

manim.ITALIC

"italic"

Font-slant alias matching Manim's ``ITALIC`` text style constant.

Examples
value = ITALIC

LARGE_BUFF

constant

manim.LARGE_BUFF

1

LARGE BUFF spacing constant.

Examples
value = LARGE_BUFF

LEFT

constant

manim.LEFT

(-1, 0, 0)

Unit vector that points left in scene coordinates.

Examples
value = LEFT

LEFT_SIDE

constant

manim.LEFT_SIDE

(-1, 0, 0)

LEFT_SIDE direction vector constant.

Examples
value = LEFT_SIDE

LIGHT_BROWN

constant

manim.LIGHT_BROWN

"#B08968"

LIGHT BROWN color constant.

Examples
value = LIGHT_BROWN

LIGHT_GRAY

constant

manim.LIGHT_GRAY

"#BBBBBB"

LIGHT GRAY constant.

Examples
value = LIGHT_GRAY

LIGHT_GREY

constant

manim.LIGHT_GREY

LIGHT_GRAY

LIGHT GREY constant.

Examples
value = LIGHT_GREY

LIGHT_PINK

constant

manim.LIGHT_PINK

"#DC75CD"

LIGHT PINK color constant.

Examples
value = LIGHT_PINK

LIGHTER_GRAY

constant

manim.LIGHTER_GRAY

"#DDDDDD"

LIGHTER GRAY constant.

Examples
value = LIGHTER_GRAY

LIGHTER_GREY

constant

manim.LIGHTER_GREY

"#DDDDDD"

LIGHTER GREY constant.

Examples
value = LIGHTER_GREY

LOGO_BLACK

constant

manim.LOGO_BLACK

"#343434"

LOGO BLACK color constant.

Examples
value = LOGO_BLACK

LOGO_BLUE

constant

manim.LOGO_BLUE

"#525893"

LOGO BLUE color constant.

Examples
value = LOGO_BLUE

LOGO_GREEN

constant

manim.LOGO_GREEN

"#87C2A5"

LOGO GREEN color constant.

Examples
value = LOGO_GREEN

LOGO_RED

constant

manim.LOGO_RED

"#E07A5F"

LOGO RED color constant.

Examples
value = LOGO_RED

LOGO_WHITE

constant

manim.LOGO_WHITE

"#ECE7E2"

LOGO WHITE color constant.

Examples
value = LOGO_WHITE

MAGENTA

constant

manim.MAGENTA

"#FF00FF"

MAGENTA constant.

Examples
value = MAGENTA

MAROON

constant

manim.MAROON

"#C55F73"

MAROON color constant.

Examples
value = MAROON

MAROON_A

constant

manim.MAROON_A

"#ECABC1"

MAROON A color constant.

Examples
value = MAROON_A

MAROON_B

constant

manim.MAROON_B

"#EC92AB"

MAROON B color constant.

Examples
value = MAROON_B

MAROON_C

constant

manim.MAROON_C

"#C55F73"

MAROON C color constant.

Examples
value = MAROON_C

MAROON_D

constant

manim.MAROON_D

"#A24D61"

MAROON D color constant.

Examples
value = MAROON_D

MAROON_E

constant

manim.MAROON_E

"#94424F"

MAROON E color constant.

Examples
value = MAROON_E

MED_LARGE_BUFF

constant

manim.MED_LARGE_BUFF

0.5

MED LARGE BUFF spacing constant.

Examples
value = MED_LARGE_BUFF

MED_SMALL_BUFF

constant

manim.MED_SMALL_BUFF

0.25

MED SMALL BUFF spacing constant.

Examples
value = MED_SMALL_BUFF

NORMAL

constant

manim.NORMAL

"normal"

Font-weight alias matching Manim's ``NORMAL`` text style constant.

Examples
value = NORMAL

ORANGE

constant

manim.ORANGE

"#FF862F"

ORANGE color constant.

Examples
value = ORANGE

ORIGIN

constant

manim.ORIGIN

(0, 0, 0)

Origin point for the default scene coordinate system.

Examples
value = ORIGIN

OUT

constant

manim.OUT

(0, 0, 1)

OUT direction vector constant.

Examples
value = OUT

PI

constant

manim.PI

3.141592653589793

Ratio of a circle's circumference to its diameter.

Examples
value = PI

PINK

constant

manim.PINK

"#D147BD"

PINK color constant.

Examples
value = PINK

PURE_BLUE

constant

manim.PURE_BLUE

"#0000FF"

PURE BLUE color constant.

Examples
value = PURE_BLUE

PURE_CYAN

constant

manim.PURE_CYAN

"#00FFFF"

PURE CYAN color constant.

Examples
value = PURE_CYAN

PURE_GREEN

constant

manim.PURE_GREEN

"#00FF00"

PURE GREEN color constant.

Examples
value = PURE_GREEN

PURE_MAGENTA

constant

manim.PURE_MAGENTA

"#FF00FF"

PURE MAGENTA constant.

Examples
value = PURE_MAGENTA

PURE_RED

constant

manim.PURE_RED

"#FF0000"

PURE RED color constant.

Examples
value = PURE_RED

PURE_YELLOW

constant

manim.PURE_YELLOW

"#FFFF00"

PURE YELLOW color constant.

Examples
value = PURE_YELLOW

PURPLE

constant

manim.PURPLE

"#9A72AC"

PURPLE color constant.

Examples
value = PURPLE

PURPLE_A

constant

manim.PURPLE_A

"#CAA3E8"

PURPLE A color constant.

Examples
value = PURPLE_A

PURPLE_B

constant

manim.PURPLE_B

"#B189C6"

PURPLE B color constant.

Examples
value = PURPLE_B

PURPLE_C

constant

manim.PURPLE_C

"#9A72AC"

PURPLE C color constant.

Examples
value = PURPLE_C

PURPLE_D

constant

manim.PURPLE_D

"#715582"

PURPLE D color constant.

Examples
value = PURPLE_D

PURPLE_E

constant

manim.PURPLE_E

"#644172"

PURPLE E color constant.

Examples
value = PURPLE_E

random

constant

manim.random

_RandomShim()

Random constant.

Examples
value = random

rate_functions

constant

manim.rate_functions

_RateFunctions()

Rate functions constant.

Examples
value = rate_functions

RED

constant

manim.RED

"#FC6255"

RED color constant.

Examples
value = RED

RED_A

constant

manim.RED_A

"#F7A1A3"

RED A color constant.

Examples
value = RED_A

RED_B

constant

manim.RED_B

"#FF8080"

RED B color constant.

Examples
value = RED_B

RED_C

constant

manim.RED_C

"#FC6255"

RED C color constant.

Examples
value = RED_C

RED_D

constant

manim.RED_D

"#E65A4C"

RED D color constant.

Examples
value = RED_D

RED_E

constant

manim.RED_E

"#CF5044"

RED E color constant.

Examples
value = RED_E

Restore

constant

manim.Restore

_restore_animation

Restore constant.

Examples
value = Restore

RIGHT

constant

manim.RIGHT

(1, 0, 0)

Unit vector that points right in scene coordinates.

Examples
value = RIGHT

RIGHT_SIDE

constant

manim.RIGHT_SIDE

(1, 0, 0)

RIGHT_SIDE direction vector constant.

Examples
value = RIGHT_SIDE

SMALL_BUFF

constant

manim.SMALL_BUFF

0.1

SMALL BUFF spacing constant.

Examples
value = SMALL_BUFF

START_X

constant

manim.START_X

30

START X constant.

Examples
value = START_X

START_Y

constant

manim.START_Y

20

START Y constant.

Examples
value = START_Y

TAU

constant

manim.TAU

6.283185307179586

Full turn constant, equal to ``2 * PI``.

Examples
value = TAU

TEAL

constant

manim.TEAL

"#5CD0B3"

TEAL color constant.

Examples
value = TEAL

TEAL_A

constant

manim.TEAL_A

"#ACEAD7"

TEAL A color constant.

Examples
value = TEAL_A

TEAL_B

constant

manim.TEAL_B

"#76DDC0"

TEAL B color constant.

Examples
value = TEAL_B

TEAL_C

constant

manim.TEAL_C

"#5CD0B3"

TEAL C color constant.

Examples
value = TEAL_C

TEAL_D

constant

manim.TEAL_D

"#55C1A7"

TEAL D color constant.

Examples
value = TEAL_D

TEAL_E

constant

manim.TEAL_E

"#49A88F"

TEAL E color constant.

Examples
value = TEAL_E

TEXT_MOBJECT_SCALE

constant

manim.TEXT_MOBJECT_SCALE

1.18

TEXT MOBJECT SCALE constant.

Examples
value = TEXT_MOBJECT_SCALE

TOP

constant

manim.TOP

(0, 1, 0)

TOP direction vector constant.

Examples
value = TOP

UL

constant

manim.UL

(-1, 1, 0)

UL direction vector constant.

Examples
value = UL

UP

constant

manim.UP

(0, 1, 0)

Unit vector that points upward in scene coordinates.

Examples
value = UP

UR

constant

manim.UR

(1, 1, 0)

UR direction vector constant.

Examples
value = UR

WHITE

constant

manim.WHITE

"#FFFFFF"

WHITE color constant.

Examples
value = WHITE

X_AXIS

constant

manim.X_AXIS

(1, 0, 0)

X AXIS constant.

Examples
value = X_AXIS

Y_AXIS

constant

manim.Y_AXIS

(0, 1, 0)

Y AXIS constant.

Examples
value = Y_AXIS

YELLOW

constant

manim.YELLOW

"#F7D96F"

YELLOW color constant.

Examples
value = YELLOW

YELLOW_A

constant

manim.YELLOW_A

"#FFF1B6"

YELLOW A color constant.

Examples
value = YELLOW_A

YELLOW_B

constant

manim.YELLOW_B

"#FFEA94"

YELLOW B color constant.

Examples
value = YELLOW_B

YELLOW_C

constant

manim.YELLOW_C

"#F7D96F"

YELLOW C color constant.

Examples
value = YELLOW_C

YELLOW_D

constant

manim.YELLOW_D

"#F4D345"

YELLOW D color constant.

Examples
value = YELLOW_D

YELLOW_E

constant

manim.YELLOW_E

"#E8C11C"

YELLOW E color constant.

Examples
value = YELLOW_E

Z_AXIS

constant

manim.Z_AXIS

(0, 0, 1)

Z AXIS constant.

Examples
value = Z_AXIS

Functions

115

AddTextLetterByLetter

function

manim.AddTextLetterByLetter

def AddTextLetterByLetter(obj, run_time=None, **kwargs)

Add Text Letter By Letter function.

Parameters
obj

Obj accepted by AddTextLetterByLetter.

run_time

Run time accepted by AddTextLetterByLetter.

kwargs

Kwargs accepted by AddTextLetterByLetter.

Returns

The animation, mobject, or computed value produced by AddTextLetterByLetter.

Examples
result = AddTextLetterByLetter(obj, run_time)

always_redraw

function

manim.always_redraw

def always_redraw(func)

Creates an object that is redrawn every frame by calling func(). The returned object is tagged and given an updater that copies fresh geometry/state every frame, mirroring Manim's always_redraw behavior.

Parameters
func

Callback returning a freshly constructed mobject.

Returns

A mobject kept in sync with the callback result on every frame.

Examples
tracker = ValueTracker(0)dot = always_redraw(lambda: Dot(RIGHT * tracker.get_value()))

angle_of_vector

function

manim.angle_of_vector

def angle_of_vector(vector)

Return the polar angle of a 2D vector in radians.

Parameters
vector

Vector accepted by angle_of_vector.

Returns

The animation, mobject, or computed value produced by angle_of_vector.

Examples
result = angle_of_vector(vector)

AnimationGroup

function

manim.AnimationGroup

def AnimationGroup(*animations, lag_ratio=0, run_time=None, **kwargs)

Run multiple animations together as a grouped unit.

Parameters
animations

Child animations to run together.

lag_ratio

Relative offset between child animations.

run_time

Optional total duration override.

kwargs

Additional group options passed through to playback.

Returns

A grouped animation descriptor consumed by ``Scene.play``.

Examples
scene.play(AnimationGroup(FadeIn(left), FadeIn(right), lag_ratio=0.1))

ApplyFunction

function

manim.ApplyFunction

def ApplyFunction(func, mobject, run_time=None, **kwargs)

Animate a mobject toward the result of applying a callback to it.

Parameters
func

Callback that mutates and returns the target mobject state.

mobject

Source mobject.

run_time

Optional animation duration override.

kwargs

Additional transform options.

Returns

The animation, mobject, or computed value produced by ApplyFunction.

Examples
scene.play(ApplyFunction(mobject))

ApplyMethod

function

manim.ApplyMethod

def ApplyMethod(method, *args, run_time=None, **kwargs)

Apply Method animation helper.

Parameters
method

Method accepted by ApplyMethod.

args

Args accepted by ApplyMethod.

run_time

Run time accepted by ApplyMethod.

kwargs

Kwargs accepted by ApplyMethod.

Returns

The animation, mobject, or computed value produced by ApplyMethod.

Examples
scene.play(ApplyMethod(mobject))

ApplyPointwiseFunction

function

manim.ApplyPointwiseFunction

def ApplyPointwiseFunction(func, mobject, run_time=None, **kwargs)

Apply Pointwise Function animation helper.

Parameters
func

Func accepted by ApplyPointwiseFunction.

mobject

Mobject accepted by ApplyPointwiseFunction.

run_time

Run time accepted by ApplyPointwiseFunction.

kwargs

Kwargs accepted by ApplyPointwiseFunction.

Returns

The animation, mobject, or computed value produced by ApplyPointwiseFunction.

Examples
scene.play(ApplyPointwiseFunction(mobject))

ApplyPointwiseFunctionToCenter

function

manim.ApplyPointwiseFunctionToCenter

def ApplyPointwiseFunctionToCenter(func, mobject, run_time=None, **kwargs)

Apply Pointwise Function To Center animation helper.

Parameters
func

Func accepted by ApplyPointwiseFunctionToCenter.

mobject

Mobject accepted by ApplyPointwiseFunctionToCenter.

run_time

Run time accepted by ApplyPointwiseFunctionToCenter.

kwargs

Kwargs accepted by ApplyPointwiseFunctionToCenter.

Returns

The animation, mobject, or computed value produced by ApplyPointwiseFunctionToCenter.

Examples
scene.play(ApplyPointwiseFunctionToCenter(mobject))

ApplyWave

function

manim.ApplyWave

def ApplyWave(mobject, direction=RIGHT, amplitude=0.25, color=YELLOW, run_time=None, **kwargs)

Approximate a wave highlight by sliding a temporary colored copy.

Parameters
mobject

Target mobject to emphasize.

direction

Wave travel direction.

amplitude

Shift distance applied to the temporary overlay.

color

Highlight color for the overlay.

run_time

Optional animation duration override.

kwargs

Additional animation options passed through to playback.

Returns

The animation, mobject, or computed value produced by ApplyWave.

Examples
scene.play(ApplyWave(text, direction=UP))

arccos

function

manim.arccos

def arccos(x)

Arccos math helper.

Parameters
x

X accepted by arccos.

Returns

The animation, mobject, or computed value produced by arccos.

Examples
result = arccos(x)

bounce

function

manim.bounce

def bounce(t)

Bounce easing function.

Parameters
t

T accepted by bounce.

Returns

The animation, mobject, or computed value produced by bounce.

Examples
result = bounce(t)

BraceBetweenPoints

function

manim.BraceBetweenPoints

def BraceBetweenPoints(point1, point2, direction=RIGHT, **kwargs)

Create a brace between two points

Parameters
point1

Point1 accepted by BraceBetweenPoints.

point2

Point2 accepted by BraceBetweenPoints.

direction

Direction accepted by BraceBetweenPoints.

kwargs

Kwargs accepted by BraceBetweenPoints.

Returns

The animation, mobject, or computed value produced by BraceBetweenPoints.

Examples
result = BraceBetweenPoints(point1, point2)

ceil

function

manim.ceil

def ceil(x)

Ceil function.

Parameters
x

X accepted by ceil.

Returns

The animation, mobject, or computed value produced by ceil.

Examples
result = ceil(x)

Circumscribe

function

manim.Circumscribe

def Circumscribe(mobject, shape=None, color=YELLOW, buff=0.1, stroke_width=6, run_time=None, **kwargs)

Draw and fade a temporary outline around a target mobject.

Parameters
mobject

Target mobject to trace.

shape

Optional outline constructor such as ``Circle``.

color

Outline color.

buff

Padding between the outline and target.

stroke_width

Outline stroke width.

run_time

Optional animation duration override.

kwargs

Additional styling or playback options.

Returns

The animation, mobject, or computed value produced by Circumscribe.

Examples
scene.play(Circumscribe(formula))scene.play(Circumscribe(formula, shape=Circle, color=BLUE))

ClockwiseTransform

function

manim.ClockwiseTransform

def ClockwiseTransform(obj, target_mobject, run_time=None, **kwargs)

Clockwise Transform animation helper.

Parameters
obj

Obj accepted by ClockwiseTransform.

target_mobject

Target mobject accepted by ClockwiseTransform.

run_time

Run time accepted by ClockwiseTransform.

kwargs

Kwargs accepted by ClockwiseTransform.

Returns

The animation, mobject, or computed value produced by ClockwiseTransform.

Examples
result = ClockwiseTransform(obj, target_mobject)

color_gradient

function

manim.color_gradient

def color_gradient(reference_colors, length_of_output)

Interpolate a list of colors into a gradient of the requested length.

Parameters
reference_colors

Reference colors accepted by color_gradient.

length_of_output

Length of output accepted by color_gradient.

Returns

The animation, mobject, or computed value produced by color_gradient.

Examples
result = color_gradient(reference_colors, length_of_output)

cos

function

manim.cos

def cos(x)

Cos math helper.

Parameters
x

X accepted by cos.

Returns

The animation, mobject, or computed value produced by cos.

Examples
result = cos(x)

CounterclockwiseTransform

function

manim.CounterclockwiseTransform

def CounterclockwiseTransform(obj, target_mobject, run_time=None, **kwargs)

Counterclockwise Transform animation helper.

Parameters
obj

Obj accepted by CounterclockwiseTransform.

target_mobject

Target mobject accepted by CounterclockwiseTransform.

run_time

Run time accepted by CounterclockwiseTransform.

kwargs

Kwargs accepted by CounterclockwiseTransform.

Returns

The animation, mobject, or computed value produced by CounterclockwiseTransform.

Examples
result = CounterclockwiseTransform(obj, target_mobject)

Create

function

manim.Create

def Create(obj, run_time=None, **kwargs)

Animate a mobject as if it is being drawn into the scene.

Parameters
obj

Mobject to animate.

run_time

Optional animation duration override.

kwargs

Additional animation options passed through to playback.

Returns

A normalized animation descriptor consumed by ``Scene.play``.

Examples
scene.play(Create(Square()), run_time=1)

CyclicReplace

function

manim.CyclicReplace

def CyclicReplace(*mobjects, run_time=None, **kwargs)

Cyclic Replace animation helper.

Parameters
mobjects

Mobjects accepted by CyclicReplace.

run_time

Run time accepted by CyclicReplace.

kwargs

Kwargs accepted by CyclicReplace.

Returns

The animation, mobject, or computed value produced by CyclicReplace.

Examples
result = CyclicReplace(mobjects, run_time)

degrees_to_rad

function

manim.degrees_to_rad

def degrees_to_rad(degrees)

Degrees to rad math helper.

Parameters
degrees

Degrees accepted by degrees_to_rad.

Returns

The animation, mobject, or computed value produced by degrees_to_rad.

Examples
result = degrees_to_rad(degrees)

double_smooth

function

manim.double_smooth

def double_smooth(t)

Double smooth easing function.

Parameters
t

T accepted by double_smooth.

Returns

The animation, mobject, or computed value produced by double_smooth.

Examples
result = double_smooth(t)

ease_in

function

manim.ease_in

def ease_in(t)

Ease in easing function.

Parameters
t

T accepted by ease_in.

Returns

The animation, mobject, or computed value produced by ease_in.

Examples
result = ease_in(t)

ease_in_back

function

manim.ease_in_back

def ease_in_back(t)

Ease in back easing function.

Parameters
t

T accepted by ease_in_back.

Returns

The animation, mobject, or computed value produced by ease_in_back.

Examples
result = ease_in_back(t)

ease_in_bounce

function

manim.ease_in_bounce

def ease_in_bounce(t)

Ease in bounce easing function.

Parameters
t

T accepted by ease_in_bounce.

Returns

The animation, mobject, or computed value produced by ease_in_bounce.

Examples
result = ease_in_bounce(t)

ease_in_circ

function

manim.ease_in_circ

def ease_in_circ(t)

Ease in circ easing function.

Parameters
t

T accepted by ease_in_circ.

Returns

The animation, mobject, or computed value produced by ease_in_circ.

Examples
result = ease_in_circ(t)

ease_in_cubic

function

manim.ease_in_cubic

def ease_in_cubic(t)

Ease in cubic easing function.

Parameters
t

T accepted by ease_in_cubic.

Returns

The animation, mobject, or computed value produced by ease_in_cubic.

Examples
result = ease_in_cubic(t)

ease_in_elastic

function

manim.ease_in_elastic

def ease_in_elastic(t)

Ease in elastic easing function.

Parameters
t

T accepted by ease_in_elastic.

Returns

The animation, mobject, or computed value produced by ease_in_elastic.

Examples
result = ease_in_elastic(t)

ease_in_expo

function

manim.ease_in_expo

def ease_in_expo(t)

Ease in expo easing function.

Parameters
t

T accepted by ease_in_expo.

Returns

The animation, mobject, or computed value produced by ease_in_expo.

Examples
result = ease_in_expo(t)

ease_in_out

function

manim.ease_in_out

def ease_in_out(t)

Ease in out easing function.

Parameters
t

T accepted by ease_in_out.

Returns

The animation, mobject, or computed value produced by ease_in_out.

Examples
result = ease_in_out(t)

ease_in_out_back

function

manim.ease_in_out_back

def ease_in_out_back(t)

Ease in out back easing function.

Parameters
t

T accepted by ease_in_out_back.

Returns

The animation, mobject, or computed value produced by ease_in_out_back.

Examples
result = ease_in_out_back(t)

ease_in_out_bounce

function

manim.ease_in_out_bounce

def ease_in_out_bounce(t)

Ease in out bounce easing function.

Parameters
t

T accepted by ease_in_out_bounce.

Returns

The animation, mobject, or computed value produced by ease_in_out_bounce.

Examples
result = ease_in_out_bounce(t)

ease_in_out_circ

function

manim.ease_in_out_circ

def ease_in_out_circ(t)

Ease in out circ easing function.

Parameters
t

T accepted by ease_in_out_circ.

Returns

The animation, mobject, or computed value produced by ease_in_out_circ.

Examples
result = ease_in_out_circ(t)

ease_in_out_cubic

function

manim.ease_in_out_cubic

def ease_in_out_cubic(t)

Ease in out cubic easing function.

Parameters
t

T accepted by ease_in_out_cubic.

Returns

The animation, mobject, or computed value produced by ease_in_out_cubic.

Examples
result = ease_in_out_cubic(t)

ease_in_out_elastic

function

manim.ease_in_out_elastic

def ease_in_out_elastic(t)

Ease in out elastic easing function.

Parameters
t

T accepted by ease_in_out_elastic.

Returns

The animation, mobject, or computed value produced by ease_in_out_elastic.

Examples
result = ease_in_out_elastic(t)

ease_in_out_expo

function

manim.ease_in_out_expo

def ease_in_out_expo(t)

Ease in out expo easing function.

Parameters
t

T accepted by ease_in_out_expo.

Returns

The animation, mobject, or computed value produced by ease_in_out_expo.

Examples
result = ease_in_out_expo(t)

ease_in_out_quad

function

manim.ease_in_out_quad

def ease_in_out_quad(t)

Ease in out quad easing function.

Parameters
t

T accepted by ease_in_out_quad.

Returns

The animation, mobject, or computed value produced by ease_in_out_quad.

Examples
result = ease_in_out_quad(t)

ease_in_out_quart

function

manim.ease_in_out_quart

def ease_in_out_quart(t)

Ease in out quart easing function.

Parameters
t

T accepted by ease_in_out_quart.

Returns

The animation, mobject, or computed value produced by ease_in_out_quart.

Examples
result = ease_in_out_quart(t)

ease_in_out_quint

function

manim.ease_in_out_quint

def ease_in_out_quint(t)

Ease in out quint easing function.

Parameters
t

T accepted by ease_in_out_quint.

Returns

The animation, mobject, or computed value produced by ease_in_out_quint.

Examples
result = ease_in_out_quint(t)

ease_in_out_sine

function

manim.ease_in_out_sine

def ease_in_out_sine(t)

Ease in out sine easing function.

Parameters
t

T accepted by ease_in_out_sine.

Returns

The animation, mobject, or computed value produced by ease_in_out_sine.

Examples
result = ease_in_out_sine(t)

ease_in_quad

function

manim.ease_in_quad

def ease_in_quad(t)

Ease in quad easing function.

Parameters
t

T accepted by ease_in_quad.

Returns

The animation, mobject, or computed value produced by ease_in_quad.

Examples
result = ease_in_quad(t)

ease_in_quart

function

manim.ease_in_quart

def ease_in_quart(t)

Ease in quart easing function.

Parameters
t

T accepted by ease_in_quart.

Returns

The animation, mobject, or computed value produced by ease_in_quart.

Examples
result = ease_in_quart(t)

ease_in_quint

function

manim.ease_in_quint

def ease_in_quint(t)

Ease in quint easing function.

Parameters
t

T accepted by ease_in_quint.

Returns

The animation, mobject, or computed value produced by ease_in_quint.

Examples
result = ease_in_quint(t)

ease_in_sine

function

manim.ease_in_sine

def ease_in_sine(t)

Ease in sine easing function.

Parameters
t

T accepted by ease_in_sine.

Returns

The animation, mobject, or computed value produced by ease_in_sine.

Examples
result = ease_in_sine(t)

ease_out

function

manim.ease_out

def ease_out(t)

Ease out easing function.

Parameters
t

T accepted by ease_out.

Returns

The animation, mobject, or computed value produced by ease_out.

Examples
result = ease_out(t)

ease_out_back

function

manim.ease_out_back

def ease_out_back(t)

Ease out back easing function.

Parameters
t

T accepted by ease_out_back.

Returns

The animation, mobject, or computed value produced by ease_out_back.

Examples
result = ease_out_back(t)

ease_out_bounce

function

manim.ease_out_bounce

def ease_out_bounce(t)

Ease out bounce easing function.

Parameters
t

T accepted by ease_out_bounce.

Returns

The animation, mobject, or computed value produced by ease_out_bounce.

Examples
result = ease_out_bounce(t)

ease_out_circ

function

manim.ease_out_circ

def ease_out_circ(t)

Ease out circ easing function.

Parameters
t

T accepted by ease_out_circ.

Returns

The animation, mobject, or computed value produced by ease_out_circ.

Examples
result = ease_out_circ(t)

ease_out_cubic

function

manim.ease_out_cubic

def ease_out_cubic(t)

Ease out cubic easing function.

Parameters
t

T accepted by ease_out_cubic.

Returns

The animation, mobject, or computed value produced by ease_out_cubic.

Examples
result = ease_out_cubic(t)

ease_out_elastic

function

manim.ease_out_elastic

def ease_out_elastic(t)

Ease out elastic easing function.

Parameters
t

T accepted by ease_out_elastic.

Returns

The animation, mobject, or computed value produced by ease_out_elastic.

Examples
result = ease_out_elastic(t)

ease_out_expo

function

manim.ease_out_expo

def ease_out_expo(t)

Ease out expo easing function.

Parameters
t

T accepted by ease_out_expo.

Returns

The animation, mobject, or computed value produced by ease_out_expo.

Examples
result = ease_out_expo(t)

ease_out_quad

function

manim.ease_out_quad

def ease_out_quad(t)

Ease out quad easing function.

Parameters
t

T accepted by ease_out_quad.

Returns

The animation, mobject, or computed value produced by ease_out_quad.

Examples
result = ease_out_quad(t)

ease_out_quart

function

manim.ease_out_quart

def ease_out_quart(t)

Ease out quart easing function.

Parameters
t

T accepted by ease_out_quart.

Returns

The animation, mobject, or computed value produced by ease_out_quart.

Examples
result = ease_out_quart(t)

ease_out_quint

function

manim.ease_out_quint

def ease_out_quint(t)

Ease out quint easing function.

Parameters
t

T accepted by ease_out_quint.

Returns

The animation, mobject, or computed value produced by ease_out_quint.

Examples
result = ease_out_quint(t)

ease_out_sine

function

manim.ease_out_sine

def ease_out_sine(t)

Ease out sine easing function.

Parameters
t

T accepted by ease_out_sine.

Returns

The animation, mobject, or computed value produced by ease_out_sine.

Examples
result = ease_out_sine(t)

elastic

function

manim.elastic

def elastic(t)

Elastic easing function.

Parameters
t

T accepted by elastic.

Returns

The animation, mobject, or computed value produced by elastic.

Examples
result = elastic(t)

exponential_decay

function

manim.exponential_decay

def exponential_decay(t, half_life=0.1)

Exponential decay easing function.

Parameters
t

T accepted by exponential_decay.

half_life

Half life accepted by exponential_decay.

Returns

The animation, mobject, or computed value produced by exponential_decay.

Examples
result = exponential_decay(t, half_life)

FadeIn

function

manim.FadeIn

def FadeIn(obj, run_time=None, **kwargs)

Animate a mobject from invisible to visible.

Parameters
obj

Mobject to reveal.

run_time

Optional animation duration override.

kwargs

Additional animation options such as ``shift`` or ``scale``.

Returns

A normalized animation descriptor consumed by ``Scene.play``.

Examples
scene.play(FadeIn(card, shift=UP * 0.2))

FadeOut

function

manim.FadeOut

def FadeOut(obj, run_time=None, **kwargs)

Animate a mobject from visible to invisible.

Parameters
obj

Obj accepted by FadeOut.

run_time

Run time accepted by FadeOut.

kwargs

Kwargs accepted by FadeOut.

Returns

The animation, mobject, or computed value produced by FadeOut.

Examples
scene.play(FadeOut(mobject))

Flash

function

manim.Flash

def Flash(point_or_mobject, color=YELLOW, line_length=0.35, stroke_width=6, run_time=None, **kwargs)

Approximate Manim's flash burst with a temporary star marker.

Parameters
point_or_mobject

World point or mobject center to flash.

color

Burst color.

line_length

Approximate burst radius.

stroke_width

Marker stroke width.

run_time

Optional animation duration override.

kwargs

Additional animation options passed through to playback.

Returns

The animation, mobject, or computed value produced by Flash.

Examples
scene.play(Flash(dot))scene.play(Flash(ORIGIN, color=ORANGE))

floor

function

manim.floor

def floor(x)

Floor function.

Parameters
x

X accepted by floor.

Returns

The animation, mobject, or computed value produced by floor.

Examples
result = floor(x)

FocusOn

function

manim.FocusOn

def FocusOn(mobject, color=YELLOW, buff=0.25, run_time=None, **kwargs)

Spotlight a target with a temporary circular focus ring.

Parameters
mobject

Target mobject to emphasize.

color

Ring color.

buff

Extra padding around the target.

run_time

Optional animation duration override.

kwargs

Additional animation or styling options.

Returns

The animation, mobject, or computed value produced by FocusOn.

Examples
scene.play(FocusOn(graph_label))

get_image_asset

function

manim.get_image_asset

def get_image_asset(image_id, default=None)

Get image asset function.

Parameters
image_id

Image id accepted by get_image_asset.

default

Default accepted by get_image_asset.

Returns

The animation, mobject, or computed value produced by get_image_asset.

Examples
result = get_image_asset(image_id, default)

get_images_map

function

manim.get_images_map

def get_images_map()

Get images map function.

Returns

The animation, mobject, or computed value produced by get_images_map.

Examples
result = get_images_map()

GrowArrow

function

manim.GrowArrow

def GrowArrow(obj, run_time=None, **kwargs)

Animate an arrow-like mobject growing into view.

Parameters
obj

Arrow or line-like mobject to reveal.

run_time

Optional animation duration override.

kwargs

Additional animation options passed through to playback.

Returns

A normalized animation descriptor consumed by ``Scene.play``.

Examples
scene.play(GrowArrow(Arrow(LEFT, RIGHT)))

GrowFromCenter

function

manim.GrowFromCenter

def GrowFromCenter(obj, run_time=None, **kwargs)

Grow From Center function.

Parameters
obj

Obj accepted by GrowFromCenter.

run_time

Run time accepted by GrowFromCenter.

kwargs

Kwargs accepted by GrowFromCenter.

Returns

The animation, mobject, or computed value produced by GrowFromCenter.

Examples
scene.play(GrowFromCenter(mobject))

GrowFromPoint

function

manim.GrowFromPoint

def GrowFromPoint(obj, point, run_time=None, **kwargs)

Grow From Point function.

Parameters
obj

Obj accepted by GrowFromPoint.

point

Point accepted by GrowFromPoint.

run_time

Run time accepted by GrowFromPoint.

kwargs

Kwargs accepted by GrowFromPoint.

Returns

The animation, mobject, or computed value produced by GrowFromPoint.

Examples
scene.play(GrowFromPoint(mobject))

Indicate

function

manim.Indicate

def Indicate(obj, color=YELLOW, scale_factor=1.1, run_time=None, **kwargs)

Overlay a short pulse highlight on a mobject.

Parameters
obj

Mobject to highlight.

color

Highlight color for the temporary overlay.

scale_factor

Pulse scale applied to the overlay.

run_time

Optional animation duration override.

kwargs

Additional animation options passed through to playback.

Returns

The animation, mobject, or computed value produced by Indicate.

Examples
scene.play(Indicate(label, color=YELLOW))

interpolate_color

function

manim.interpolate_color

def interpolate_color(colora, colorb, amount)

Linearly interpolate between two colors.

Parameters
colora

Colora accepted by interpolate_color.

colorb

Colorb accepted by interpolate_color.

amount

Amount accepted by interpolate_color.

Returns

The animation, mobject, or computed value produced by interpolate_color.

Examples
result = interpolate_color(colora, colorb)

LaggedStart

function

manim.LaggedStart

def LaggedStart(*animations, lag_ratio=0.1, run_time=None, **kwargs)

Run multiple animations with a staggered start offset.

Parameters
animations

Animations accepted by LaggedStart.

lag_ratio

Lag ratio accepted by LaggedStart.

run_time

Run time accepted by LaggedStart.

kwargs

Kwargs accepted by LaggedStart.

Returns

The animation, mobject, or computed value produced by LaggedStart.

Examples
result = LaggedStart(animations, lag_ratio)

LaggedStartMap

function

manim.LaggedStartMap

def LaggedStartMap(animation_func, group, lag_ratio=0.1, run_time=None, **kwargs)

Map an animation factory across a group and stagger the results.

Parameters
animation_func

Callable that creates one animation per item.

group

Group or iterable of mobjects.

lag_ratio

Fractional stagger applied between generated animations.

run_time

Optional duration override for the generated group.

kwargs

Extra keyword arguments forwarded to ``animation_func``.

Returns

A grouped animation descriptor consumed by ``Scene.play``.

Examples
result = LaggedStartMap(animation_func, group)

linear

function

manim.linear

def linear(t)

Linear easing function.

Parameters
t

T accepted by linear.

Returns

The animation, mobject, or computed value produced by linear.

Examples
result = linear(t)

lingering

function

manim.lingering

def lingering(t)

Lingering function.

Parameters
t

T accepted by lingering.

Returns

The animation, mobject, or computed value produced by lingering.

Examples
result = lingering(t)

MaintainPositionRelativeTo

function

manim.MaintainPositionRelativeTo

def MaintainPositionRelativeTo(mobject, tracked_mobject, run_time=None, **kwargs)

Maintain Position Relative To function.

Parameters
mobject

Mobject accepted by MaintainPositionRelativeTo.

tracked_mobject

Tracked mobject accepted by MaintainPositionRelativeTo.

run_time

Run time accepted by MaintainPositionRelativeTo.

kwargs

Kwargs accepted by MaintainPositionRelativeTo.

Returns

The animation, mobject, or computed value produced by MaintainPositionRelativeTo.

Examples
result = MaintainPositionRelativeTo(mobject, tracked_mobject)

MoveAlongPath

function

manim.MoveAlongPath

def MoveAlongPath(obj, path, run_time=None, **kwargs)

Animate ``obj`` along sampled points from a path-like mobject.

Parameters
obj

Obj accepted by MoveAlongPath.

path

Path accepted by MoveAlongPath.

run_time

Run time accepted by MoveAlongPath.

kwargs

Kwargs accepted by MoveAlongPath.

Returns

The animation, mobject, or computed value produced by MoveAlongPath.

Examples
scene.play(MoveAlongPath(mobject))

MoveTo

function

manim.MoveTo

def MoveTo(obj, point, run_time=None, **kwargs)

Animate a move to a target point.

Parameters
obj

Mobject to move.

point

Destination point.

run_time

Optional animation duration override.

kwargs

Additional animation options passed through to playback.

Returns

A normalized transform descriptor consumed by ``Scene.play``.

Examples
scene.play(MoveTo(dot, UP * 2))

MoveToTarget

function

manim.MoveToTarget

def MoveToTarget(obj, run_time=None, **kwargs)

Move To Target function.

Parameters
obj

Obj accepted by MoveToTarget.

run_time

Run time accepted by MoveToTarget.

kwargs

Kwargs accepted by MoveToTarget.

Returns

The animation, mobject, or computed value produced by MoveToTarget.

Examples
scene.play(MoveToTarget(mobject))

not_quite_there

function

manim.not_quite_there

def not_quite_there(t, proportion=0.7)

Not quite there function.

Parameters
t

T accepted by not_quite_there.

proportion

Proportion accepted by not_quite_there.

Returns

The animation, mobject, or computed value produced by not_quite_there.

Examples
result = not_quite_there(t, proportion)

radians

function

manim.radians

def radians(degrees)

Radians math helper.

Parameters
degrees

Degrees accepted by radians.

Returns

The animation, mobject, or computed value produced by radians.

Examples
result = radians(degrees)

ReplacementTransform

function

manim.ReplacementTransform

def ReplacementTransform(obj, target_mobject, run_time=None, **kwargs)

Transform one mobject into another while conceptually replacing it.

Parameters
obj

Obj accepted by ReplacementTransform.

target_mobject

Target mobject accepted by ReplacementTransform.

run_time

Run time accepted by ReplacementTransform.

kwargs

Kwargs accepted by ReplacementTransform.

Returns

The animation, mobject, or computed value produced by ReplacementTransform.

Examples
result = ReplacementTransform(obj, target_mobject)

Rotate

function

manim.Rotate

def Rotate(obj, angle=PI, run_time=None, axis=OUT, **kwargs)

Animate a rotation transform, optionally around ``about_point``.

Parameters
obj

Mobject to rotate.

angle

Rotation amount in radians.

run_time

Optional animation duration override.

axis

Rotation axis vector (3D compatibility).

kwargs

Additional animation options, including ``about_point``.

Returns

A normalized transform descriptor consumed by ``Scene.play``.

Examples
scene.play(Rotate(square, angle=PI / 2, about_point=ORIGIN))

Rotating

function

manim.Rotating

def Rotating(obj, angle=2 * PI, about_point=None, run_time=None, **kwargs)

Rotating function.

Parameters
obj

Obj accepted by Rotating.

angle

Angle accepted by Rotating.

about_point

About point accepted by Rotating.

run_time

Run time accepted by Rotating.

kwargs

Kwargs accepted by Rotating.

Returns

The animation, mobject, or computed value produced by Rotating.

Examples
result = Rotating(obj, angle)

running_start

function

manim.running_start

def running_start(t, pull_factor=-0.5)

Running start function.

Parameters
t

T accepted by running_start.

pull_factor

Pull factor accepted by running_start.

Returns

The animation, mobject, or computed value produced by running_start.

Examples
result = running_start(t, pull_factor)

rush_from

function

manim.rush_from

def rush_from(t)

Rush from easing function.

Parameters
t

T accepted by rush_from.

Returns

The animation, mobject, or computed value produced by rush_from.

Examples
result = rush_from(t)

rush_into

function

manim.rush_into

def rush_into(t)

Rush into easing function.

Parameters
t

T accepted by rush_into.

Returns

The animation, mobject, or computed value produced by rush_into.

Examples
result = rush_into(t)

Scale

function

manim.Scale

def Scale(obj, factor, run_time=None, **kwargs)

Animate a scale transform, optionally around ``about_point``.

Parameters
obj

Mobject to scale.

factor

Scalar or per-axis scale value.

run_time

Optional animation duration override.

kwargs

Additional animation options, including ``about_point``.

Returns

A normalized transform descriptor consumed by ``Scene.play``.

Examples
scene.play(Scale(group, 1.2, about_point=ORIGIN))

ScaleInPlace

function

manim.ScaleInPlace

def ScaleInPlace(obj, factor, run_time=None, **kwargs)

Scale In Place function.

Parameters
obj

Obj accepted by ScaleInPlace.

factor

Factor accepted by ScaleInPlace.

run_time

Run time accepted by ScaleInPlace.

kwargs

Kwargs accepted by ScaleInPlace.

Returns

The animation, mobject, or computed value produced by ScaleInPlace.

Examples
scene.play(ScaleInPlace(mobject))

Shift

function

manim.Shift

def Shift(obj, vector, run_time=None, **kwargs)

Animate a translation by a vector.

Parameters
obj

Obj accepted by Shift.

vector

Vector accepted by Shift.

run_time

Run time accepted by Shift.

kwargs

Kwargs accepted by Shift.

Returns

The animation, mobject, or computed value produced by Shift.

Examples
result = Shift(obj, vector)

ShowPassingFlash

function

manim.ShowPassingFlash

def ShowPassingFlash(mobject, color=YELLOW, run_time=None, **kwargs)

Sweep a temporary highlighted copy across an existing mobject.

Parameters
mobject

Target mobject to flash.

color

Highlight color for the temporary overlay.

run_time

Optional animation duration override.

kwargs

Additional animation options passed through to playback.

Returns

The animation, mobject, or computed value produced by ShowPassingFlash.

Examples
scene.play(ShowPassingFlash(path, color=GREEN))

ShowPassingFlashAround

function

manim.ShowPassingFlashAround

def ShowPassingFlashAround(mobject, color=YELLOW, buff=0.1, stroke_width=6, run_time=None, **kwargs)

Sweep a temporary border around a target mobject.

Parameters
mobject

Target mobject to outline.

color

Outline color.

buff

Padding between the outline and target.

stroke_width

Outline stroke width.

run_time

Optional animation duration override.

kwargs

Additional animation or styling options.

Returns

The animation, mobject, or computed value produced by ShowPassingFlashAround.

Examples
scene.play(ShowPassingFlashAround(card, color=BLUE))

ShrinkToCenter

function

manim.ShrinkToCenter

def ShrinkToCenter(obj, run_time=None, **kwargs)

Shrink To Center function.

Parameters
obj

Obj accepted by ShrinkToCenter.

run_time

Run time accepted by ShrinkToCenter.

kwargs

Kwargs accepted by ShrinkToCenter.

Returns

The animation, mobject, or computed value produced by ShrinkToCenter.

Examples
result = ShrinkToCenter(obj, run_time)

sin

function

manim.sin

def sin(x)

Sin math helper.

Parameters
x

X accepted by sin.

Returns

The animation, mobject, or computed value produced by sin.

Examples
result = sin(x)

slow_into

function

manim.slow_into

def slow_into(t)

Slow into easing function.

Parameters
t

T accepted by slow_into.

Returns

The animation, mobject, or computed value produced by slow_into.

Examples
result = slow_into(t)

smooth

function

manim.smooth

def smooth(t)

Smooth easing function.

Parameters
t

T accepted by smooth.

Returns

The animation, mobject, or computed value produced by smooth.

Examples
result = smooth(t)

sqrt

function

manim.sqrt

def sqrt(x)

Sqrt math helper.

Parameters
x

X accepted by sqrt.

Returns

The animation, mobject, or computed value produced by sqrt.

Examples
result = sqrt(x)

squish_rate_func

function

manim.squish_rate_func

def squish_rate_func(func, a=0.4, b=0.6)

Squish rate func function.

Parameters
func

Func accepted by squish_rate_func.

a

A accepted by squish_rate_func.

b

B accepted by squish_rate_func.

Returns

The animation, mobject, or computed value produced by squish_rate_func.

Examples
result = squish_rate_func(func, a)

Succession

function

manim.Succession

def Succession(*animations, run_time=None, **kwargs)

Succession function.

Parameters
animations

Animations accepted by Succession.

run_time

Run time accepted by Succession.

kwargs

Kwargs accepted by Succession.

Returns

The animation, mobject, or computed value produced by Succession.

Examples
result = Succession(animations, run_time)

SurroundingRectangleWithBuffer

function

manim.SurroundingRectangleWithBuffer

def SurroundingRectangleWithBuffer(mobject, buff=0.2, **kwargs)

Surrounding Rectangle With Buffer function.

Parameters
mobject

Mobject accepted by SurroundingRectangleWithBuffer.

buff

Buff accepted by SurroundingRectangleWithBuffer.

kwargs

Kwargs accepted by SurroundingRectangleWithBuffer.

Returns

The animation, mobject, or computed value produced by SurroundingRectangleWithBuffer.

Examples
result = SurroundingRectangleWithBuffer(mobject, buff)

tan

function

manim.tan

def tan(x)

Tan math helper.

Parameters
x

X accepted by tan.

Returns

The animation, mobject, or computed value produced by tan.

Examples
result = tan(x)

there_and_back

function

manim.there_and_back

def there_and_back(t)

There and back easing function.

Parameters
t

T accepted by there_and_back.

Returns

The animation, mobject, or computed value produced by there_and_back.

Examples
result = there_and_back(t)

there_and_back_with_pause

function

manim.there_and_back_with_pause

def there_and_back_with_pause(t, pause_ratio=1.0 / 3.0)

There and back with pause function.

Parameters
t

T accepted by there_and_back_with_pause.

pause_ratio

Pause ratio accepted by there_and_back_with_pause.

Returns

The animation, mobject, or computed value produced by there_and_back_with_pause.

Examples
result = there_and_back_with_pause(t, pause_ratio)

Transform

function

manim.Transform

def Transform(obj, target_mobject, run_time=None, **kwargs)

Morph one mobject or group into another target state.

Parameters
obj

Source mobject or group.

target_mobject

Target mobject or group to morph toward.

run_time

Optional animation duration override.

kwargs

Additional transform options such as ``path_arc``.

Returns

A normalized transform descriptor consumed by ``Scene.play``.

Examples
scene.play(Transform(square, circle), run_time=0.8)

TransformFromCopy

function

manim.TransformFromCopy

def TransformFromCopy(obj, target_mobject, run_time=None, **kwargs)

Transform From Copy function.

Parameters
obj

Obj accepted by TransformFromCopy.

target_mobject

Target mobject accepted by TransformFromCopy.

run_time

Run time accepted by TransformFromCopy.

kwargs

Kwargs accepted by TransformFromCopy.

Returns

The animation, mobject, or computed value produced by TransformFromCopy.

Examples
scene.play(TransformFromCopy(mobject))

TransformMatchingShapes

function

manim.TransformMatchingShapes

def TransformMatchingShapes(mobject, target_mobject, run_time=None, **kwargs)

Approximate Manim's shape-matching transform with a regular transform.

Parameters
mobject

Source mobject.

target_mobject

Target mobject to transform into.

run_time

Optional animation duration override.

kwargs

Additional transform options.

Returns

The animation, mobject, or computed value produced by TransformMatchingShapes.

Examples
scene.play(TransformMatchingShapes(title_a, title_b))

TransformMatchingStrings

function

manim.TransformMatchingStrings

def TransformMatchingStrings(*args, **kwargs)

Transform Matching Strings function.

Parameters
args

Args accepted by TransformMatchingStrings.

kwargs

Kwargs accepted by TransformMatchingStrings.

Returns

The animation, mobject, or computed value produced by TransformMatchingStrings.

Examples
scene.play(TransformMatchingStrings(mobject))

TransformMatchingTex

function

manim.TransformMatchingTex

def TransformMatchingTex(*args, **kwargs)

Transform Matching Tex function.

Parameters
args

Args accepted by TransformMatchingTex.

kwargs

Kwargs accepted by TransformMatchingTex.

Returns

The animation, mobject, or computed value produced by TransformMatchingTex.

Examples
scene.play(TransformMatchingTex(mobject))

Uncreate

function

manim.Uncreate

def Uncreate(obj, run_time=None, **kwargs)

Uncreate function.

Parameters
obj

Obj accepted by Uncreate.

run_time

Run time accepted by Uncreate.

kwargs

Kwargs accepted by Uncreate.

Returns

The animation, mobject, or computed value produced by Uncreate.

Examples
scene.play(Uncreate(mobject))

Unwrite

function

manim.Unwrite

def Unwrite(obj, run_time=None, **kwargs)

Unwrite function.

Parameters
obj

Obj accepted by Unwrite.

run_time

Run time accepted by Unwrite.

kwargs

Kwargs accepted by Unwrite.

Returns

The animation, mobject, or computed value produced by Unwrite.

Examples
result = Unwrite(obj, run_time)

UpdateFromAlphaFunc

function

manim.UpdateFromAlphaFunc

def UpdateFromAlphaFunc(mobject, update_func, run_time=None, **kwargs)

Update From Alpha Func function.

Parameters
mobject

Mobject accepted by UpdateFromAlphaFunc.

update_func

Update func accepted by UpdateFromAlphaFunc.

run_time

Run time accepted by UpdateFromAlphaFunc.

kwargs

Kwargs accepted by UpdateFromAlphaFunc.

Returns

The animation, mobject, or computed value produced by UpdateFromAlphaFunc.

Examples
result = UpdateFromAlphaFunc(mobject, update_func)

UpdateFromFunc

function

manim.UpdateFromFunc

def UpdateFromFunc(mobject, update_func, run_time=None, **kwargs)

Update From Func function.

Parameters
mobject

Mobject accepted by UpdateFromFunc.

update_func

Update func accepted by UpdateFromFunc.

run_time

Run time accepted by UpdateFromFunc.

kwargs

Kwargs accepted by UpdateFromFunc.

Returns

The animation, mobject, or computed value produced by UpdateFromFunc.

Examples
result = UpdateFromFunc(mobject, update_func)

Wait

function

manim.Wait

def Wait(run_time=1, **kwargs)

Consume time inside animation groups without mutating scene objects.

Parameters
run_time

Run time accepted by Wait.

kwargs

Kwargs accepted by Wait.

Returns

The animation, mobject, or computed value produced by Wait.

Examples
result = Wait(run_time, kwargs)

wiggle

function

manim.wiggle

def wiggle(t, wiggles=2)

Wiggle easing function.

Parameters
t

T accepted by wiggle.

wiggles

Wiggles accepted by wiggle.

Returns

The animation, mobject, or computed value produced by wiggle.

Examples
result = wiggle(t, wiggles)

Wiggle

function

manim.Wiggle

def Wiggle(obj, angle=PI/8, run_time=None, **kwargs)

Wiggle easing function.

Parameters
obj

Obj accepted by Wiggle.

angle

Angle accepted by Wiggle.

run_time

Run time accepted by Wiggle.

kwargs

Kwargs accepted by Wiggle.

Returns

The animation, mobject, or computed value produced by Wiggle.

Examples
result = Wiggle(obj, angle)

Write

function

manim.Write

def Write(obj, run_time=None, **kwargs)

Animate text or strokes with a writing-style reveal.

Parameters
obj

Text or stroke-based mobject to reveal.

run_time

Optional animation duration override.

kwargs

Additional animation options passed through to playback.

Returns

A normalized animation descriptor consumed by ``Scene.play``.

Examples
scene.play(Write(Text("Hello world")))

Classes

117

BackgroundAudioBlock

classdepth 0

manim.BackgroundAudioBlock

class BackgroundAudioBlock

Context manager for syncing background audio timing

Returns

A BackgroundAudioBlock instance ready to add to a scene or combine with other mobjects.

Examples
obj = BackgroundAudioBlock()

CameraFrame

classdepth 0

manim.CameraFrame

class CameraFrame(_CameraFrame)

3D camera frame wrapper exposed by ``ThreeDScene.camera.frame``.

Parameters
_CameraFrame

Camera Frame accepted by CameraFrame.

Returns

A CameraFrame instance ready to add to a scene or combine with other mobjects.

Examples
obj = CameraFrame()

Cone

classdepth 0

manim.Cone

class Cone(_ThreeDBase)

Circular cone with a capped base.

Parameters
base_radius

Radius of the circular base.

height

Total cone height.

resolution

``(u_steps, v_steps)`` mesh sampling density.

kwargs

Additional style or placement arguments.

Returns

A Cone instance ready to add to a scene or combine with other mobjects.

Examples
cone = Cone(base_radius=0.8, height=1.8, color=ORANGE)

Cube

classdepth 0

manim.Cube

class Cube(_ThreeDBase)

Axis-aligned cube centered at the local origin.

Parameters
side_length

Edge length of the cube in scene units.

kwargs

Additional style or placement arguments.

Returns

A Cube instance ready to add to a scene or combine with other mobjects.

Examples
cube = Cube(side_length=1.8, color=BLUE, fill_opacity=0.4)

Cylinder

classdepth 0

manim.Cylinder

class Cylinder(_ThreeDBase)

Circular cylinder with top and bottom caps.

Parameters
radius

Radius of the cylinder body.

height

Total cylinder height.

resolution

``(u_steps, v_steps)`` mesh sampling density.

kwargs

Additional style or placement arguments.

Returns

A Cylinder instance ready to add to a scene or combine with other mobjects.

Examples
tube = Cylinder(radius=0.7, height=2.0, color=GREEN)

Dot3D

classdepth 0

manim.Dot3D

class Dot3D(_ThreeDBase)

Small filled 3D marker positioned at a single point.

Parameters
point

Center point in scene coordinates.

radius

Rendered radius of the dot.

kwargs

Additional style or placement arguments.

Returns

A Dot3D instance ready to add to a scene or combine with other mobjects.

Examples
marker = Dot3D(point=[0.5, 0.3, 1.2], radius=0.08, color=YELLOW)

Line3D

classdepth 0

manim.Line3D

class Line3D(_ThreeDBase)

Straight 3D segment between explicit start and end points.

Parameters
start

Segment start point.

end

Segment end point.

kwargs

Additional style or placement arguments.

Returns

A Line3D instance ready to add to a scene or combine with other mobjects.

Examples
segment = Line3D(start=[-1, -0.5, 0], end=[1, 0.5, 0.8], color=WHITE)

Polyhedron

classdepth 0

manim.Polyhedron

class Polyhedron(_ThreeDBase)

General 3D mesh built from explicit vertices and polygon faces.

Parameters
vertices

Iterable of 3D points.

faces

Iterable of faces, each face being a list of vertex indices.

kwargs

Additional style or placement arguments.

Notes

When ``vertices`` and ``faces`` are omitted, the runtime supplies a visible skewed triangular-prism placeholder mesh.

Returns

A Polyhedron instance ready to add to a scene or combine with other mobjects.

Examples
poly = Polyhedron(    vertices=[[0, 0, 0], [1, 0, 0], [0, 1, 0], [0, 0, 1]],    faces=[[0, 1, 2], [0, 1, 3], [0, 2, 3], [1, 2, 3]],    color=WHITE,)

Prism

classdepth 0

manim.Prism

class Prism(_ThreeDBase)

Axis-aligned rectangular prism centered at the local origin.

Parameters
dimensions

``(width, height, depth)`` tuple in scene units.

kwargs

Additional style or placement arguments.

Returns

A Prism instance ready to add to a scene or combine with other mobjects.

Examples
prism = Prism(dimensions=[1.8, 1.2, 1.0], color=PURPLE)

Sphere

classdepth 0

manim.Sphere

class Sphere(_ThreeDBase)

Triangulated sphere generated from latitude and longitude samples.

Parameters
radius

Sphere radius in scene units.

resolution

``(u_steps, v_steps)`` sampling density used to build the mesh.

kwargs

Additional style or placement arguments.

Returns

A Sphere instance ready to add to a scene or combine with other mobjects.

Examples
globe = Sphere(radius=1.1, resolution=(18, 36), color=TEAL)

ThreeDCamera

classdepth 0

manim.ThreeDCamera

class ThreeDCamera(_Camera)

Perspective camera wrapper exposed by ``ThreeDScene.camera``.

Parameters
_Camera

Camera accepted by ThreeDCamera.

Returns

A ThreeDCamera instance ready to add to a scene or combine with other mobjects.

Examples
obj = ThreeDCamera()

Torus

classdepth 0

manim.Torus

class Torus(_ThreeDBase)

Donut-shaped surface parameterized by major and minor radii.

Parameters
major_radius

Distance from the torus center to the tube center.

minor_radius

Radius of the tube cross-section.

resolution

``(u_steps, v_steps)`` mesh sampling density.

kwargs

Additional style or placement arguments.

Returns

A Torus instance ready to add to a scene or combine with other mobjects.

Examples
torus = Torus(major_radius=1.4, minor_radius=0.45, color=PINK)

VoiceoverBlock

classdepth 0

manim.VoiceoverBlock

class VoiceoverBlock

Context manager for syncing animations with voiceover timing

Returns

A VoiceoverBlock instance ready to add to a scene or combine with other mobjects.

Examples
obj = VoiceoverBlock()

SurfaceMesh

classdepth 0

manim.SurfaceMesh

class SurfaceMesh(_ThreeDBase)

Wireframe mesh extracted from a sampled surface.

Parameters
surface

Existing ``Surface`` or ``ParametricSurface`` to sample from.

resolution

Optional fallback resolution used when ``surface`` is omitted.

kwargs

Additional style or placement arguments.

Returns

A SurfaceMesh instance ready to add to a scene or combine with other mobjects.

Examples
surf = Surface(lambda u, v: [u, v, sin(u) * cos(v)])mesh = SurfaceMesh(surf, color=WHITE, stroke_width=1.2)
Methods
1
update_from_surface
method
def update_from_surface(self, surface=None)

Refresh the wireframe from the latest sampled surface geometry.

Parameters
surface

Surface accepted by update_from_surface.

Returns

The updated SurfaceMesh after calling update_from_surface.

Examples
obj.update_from_surface(surface)

Color

classdepth 0

manim.Color

class Color

Lightweight color wrapper used by compatibility properties.

Returns

A Color instance ready to add to a scene or combine with other mobjects.

Examples
obj = Color()
Methods
2
to_hex
method
def to_hex(self)

Return the color as a lowercase hex string, e.g. '#0f172a'.

Returns

The updated Color after calling to_hex.

Examples
obj.to_hex()
to_rgb
method
def to_rgb(self)

To rgb method.

Returns

The updated Color after calling to_rgb.

Examples
obj.to_rgb()

Surface

classdepth 0

manim.Surface

class Surface(_ThreeDBase)

Sampled parametric surface over a rectangular ``(u, v)`` domain.

Parameters
func

Callable of ``(u, v)`` returning a 3D point.

u_range

Inclusive parameter interval for ``u``.

v_range

Inclusive parameter interval for ``v``.

resolution

``(u_steps, v_steps)`` mesh sampling density.

checkerboard_colors

Optional alternating face colors applied after mesh generation.

kwargs

Additional style or placement arguments.

Returns

A Surface instance ready to add to a scene or combine with other mobjects.

Examples
surf = Surface(    lambda u, v: [u, v, 0.3 * sin(u) * cos(v)],    u_range=[-1.5, 1.5],    v_range=[-1.5, 1.5],)
Methods
3
set_fill_by_checkerboard
method
def set_fill_by_checkerboard(self, *colors, opacity=None)

Apply an alternating checkerboard fill pattern across the surface faces.

Parameters
colors

One or more colors to cycle across adjacent surface patches.

opacity

Optional fill opacity override applied with the checkerboard.

Returns

The surface instance for chaining.

Examples
surf.set_fill_by_checkerboard(BLUE_D, BLUE_E, opacity=0.95)
set_fill_by_value
method
def set_fill_by_value(self, *colors, values=None, axis=2, min_value=None, max_value=None, opacity=None, per_face=False)

Color the sampled surface from a scalar field.

Parameters
colors

Two or more colors describing the gradient stops.

values

Optional scalar samples or callable. When omitted, the chosen axis component of each sampled vertex is used.

axis

Axis to sample when ``values`` is omitted.

min_value

Optional lower bound for normalization.

max_value

Optional upper bound for normalization.

opacity

Optional fill opacity override.

per_face

Use one color per face center instead of smooth per-vertex interpolation.

Returns

The surface for chaining.

Examples
surf.set_fill_by_value(BLUE_D, GREEN_D, YELLOW_D, RED_D, axis="z")surf.set_fill_by_value(    BLUE_D, GREEN_D, YELLOW_D, RED_D,    values=lambda x, y, z: z,    min_value=-0.4,    max_value=0.4,)
update_surface
method
def update_surface(self, func=None, u_range=None, v_range=None, resolution=None, refresh_fill=True)

Recompute the current surface mesh in place.

Parameters
func

Optional replacement ``(u, v) -> point`` callable.

u_range

Optional replacement parameter range for ``u``.

v_range

Optional replacement parameter range for ``v``.

resolution

Optional replacement sampling density.

refresh_fill

Reapply the current checkerboard or value-based fill mapping after updating the geometry.

Returns

The surface instance for chaining.

Examples
surface.add_updater(lambda mob, dt: mob.update_surface(    lambda u, v: [u, v, wave(u, v, tracker.get_value())]))

ThreeDAxes

classdepth 0

manim.ThreeDAxes

class ThreeDAxes(_ThreeDBase)

Three-dimensional Cartesian axes with coordinate conversion helpers.

Parameters
x_range

``(min, max, step)`` tuple for the x-axis.

y_range

``(min, max, step)`` tuple for the y-axis.

z_range

``(min, max, step)`` tuple for the z-axis.

x_length

Rendered x-axis length in scene units.

y_length

Rendered y-axis length in scene units.

z_length

Rendered z-axis length in scene units.

axis_config

Shared axis style configuration.

x_axis_config

X-axis-specific style overrides.

y_axis_config

Y-axis-specific style overrides.

z_axis_config

Z-axis-specific style overrides.

kwargs

Additional style or placement arguments.

Returns

A ThreeDAxes instance ready to add to a scene or combine with other mobjects.

Examples
axes = ThreeDAxes(    x_range=[-4, 4, 1],    y_range=[-3, 3, 1],    z_range=[-4, 4, 1],)
Methods
13
add
method
def add(self, *objects)

Add method.

Parameters
objects

Objects accepted by add.

Returns

The updated ThreeDAxes after calling add.

Examples
obj.add(objects)
add_coordinates
method
def add_coordinates(self, x_values=None, y_values=None, z_values=None, **kwargs)

Attach numeric coordinate labels to the visible 3D axes.

Parameters
x_values

Optional explicit x-axis values or value-to-label mapping.

y_values

Optional explicit y-axis values or value-to-label mapping.

z_values

Optional explicit z-axis values or value-to-label mapping.

kwargs

Label styling such as ``font_size``, ``color``, and ``buff``.

Returns

The axes instance for chaining. Notes: The origin label ``0`` is omitted so only one visual origin marker is shown where the axes intersect.

Examples
axes.add_coordinates(x_values=[-2, -1, 1, 2], z_values={1: "top"})
c2p
method
def c2p(self, x, y, z=0)

Convert 3D axis coordinates into scene points.

Parameters
x

X-axis coordinate value.

y

Y-axis coordinate value.

z

Z-axis coordinate value.

Returns

A 3D point in scene coordinates.

Examples
point = axes.c2p(1.5, -2, 0.5)
coords_to_point
method
def coords_to_point(self, x, y, z=0)

Alias for :meth:`c2p` kept for Manim compatibility.

Parameters
x

X accepted by coords_to_point.

y

Y accepted by coords_to_point.

z

Z accepted by coords_to_point.

Returns

The updated ThreeDAxes after calling coords_to_point.

Examples
obj.coords_to_point(x, y)
get_axis_labels
method
def get_axis_labels(self, x_label="x", y_label="y", z_label="z", **kwargs)

Return a ``VGroup`` containing x, y, and z axis labels.

Parameters
x_label

X label accepted by get_axis_labels.

y_label

Y label accepted by get_axis_labels.

z_label

Z label accepted by get_axis_labels.

kwargs

Kwargs accepted by get_axis_labels.

Returns

The updated ThreeDAxes after calling get_axis_labels.

Examples
obj.get_axis_labels(x_label, y_label)
get_origin
method
def get_origin(self)

Get origin method.

Returns

The updated ThreeDAxes after calling get_origin.

Examples
obj.get_origin()
get_x_axis_label
method
def get_x_axis_label(self, label, edge=RIGHT, direction=DOWN, buff=0.2, **kwargs)

Build a label mobject near the positive end of the x-axis.

Parameters
label

Label accepted by get_x_axis_label.

edge

Edge accepted by get_x_axis_label.

direction

Direction accepted by get_x_axis_label.

buff

Buff accepted by get_x_axis_label.

kwargs

Kwargs accepted by get_x_axis_label.

Returns

The updated ThreeDAxes after calling get_x_axis_label.

Examples
obj.get_x_axis_label(label, edge)
get_y_axis_label
method
def get_y_axis_label(self, label, edge=UP, direction=RIGHT, buff=0.2, **kwargs)

Build a label mobject near the positive end of the y-axis.

Parameters
label

Label accepted by get_y_axis_label.

edge

Edge accepted by get_y_axis_label.

direction

Direction accepted by get_y_axis_label.

buff

Buff accepted by get_y_axis_label.

kwargs

Kwargs accepted by get_y_axis_label.

Returns

The updated ThreeDAxes after calling get_y_axis_label.

Examples
obj.get_y_axis_label(label, edge)
get_z_axis_label
method
def get_z_axis_label(self, label, edge=OUT, direction=(-1, 0, 0.75), buff=0.2, **kwargs)

Build a label mobject near the positive end of the z-axis.

Parameters
label

Label accepted by get_z_axis_label.

edge

Edge accepted by get_z_axis_label.

direction

Direction accepted by get_z_axis_label.

buff

Buff accepted by get_z_axis_label.

kwargs

Kwargs accepted by get_z_axis_label.

Returns

The updated ThreeDAxes after calling get_z_axis_label.

Examples
obj.get_z_axis_label(label, edge)
move_to
method
def move_to(self, point_or_mobject, **kwargs)

Move the target so its center lands on the given point.

Parameters
point_or_mobject

Point or mobject accepted by move_to.

kwargs

Kwargs accepted by move_to.

Returns

The updated ThreeDAxes after calling move_to.

Examples
obj.move_to(point_or_mobject, kwargs)
plot_parametric_curve
method
def plot_parametric_curve(self, function, t_range=None, color=None, stroke_width=3, **kwargs)

Sample a 3D parametric curve and return it as a path mobject.

Parameters
function

Callback mapping ``t`` to ``(x, y, z)`` axis coordinates.

t_range

``[t_min, t_max]`` or ``[t_min, t_max, step]`` domain.

color

Optional stroke color.

stroke_width

Optional stroke width.

kwargs

Additional style arguments.

Returns

A ``VMobject`` whose points are already converted into scene-space coordinates using this axes instance.

Examples
obj.plot_parametric_curve(function, t_range)
remove
method
def remove(self, *objects)

Remove method.

Parameters
objects

Objects accepted by remove.

Returns

The updated ThreeDAxes after calling remove.

Examples
obj.remove(objects)
shift
method
def shift(self, vector)

Translate the target by the provided vector.

Parameters
vector

Vector accepted by shift.

Returns

The updated ThreeDAxes after calling shift.

Examples
obj.shift(vector)

AnimationProxy

classdepth 0

manim.AnimationProxy

class AnimationProxy

Animation Proxy class.

Returns

A AnimationProxy instance ready to add to a scene or combine with other mobjects.

Examples
obj = AnimationProxy()
Methods
22
align_to
method
def align_to(self, mobject_or_point, direction)

Align to method.

Parameters
mobject_or_point

Mobject or point accepted by align_to.

direction

Direction accepted by align_to.

Returns

The updated AnimationProxy after calling align_to.

Examples
obj.align_to(mobject_or_point, direction)
center
method
def center(self)

Center method.

Returns

The updated AnimationProxy after calling center.

Examples
obj.center()
increment_value
method
def increment_value(self, delta)

Increment value on the tracked scalar value.

Parameters
delta

Delta accepted by increment_value.

Returns

The updated AnimationProxy after calling increment_value.

Examples
obj.increment_value(delta)
move_to
method
def move_to(self, point)

Move the target so its center lands on the given point.

Parameters
point

Point accepted by move_to.

Returns

The updated AnimationProxy after calling move_to.

Examples
obj.move_to(point)
next_to
method
def next_to(self, mobject_or_point, direction=RIGHT, buff=DEFAULT_MOBJECT_TO_MOBJECT_BUFFER, aligned_edge=ORIGIN)

Next to method.

Parameters
mobject_or_point

Mobject or point accepted by next_to.

direction

Direction accepted by next_to.

buff

Buff accepted by next_to.

aligned_edge

Aligned edge accepted by next_to.

Returns

The updated AnimationProxy after calling next_to.

Examples
obj.next_to(mobject_or_point, direction)
rotate
method
def rotate(self, angle, axis=OUT, about_point=None)

Rotate the target around a point or axis.

Parameters
angle

Angle accepted by rotate.

axis

Axis accepted by rotate.

about_point

About point accepted by rotate.

Returns

The updated AnimationProxy after calling rotate.

Examples
obj.rotate(angle, axis)
rotate_about_origin
method
def rotate_about_origin(self, angle, axis=OUT)

Rotate the target around a point or axis.

Parameters
angle

Angle accepted by rotate_about_origin.

axis

Axis accepted by rotate_about_origin.

Returns

The updated AnimationProxy after calling rotate_about_origin.

Examples
obj.rotate_about_origin(angle, axis)
scale
method
def scale(self, factor, about_point=None)

Scale the target by a uniform or per-axis factor.

Parameters
factor

Factor accepted by scale.

about_point

About point accepted by scale.

Returns

The updated AnimationProxy after calling scale.

Examples
obj.scale(factor, about_point)
set
method
def set(self, **kwargs)

Set method.

Parameters
kwargs

Kwargs accepted by set.

Returns

The updated AnimationProxy after calling set.

Examples
obj.set(kwargs)
set_color
method
def set_color(self, color)

Update set color styling on the target.

Parameters
color

Color accepted by set_color.

Returns

The updated AnimationProxy after calling set_color.

Examples
obj.set_color(color)
set_fill
method
def set_fill(self, color=None, opacity=None)

Update set fill styling on the target.

Parameters
color

Color accepted by set_fill.

opacity

Opacity accepted by set_fill.

Returns

The updated AnimationProxy after calling set_fill.

Examples
obj.set_fill(color, opacity)
set_opacity
method
def set_opacity(self, opacity)

Update set opacity styling on the target.

Parameters
opacity

Opacity accepted by set_opacity.

Returns

The updated AnimationProxy after calling set_opacity.

Examples
obj.set_opacity(opacity)
set_run_time
method
def set_run_time(self, run_time)

Set run time method.

Parameters
run_time

Run time accepted by set_run_time.

Returns

The updated AnimationProxy after calling set_run_time.

Examples
obj.set_run_time(run_time)
set_stroke
method
def set_stroke(self, color=None, width=None, opacity=None)

Update set stroke styling on the target.

Parameters
color

Color accepted by set_stroke.

width

Width accepted by set_stroke.

opacity

Opacity accepted by set_stroke.

Returns

The updated AnimationProxy after calling set_stroke.

Examples
obj.set_stroke(color, width)
set_stroke_width
method
def set_stroke_width(self, width)

Set stroke width method.

Parameters
width

Width accepted by set_stroke_width.

Returns

The updated AnimationProxy after calling set_stroke_width.

Examples
obj.set_stroke_width(width)
set_value
method
def set_value(self, value)

Set value on the tracked scalar value.

Parameters
value

Value accepted by set_value.

Returns

The updated AnimationProxy after calling set_value.

Examples
obj.set_value(value)
set_x
method
def set_x(self, x, direction=ORIGIN)

Set x method.

Parameters
x

X accepted by set_x.

direction

Direction accepted by set_x.

Returns

The updated AnimationProxy after calling set_x.

Examples
obj.set_x(x, direction)
set_y
method
def set_y(self, y, direction=ORIGIN)

Set y method.

Parameters
y

Y accepted by set_y.

direction

Direction accepted by set_y.

Returns

The updated AnimationProxy after calling set_y.

Examples
obj.set_y(y, direction)
set_z
method
def set_z(self, z, direction=ORIGIN)

Set z method.

Parameters
z

Z accepted by set_z.

direction

Direction accepted by set_z.

Returns

The updated AnimationProxy after calling set_z.

Examples
obj.set_z(z, direction)
shift
method
def shift(self, vector)

Translate the target by the provided vector.

Parameters
vector

Vector accepted by shift.

Returns

The updated AnimationProxy after calling shift.

Examples
obj.shift(vector)
to_corner
method
def to_corner(self, corner, buff=0.5)

To corner method.

Parameters
corner

Corner accepted by to_corner.

buff

Buff accepted by to_corner.

Returns

The updated AnimationProxy after calling to_corner.

Examples
obj.to_corner(corner, buff)
to_edge
method
def to_edge(self, edge, buff=0.5)

To edge method.

Parameters
edge

Edge accepted by to_edge.

buff

Buff accepted by to_edge.

Returns

The updated AnimationProxy after calling to_edge.

Examples
obj.to_edge(edge, buff)

Scene

classdepth 0

manim.Scene

class Scene

Top-level animation container that owns the timeline and exported state.

Parameters
duration

Upper-bound scene duration used before timeline baking resolves the final value.

width

Output width in pixels.

height

Output height in pixels.

backgroundColor

Scene background color.

showGrid

Whether to show the debug grid in supported viewers.

fps

Legacy override for backwards compatibility. Prefer compile API fps options.

Returns

A Scene instance ready to add to a scene or combine with other mobjects.

Examples
scene = Scene(width=960, height=540)scene.add(Text("Hello"))scene.wait(1)
Methods
23
add
method
def add(self, *objs)

Add mobjects to the scene immediately without an animation.

Parameters
objs

Mobjects to register and make visible.

Returns

The scene instance for chaining.

Examples
self.add(objs)
add_background_audio
method
def add_background_audio(self, audio_id, url="", volume=1, mp3="")

Add background audio method.

Parameters
audio_id

Audio id accepted by add_background_audio.

url

Url accepted by add_background_audio.

volume

Volume accepted by add_background_audio.

mp3

Mp3 accepted by add_background_audio.

Returns

Updates the Scene timeline or state after calling add_background_audio.

Examples
self.add_background_audio(audio_id, url)
add_fixed_in_frame_mobjects
method
def add_fixed_in_frame_mobjects(self, *objs)

Pin mobjects to the camera frame and add them to the scene.

Parameters
objs

Objs accepted by add_fixed_in_frame_mobjects.

Returns

Updates the Scene timeline or state after calling add_fixed_in_frame_mobjects.

Examples
self.add_fixed_in_frame_mobjects(objs)
add_fixed_orientation_mobjects
method
def add_fixed_orientation_mobjects(self, *objs)

Add fixed orientation mobjects method.

Parameters
objs

Objs accepted by add_fixed_orientation_mobjects.

Returns

Updates the Scene timeline or state after calling add_fixed_orientation_mobjects.

Examples
self.add_fixed_orientation_mobjects(objs)
add_image_asset
method
def add_image_asset(self, image_id, url="", width=0, height=0, kind="image", mimeType="", path="")

Add image asset method.

Parameters
image_id

Image id accepted by add_image_asset.

url

Url accepted by add_image_asset.

width

Width accepted by add_image_asset.

height

Height accepted by add_image_asset.

kind

Kind accepted by add_image_asset.

mimeType

Mime Type accepted by add_image_asset.

path

Path accepted by add_image_asset.

Returns

Updates the Scene timeline or state after calling add_image_asset.

Examples
self.add_image_asset(image_id, url)
clear
method
def clear(self)

Hide all currently visible scene mobjects, including fixed overlays.

Returns

Updates the Scene timeline or state after calling clear.

Examples
self.clear()
clear_content
method
def clear_content(self)

Hide non-fixed scene content while preserving fixed-frame overlays.

Returns

Updates the Scene timeline or state after calling clear_content.

Examples
self.clear_content()
clear_fixed_in_frame_mobjects
method
def clear_fixed_in_frame_mobjects(self)

Hide fixed-frame overlays from the current timeline time onward.

Returns

Updates the Scene timeline or state after calling clear_fixed_in_frame_mobjects.

Examples
self.clear_fixed_in_frame_mobjects()
construct
method
def construct(self)

Construct method.

Returns

Updates the Scene timeline or state after calling construct.

Examples
self.construct()
export
method
def export(self)

Export method.

Returns

Updates the Scene timeline or state after calling export.

Examples
self.export()
fade_out_all
method
def fade_out_all(self, run_time=1, rate_func=None, preserve_fixed_in_frame=False)

Fade out all currently visible scene mobjects.

Parameters
run_time

Duration of the fade.

rate_func

Optional easing callback.

preserve_fixed_in_frame

Keep fixed-frame overlays visible when true.

Returns

The scene instance for chaining.

Examples
self.fade_out_all(run_time, rate_func)
get_image_asset
method
def get_image_asset(self, image_id, default=None)

Get image asset method.

Parameters
image_id

Image id accepted by get_image_asset.

default

Default accepted by get_image_asset.

Returns

Updates the Scene timeline or state after calling get_image_asset.

Examples
self.get_image_asset(image_id, default)
move_camera
method
def move_camera(self, position=None, zoom=None, run_time=1, rate_func=None)

Animate the 2D camera frame position and zoom.

Parameters
position

Optional point the camera frame should move to.

zoom

Optional target zoom level. Internally this is converted into the scale factor required by the camera frame.

run_time

Animation duration in seconds.

rate_func

Optional easing callback forwarded to ``play``.

Returns

The scene instance for chaining.

Examples
scene.move_camera(position=RIGHT * 2, run_time=1.0)scene.move_camera(position=ORIGIN, zoom=1.4, rate_func=smooth)
play
method
def play(self, *animations, run_time=1, rate_func=None, run_func=None, lag_ratio=0, **kwargs)

Schedule one or more animations onto the scene timeline.

Parameters
animations

Animation objects, animation groups, or animate proxies.

run_time

Default duration used when an animation does not set one.

rate_func

Optional easing callback.

run_func

Alias accepted for compatibility with older code.

lag_ratio

Offset ratio applied when sequencing multiple animations.

kwargs

Additional animation keyword arguments such as easing hints.

Returns

The scene instance for chaining.

Examples
scene.play(Create(circle), run_time=1.2)scene.play(square.animate.shift(RIGHT * 2), rate_func=linear)
play_background_audio_block
method
def play_background_audio_block(self, audio_id, volume=None, fade_in=0, fade_out=0, loop=False)

Play background audio block method.

Parameters
audio_id

Audio id accepted by play_background_audio_block.

volume

Volume accepted by play_background_audio_block.

fade_in

Fade in accepted by play_background_audio_block.

fade_out

Fade out accepted by play_background_audio_block.

loop

Loop accepted by play_background_audio_block.

Returns

Updates the Scene timeline or state after calling play_background_audio_block.

Examples
self.play_background_audio_block(audio_id, volume)
remove
method
def remove(self, *objs)

Hide mobjects from the current timeline time onward.

Parameters
objs

Objs accepted by remove.

Returns

Updates the Scene timeline or state after calling remove.

Examples
self.remove(objs)
remove_fixed_in_frame_mobjects
method
def remove_fixed_in_frame_mobjects(self, *objs)

Release pinned mobjects into world space without a visible jump.

Parameters
objs

Objs accepted by remove_fixed_in_frame_mobjects.

Returns

Updates the Scene timeline or state after calling remove_fixed_in_frame_mobjects.

Examples
self.remove_fixed_in_frame_mobjects(objs)
reset_camera
method
def reset_camera(self, run_time=0, rate_func=None)

Restore the camera to the scene's captured initial camera state.

Parameters
run_time

Run time accepted by reset_camera.

rate_func

Rate func accepted by reset_camera.

Returns

Updates the Scene timeline or state after calling reset_camera.

Examples
self.reset_camera(run_time, rate_func)
set_background_audios
method
def set_background_audios(self, audio_map)

Set background audios method.

Parameters
audio_map

Audio map accepted by set_background_audios.

Returns

Updates the Scene timeline or state after calling set_background_audios.

Examples
self.set_background_audios(audio_map)
set_images
method
def set_images(self, image_map)

Set images method.

Parameters
image_map

Image map accepted by set_images.

Returns

Updates the Scene timeline or state after calling set_images.

Examples
self.set_images(image_map)
tear_down
method
def tear_down(self)

Tear down method.

Returns

Updates the Scene timeline or state after calling tear_down.

Examples
self.tear_down()
wait
method
def wait(self, duration=1)

Advance the scene clock without adding a new animation.

Parameters
duration

Number of seconds to advance the scene clock.

Returns

The scene instance for chaining.

Examples
self.wait(duration)
zoom_camera
method
def zoom_camera(self, zoom=None, factor=None, run_time=1, rate_func=None)

Zoom camera method.

Parameters
zoom

Zoom accepted by zoom_camera.

factor

Factor accepted by zoom_camera.

run_time

Run time accepted by zoom_camera.

rate_func

Rate func accepted by zoom_camera.

Returns

Updates the Scene timeline or state after calling zoom_camera.

Examples
self.zoom_camera(zoom, factor)

MathObject

classdepth 0

manim.MathObject

class MathObject

Base class for drawable objects in the Manim Web runtime.

Returns

A MathObject instance ready to add to a scene or combine with other mobjects.

Examples
obj = MathObject()
Methods
65
add
method
def add(self, *objects)

Attach one or more submobjects to this mobject.

Parameters
objects

Objects accepted by add.

Returns

The updated MathObject after calling add.

Examples
obj.add(objects)
add_updater
method
def add_updater(self, updater)

Register a callback that runs while the scene timeline advances.

Parameters
updater

Updater accepted by add_updater.

Returns

The updated MathObject after calling add_updater.

Examples
obj.add_updater(updater)
align_to
method
def align_to(self, mobject_or_point, direction)

Align to method.

Parameters
mobject_or_point

Mobject or point accepted by align_to.

direction

Direction accepted by align_to.

Returns

The updated MathObject after calling align_to.

Examples
obj.align_to(mobject_or_point, direction)
append_points
method
def append_points(self, points)

Append points method.

Parameters
points

Points accepted by append_points.

Returns

The updated MathObject after calling append_points.

Examples
obj.append_points(points)
become
method
def become(self, mobject, match_center=False)

Become method.

Parameters
mobject

Mobject accepted by become.

match_center

Match center accepted by become.

Returns

The updated MathObject after calling become.

Examples
obj.become(circle, match_center)
center
method
def center(self)

Manim convenience alias: move the mobject to the origin and return self. Enables chaining like .arrange(...).center().shift(...).

Returns

The updated MathObject after calling center.

Examples
obj.center()
clear_updaters
method
def clear_updaters(self)

Disable all previously registered updater callbacks.

Returns

The updated MathObject after calling clear_updaters.

Examples
obj.clear_updaters()
family_members_with_points
method
def family_members_with_points(self)

Return family members that currently contribute visible geometry.

Returns

The updated MathObject after calling family_members_with_points.

Examples
obj.family_members_with_points()
generate_target
method
def generate_target(self)

Generate target method.

Returns

The updated MathObject after calling generate_target.

Examples
obj.generate_target()
get_bottom
method
def get_bottom(self)

Get bottom method.

Returns

The updated MathObject after calling get_bottom.

Examples
obj.get_bottom()
get_center
method
def get_center(self, query_time=None)

Return the object center, optionally sampled at a specific timeline time.

Parameters
query_time

Optional timeline time to sample against.

Returns

A 3D point tuple representing the object center.

Examples
obj.get_center(query_time)
get_color
method
def get_color(self)

Get color method.

Returns

The updated MathObject after calling get_color.

Examples
obj.get_color()
get_coord
method
def get_coord(self, dim)

Return the coordinate of the mobject center along one dimension.

Parameters
dim

Coordinate index ``0`` for x, ``1`` for y, or ``2`` for z.

Returns

The numeric coordinate value. Invalid indices fall back to ``0``.

Examples
obj.get_coord(dim)
get_corner
method
def get_corner(self, direction)

Get corner method.

Parameters
direction

Direction accepted by get_corner.

Returns

The updated MathObject after calling get_corner.

Examples
obj.get_corner(direction)
get_edge_center
method
def get_edge_center(self, direction)

Get edge center method.

Parameters
direction

Direction accepted by get_edge_center.

Returns

The updated MathObject after calling get_edge_center.

Examples
obj.get_edge_center(direction)
get_end
method
def get_end(self)

Get end method.

Returns

The updated MathObject after calling get_end.

Examples
obj.get_end()
get_family
method
def get_family(self)

Return this mobject and all descendant mobjects as a flat list.

Returns

The updated MathObject after calling get_family.

Examples
obj.get_family()
get_fill_color
method
def get_fill_color(self)

Get fill color method.

Returns

The updated MathObject after calling get_fill_color.

Examples
obj.get_fill_color()
get_fill_opacity
method
def get_fill_opacity(self)

Get fill opacity method.

Returns

The updated MathObject after calling get_fill_opacity.

Examples
obj.get_fill_opacity()
get_left
method
def get_left(self)

Get left method.

Returns

The updated MathObject after calling get_left.

Examples
obj.get_left()
get_opacity
method
def get_opacity(self)

Get opacity method.

Returns

The updated MathObject after calling get_opacity.

Examples
obj.get_opacity()
get_property
method
def get_property(self, name)

Get property method.

Parameters
name

Name accepted by get_property.

Returns

The updated MathObject after calling get_property.

Examples
obj.get_property(name)
get_right
method
def get_right(self)

Get right method.

Returns

The updated MathObject after calling get_right.

Examples
obj.get_right()
get_start
method
def get_start(self)

Get start method.

Returns

The updated MathObject after calling get_start.

Examples
obj.get_start()
get_stroke_color
method
def get_stroke_color(self)

Get stroke color method.

Returns

The updated MathObject after calling get_stroke_color.

Examples
obj.get_stroke_color()
get_stroke_opacity
method
def get_stroke_opacity(self)

Get stroke opacity method.

Returns

The updated MathObject after calling get_stroke_opacity.

Examples
obj.get_stroke_opacity()
get_top
method
def get_top(self)

Get top method.

Returns

The updated MathObject after calling get_top.

Examples
obj.get_top()
get_updaters
method
def get_updaters(self)

Return the currently active updater callbacks registered on this mobject.

Returns

The updated MathObject after calling get_updaters.

Examples
obj.get_updaters()
get_x
method
def get_x(self)

Return the x-coordinate of the mobject center.

Returns

The updated MathObject after calling get_x.

Examples
obj.get_x()
get_y
method
def get_y(self)

Return the y-coordinate of the mobject center.

Returns

The updated MathObject after calling get_y.

Examples
obj.get_y()
get_z
method
def get_z(self)

Return the z-coordinate of the mobject center.

Returns

The updated MathObject after calling get_z.

Examples
obj.get_z()
has_points
method
def has_points(self)

Has points method.

Returns

The updated MathObject after calling has_points.

Examples
obj.has_points()
move_to
method
def move_to(self, point_or_mobject, aligned_edge=None, **kwargs)

Move the object center to a point or another mobject's center.

Parameters
point_or_mobject

Target point or mobject to align to.

aligned_edge

Optional corner direction used for aligned placement.

kwargs

Accepted for API compatibility.

Returns

The mutated mobject so calls can be chained.

Examples
obj.move_to(point_or_mobject, aligned_edge)
next_to
method
def next_to( self, mobject_or_point, direction=RIGHT, buff=DEFAULT_MOBJECT_TO_MOBJECT_BUFFER, aligned_edge=ORIGIN, )

Place the object next to another object or point with a buffer.

Parameters
mobject_or_point

Reference object or point.

direction

Placement direction relative to the reference.

buff

Spacing between the reference and this object.

aligned_edge

Optional secondary edge alignment. Defaults to ORIGIN, which keeps the object centered on the perpendicular axis unless an edge such as LEFT, RIGHT, UP, or DOWN is provided.

Returns

The mutated mobject so calls can be chained.

Examples
obj.next_to(mobject_or_point, direction)
point_from_proportion
method
def point_from_proportion(self, alpha)

Point from proportion method.

Parameters
alpha

Alpha accepted by point_from_proportion.

Returns

The updated MathObject after calling point_from_proportion.

Examples
obj.point_from_proportion(alpha)
remove
method
def remove(self, *objects)

Remove method.

Parameters
objects

Objects accepted by remove.

Returns

The updated MathObject after calling remove.

Examples
obj.remove(objects)
remove_updater
method
def remove_updater(self, updater)

Remove updater method.

Parameters
updater

Updater accepted by remove_updater.

Returns

The updated MathObject after calling remove_updater.

Examples
obj.remove_updater(updater)
rotate
method
def rotate(self, angle, axis=OUT, about_point=None)

Rotate the object, optionally around an explicit pivot.

Parameters
angle

Rotation amount in radians.

axis

Rotation axis vector (3D compatibility).

about_point

Optional pivot used for orbit-style rotation.

Returns

The mutated mobject so calls can be chained.

Examples
obj.rotate(angle, axis)
rotate_about_origin
method
def rotate_about_origin(self, angle, axis=OUT)

Rotate the object around the scene origin.

Parameters
angle

Angle accepted by rotate_about_origin.

axis

Axis accepted by rotate_about_origin.

Returns

The updated MathObject after calling rotate_about_origin.

Examples
obj.rotate_about_origin(angle, axis)
scale
method
def scale(self, factor, about_point=None)

Scale the object, optionally around an explicit pivot.

Parameters
factor

Scalar or per-axis scale value.

about_point

Optional pivot used for orbit-style scaling.

Returns

The mutated mobject so calls can be chained.

Examples
obj.scale(factor, about_point)
set_color
method
def set_color(self, color)

Update set color styling on the target.

Parameters
color

Color accepted by set_color.

Returns

The updated MathObject after calling set_color.

Examples
obj.set_color(color)
set_coord
method
def set_coord(self, value, dim, direction=ORIGIN)

Move the mobject so a chosen coordinate matches ``value``.

Parameters
value

Target coordinate value.

dim

Coordinate index ``0`` for x, ``1`` for y, or ``2`` for z.

direction

Alignment direction. ``ORIGIN`` aligns the center, while axis directions such as ``LEFT`` or ``UP`` align the corresponding edge similarly to Manim.

Returns

The mutated mobject so calls can be chained.

Examples
obj.set_coord(value, dim)
set_fill
method
def set_fill(self, color=None, opacity=None)

Update set fill styling on the target.

Parameters
color

Color accepted by set_fill.

opacity

Opacity accepted by set_fill.

Returns

The updated MathObject after calling set_fill.

Examples
obj.set_fill(color, opacity)
set_fill_by_radial_gradient
method
def set_fill_by_radial_gradient(self, *colors)

Apply a radial fill gradient to shapes like Circle and Ellipse.

Parameters
colors

Colors accepted by set_fill_by_radial_gradient.

Returns

The updated MathObject after calling set_fill_by_radial_gradient.

Examples
obj.set_fill_by_radial_gradient(colors)
set_fill_opacity
method
def set_fill_opacity(self, opacity)

Set fill opacity method.

Parameters
opacity

Opacity accepted by set_fill_opacity.

Returns

The updated MathObject after calling set_fill_opacity.

Examples
obj.set_fill_opacity(opacity)
set_height
method
def set_height(self, height, stretch=False)

Resize the mobject to the requested height.

Parameters
height

Target height in scene units.

stretch

When ``True``, only stretch the y-axis. Otherwise apply uniform scaling like Manim's default ``set_height`` behavior.

Returns

The updated MathObject after calling set_height.

Examples
obj.set_height(height, stretch)
set_opacity
method
def set_opacity(self, opacity)

Update set opacity styling on the target.

Parameters
opacity

Opacity accepted by set_opacity.

Returns

The updated MathObject after calling set_opacity.

Examples
obj.set_opacity(opacity)
set_property
method
def set_property(self, name, value)

Set property method.

Parameters
name

Name accepted by set_property.

value

Value accepted by set_property.

Returns

The updated MathObject after calling set_property.

Examples
obj.set_property(name, value)
set_stroke
method
def set_stroke(self, color=None, width=None, opacity=None)

Update set stroke styling on the target.

Parameters
color

Color accepted by set_stroke.

width

Width accepted by set_stroke.

opacity

Opacity accepted by set_stroke.

Returns

The updated MathObject after calling set_stroke.

Examples
obj.set_stroke(color, width)
set_stroke_width
method
def set_stroke_width(self, width)

Set stroke width method.

Parameters
width

Width accepted by set_stroke_width.

Returns

The updated MathObject after calling set_stroke_width.

Examples
obj.set_stroke_width(width)
set_width
method
def set_width(self, width, stretch=False)

Resize the mobject to the requested width.

Parameters
width

Target width in scene units.

stretch

When ``True``, only stretch the x-axis. Otherwise apply uniform scaling like Manim's default ``set_width`` behavior.

Returns

The updated MathObject after calling set_width.

Examples
obj.set_width(width, stretch)
set_x
method
def set_x(self, x, direction=ORIGIN)

Move the mobject so its x-coordinate matches ``x``.

Parameters
x

X accepted by set_x.

direction

Direction accepted by set_x.

Returns

The updated MathObject after calling set_x.

Examples
obj.set_x(x, direction)
set_y
method
def set_y(self, y, direction=ORIGIN)

Move the mobject so its y-coordinate matches ``y``.

Parameters
y

Y accepted by set_y.

direction

Direction accepted by set_y.

Returns

The updated MathObject after calling set_y.

Examples
obj.set_y(y, direction)
set_z
method
def set_z(self, z, direction=ORIGIN)

Move the mobject so its z-coordinate matches ``z``.

Parameters
z

Z accepted by set_z.

direction

Direction accepted by set_z.

Returns

The updated MathObject after calling set_z.

Examples
obj.set_z(z, direction)
shift
method
def shift(self, vector)

Translate the object by a vector in scene coordinates.

Parameters
vector

Translation vector expressed in scene coordinates.

Returns

The mutated mobject so calls can be chained.

Examples
obj.shift(vector)
to_bottom
method
def to_bottom(self, buff=0.5)

To bottom method.

Parameters
buff

Buff accepted by to_bottom.

Returns

The updated MathObject after calling to_bottom.

Examples
obj.to_bottom(buff)
to_corner
method
def to_corner(self, corner, buff=0.5)

Move the object to a frame corner while respecting its own bounds.

Parameters
corner

Corner direction such as ``UL`` or ``DR``.

buff

Margin to keep from the corner.

Returns

The mutated mobject so calls can be chained.

Examples
obj.to_corner(corner, buff)
to_dl
method
def to_dl(self, buff=0.5)

To dl method.

Parameters
buff

Buff accepted by to_dl.

Returns

The updated MathObject after calling to_dl.

Examples
obj.to_dl(buff)
to_dr
method
def to_dr(self, buff=0.5)

To dr method.

Parameters
buff

Buff accepted by to_dr.

Returns

The updated MathObject after calling to_dr.

Examples
obj.to_dr(buff)
to_edge
method
def to_edge(self, edge, buff=0.5)

Move the object to a frame edge while respecting its own bounds.

Parameters
edge

Direction of the frame edge to align to.

buff

Margin to keep from the edge.

Returns

The mutated mobject so calls can be chained.

Examples
obj.to_edge(edge, buff)
to_left
method
def to_left(self, buff=0.5)

To left method.

Parameters
buff

Buff accepted by to_left.

Returns

The updated MathObject after calling to_left.

Examples
obj.to_left(buff)
to_right
method
def to_right(self, buff=0.5)

To right method.

Parameters
buff

Buff accepted by to_right.

Returns

The updated MathObject after calling to_right.

Examples
obj.to_right(buff)
to_top
method
def to_top(self, buff=0.5)

To top method.

Parameters
buff

Buff accepted by to_top.

Returns

The updated MathObject after calling to_top.

Examples
obj.to_top(buff)
to_ul
method
def to_ul(self, buff=0.5)

To ul method.

Parameters
buff

Buff accepted by to_ul.

Returns

The updated MathObject after calling to_ul.

Examples
obj.to_ul(buff)
to_ur
method
def to_ur(self, buff=0.5)

To ur method.

Parameters
buff

Buff accepted by to_ur.

Returns

The updated MathObject after calling to_ur.

Examples
obj.to_ur(buff)

Arc

classdepth 1

manim.Arc

class Arc(MathObject)

Circular arc matching Manim's Arc constructor shape semantics.

Parameters
MathObject

Math Object accepted by Arc.

Returns

A Arc instance ready to add to a scene or combine with other mobjects.

Examples
obj = Arc()

Arrow

classdepth 1

manim.Arrow

class Arrow(MathObject)

Line segment with an arrow tip oriented toward the end point.

Parameters
start

Start point of the arrow shaft.

end

End point of the arrow shaft.

kwargs

Additional style or placement arguments.

Returns

A Arrow instance ready to add to a scene or combine with other mobjects.

Examples
arrow = Arrow(LEFT, RIGHT, color=YELLOW)

Arrow3D

classdepth 1

manim.Arrow3D

class Arrow3D(Line3D)

3D line segment with an arrow tip at the end point.

Parameters
start

Arrow tail point.

end

Arrow tip anchor point.

tip_length

Length of the rendered arrow tip.

tip_width

Width of the rendered arrow tip.

kwargs

Additional style or placement arguments.

Returns

A Arrow3D instance ready to add to a scene or combine with other mobjects.

Examples
obj = Arrow3D()

ConvexHull3D

classdepth 1

manim.ConvexHull3D

class ConvexHull3D(Polyhedron)

Convex Hull3 D class.

Parameters
Polyhedron

Polyhedron accepted by ConvexHull3D.

Returns

A ConvexHull3D instance ready to add to a scene or combine with other mobjects.

Examples
obj = ConvexHull3D()

CubicBezier

classdepth 1

manim.CubicBezier

class CubicBezier(MathObject)

Cubic Bezier curve defined by four control points.

Parameters
MathObject

Math Object accepted by CubicBezier.

Returns

A CubicBezier instance ready to add to a scene or combine with other mobjects.

Examples
obj = CubicBezier()

Dodecahedron

classdepth 1

manim.Dodecahedron

class Dodecahedron(Polyhedron)

Regular dodecahedron convenience polyhedron.

Parameters
Polyhedron

Polyhedron accepted by Dodecahedron.

Returns

A Dodecahedron instance ready to add to a scene or combine with other mobjects.

Examples
obj = Dodecahedron()

FunctionGraph

classdepth 1

manim.FunctionGraph

class FunctionGraph(MathObject)

Function Graph class.

Parameters
MathObject

Math Object accepted by FunctionGraph.

Returns

A FunctionGraph instance ready to add to a scene or combine with other mobjects.

Examples
obj = FunctionGraph()

Icosahedron

classdepth 1

manim.Icosahedron

class Icosahedron(Polyhedron)

Regular icosahedron convenience polyhedron.

Parameters
Polyhedron

Polyhedron accepted by Icosahedron.

Returns

A Icosahedron instance ready to add to a scene or combine with other mobjects.

Examples
obj = Icosahedron()

ImageMobject

classdepth 1

manim.ImageMobject

class ImageMobject(MathObject)

Raster image loaded from the user workspace or scene asset map.

Parameters
source

File path or URL-like source string.

image_id

Optional image asset id from the scene asset map.

width

Optional rendered width.

height

Optional rendered height.

kind

Asset kind metadata.

mimeType

Optional MIME type metadata.

kwargs

Additional style or placement arguments.

Returns

A ImageMobject instance ready to add to a scene or combine with other mobjects.

Examples
logo = ImageMobject("assets/logo.png").scale(0.8)

ImplicitFunction

classdepth 1

manim.ImplicitFunction

class ImplicitFunction(MathObject)

Implicit Function class.

Parameters
MathObject

Math Object accepted by ImplicitFunction.

Returns

A ImplicitFunction instance ready to add to a scene or combine with other mobjects.

Examples
obj = ImplicitFunction()

Line

classdepth 1

manim.Line

class Line(MathObject)

Straight segment defined by explicit start and end points.

Parameters
start

Start point of the segment.

end

End point of the segment.

kwargs

Additional style or placement arguments.

Returns

A Line instance ready to add to a scene or combine with other mobjects.

Examples
obj = Line()

Mobject

classdepth 1

manim.Mobject

class Mobject(MathObject)

Mobject class.

Parameters
MathObject

Math Object accepted by Mobject.

Returns

A Mobject instance ready to add to a scene or combine with other mobjects.

Examples
obj = Mobject()

MovingCameraScene

classdepth 1

manim.MovingCameraScene

class MovingCameraScene(Scene)

MovingCameraScene scene class.

Parameters
Scene

Scene accepted by MovingCameraScene.

Returns

A MovingCameraScene instance ready to add to a scene or combine with other mobjects.

Examples
class Demo(MovingCameraScene):    def construct(self):        pass

NumberLine

classdepth 1

manim.NumberLine

class NumberLine(MathObject)

Number Line class.

Parameters
MathObject

Math Object accepted by NumberLine.

Returns

A NumberLine instance ready to add to a scene or combine with other mobjects.

Examples
obj = NumberLine()

Octahedron

classdepth 1

manim.Octahedron

class Octahedron(Polyhedron)

Regular octahedron convenience polyhedron.

Parameters
Polyhedron

Polyhedron accepted by Octahedron.

Returns

A Octahedron instance ready to add to a scene or combine with other mobjects.

Examples
obj = Octahedron()

ParametricFunction

classdepth 1

manim.ParametricFunction

class ParametricFunction(MathObject)

Curve generated by sampling a callable or expression over ``t_range``.

Parameters
MathObject

Math Object accepted by ParametricFunction.

Returns

A ParametricFunction instance ready to add to a scene or combine with other mobjects.

Examples
obj = ParametricFunction()

ParametricSurface

classdepth 1

manim.ParametricSurface

class ParametricSurface(Surface)

Alias of :class:`Surface` kept for Manim API compatibility.

Parameters
Surface

Surface accepted by ParametricSurface.

Returns

A ParametricSurface instance ready to add to a scene or combine with other mobjects.

Examples
obj = ParametricSurface()

Polygon

classdepth 1

manim.Polygon

class Polygon(MathObject)

Polygon class.

Parameters
MathObject

Math Object accepted by Polygon.

Returns

A Polygon instance ready to add to a scene or combine with other mobjects.

Examples
obj = Polygon()

Rectangle

classdepth 1

manim.Rectangle

class Rectangle(MathObject)

Axis-aligned rectangle parameterized by width and height.

Parameters
width

Rectangle width in scene units.

height

Rectangle height in scene units.

object_type

Internal type override used by subclasses.

kwargs

Additional style or placement arguments.

Returns

A Rectangle instance ready to add to a scene or combine with other mobjects.

Examples
obj = Rectangle()

RegularPolygon

classdepth 1

manim.RegularPolygon

class RegularPolygon(MathObject)

Regular Polygon class.

Parameters
MathObject

Math Object accepted by RegularPolygon.

Returns

A RegularPolygon instance ready to add to a scene or combine with other mobjects.

Examples
obj = RegularPolygon()

Square

classdepth 1

manim.Square

class Square(MathObject)

Square mobject sampled densely for smoother morphing.

Parameters
side_length

Edge length in scene units.

kwargs

Additional style or placement arguments.

Returns

A Square instance ready to add to a scene or combine with other mobjects.

Examples
square = Square(side_length=2).set_color(WHITE)

Tetrahedron

classdepth 1

manim.Tetrahedron

class Tetrahedron(Polyhedron)

Regular tetrahedron convenience polyhedron.

Parameters
Polyhedron

Polyhedron accepted by Tetrahedron.

Returns

A Tetrahedron instance ready to add to a scene or combine with other mobjects.

Examples
obj = Tetrahedron()

Tex

classdepth 1

manim.Tex

class Tex(MathObject)

LaTeX-like text mobject represented as a single tex string.

Parameters
tex

TeX source string.

fontSize

Text size in pixels.

font_size

Snake-case alias for ``fontSize``.

kwargs

Additional style or placement arguments.

Returns

A Tex instance ready to add to a scene or combine with other mobjects.

Examples
obj = Tex()

Triangle

classdepth 1

manim.Triangle

class Triangle(MathObject)

Triangle class.

Parameters
MathObject

Math Object accepted by Triangle.

Returns

A Triangle instance ready to add to a scene or combine with other mobjects.

Examples
obj = Triangle()

Text

classdepth 1

manim.Text

class Text(MathObject)

Plain text mobject rendered with the runtime text renderer.

Parameters
text

Display string.

fontSize

Text size in pixels.

font_size

Snake-case alias for ``fontSize``.

kwargs

Additional style or placement arguments.

Returns

A Text instance ready to add to a scene or combine with other mobjects.

Examples
title = Text("Polar Symmetry", font_size=48, color=BLUE)
Methods
1
get_text
method
def get_text(self)

Get text method.

Returns

The updated Text after calling get_text.

Examples
obj.get_text()

Circle

classdepth 1

manim.Circle

class Circle(MathObject)

Circular outline or filled shape with Manim-style defaults.

Parameters
radius

Circle radius in scene units.

kwargs

Additional style or placement arguments.

Returns

A Circle instance ready to add to a scene or combine with other mobjects.

Examples
circle = Circle(radius=1.5, color=BLUE)
Methods
2
get_radius
method
def get_radius(self)

Get radius method.

Returns

The updated Circle after calling get_radius.

Examples
obj.get_radius()
point_at_angle
method
def point_at_angle(self, angle_radians)

Point at angle method.

Parameters
angle_radians

Angle radians accepted by point_at_angle.

Returns

The updated Circle after calling point_at_angle.

Examples
obj.point_at_angle(angle_radians)

DecimalNumber

classdepth 1

manim.DecimalNumber

class DecimalNumber(MathObject)

Decimal Number class.

Parameters
MathObject

Math Object accepted by DecimalNumber.

Returns

A DecimalNumber instance ready to add to a scene or combine with other mobjects.

Examples
obj = DecimalNumber()
Methods
2
get_value
method
def get_value(self)

Get value on the tracked scalar value.

Returns

The updated DecimalNumber after calling get_value.

Examples
obj.get_value()
set_value
method
def set_value(self, value)

Set value on the tracked scalar value.

Parameters
value

Value accepted by set_value.

Returns

The updated DecimalNumber after calling set_value.

Examples
obj.set_value(value)

ValueTracker

classdepth 1

manim.ValueTracker

class ValueTracker(MathObject)

Numeric container used to drive animations and redraw callbacks.

Parameters
value

Initial numeric value.

kwargs

Additional mobject configuration.

Returns

A ValueTracker instance ready to add to a scene or combine with other mobjects.

Examples
tracker = ValueTracker(0)scene.play(tracker.animate.set_value(10))
Methods
3
get_value
method
def get_value(self)

Get value on the tracked scalar value.

Returns

The updated ValueTracker after calling get_value.

Examples
obj.get_value()
increment_value
method
def increment_value(self, delta)

Increment value on the tracked scalar value.

Parameters
delta

Delta accepted by increment_value.

Returns

The updated ValueTracker after calling increment_value.

Examples
obj.increment_value(delta)
set_value
method
def set_value(self, value)

Set value on the tracked scalar value.

Parameters
value

Value accepted by set_value.

Returns

The updated ValueTracker after calling set_value.

Examples
obj.set_value(value)

Brace

classdepth 1

manim.Brace

class Brace(MathObject)

Brace class.

Parameters
MathObject

Math Object accepted by Brace.

Returns

A Brace instance ready to add to a scene or combine with other mobjects.

Examples
obj = Brace()
Methods
4
get_direction
method
def get_direction(self)

Get direction method.

Returns

The updated Brace after calling get_direction.

Examples
obj.get_direction()
get_text
method
def get_text(self, text, **kwargs)

Get text method.

Parameters
text

Text accepted by get_text.

kwargs

Kwargs accepted by get_text.

Returns

The updated Brace after calling get_text.

Examples
obj.get_text(text, kwargs)
get_tip
method
def get_tip(self)

Get tip method.

Returns

The updated Brace after calling get_tip.

Examples
obj.get_tip()
put_at_tip
method
def put_at_tip(self, mob, use_next_to=True, **kwargs)

Put at tip method.

Parameters
mob

Mob accepted by put_at_tip.

use_next_to

Use next to accepted by put_at_tip.

kwargs

Kwargs accepted by put_at_tip.

Returns

The updated Brace after calling put_at_tip.

Examples
obj.put_at_tip(mob, use_next_to)

ThreeDScene

classdepth 1

manim.ThreeDScene

class ThreeDScene(Scene)

3D scene with perspective camera controls compatible with Manim-style APIs.

Parameters
Scene

Scene accepted by ThreeDScene.

Returns

A ThreeDScene instance ready to add to a scene or combine with other mobjects.

Examples
class OrbitScene(ThreeDScene):    def construct(self):        self.set_camera_orientation(phi=70 * DEGREES, theta=-45 * DEGREES)        self.add(ThreeDAxes(), Cube())
Methods
4
begin_ambient_camera_rotation
method
def begin_ambient_camera_rotation(self, rate=0.02, **kwargs)

Start a persistent camera updater that rotates the 3D frame.

Parameters
rate

Angular speed in radians per second.

kwargs

Supports ``about="theta"``, ``"phi"``, or ``"gamma"`` to choose which camera angle is animated.

Returns

The scene instance for chaining.

Examples
self.begin_ambient_camera_rotation(rate=0.12)self.begin_ambient_camera_rotation(rate=0.05, about="phi")
move_camera
method
def move_camera( self, phi=None, theta=None, gamma=None, zoom=None, focal_distance=None, distance=None, frame_center=None, run_time=1, rate_func=None, **kwargs )

Animate the 3D camera frame from its current pose to a new pose.

Parameters
phi

Target polar angle in radians. Leave unset to keep the current vertical viewing angle.

theta

Target azimuthal angle in radians around the scene.

gamma

Target roll angle around the viewing axis.

zoom

Target zoom factor for the camera frame.

focal_distance

Target perspective focal distance.

distance

Target camera distance from the frame center.

frame_center

Optional point that the camera frame should move to while the orientation change is playing.

run_time

Animation duration in seconds.

rate_func

Optional easing callback passed through to ``play``.

kwargs

Compatibility aliases such as ``distance``.

Returns

The scene instance, so calls can be chained.

Examples
self.move_camera(phi=75 * DEGREES, theta=-PI / 3, run_time=1.5)self.move_camera(theta=-PI / 3, distance=7, run_time=1.2)self.move_camera(frame_center=ORIGIN, zoom=1.4, rate_func=smooth)
set_camera_orientation
method
def set_camera_orientation(self, phi=None, theta=None, gamma=None, zoom=None, focal_distance=None, distance=None, **kwargs)

Set the active 3D camera orientation immediately.

Parameters
phi

Polar angle of the camera.

theta

Azimuthal angle of the camera.

gamma

Roll angle around the viewing axis.

zoom

Camera zoom factor.

focal_distance

Perspective focal distance.

distance

Distance from the camera to the frame center.

kwargs

Compatibility aliases such as ``distance``.

Returns

The scene instance for chaining.

Examples
self.set_camera_orientation(phi, theta)
stop_ambient_camera_rotation
method
def stop_ambient_camera_rotation(self, about="theta")

Stop a previously registered ambient camera rotation updater.

Parameters
about

Axis name used when the rotation was started. Invalid values fall back to the last active axis tracked by the scene.

Returns

The scene instance for chaining.

Examples
self.stop_ambient_camera_rotation()self.stop_ambient_camera_rotation(about="phi")

PolarPlane

classdepth 1

manim.PolarPlane

class PolarPlane(MathObject)

Polar coordinate plane with radial and angular labeling helpers.

Parameters
radius_max

Maximum labeled radius value represented by the outer ring.

size

Rendered diameter of the plane in scene units.

azimuth_units

Label style for angular coordinates, such as ``"PI radians"``.

azimuth_step

Angular step between azimuth labels in radians.

radius_step

Radial step between concentric coordinate labels.

azimuth_label_font_size

Font size used for angular labels.

radius_config

Optional style overrides for radial labels.

background_line_style

Optional style metadata for grid rendering.

kwargs

Additional style or placement arguments.

Returns

A PolarPlane instance ready to add to a scene or combine with other mobjects.

Examples
plane = PolarPlane(radius_max=3, size=6, azimuth_step=PI / 6)
Methods
5
add
method
def add(self, *objects)

Add method.

Parameters
objects

Objects accepted by add.

Returns

The updated PolarPlane after calling add.

Examples
obj.add(objects)
add_coordinates
method
def add_coordinates(self)

Attach radial and azimuth coordinate labels to the polar plane.

Returns

The plane instance for chaining.

Examples
plane.add_coordinates()
c2p
method
def c2p(self, radius, azimuth)

Alias for :meth:`coords_to_point` kept for coordinate-system compatibility.

Parameters
radius

Radius accepted by c2p.

azimuth

Azimuth accepted by c2p.

Returns

The updated PolarPlane after calling c2p.

Examples
obj.c2p(radius, azimuth)
coords_to_point
method
def coords_to_point(self, radius, azimuth)

Convert polar coordinates into a scene-space point.

Parameters
radius

Radial distance in plane coordinates.

azimuth

Polar angle in radians.

Returns

A 3D scene point lying on the plane.

Examples
obj.coords_to_point(radius, azimuth)
remove
method
def remove(self, *objects)

Remove method.

Parameters
objects

Objects accepted by remove.

Returns

The updated PolarPlane after calling remove.

Examples
obj.remove(objects)

VoiceoverScene

classdepth 1

manim.VoiceoverScene

class VoiceoverScene(Scene)

Scene subclass with reusable voiceover helpers for narrated 2D timelines.

Parameters
Scene

Scene accepted by VoiceoverScene.

Returns

A VoiceoverScene instance ready to add to a scene or combine with other mobjects.

Examples
class Demo(VoiceoverScene):    def construct(self):        self.add_voiceover("intro", "Narrated scene", 1.2)        with self.play_voiceover_block("intro"):            self.play(Write(Text("Narrated scene")))
Methods
5
add_voiceover
method
def add_voiceover(self, voiceover_id, text, duration=None, title=None, mp3="", url="")

Register a local voiceover entry with its narration text and duration.

Parameters
voiceover_id

Unique identifier for this voiceover

text

The voiceover text/description

duration

Optional duration hint in seconds

Returns

Updates the VoiceoverScene timeline or state after calling add_voiceover.

Examples
self.add_voiceover(voiceover_id, text)
create_header
method
def create_header(self, title_tex, subtitle_tex)

Create a narrated-slide header with title and subtitle text.

Parameters
title_tex

Main header text shown in the accent style.

subtitle_tex

Secondary line shown below the title.

Returns

A VGroup positioned near the top edge of the frame.

Examples
self.create_header(title_tex, subtitle_tex)
export
method
def export(self)

Export scene data including voiceover information

Returns

Updates the VoiceoverScene timeline or state after calling export.

Examples
self.export()
play_voiceover_block
method
def play_voiceover_block(self, voiceover_id)

Context manager for synchronizing animations with a voiceover entry.

Parameters
voiceover_id

Voiceover id accepted by play_voiceover_block.

Returns

Updates the VoiceoverScene timeline or state after calling play_voiceover_block.

Examples
self.play_voiceover_block(voiceover_id)
set_voiceovers
method
def set_voiceovers(self, voiceover_map)

Replace the current local voiceover map in one call.

Parameters
voiceover_map

Dictionary mapping voiceover_id to {text, duration}

Returns

Updates the VoiceoverScene timeline or state after calling set_voiceovers.

Examples
self.set_voiceovers(voiceover_map)

VMobject

classdepth 1

manim.VMobject

class VMobject(MathObject)

VMobject class.

Parameters
MathObject

Math Object accepted by VMobject.

Returns

A VMobject instance ready to add to a scene or combine with other mobjects.

Examples
obj = VMobject()
Methods
6
add_line_to
method
def add_line_to(self, point)

Add line to method.

Parameters
point

Point accepted by add_line_to.

Returns

The updated VMobject after calling add_line_to.

Examples
obj.add_line_to(point)
has_points
method
def has_points(self)

Has points method.

Returns

The updated VMobject after calling has_points.

Examples
obj.has_points()
set_points
method
def set_points(self, points)

Set points method.

Parameters
points

Points accepted by set_points.

Returns

The updated VMobject after calling set_points.

Examples
obj.set_points(points)
set_points_as_corners
method
def set_points_as_corners(self, points)

Set points as corners method.

Parameters
points

Points accepted by set_points_as_corners.

Returns

The updated VMobject after calling set_points_as_corners.

Examples
obj.set_points_as_corners(points)
set_points_smoothly
method
def set_points_smoothly(self, points)

Set points smoothly method.

Parameters
points

Points accepted by set_points_smoothly.

Returns

The updated VMobject after calling set_points_smoothly.

Examples
obj.set_points_smoothly(points)
start_new_path
method
def start_new_path(self, point)

Start new path method.

Parameters
point

Point accepted by start_new_path.

Returns

The updated VMobject after calling start_new_path.

Examples
obj.start_new_path(point)

Group

classdepth 1

manim.Group

class Group(MathObject)

Container that groups child mobjects without changing their types.

Parameters
MathObject

Math Object accepted by Group.

Returns

A Group instance ready to add to a scene or combine with other mobjects.

Examples
obj = Group()
Methods
7
add
method
def add(self, *objects)

Append one or more child mobjects to the group.

Parameters
objects

Objects accepted by add.

Returns

The updated Group after calling add.

Examples
obj.add(objects)
arrange
method
def arrange(self, direction=RIGHT, buff=DEFAULT_MOBJECT_TO_MOBJECT_BUFFER, center=True, **kwargs)

Lay out children sequentially along a direction with spacing.

Parameters
direction

Direction accepted by arrange.

buff

Buff accepted by arrange.

center

Center accepted by arrange.

kwargs

Kwargs accepted by arrange.

Returns

The updated Group after calling arrange.

Examples
obj.arrange(direction, buff)
arrange_in_grid
method
def arrange_in_grid(self, rows=None, cols=None, buff=0.5, center=True, **kwargs)

Arrange in grid method.

Parameters
rows

Rows accepted by arrange_in_grid.

cols

Cols accepted by arrange_in_grid.

buff

Buff accepted by arrange_in_grid.

center

Center accepted by arrange_in_grid.

kwargs

Kwargs accepted by arrange_in_grid.

Returns

The updated Group after calling arrange_in_grid.

Examples
obj.arrange_in_grid(rows, cols)
get_center
method
def get_center(self, query_time=None)

Get center method.

Parameters
query_time

Query time accepted by get_center.

Returns

The updated Group after calling get_center.

Examples
obj.get_center(query_time)
move_to
method
def move_to(self, point_or_mobject, aligned_edge=None, **kwargs)

Move the target so its center lands on the given point.

Parameters
point_or_mobject

Point or mobject accepted by move_to.

aligned_edge

Aligned edge accepted by move_to.

kwargs

Kwargs accepted by move_to.

Returns

The updated Group after calling move_to.

Examples
obj.move_to(point_or_mobject, aligned_edge)
remove
method
def remove(self, *objects)

Remove one or more child mobjects from the group.

Parameters
objects

Objects accepted by remove.

Returns

The updated Group after calling remove.

Examples
obj.remove(objects)
shift
method
def shift(self, vector)

Translate the target by the provided vector.

Parameters
vector

Vector accepted by shift.

Returns

The updated Group after calling shift.

Examples
obj.shift(vector)

ZoomedScene

classdepth 1

manim.ZoomedScene

class ZoomedScene(Scene)

Scene variant that renders a second zoomed inset of the main camera.

Parameters
Scene

Scene accepted by ZoomedScene.

Returns

A ZoomedScene instance ready to add to a scene or combine with other mobjects.

Examples
class Demo(ZoomedScene):    def construct(self):        dot = Dot()        self.add(dot)        self.activate_zooming()        self.play(self.get_zoomed_display_pop_out_animation())
Methods
7
activate_zooming
method
def activate_zooming(self, animate=False)

Enable the zoom frame and zoomed display overlay for the scene.

Parameters
animate

When ``True``, also play the default zoom-in and pop-out animations immediately after activation.

Returns

The scene instance for chaining.

Examples
self.activate_zooming(animate)
begin_ambient_camera_rotation
method
def begin_ambient_camera_rotation(self, rate=0.02, about="theta")

Start continuous ambient rotation on the zoomed scene camera.

Parameters
rate

Angular speed in radians per second.

about

Camera angle to animate: ``"theta"``, ``"phi"``, or ``"gamma"``.

Returns

The scene instance for chaining.

Examples
self.begin_ambient_camera_rotation(rate, about)
get_zoom_in_animation
method
def get_zoom_in_animation(self, run_time=2, **kwargs)

Return the animation that shrinks the zoom frame into place.

Parameters
run_time

Duration of the zoom-in transition.

kwargs

Additional animation keyword arguments forwarded to ``ApplyMethod``.

Returns

An animation object that restores the zoom frame from a full-screen state to its configured size and position.

Examples
self.get_zoom_in_animation(run_time, kwargs)
get_zoomed_display_pop_out_animation
method
def get_zoomed_display_pop_out_animation(self)

Return the inset pop-out animation for the zoomed display.

Returns

An animation group targeting the zoomed image and display frame, or a fallback display animation when child components are unavailable.

Examples
self.get_zoomed_display_pop_out_animation()
move_camera
method
def move_camera( self, phi=None, theta=None, gamma=None, zoom=None, focal_distance=None, distance=None, frame_center=None, run_time=1, rate_func=None, **kwargs )

Animate the zoomed scene's shared camera frame as a 3D camera move.

Parameters
phi

Target polar angle in radians.

theta

Target azimuthal angle in radians.

gamma

Target roll angle.

zoom

Target zoom factor.

focal_distance

Target focal distance.

distance

Target distance from the frame center.

frame_center

Optional point to move the camera frame toward.

run_time

Animation duration in seconds.

rate_func

Optional easing callback.

kwargs

Additional compatibility aliases.

Returns

The scene instance for chaining.

Examples
self.move_camera(theta=-PI / 4, distance=6, run_time=1.2)self.move_camera(frame_center=ORIGIN, zoom=1.3, rate_func=smooth)
set_camera_orientation
method
def set_camera_orientation(self, phi=None, theta=None, gamma=None, zoom=None, focal_distance=None, distance=None, **kwargs)

Enable 3D camera support and set the zoomed scene camera immediately.

Parameters
phi

Polar angle in radians.

theta

Azimuthal angle in radians.

gamma

Roll angle around the viewing axis.

zoom

Camera zoom factor.

focal_distance

Perspective focal distance.

distance

Camera distance from the frame center.

kwargs

Additional compatibility aliases.

Returns

The scene instance for chaining.

Examples
self.set_camera_orientation(phi, theta)
stop_ambient_camera_rotation
method
def stop_ambient_camera_rotation(self, about="theta")

Stop ambient camera rotation previously started on the zoomed scene.

Parameters
about

Camera angle whose ambient updater should be removed.

Returns

The scene instance for chaining.

Examples
self.stop_ambient_camera_rotation(about)

Code

classdepth 1

manim.Code

class Code(MathObject)

Shared-layout code block that preserves Manim-style constructor options.

Parameters
MathObject

Math Object accepted by Code.

Returns

A Code instance ready to add to a scene or combine with other mobjects.

Examples
obj = Code()
Methods
8
align_to
method
def align_to(self, mobject_or_point, direction)

Align to method.

Parameters
mobject_or_point

Mobject or point accepted by align_to.

direction

Direction accepted by align_to.

Returns

The updated Code after calling align_to.

Examples
obj.align_to(mobject_or_point, direction)
center
method
def center(self)

Center method.

Returns

The updated Code after calling center.

Examples
obj.center()
move_to
method
def move_to(self, point_or_mobject, aligned_edge=None, **kwargs)

Move the target so its center lands on the given point.

Parameters
point_or_mobject

Point or mobject accepted by move_to.

aligned_edge

Aligned edge accepted by move_to.

kwargs

Kwargs accepted by move_to.

Returns

The updated Code after calling move_to.

Examples
obj.move_to(point_or_mobject, aligned_edge)
next_to
method
def next_to(self, mobject_or_point, direction=RIGHT, buff=DEFAULT_MOBJECT_TO_MOBJECT_BUFFER, aligned_edge=ORIGIN)

Next to method.

Parameters
mobject_or_point

Mobject or point accepted by next_to.

direction

Direction accepted by next_to.

buff

Buff accepted by next_to.

aligned_edge

Aligned edge accepted by next_to.

Returns

The updated Code after calling next_to.

Examples
obj.next_to(mobject_or_point, direction)
rotate
method
def rotate(self, angle, axis=OUT, about_point=None)

Rotate the target around a point or axis.

Parameters
angle

Angle accepted by rotate.

axis

Axis accepted by rotate.

about_point

About point accepted by rotate.

Returns

The updated Code after calling rotate.

Examples
obj.rotate(angle, axis)
scale
method
def scale(self, factor, about_point=None)

Scale the target by a uniform or per-axis factor.

Parameters
factor

Factor accepted by scale.

about_point

About point accepted by scale.

Returns

The updated Code after calling scale.

Examples
obj.scale(factor, about_point)
shift
method
def shift(self, vector)

Translate the target by the provided vector.

Parameters
vector

Vector accepted by shift.

Returns

The updated Code after calling shift.

Examples
obj.shift(vector)
to_edge
method
def to_edge(self, edge, buff=0.5)

To edge method.

Parameters
edge

Edge accepted by to_edge.

buff

Buff accepted by to_edge.

Returns

The updated Code after calling to_edge.

Examples
obj.to_edge(edge, buff)

Axes

classdepth 1

manim.Axes

class Axes(MathObject)

Coordinate axes with configurable ranges and visual lengths.

Parameters
x_range

``(min, max, step)`` tuple for the x-axis.

y_range

``(min, max, step)`` tuple for the y-axis.

x_length

Rendered x-axis length in scene units.

y_length

Rendered y-axis length in scene units.

axis_config

Shared axis style configuration.

x_axis_config

X-axis-specific style overrides.

y_axis_config

Y-axis-specific style overrides.

kwargs

Additional style or placement arguments.

Returns

A Axes instance ready to add to a scene or combine with other mobjects.

Examples
axes = Axes(x_range=[0, 4, 1], y_range=[0, 3, 1]).to_edge(DOWN, buff=0.6)
Methods
11
c2p
method
def c2p(self, x, y)

C2p method.

Parameters
x

X accepted by c2p.

y

Y accepted by c2p.

Returns

The updated Axes after calling c2p.

Examples
obj.c2p(x, y)
coords_to_point
method
def coords_to_point(self, *coords)

Coords to point method.

Parameters
coords

Coords accepted by coords_to_point.

Returns

The updated Axes after calling coords_to_point.

Examples
obj.coords_to_point(coords)
get_axis_labels
method
def get_axis_labels(self, x_label="x", y_label="y", **kwargs)

Get axis labels method.

Parameters
x_label

X label accepted by get_axis_labels.

y_label

Y label accepted by get_axis_labels.

kwargs

Kwargs accepted by get_axis_labels.

Returns

The updated Axes after calling get_axis_labels.

Examples
obj.get_axis_labels(x_label, y_label)
get_horizontal_line
method
def get_horizontal_line(self, point, line_func=None, color=None, stroke_width=2, **kwargs)

Get horizontal line method.

Parameters
point

Point accepted by get_horizontal_line.

line_func

Line func accepted by get_horizontal_line.

color

Color accepted by get_horizontal_line.

stroke_width

Stroke width accepted by get_horizontal_line.

kwargs

Kwargs accepted by get_horizontal_line.

Returns

The updated Axes after calling get_horizontal_line.

Examples
obj.get_horizontal_line(point, line_func)
get_origin
method
def get_origin(self)

Get origin method.

Returns

The updated Axes after calling get_origin.

Examples
obj.get_origin()
get_vertical_line
method
def get_vertical_line(self, point, line_func=None, color=None, stroke_width=2, **kwargs)

Get vertical line method.

Parameters
point

Point accepted by get_vertical_line.

line_func

Line func accepted by get_vertical_line.

color

Color accepted by get_vertical_line.

stroke_width

Stroke width accepted by get_vertical_line.

kwargs

Kwargs accepted by get_vertical_line.

Returns

The updated Axes after calling get_vertical_line.

Examples
obj.get_vertical_line(point, line_func)
get_x_axis_label
method
def get_x_axis_label(self, label, edge=RIGHT, direction=DOWN, buff=0.25, **kwargs)

Get x axis label method.

Parameters
label

Label accepted by get_x_axis_label.

edge

Edge accepted by get_x_axis_label.

direction

Direction accepted by get_x_axis_label.

buff

Buff accepted by get_x_axis_label.

kwargs

Kwargs accepted by get_x_axis_label.

Returns

The updated Axes after calling get_x_axis_label.

Examples
obj.get_x_axis_label(label, edge)
get_y_axis_label
method
def get_y_axis_label(self, label, edge=UP, direction=LEFT, buff=0.25, **kwargs)

Get y axis label method.

Parameters
label

Label accepted by get_y_axis_label.

edge

Edge accepted by get_y_axis_label.

direction

Direction accepted by get_y_axis_label.

buff

Buff accepted by get_y_axis_label.

kwargs

Kwargs accepted by get_y_axis_label.

Returns

The updated Axes after calling get_y_axis_label.

Examples
obj.get_y_axis_label(label, edge)
move_to
method
def move_to(self, point_or_mobject, **kwargs)

Move the target so its center lands on the given point.

Parameters
point_or_mobject

Point or mobject accepted by move_to.

kwargs

Kwargs accepted by move_to.

Returns

The updated Axes after calling move_to.

Examples
obj.move_to(point_or_mobject, kwargs)
plot
method
def plot(self, func, x_range=None, color=None, stroke_width=3, **kwargs)

Plot method.

Parameters
func

Func accepted by plot.

x_range

X range accepted by plot.

color

Color accepted by plot.

stroke_width

Stroke width accepted by plot.

kwargs

Kwargs accepted by plot.

Returns

The updated Axes after calling plot.

Examples
obj.plot(func, x_range)
shift
method
def shift(self, vector)

Translate the target by the provided vector.

Parameters
vector

Vector accepted by shift.

Returns

The updated Axes after calling shift.

Examples
obj.shift(vector)

Angle

classdepth 2

manim.Angle

class Angle(Arc)

Angle class.

Parameters
Arc

Arc accepted by Angle.

Returns

A Angle instance ready to add to a scene or combine with other mobjects.

Examples
obj = Angle()

AnnularSector

classdepth 2

manim.AnnularSector

class AnnularSector(Polygon)

Annular Sector class.

Parameters
Polygon

Polygon accepted by AnnularSector.

Returns

A AnnularSector instance ready to add to a scene or combine with other mobjects.

Examples
obj = AnnularSector()

ArcBetweenPoints

classdepth 2

manim.ArcBetweenPoints

class ArcBetweenPoints(Arc)

Circular arc spanning two points using Manim's constructor rules.

Parameters
Arc

Arc accepted by ArcBetweenPoints.

Returns

A ArcBetweenPoints instance ready to add to a scene or combine with other mobjects.

Examples
obj = ArcBetweenPoints()

ArcPolygon

classdepth 2

manim.ArcPolygon

class ArcPolygon(Polygon)

Arc Polygon class.

Parameters
Polygon

Polygon accepted by ArcPolygon.

Returns

A ArcPolygon instance ready to add to a scene or combine with other mobjects.

Examples
obj = ArcPolygon()

ArrowCircleFilledTip

classdepth 2

manim.ArrowCircleFilledTip

class ArrowCircleFilledTip(Circle)

Arrow Circle Filled Tip class.

Parameters
Circle

Circle accepted by ArrowCircleFilledTip.

Returns

A ArrowCircleFilledTip instance ready to add to a scene or combine with other mobjects.

Examples
obj = ArrowCircleFilledTip()

ArrowCircleTip

classdepth 2

manim.ArrowCircleTip

class ArrowCircleTip(Circle)

Arrow Circle Tip class.

Parameters
Circle

Circle accepted by ArrowCircleTip.

Returns

A ArrowCircleTip instance ready to add to a scene or combine with other mobjects.

Examples
obj = ArrowCircleTip()

ArrowSquareFilledTip

classdepth 2

manim.ArrowSquareFilledTip

class ArrowSquareFilledTip(Square)

Arrow Square Filled Tip class.

Parameters
Square

Square accepted by ArrowSquareFilledTip.

Returns

A ArrowSquareFilledTip instance ready to add to a scene or combine with other mobjects.

Examples
obj = ArrowSquareFilledTip()

ArrowSquareTip

classdepth 2

manim.ArrowSquareTip

class ArrowSquareTip(Square)

Arrow Square Tip class.

Parameters
Square

Square accepted by ArrowSquareTip.

Returns

A ArrowSquareTip instance ready to add to a scene or combine with other mobjects.

Examples
obj = ArrowSquareTip()

ArrowTriangleFilledTip

classdepth 2

manim.ArrowTriangleFilledTip

class ArrowTriangleFilledTip(Polygon)

Filled triangular arrow tip sized with Manim-like defaults.

Parameters
Polygon

Polygon accepted by ArrowTriangleFilledTip.

Returns

A ArrowTriangleFilledTip instance ready to add to a scene or combine with other mobjects.

Examples
obj = ArrowTriangleFilledTip()

BraceBetweenPoints

classdepth 2

manim.BraceBetweenPoints

class BraceBetweenPoints(Brace)

Brace Between Points class.

Parameters
Brace

Brace accepted by BraceBetweenPoints.

Returns

A BraceBetweenPoints instance ready to add to a scene or combine with other mobjects.

Examples
obj = BraceBetweenPoints()

ConvexHull

classdepth 2

manim.ConvexHull

class ConvexHull(Polygon)

Convex Hull class.

Parameters
Polygon

Polygon accepted by ConvexHull.

Returns

A ConvexHull instance ready to add to a scene or combine with other mobjects.

Examples
obj = ConvexHull()

DashedLine

classdepth 2

manim.DashedLine

class DashedLine(Line)

Dashed Line class.

Parameters
Line

Line accepted by DashedLine.

Returns

A DashedLine instance ready to add to a scene or combine with other mobjects.

Examples
obj = DashedLine()

Dot

classdepth 2

manim.Dot

class Dot(Circle)

Filled circular point marker.

Parameters
Circle

Circle accepted by Dot.

Returns

A Dot instance ready to add to a scene or combine with other mobjects.

Examples
obj = Dot()

DoubleArrow

classdepth 2

manim.DoubleArrow

class DoubleArrow(Arrow)

Line segment with arrow tips at both the start and end points.

Parameters
start

Start point of the arrow shaft.

end

End point of the arrow shaft.

kwargs

Additional style or placement arguments.

Returns

A DoubleArrow instance ready to add to a scene or combine with other mobjects.

Examples
connector = DoubleArrow(LEFT, RIGHT, color=YELLOW)

Elbow

classdepth 2

manim.Elbow

class Elbow(Polygon)

Elbow class.

Parameters
Polygon

Polygon accepted by Elbow.

Returns

A Elbow instance ready to add to a scene or combine with other mobjects.

Examples
obj = Elbow()

Ellipse

classdepth 2

manim.Ellipse

class Ellipse(Circle)

Ellipse class.

Parameters
Circle

Circle accepted by Ellipse.

Returns

A Ellipse instance ready to add to a scene or combine with other mobjects.

Examples
obj = Ellipse()

MarkupText

classdepth 2

manim.MarkupText

class MarkupText(Text)

Text that accepts simple inline markup tags and strips them for rendering.

Parameters
Text

Text accepted by MarkupText.

Returns

A MarkupText instance ready to add to a scene or combine with other mobjects.

Examples
obj = MarkupText()

MathTex

classdepth 2

manim.MathTex

class MathTex(Tex)

Math-oriented ``Tex`` variant that accepts multiple fragments.

Parameters
tex_strings

One or more TeX fragments.

fontSize

Text size in pixels.

font_size

Snake-case alias for ``fontSize``.

arg_separator

Separator inserted between fragments.

kwargs

Additional style or placement arguments.

Returns

A MathTex instance ready to add to a scene or combine with other mobjects.

Examples
eq = MathTex(r"e^{i\\pi} + 1 = 0")

Polygram

classdepth 2

manim.Polygram

class Polygram(Polygon)

Polygram class.

Parameters
Polygon

Polygon accepted by Polygram.

Returns

A Polygram instance ready to add to a scene or combine with other mobjects.

Examples
obj = Polygram()

RegularPolygram

classdepth 2

manim.RegularPolygram

class RegularPolygram(Polygon)

Regular Polygram class.

Parameters
Polygon

Polygon accepted by RegularPolygram.

Returns

A RegularPolygram instance ready to add to a scene or combine with other mobjects.

Examples
obj = RegularPolygram()

RightAngle

classdepth 2

manim.RightAngle

class RightAngle(Polygon)

Right Angle class.

Parameters
Polygon

Polygon accepted by RightAngle.

Returns

A RightAngle instance ready to add to a scene or combine with other mobjects.

Examples
obj = RightAngle()

RoundedRectangle

classdepth 2

manim.RoundedRectangle

class RoundedRectangle(Rectangle)

Rectangle variant with rounded corners.

Parameters
Rectangle

Rectangle accepted by RoundedRectangle.

Returns

A RoundedRectangle instance ready to add to a scene or combine with other mobjects.

Examples
obj = RoundedRectangle()

Sector

classdepth 2

manim.Sector

class Sector(Polygon)

Sector class.

Parameters
Polygon

Polygon accepted by Sector.

Returns

A Sector instance ready to add to a scene or combine with other mobjects.

Examples
obj = Sector()

Star

classdepth 2

manim.Star

class Star(Polygon)

Star class.

Parameters
Polygon

Polygon accepted by Star.

Returns

A Star instance ready to add to a scene or combine with other mobjects.

Examples
obj = Star()

SurroundingRectangle

classdepth 2

manim.SurroundingRectangle

class SurroundingRectangle(Rectangle)

Rectangle that surrounds a mobject - exports as 'Rectangle' type

Parameters
Rectangle

Rectangle accepted by SurroundingRectangle.

Returns

A SurroundingRectangle instance ready to add to a scene or combine with other mobjects.

Examples
obj = SurroundingRectangle()

SVGMobject

classdepth 2

manim.SVGMobject

class SVGMobject(ImageMobject)

SVG-backed image mobject.

Parameters
ImageMobject

Image Mobject accepted by SVGMobject.

Returns

A SVGMobject instance ready to add to a scene or combine with other mobjects.

Examples
obj = SVGMobject()

TangentLine

classdepth 2

manim.TangentLine

class TangentLine(Line)

Tangent Line class.

Parameters
Line

Line accepted by TangentLine.

Returns

A TangentLine instance ready to add to a scene or combine with other mobjects.

Examples
obj = TangentLine()

Underline

classdepth 2

manim.Underline

class Underline(Line)

Underline class.

Parameters
Line

Line accepted by Underline.

Returns

A Underline instance ready to add to a scene or combine with other mobjects.

Examples
obj = Underline()

Vector

classdepth 2

manim.Vector

class Vector(Arrow)

Vector class.

Parameters
Arrow

Arrow accepted by Vector.

Returns

A Vector instance ready to add to a scene or combine with other mobjects.

Examples
obj = Vector()

Vector3D

classdepth 2

manim.Vector3D

class Vector3D(Arrow3D)

Arrow that starts at the origin and points along a direction vector.

Parameters
direction

3D direction vector used as the arrow end point.

kwargs

Additional style or placement arguments.

Returns

A Vector3D instance ready to add to a scene or combine with other mobjects.

Examples
velocity = Vector3D([0.9, 0.7, 1.1], color=RED)

VGroup

classdepth 2

manim.VGroup

class VGroup(Group)

Group variant used for vectorized collections of mobjects.

Parameters
Group

Group accepted by VGroup.

Returns

A VGroup instance ready to add to a scene or combine with other mobjects.

Examples
obj = VGroup()

Integer

classdepth 2

manim.Integer

class Integer(DecimalNumber)

Integer-valued number mobject with animate/set_value support.

Parameters
DecimalNumber

Decimal Number accepted by Integer.

Returns

A Integer instance ready to add to a scene or combine with other mobjects.

Examples
obj = Integer()
Methods
1
set_value
method
def set_value(self, value)

Set value on the tracked scalar value.

Parameters
value

Value accepted by set_value.

Returns

The updated Integer after calling set_value.

Examples
obj.set_value(value)

TracedPath

classdepth 2

manim.TracedPath

class TracedPath(VMobject)

Continuously trace points returned by a callback over time.

Parameters
VMobject

VMobject accepted by TracedPath.

Returns

A TracedPath instance ready to add to a scene or combine with other mobjects.

Examples
obj = TracedPath()
Methods
1
update_path
method
def update_path(self, mob, dt)

Update path method.

Parameters
mob

Mob accepted by update_path.

dt

Dt accepted by update_path.

Returns

The updated TracedPath after calling update_path.

Examples
obj.update_path(mob, dt)

VoiceoverThreeDScene

classdepth 2

manim.VoiceoverThreeDScene

class VoiceoverThreeDScene(ThreeDScene)

ThreeDScene variant with the same reusable voiceover helpers as VoiceoverScene.

Parameters
ThreeDScene

Three DScene accepted by VoiceoverThreeDScene.

Returns

A VoiceoverThreeDScene instance ready to add to a scene or combine with other mobjects.

Examples
class Demo(VoiceoverThreeDScene):    def construct(self):        self.add_voiceover("intro", "Narrated 3D scene", 1.4)        self.set_camera_orientation(phi=70 * DEGREES, theta=-45 * DEGREES)        cube = Cube().set_color(BLUE)        self.add(cube)        with self.play_voiceover_block("intro"):            self.begin_ambient_camera_rotation(rate=0.15)            self.wait(1.4)            self.stop_ambient_camera_rotation()
Methods
5
add_voiceover
method
def add_voiceover(self, voiceover_id, text, duration, title=None, mp3="", url="")

Register a local voiceover entry with its narration text and duration.

Parameters
voiceover_id

Unique identifier for this voiceover

text

The voiceover text/description

duration

Duration in seconds

Returns

Updates the VoiceoverThreeDScene timeline or state after calling add_voiceover.

Examples
self.add_voiceover(voiceover_id, text)
create_header
method
def create_header(self, title_tex, subtitle_tex)

Create a narrated-slide header with title and subtitle text.

Parameters
title_tex

Main header text shown in the accent style.

subtitle_tex

Secondary line shown below the title.

Returns

A VGroup positioned near the top edge of the frame.

Examples
self.create_header(title_tex, subtitle_tex)
export
method
def export(self)

Export 3D scene data including voiceover information

Returns

Updates the VoiceoverThreeDScene timeline or state after calling export.

Examples
self.export()
play_voiceover_block
method
def play_voiceover_block(self, voiceover_id)

Context manager for synchronizing 3D animations with a voiceover entry.

Parameters
voiceover_id

Voiceover id accepted by play_voiceover_block.

Returns

Updates the VoiceoverThreeDScene timeline or state after calling play_voiceover_block.

Examples
self.play_voiceover_block(voiceover_id)
set_voiceovers
method
def set_voiceovers(self, voiceover_map)

Replace the current local voiceover map in one call.

Parameters
voiceover_map

Dictionary mapping voiceover_id to {text, duration}

Returns

Updates the VoiceoverThreeDScene timeline or state after calling set_voiceovers.

Examples
self.set_voiceovers(voiceover_map)

NumberPlane

classdepth 2

manim.NumberPlane

class NumberPlane(Axes)

Cartesian grid plane with vector and coordinate-label helpers.

Parameters
x_range

``(min, max, step)`` tuple for the x-axis.

y_range

``(min, max, step)`` tuple for the y-axis.

x_length

Rendered x-axis length in scene units.

y_length

Rendered y-axis length in scene units.

axis_config

Shared axis style configuration.

x_axis_config

X-axis-specific style overrides.

y_axis_config

Y-axis-specific style overrides.

background_line_style

Style metadata for primary grid lines.

faded_line_style

Style metadata for secondary grid lines.

faded_line_ratio

Density ratio for faded grid lines.

make_smooth_after_applying_functions

Compatibility flag stored in exported metadata.

kwargs

Additional style or placement arguments.

Returns

A NumberPlane instance ready to add to a scene or combine with other mobjects.

Examples
plane = NumberPlane(x_range=[-4, 4, 1], y_range=[-3, 3, 1])
Methods
9
add
method
def add(self, *objects)

Add method.

Parameters
objects

Objects accepted by add.

Returns

The updated NumberPlane after calling add.

Examples
obj.add(objects)
add_coordinates
method
def add_coordinates(self, x_values=None, y_values=None, **kwargs)

Attach numeric coordinate labels to the x and y axes.

Parameters
x_values

Optional explicit x-axis values.

y_values

Optional explicit y-axis values.

kwargs

Label styling such as ``font_size`` and ``color``.

Returns

The plane instance for chaining.

Examples
obj.add_coordinates(x_values, y_values)
get_axis_labels
method
def get_axis_labels(self, x_label="x", y_label="y", **kwargs)

Return a ``VGroup`` containing x and y axis labels.

Parameters
x_label

X label accepted by get_axis_labels.

y_label

Y label accepted by get_axis_labels.

kwargs

Kwargs accepted by get_axis_labels.

Returns

The updated NumberPlane after calling get_axis_labels.

Examples
obj.get_axis_labels(x_label, y_label)
get_coordinate_labels
method
def get_coordinate_labels(self, x_values=None, y_values=None, **kwargs)

Return numeric coordinate labels for the visible x and y axes.

Parameters
x_values

Optional explicit x-axis values.

y_values

Optional explicit y-axis values.

kwargs

Label styling such as ``font_size`` and ``color``.

Returns

A ``VGroup`` of label mobjects. Notes: The origin label ``0`` is omitted to avoid duplicate labels where the axes intersect.

Examples
obj.get_coordinate_labels(x_values, y_values)
get_vector
method
def get_vector(self, coords, **kwargs)

Return an arrow from the plane origin to a coordinate on the plane.

Parameters
coords

Target coordinate pair.

kwargs

Additional ``Arrow`` styling arguments.

Returns

An ``Arrow`` whose endpoints are resolved through the plane mapping.

Examples
obj.get_vector(coords, kwargs)
get_x_axis_label
method
def get_x_axis_label(self, label, edge=RIGHT, direction=DOWN, buff=0.25, **kwargs)

Build a label mobject near the positive end of the x-axis.

Parameters
label

Label accepted by get_x_axis_label.

edge

Edge accepted by get_x_axis_label.

direction

Direction accepted by get_x_axis_label.

buff

Buff accepted by get_x_axis_label.

kwargs

Kwargs accepted by get_x_axis_label.

Returns

The updated NumberPlane after calling get_x_axis_label.

Examples
obj.get_x_axis_label(label, edge)
get_y_axis_label
method
def get_y_axis_label(self, label, edge=UP, direction=LEFT, buff=0.25, **kwargs)

Build a label mobject near the positive end of the y-axis.

Parameters
label

Label accepted by get_y_axis_label.

edge

Edge accepted by get_y_axis_label.

direction

Direction accepted by get_y_axis_label.

buff

Buff accepted by get_y_axis_label.

kwargs

Kwargs accepted by get_y_axis_label.

Returns

The updated NumberPlane after calling get_y_axis_label.

Examples
obj.get_y_axis_label(label, edge)
prepare_for_nonlinear_transform
method
def prepare_for_nonlinear_transform(self, num_inserted_curves=50)

Mark the plane as prepared for nonlinear transforms.

Parameters
num_inserted_curves

Metadata hint describing the requested curve density.

Returns

The plane instance for chaining.

Examples
obj.prepare_for_nonlinear_transform(num_inserted_curves)
remove
method
def remove(self, *objects)

Remove method.

Parameters
objects

Objects accepted by remove.

Returns

The updated NumberPlane after calling remove.

Examples
obj.remove(objects)

AnnotationDot

classdepth 3

manim.AnnotationDot

class AnnotationDot(Dot)

Annotation Dot class.

Parameters
Dot

Dot accepted by AnnotationDot.

Returns

A AnnotationDot instance ready to add to a scene or combine with other mobjects.

Examples
obj = AnnotationDot()

Annulus

classdepth 3

manim.Annulus

class Annulus(AnnularSector)

Annulus class.

Parameters
AnnularSector

Annular Sector accepted by Annulus.

Returns

A Annulus instance ready to add to a scene or combine with other mobjects.

Examples
obj = Annulus()

ArcBrace

classdepth 3

manim.ArcBrace

class ArcBrace(BraceBetweenPoints)

Arc Brace class.

Parameters
BraceBetweenPoints

Brace Between Points accepted by ArcBrace.

Returns

A ArcBrace instance ready to add to a scene or combine with other mobjects.

Examples
obj = ArcBrace()

ArcPolygonFromArcs

classdepth 3

manim.ArcPolygonFromArcs

class ArcPolygonFromArcs(ArcPolygon)

Arc Polygon From Arcs class.

Parameters
ArcPolygon

Arc Polygon accepted by ArcPolygonFromArcs.

Returns

A ArcPolygonFromArcs instance ready to add to a scene or combine with other mobjects.

Examples
obj = ArcPolygonFromArcs()

ArrowTip

classdepth 3

manim.ArrowTip

class ArrowTip(ArrowTriangleFilledTip)

Arrow Tip class.

Parameters
ArrowTriangleFilledTip

Arrow Triangle Filled Tip accepted by ArrowTip.

Returns

A ArrowTip instance ready to add to a scene or combine with other mobjects.

Examples
obj = ArrowTip()

ArrowTriangleTip

classdepth 3

manim.ArrowTriangleTip

class ArrowTriangleTip(ArrowTriangleFilledTip)

Arrow Triangle Tip class.

Parameters
ArrowTriangleFilledTip

Arrow Triangle Filled Tip accepted by ArrowTriangleTip.

Returns

A ArrowTriangleTip instance ready to add to a scene or combine with other mobjects.

Examples
obj = ArrowTriangleTip()

BackgroundRectangle

classdepth 3

manim.BackgroundRectangle

class BackgroundRectangle(SurroundingRectangle)

Filled rectangle sized to sit behind another mobject.

Parameters
SurroundingRectangle

Surrounding Rectangle accepted by BackgroundRectangle.

Returns

A BackgroundRectangle instance ready to add to a scene or combine with other mobjects.

Examples
obj = BackgroundRectangle()

BraceLabel

classdepth 3

manim.BraceLabel

class BraceLabel(VGroup)

Brace Label class.

Parameters
VGroup

VGroup accepted by BraceLabel.

Returns

A BraceLabel instance ready to add to a scene or combine with other mobjects.

Examples
obj = BraceLabel()

Cross

classdepth 3

manim.Cross

class Cross(VGroup)

Simple diagonal cross mark used for highlights and failure indicators.

Parameters
VGroup

VGroup accepted by Cross.

Returns

A Cross instance ready to add to a scene or combine with other mobjects.

Examples
obj = Cross()

CurvedArrow

classdepth 3

manim.CurvedArrow

class CurvedArrow(ArcBetweenPoints)

Curved Arrow class.

Parameters
ArcBetweenPoints

Arc Between Points accepted by CurvedArrow.

Returns

A CurvedArrow instance ready to add to a scene or combine with other mobjects.

Examples
obj = CurvedArrow()

Cutout

classdepth 3

manim.Cutout

class Cutout(VGroup)

Cutout class.

Parameters
VGroup

VGroup accepted by Cutout.

Returns

A Cutout instance ready to add to a scene or combine with other mobjects.

Examples
obj = Cutout()

Difference

classdepth 3

manim.Difference

class Difference(VGroup)

Difference class.

Parameters
VGroup

VGroup accepted by Difference.

Returns

A Difference instance ready to add to a scene or combine with other mobjects.

Examples
obj = Difference()

Exclusion

classdepth 3

manim.Exclusion

class Exclusion(VGroup)

Exclusion class.

Parameters
VGroup

VGroup accepted by Exclusion.

Returns

A Exclusion instance ready to add to a scene or combine with other mobjects.

Examples
obj = Exclusion()

Intersection

classdepth 3

manim.Intersection

class Intersection(VGroup)

Intersection class.

Parameters
VGroup

VGroup accepted by Intersection.

Returns

A Intersection instance ready to add to a scene or combine with other mobjects.

Examples
obj = Intersection()

LabeledDot

classdepth 3

manim.LabeledDot

class LabeledDot(VGroup)

Labeled Dot class.

Parameters
VGroup

VGroup accepted by LabeledDot.

Returns

A LabeledDot instance ready to add to a scene or combine with other mobjects.

Examples
obj = LabeledDot()

Matrix

classdepth 3

manim.Matrix

class Matrix(VGroup)

Minimal matrix helper that arranges entries in rows with brackets.

Parameters
VGroup

VGroup accepted by Matrix.

Returns

A Matrix instance ready to add to a scene or combine with other mobjects.

Examples
obj = Matrix()

Paragraph

classdepth 3

manim.Paragraph

class Paragraph(VGroup)

Vertical stack of text lines with alignment controls.

Parameters
VGroup

VGroup accepted by Paragraph.

Returns

A Paragraph instance ready to add to a scene or combine with other mobjects.

Examples
obj = Paragraph()

StealthTip

classdepth 3

manim.StealthTip

class StealthTip(ArrowTriangleFilledTip)

Stealth Tip class.

Parameters
ArrowTriangleFilledTip

Arrow Triangle Filled Tip accepted by StealthTip.

Returns

A StealthTip instance ready to add to a scene or combine with other mobjects.

Examples
obj = StealthTip()

TangentialArc

classdepth 3

manim.TangentialArc

class TangentialArc(ArcBetweenPoints)

Tangential Arc class.

Parameters
ArcBetweenPoints

Arc Between Points accepted by TangentialArc.

Returns

A TangentialArc instance ready to add to a scene or combine with other mobjects.

Examples
obj = TangentialArc()

Title

classdepth 3

manim.Title

class Title(VGroup)

Minimal title helper aligned to the top edge like Manim's Title.

Parameters
VGroup

VGroup accepted by Title.

Returns

A Title instance ready to add to a scene or combine with other mobjects.

Examples
obj = Title()

Union

classdepth 3

manim.Union

class Union(VGroup)

Union class.

Parameters
VGroup

VGroup accepted by Union.

Returns

A Union instance ready to add to a scene or combine with other mobjects.

Examples
obj = Union()

Table

classdepth 3

manim.Table

class Table(VGroup)

Simple table made of rectangle/text cells with ``get_rows()`` compatibility.

Parameters
VGroup

VGroup accepted by Table.

Returns

A Table instance ready to add to a scene or combine with other mobjects.

Examples
obj = Table()
Methods
1
get_rows
method
def get_rows(self)

Get rows method.

Returns

The updated Table after calling get_rows.

Examples
obj.get_rows()

BulletedList

classdepth 3

manim.BulletedList

class BulletedList(VGroup)

Vertical stack of TeX items with bullet dots, mirroring Manim's helper.

Parameters
VGroup

VGroup accepted by BulletedList.

Returns

A BulletedList instance ready to add to a scene or combine with other mobjects.

Examples
obj = BulletedList()
Methods
4
fade_all_but
method
def fade_all_but(self, tex, opacity=0.5, substring=True)

Fade all but method.

Parameters
tex

Tex accepted by fade_all_but.

opacity

Opacity accepted by fade_all_but.

substring

Substring accepted by fade_all_but.

Returns

The updated BulletedList after calling fade_all_but.

Examples
obj.fade_all_but(tex, opacity)
get_part_by_tex
method
def get_part_by_tex(self, tex, substring=True)

Get part by tex method.

Parameters
tex

Tex accepted by get_part_by_tex.

substring

Substring accepted by get_part_by_tex.

Returns

The updated BulletedList after calling get_part_by_tex.

Examples
obj.get_part_by_tex(tex, substring)
get_parts_by_tex
method
def get_parts_by_tex(self, tex, substring=True)

Get parts by tex method.

Parameters
tex

Tex accepted by get_parts_by_tex.

substring

Substring accepted by get_parts_by_tex.

Returns

The updated BulletedList after calling get_parts_by_tex.

Examples
obj.get_parts_by_tex(tex, substring)
set_color_by_tex
method
def set_color_by_tex(self, tex, color, substring=True)

Set color by tex method.

Parameters
tex

Tex accepted by set_color_by_tex.

color

Color accepted by set_color_by_tex.

substring

Substring accepted by set_color_by_tex.

Returns

The updated BulletedList after calling set_color_by_tex.

Examples
obj.set_color_by_tex(tex, color)

BraceText

classdepth 4

manim.BraceText

class BraceText(BraceLabel)

Brace Text class.

Parameters
BraceLabel

Brace Label accepted by BraceText.

Returns

A BraceText instance ready to add to a scene or combine with other mobjects.

Examples
obj = BraceText()

CurvedDoubleArrow

classdepth 4

manim.CurvedDoubleArrow

class CurvedDoubleArrow(CurvedArrow)

Curved Double Arrow class.

Parameters
CurvedArrow

Curved Arrow accepted by CurvedDoubleArrow.

Returns

A CurvedDoubleArrow instance ready to add to a scene or combine with other mobjects.

Examples
obj = CurvedDoubleArrow()
Module

numpy

Minimal NumPy-compatible helpers exposed as the ``numpy`` shim.

Source Path
src/runtime/python_stdlib/numpy/__init__.py

Constants

11

abs

constant

numpy.abs

abs_value

Abs constant.

Examples
value = abs

arctan

constant

numpy.arctan

arctan_value

Arctan constant.

Examples
value = arctan

arctan2

constant

numpy.arctan2

arctan2_value

Arctan2 constant.

Examples
value = arctan2

cos

constant

numpy.cos

cos_value

Cos constant.

Examples
value = cos

e

constant

numpy.e

2.718281828459045

Base of the natural logarithm.

Examples
value = e

linalg

constant

numpy.linalg

_NPLinalgModule()

Linalg constant.

Examples
value = linalg

pi

constant

numpy.pi

3.141592653589793

Ratio of a circle's circumference to its diameter.

Examples
value = pi

sin

constant

numpy.sin

sin_value

Sin constant.

Examples
value = sin

sqrt

constant

numpy.sqrt

sqrt_value

Sqrt constant.

Examples
value = sqrt

tan

constant

numpy.tan

tan_value

Tan constant.

Examples
value = tan

tau

constant

numpy.tau

6.283185307179586

Full turn constant, equal to ``2 * pi``.

Examples
value = tau

Functions

16

abs_value

function

numpy.abs_value

def abs_value(value)

Abs value function.

Parameters
value

Value accepted by abs_value.

Returns

A numpy-compatible value produced by abs_value.

Examples
result = np.abs_value(value)

arange

function

numpy.arange

def arange(start, stop=None, step=1)

Return evenly spaced values in the half-open interval ``[start, stop)``.

Parameters
start

First value, or the exclusive stop value if ``stop`` is omitted.

stop

Exclusive upper bound.

step

Signed increment between values.

Returns

A list of scalar samples.

Examples
ticks = np.arange(0, 1.1, 0.1)

arctan_value

function

numpy.arctan_value

def arctan_value(value)

Arctan value function.

Parameters
value

Value accepted by arctan_value.

Returns

A numpy-compatible value produced by arctan_value.

Examples
result = np.arctan_value(value)

arctan2_value

function

numpy.arctan2_value

def arctan2_value(y, x)

Arctan2 value function.

Parameters
y

Y accepted by arctan2_value.

x

X accepted by arctan2_value.

Returns

A numpy-compatible value produced by arctan2_value.

Examples
result = np.arctan2_value(y, x)

around

function

numpy.around

def around(value, decimals=0)

Around function.

Parameters
value

Value accepted by around.

decimals

Decimals accepted by around.

Returns

A numpy-compatible value produced by around.

Examples
result = np.around(value, decimals)

array

function

numpy.array

def array(value, dtype=None)

Convert a value or nested sequence into a list-backed array shim.

Parameters
value

Scalar or nested sequence to normalize.

dtype

Accepted for compatibility and currently ignored.

Returns

A list-backed array representation understood by the runtime.

Examples
pts = np.array([[0, 0, 0], [1, 1, 0]])

clip

function

numpy.clip

def clip(value, min_value, max_value)

Clamp scalars or nested lists into the provided numeric range.

Parameters
value

Scalar or nested list to clamp.

min_value

Inclusive lower bound.

max_value

Inclusive upper bound.

Returns

A clamped value with the same basic shape as the input.

Examples
volume = np.clip(volume, 0, 1)

cos_value

function

numpy.cos_value

def cos_value(value)

Cos value function.

Parameters
value

Value accepted by cos_value.

Returns

A numpy-compatible value produced by cos_value.

Examples
result = np.cos_value(value)

exp

function

numpy.exp

def exp(value)

Exp function.

Parameters
value

Value accepted by exp.

Returns

A numpy-compatible value produced by exp.

Examples
result = np.exp(value)

linspace

function

numpy.linspace

def linspace(start, stop, num=50)

Return evenly spaced scalar samples between ``start`` and ``stop``.

Parameters
start

First sample value.

stop

Last sample value.

num

Number of requested samples.

Returns

A list of evenly spaced numeric samples.

Examples
ticks = np.linspace(0, TAU, 8)

roll

function

numpy.roll

def roll(arr, shift, axis=0)

Roll a 1D list-like sequence by ``shift`` positions.

Parameters
arr

Sequence to rotate.

shift

Signed roll amount.

axis

Accepted for compatibility and currently ignored.

Returns

A sequence with elements rotated by the requested shift.

Examples
rotated = np.roll([1, 2, 3, 4], 1)

round

function

numpy.round

def round(value, decimals=0)

Round scalars or nested sequences to a fixed precision.

Parameters
value

Scalar or nested sequence to round.

decimals

Number of decimal places to preserve.

Returns

A rounded scalar or array-like wrapper.

Examples
points = np.round(np.linspace(0, 1, 5), 2)

sin_value

function

numpy.sin_value

def sin_value(value)

Sin value function.

Parameters
value

Value accepted by sin_value.

Returns

A numpy-compatible value produced by sin_value.

Examples
result = np.sin_value(value)

sqrt_value

function

numpy.sqrt_value

def sqrt_value(value)

Sqrt value function.

Parameters
value

Value accepted by sqrt_value.

Returns

A numpy-compatible value produced by sqrt_value.

Examples
result = np.sqrt_value(value)

tan_value

function

numpy.tan_value

def tan_value(value)

Tan value function.

Parameters
value

Value accepted by tan_value.

Returns

A numpy-compatible value produced by tan_value.

Examples
result = np.tan_value(value)

uint8

function

numpy.uint8

def uint8(value)

Uint8 function.

Parameters
value

Value accepted by uint8.

Returns

A numpy-compatible value produced by uint8.

Examples
result = np.uint8(value)