BLACK
constant"#000000"Neutral black color constant used for fills and backgrounds.
Static API reference generated from the bundled Python source used by the compiler. This page is intended to be the canonical web view of the runtime surface that scenes, docs automation, and future MCP tooling can query.
This reference is generated from the bundled Python stdlib used by the compiler. Public classes, functions, and methods are indexed directly from the runtime source so the website and future MCP tooling read the same API surface.
Core Manim-compatible runtime primitives exposed to user scene code.
src/runtime/python_stdlib/manim/_core.py
"#000000"Neutral black color constant used for fills and backgrounds.
"#3b82f6"Primary blue color constant used by many examples and defaults.
PI / 180Conversion factor from degrees to radians.
(0, -1, 0)Unit vector that points downward in scene coordinates.
2.718281828459045Base of the natural logarithm.
"#22c55e"Primary green color constant used by many examples and defaults.
(-1, 0, 0)Unit vector that points left in scene coordinates.
(0, 0, 0)Origin point for the default scene coordinate system.
3.141592653589793Ratio of a circle's circumference to its diameter.
"#ef4444"Primary red color constant used by many examples and defaults.
(1, 0, 0)Unit vector that points right in scene coordinates.
6.283185307179586Full turn constant, equal to ``2 * PI``.
(0, 1, 0)Unit vector that points upward in scene coordinates.
"#ffffff"Neutral white color constant used for strokes and text.
"#eab308"Primary yellow color constant used for highlights and labels.
class AnimationProxyThis symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def set_value(self, value)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def increment_value(self, delta)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def shift(self, vector)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def move_to(self, point)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def rotate(self, angle, axis=OUT, about_point=None)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def scale(self, factor, about_point=None)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def set_color(self, color)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def set_opacity(self, opacity)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def set_fill(self, color=None, opacity=None)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def set_stroke(self, color=None, width=None, opacity=None)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def set_stroke_width(self, width)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def set(self, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class Arrow(MathObject)Line segment with an arrow tip oriented toward the end point.
Start point of the arrow shaft.
End point of the arrow shaft.
Additional style or placement arguments.
arrow = Arrow(LEFT, RIGHT, color=YELLOW)class Axes(MathObject)Coordinate axes with configurable ranges and visual lengths.
``(min, max, step)`` tuple for the x-axis.
``(min, max, step)`` tuple for the y-axis.
Rendered x-axis length in scene units.
Rendered y-axis length in scene units.
Shared axis style configuration.
X-axis-specific style overrides.
Y-axis-specific style overrides.
Additional style or placement arguments.
axes = Axes(x_range=[0, 4, 1], y_range=[0, 3, 1]).to_edge(DOWN, buff=0.6)def move_to(self, point_or_mobject, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def shift(self, vector)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def c2p(self, x, y)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def coords_to_point(self, *coords)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_origin(self)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_x_axis_label(self, label, edge=RIGHT, direction=DOWN, buff=0.25, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_y_axis_label(self, label, edge=UP, direction=LEFT, buff=0.25, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_axis_labels(self, x_label="x", y_label="y", **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_horizontal_line(self, point, line_func=None, color=None, stroke_width=2, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_vertical_line(self, point, line_func=None, color=None, stroke_width=2, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def plot(self, func, x_range=None, color=None, stroke_width=3, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class BackgroundAudioBlockContext manager for syncing background audio timing
class Brace(MathObject)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_text(self, text, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class Circle(MathObject)Circular outline or filled shape with Manim-style defaults.
Circle radius in scene units.
Additional style or placement arguments.
circle = Circle(radius=1.5, color=BLUE)def get_radius(self)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def point_at_angle(self, angle_degrees)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class DashedLine(Line)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class DecimalNumber(MathObject)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def set_value(self, value)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_value(self)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class Dot(Circle)Filled circular point marker.
class FunctionGraph(MathObject)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class Group(MathObject)Container that groups child mobjects without changing their types.
def add(self, *objects)Append one or more child mobjects to the group.
def remove(self, *objects)Remove one or more child mobjects from the group.
def get_center(self, query_time=None)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def arrange(self, direction=RIGHT, buff=DEFAULT_MOBJECT_TO_MOBJECT_BUFFER, center=True, **kwargs)Lay out children sequentially along a direction with spacing.
def arrange_in_grid(self, rows=None, cols=None, buff=0.5, center=True, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class ImageMobject(MathObject)Raster image loaded from the user workspace or scene asset map.
File path or URL-like source string.
Optional image asset id from the scene asset map.
Optional rendered width.
Optional rendered height.
Asset kind metadata.
Optional MIME type metadata.
Additional style or placement arguments.
logo = ImageMobject("assets/logo.png").scale(0.8)class ImplicitFunction(MathObject)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class Line(MathObject)Straight segment defined by explicit start and end points.
Start point of the segment.
End point of the segment.
Additional style or placement arguments.
class MathObjectBase class for drawable objects in the Manim Web runtime.
def get_property(self, name)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def set_property(self, name, value)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def move_to(self, point_or_mobject, **kwargs)Move the object center to a point or another mobject's center.
Target point or mobject to align to.
Accepted for API compatibility.
The mutated mobject so calls can be chained.
def shift(self, vector)Translate the object by a vector in scene coordinates.
Translation vector expressed in scene coordinates.
The mutated mobject so calls can be chained.
def scale(self, factor, about_point=None)Scale the object, optionally around an explicit pivot.
Scalar or per-axis scale value.
Optional pivot used for orbit-style scaling.
The mutated mobject so calls can be chained.
def rotate(self, angle, axis=OUT, about_point=None)Rotate the object, optionally around an explicit pivot.
Rotation amount in radians.
Rotation axis vector (3D compatibility).
Optional pivot used for orbit-style rotation.
The mutated mobject so calls can be chained.
def generate_target(self)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def add_updater(self, updater)Register a callback that runs while the scene timeline advances.
def remove_updater(self, updater)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def clear_updaters(self)Disable all previously registered updater callbacks.
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.
Reference object or point.
Placement direction relative to the reference.
Spacing between the reference and this object.
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.
The mutated mobject so calls can be chained.
def to_edge(self, edge, buff=0.5)Move the object to a frame edge while respecting its own bounds.
Direction of the frame edge to align to.
Margin to keep from the edge.
The mutated mobject so calls can be chained.
def to_corner(self, corner, buff=0.5)Move the object to a frame corner while respecting its own bounds.
Corner direction such as ``UL`` or ``DR``.
Margin to keep from the corner.
The mutated mobject so calls can be chained.
def align_to(self, mobject_or_point, direction)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_center(self, query_time=None)Return the object center, optionally sampled at a specific timeline time.
Optional timeline time to sample against.
A 3D point tuple representing the object center.
def center(self)Manim convenience alias: move the mobject to the origin and return self. Enables chaining like .arrange(...).center().shift(...).
def to_top(self, buff=0.5)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def to_bottom(self, buff=0.5)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def to_left(self, buff=0.5)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def to_right(self, buff=0.5)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def to_ul(self, buff=0.5)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def to_ur(self, buff=0.5)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def to_dl(self, buff=0.5)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def to_dr(self, buff=0.5)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_x(self)Return the x-coordinate of the mobject center.
def get_y(self)Return the y-coordinate of the mobject center.
def get_z(self)Return the z-coordinate of the mobject center.
def get_coord(self, dim)Return the coordinate of the mobject center along one dimension.
Coordinate index ``0`` for x, ``1`` for y, or ``2`` for z.
The numeric coordinate value. Invalid indices fall back to ``0``.
def set_coord(self, value, dim, direction=ORIGIN)Move the mobject so a chosen coordinate matches ``value``.
Target coordinate value.
Coordinate index ``0`` for x, ``1`` for y, or ``2`` for z.
Alignment direction. ``ORIGIN`` aligns the center, while axis directions such as ``LEFT`` or ``UP`` align the corresponding edge similarly to Manim.
The mutated mobject so calls can be chained.
def set_x(self, x, direction=ORIGIN)Move the mobject so its x-coordinate matches ``x``.
def set_y(self, y, direction=ORIGIN)Move the mobject so its y-coordinate matches ``y``.
def set_z(self, z, direction=ORIGIN)Move the mobject so its z-coordinate matches ``z``.
def get_edge_center(self, direction)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_top(self)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_bottom(self)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_left(self)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_right(self)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_start(self)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_end(self)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def append_points(self, points)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def point_from_proportion(self, alpha)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_corner(self, direction)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def set_color(self, color)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def set_opacity(self, opacity)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def set_fill_opacity(self, opacity)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def set_fill(self, color=None, opacity=None)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def set_stroke(self, color=None, width=None, opacity=None)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def set_stroke_width(self, width)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_opacity(self)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_fill_opacity(self)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_stroke_opacity(self)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def become(self, mobject, match_center=False)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class MathTex(Tex)Math-oriented ``Tex`` variant that accepts multiple fragments.
One or more TeX fragments.
Text size in pixels.
Snake-case alias for ``fontSize``.
Separator inserted between fragments.
Additional style or placement arguments.
eq = MathTex(r"e^{i\\pi} + 1 = 0")class Mobject(MathObject)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class NumberLine(MathObject)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class NumberPlane(MathObject)Cartesian grid with helpers for converting coordinates to points.
``(min, max, step)`` tuple for the x-axis.
``(min, max, step)`` tuple for the y-axis.
Additional style or placement arguments.
plane = NumberPlane().scale(0.9)
dot = Dot(plane.c2p(2, 1))def c2p(self, x, y)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def coords_to_point(self, x, y)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def plot(self, func, x_range=None, color=None, stroke_width=3, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class ParametricFunction(MathObject)Curve generated by sampling a callable or expression over ``t_range``.
class Polygon(MathObject)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class Rectangle(MathObject)Axis-aligned rectangle parameterized by width and height.
Rectangle width in scene units.
Rectangle height in scene units.
Internal type override used by subclasses.
Additional style or placement arguments.
class RegularPolygon(MathObject)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class RoundedRectangle(Rectangle)Rectangle variant with rounded corners.
class SceneTop-level animation container that owns the timeline and exported state.
Upper-bound scene duration used before timeline baking resolves the final value.
Target frames per second for preview and export.
Output width in pixels.
Output height in pixels.
Scene background color.
Whether to show the debug grid in supported viewers.
scene = Scene(width=1280, height=720, fps=30)
scene.add(Text("Hello"))
scene.wait(1)def construct(self)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def add_background_audio(self, audio_id, url="", volume=1, mp3="")This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def set_background_audios(self, audio_map)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def add_image_asset(self, image_id, url="", width=0, height=0, kind="image", mimeType="", path="")This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def set_images(self, image_map)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_image_asset(self, image_id, default=None)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def play_background_audio_block(self, audio_id, volume=None, fade_in=0, fade_out=0, loop=False)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
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.
Animation objects, animation groups, or animate proxies.
Default duration used when an animation does not set one.
Optional easing callback.
Alias accepted for compatibility with older code.
Offset ratio applied when sequencing multiple animations.
Additional animation keyword arguments such as easing hints.
The scene instance for chaining.
scene.play(Create(circle), run_time=1.2)
scene.play(square.animate.shift(RIGHT * 2), rate_func=linear)def move_camera(self, position=None, zoom=None, run_time=1, rate_func=None)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def zoom_camera(self, zoom=None, factor=None, run_time=1, rate_func=None)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def add_fixed_in_frame_mobjects(self, *objs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def remove_fixed_in_frame_mobjects(self, *objs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def add_fixed_orientation_mobjects(self, *objs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def add(self, *objs)Add mobjects to the scene immediately without an animation.
Mobjects to register and make visible.
The scene instance for chaining.
def remove(self, *objs)Hide mobjects from the current timeline time onward.
def wait(self, duration=1)Advance the scene clock without adding a new animation.
Number of seconds to advance the scene clock.
The scene instance for chaining.
def export(self)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class Square(MathObject)Square mobject sampled densely for smoother morphing.
Edge length in scene units.
Additional style or placement arguments.
square = Square(side_length=2).set_color(WHITE)class SurroundingRectangle(Rectangle)Rectangle that surrounds a mobject - exports as 'Rectangle' type
class SVGMobject(ImageMobject)SVG-backed image mobject.
class Tex(MathObject)LaTeX-like text mobject represented as a single tex string.
TeX source string.
Text size in pixels.
Snake-case alias for ``fontSize``.
Additional style or placement arguments.
class Text(MathObject)Plain text mobject rendered with the runtime text renderer.
Display string.
Text size in pixels.
Snake-case alias for ``fontSize``.
Additional style or placement arguments.
title = Text("Polar Symmetry", font_size=48, color=BLUE)def get_text(self)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class TracedPath(VMobject)Continuously trace points returned by a callback over time.
def update_path(self, mob, dt)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class Triangle(MathObject)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class ValueTracker(MathObject)Numeric container used to drive animations and redraw callbacks.
Initial numeric value.
Additional mobject configuration.
tracker = ValueTracker(0)
scene.play(tracker.animate.set_value(10))def get_value(self)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def set_value(self, value)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def increment_value(self, delta)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class Vector(Arrow)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class VGroup(Group)Group variant used for vectorized collections of mobjects.
class VMobject(MathObject)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def has_points(self)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def set_points(self, points)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def start_new_path(self, point)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def add_line_to(self, point)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def set_points_as_corners(self, points)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def set_points_smoothly(self, points)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class VoiceoverBlockContext manager for syncing animations with voiceover timing
class VoiceoverScene(Scene)Scene subclass with voiceover and background-audio helper blocks.
class Demo(VoiceoverScene):
def construct(self):
with self.play_voiceover_block("intro"):
self.play(Write(Text("Narrated scene")))def add_voiceover(self, voiceover_id, text, duration)Register a voiceover with its text and duration.
Unique identifier for this voiceover
The voiceover text/description
Duration in seconds
def set_voiceovers(self, voiceover_map)Set multiple voiceovers at once.
Dictionary mapping voiceover_id to {text, duration}
def play_voiceover_block(self, voiceover_id)Context manager for playing animations synchronized with voiceover.
def create_header(self, title_tex, subtitle_tex)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def export(self)Export scene data including voiceover information
def AddTextLetterByLetter(obj, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
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.
Callback returning a freshly constructed mobject.
A mobject kept in sync with the callback result on every frame.
tracker = ValueTracker(0)
dot = always_redraw(lambda: Dot(RIGHT * tracker.get_value()))def AnimationGroup(*animations, lag_ratio=0, run_time=None, **kwargs)Run multiple animations together as a grouped unit.
Child animations to run together.
Relative offset between child animations.
Optional total duration override.
Additional group options passed through to playback.
A grouped animation descriptor consumed by ``Scene.play``.
scene.play(AnimationGroup(FadeIn(left), FadeIn(right), lag_ratio=0.1))def ApplyMethod(method, *args, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ApplyPointwiseFunction(func, mobject, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def bounce(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def BraceBetweenPoints(point1, point2, direction=RIGHT, **kwargs)Create a brace between two points
def ceil(x)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ClockwiseTransform(obj, target_mobject, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def cos(x)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def CounterclockwiseTransform(obj, target_mobject, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def Create(obj, run_time=None, **kwargs)Animate a mobject as if it is being drawn into the scene.
Mobject to animate.
Optional animation duration override.
Additional animation options passed through to playback.
A normalized animation descriptor consumed by ``Scene.play``.
scene.play(Create(Square()), run_time=1)def degrees_to_rad(degrees)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def double_smooth(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in_back(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in_bounce(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in_circ(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in_cubic(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in_elastic(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in_expo(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in_out(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in_out_back(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in_out_bounce(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in_out_circ(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in_out_cubic(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in_out_elastic(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in_out_expo(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in_out_quad(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in_out_quart(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in_out_quint(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in_out_sine(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in_quad(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in_quart(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in_quint(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_in_sine(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_out(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_out_back(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_out_bounce(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_out_circ(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_out_cubic(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_out_elastic(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_out_expo(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_out_quad(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_out_quart(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_out_quint(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ease_out_sine(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def elastic(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def exponential_decay(t, half_life=0.1)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def FadeIn(obj, run_time=None, **kwargs)Animate a mobject from invisible to visible.
Mobject to reveal.
Optional animation duration override.
Additional animation options such as ``shift`` or ``scale``.
A normalized animation descriptor consumed by ``Scene.play``.
scene.play(FadeIn(card, shift=UP * 0.2))def FadeOut(obj, run_time=None, **kwargs)Animate a mobject from visible to invisible.
def Flash(point, color=YELLOW, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def floor(x)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def FocusOn(obj, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_image_asset(image_id, default=None)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_images_map()This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def GrowArrow(obj, run_time=None, **kwargs)Animate an arrow-like mobject growing into view.
Arrow or line-like mobject to reveal.
Optional animation duration override.
Additional animation options passed through to playback.
A normalized animation descriptor consumed by ``Scene.play``.
scene.play(GrowArrow(Arrow(LEFT, RIGHT)))def GrowFromCenter(obj, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def GrowFromPoint(obj, point, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def Indicate(obj, scale_factor=1.1, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def interpolate_color(colora, colorb, amount)Linearly interpolate between two colors.
def LaggedStart(*animations, lag_ratio=0.1, run_time=None, **kwargs)Run multiple animations with a staggered start offset.
def LaggedStartMap(animation_func, group, lag_ratio=0.1, run_time=None, **kwargs)Map an animation factory across a group and stagger the results.
Callable that creates one animation per item.
Group or iterable of mobjects.
Fractional stagger applied between generated animations.
Optional duration override for the generated group.
Extra keyword arguments forwarded to ``animation_func``.
A grouped animation descriptor consumed by ``Scene.play``.
def linear(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def lingering(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def MoveAlongPath(obj, path, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def MoveTo(obj, point, run_time=None, **kwargs)Animate a move to a target point.
Mobject to move.
Destination point.
Optional animation duration override.
Additional animation options passed through to playback.
A normalized transform descriptor consumed by ``Scene.play``.
scene.play(MoveTo(dot, UP * 2))def MoveToTarget(obj, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def not_quite_there(t, proportion=0.7)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def radians(degrees)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def ReplacementTransform(obj, target_mobject, run_time=None, **kwargs)Transform one mobject into another while conceptually replacing it.
def Rotate(obj, angle=PI, run_time=None, axis=OUT, **kwargs)Animate a rotation transform, optionally around ``about_point``.
Mobject to rotate.
Rotation amount in radians.
Optional animation duration override.
Rotation axis vector (3D compatibility).
Additional animation options, including ``about_point``.
A normalized transform descriptor consumed by ``Scene.play``.
scene.play(Rotate(square, angle=PI / 2, about_point=ORIGIN))def running_start(t, pull_factor=-0.5)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def rush_from(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def rush_into(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def Scale(obj, factor, run_time=None, **kwargs)Animate a scale transform, optionally around ``about_point``.
Mobject to scale.
Scalar or per-axis scale value.
Optional animation duration override.
Additional animation options, including ``about_point``.
A normalized transform descriptor consumed by ``Scene.play``.
scene.play(Scale(group, 1.2, about_point=ORIGIN))def ScaleInPlace(obj, factor, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def Shift(obj, vector, run_time=None, **kwargs)Animate a translation by a vector.
def ShrinkToCenter(obj, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def sin(x)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def slow_into(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def smooth(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def sqrt(x)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def squish_rate_func(func, a=0.4, b=0.6)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def tan(x)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def there_and_back(t)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def there_and_back_with_pause(t, pause_ratio=1.0 / 3.0)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def Transform(obj, target_mobject, run_time=None, **kwargs)Morph one mobject or group into another target state.
Source mobject or group.
Target mobject or group to morph toward.
Optional animation duration override.
Additional transform options such as ``path_arc``.
A normalized transform descriptor consumed by ``Scene.play``.
scene.play(Transform(square, circle), run_time=0.8)def TransformFromCopy(obj, target_mobject, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def Uncreate(obj, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def Unwrite(obj, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def Wait(run_time=1, **kwargs)Consume time inside animation groups without mutating scene objects.
def wiggle(t, wiggles=2)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def Wiggle(obj, angle=PI/8, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def Write(obj, run_time=None, **kwargs)Animate text or strokes with a writing-style reveal.
Text or stroke-based mobject to reveal.
Optional animation duration override.
Additional animation options passed through to playback.
A normalized animation descriptor consumed by ``Scene.play``.
scene.play(Write(Text("Hello world")))Compatibility helpers and Manim-style convenience shims.
src/runtime/python_stdlib/manim/_patches.py
"bold"Font-weight alias matching Manim's ``BOLD`` text style constant.
"italic"Font-slant alias matching Manim's ``ITALIC`` text style constant.
"normal"Font-weight alias matching Manim's ``NORMAL`` text style constant.
class Arrow3D(Line3D)3D line segment with an arrow tip at the end point.
Arrow tail point.
Arrow tip anchor point.
Length of the rendered arrow tip.
Width of the rendered arrow tip.
Additional style or placement arguments.
class ArrowTriangleFilledTip(Polygon)Filled triangular arrow tip sized with Manim-like defaults.
class BackgroundRectangle(SurroundingRectangle)Filled rectangle sized to sit behind another mobject.
class CameraFrame(_CameraFrame)3D camera frame wrapper exposed by ``ThreeDScene.camera.frame``.
class Code(VGroup)Manim-like code block with language-aware token colors and optional line numbers.
class ColorLightweight color wrapper used by compatibility properties.
def to_rgb(self)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class Cone(_ThreeDBase)Circular cone with a capped base.
Radius of the circular base.
Total cone height.
``(u_steps, v_steps)`` mesh sampling density.
Additional style or placement arguments.
cone = Cone(base_radius=0.8, height=1.8, color=ORANGE)class Cross(VGroup)Simple diagonal cross mark used for highlights and failure indicators.
class Cube(_ThreeDBase)Axis-aligned cube centered at the local origin.
Edge length of the cube in scene units.
Additional style or placement arguments.
cube = Cube(side_length=1.8, color=BLUE, fill_opacity=0.4)class CubicBezier(MathObject)Cubic Bezier curve defined by four control points.
class Cylinder(_ThreeDBase)Circular cylinder with top and bottom caps.
Radius of the cylinder body.
Total cylinder height.
``(u_steps, v_steps)`` mesh sampling density.
Additional style or placement arguments.
tube = Cylinder(radius=0.7, height=2.0, color=GREEN)class Dodecahedron(Polyhedron)Regular dodecahedron convenience polyhedron.
class Dot3D(_ThreeDBase)Small filled 3D marker positioned at a single point.
Center point in scene coordinates.
Rendered radius of the dot.
Additional style or placement arguments.
marker = Dot3D(point=[0.5, 0.3, 1.2], radius=0.08, color=YELLOW)class Icosahedron(Polyhedron)Regular icosahedron convenience polyhedron.
class Integer(DecimalNumber)Integer-valued number mobject with animate/set_value support.
def set_value(self, value)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class Line3D(_ThreeDBase)Straight 3D segment between explicit start and end points.
Segment start point.
Segment end point.
Additional style or placement arguments.
segment = Line3D(start=[-1, -0.5, 0], end=[1, 0.5, 0.8], color=WHITE)class MarkupText(Text)Text that accepts simple inline markup tags and strips them for rendering.
class Matrix(VGroup)Minimal matrix helper that arranges entries in rows with brackets.
class NumberPlane(Axes)Cartesian grid plane with vector and coordinate-label helpers.
``(min, max, step)`` tuple for the x-axis.
``(min, max, step)`` tuple for the y-axis.
Rendered x-axis length in scene units.
Rendered y-axis length in scene units.
Shared axis style configuration.
X-axis-specific style overrides.
Y-axis-specific style overrides.
Style metadata for primary grid lines.
Style metadata for secondary grid lines.
Density ratio for faded grid lines.
Compatibility flag stored in exported metadata.
Additional style or placement arguments.
plane = NumberPlane(x_range=[-4, 4, 1], y_range=[-3, 3, 1])def add(self, *objects)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def remove(self, *objects)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def get_vector(self, coords, **kwargs)Return an arrow from the plane origin to a coordinate on the plane.
Target coordinate pair.
Additional ``Arrow`` styling arguments.
An ``Arrow`` whose endpoints are resolved through the plane mapping.
def prepare_for_nonlinear_transform(self, num_inserted_curves=50)Mark the plane as prepared for nonlinear transforms.
Metadata hint describing the requested curve density.
The plane instance for chaining.
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.
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.
def get_axis_labels(self, x_label="x", y_label="y", **kwargs)Return a ``VGroup`` containing x and y axis labels.
def get_coordinate_labels(self, x_values=None, y_values=None, **kwargs)Return numeric coordinate labels for the visible x and y axes.
Optional explicit x-axis values.
Optional explicit y-axis values.
Label styling such as ``font_size`` and ``color``.
A ``VGroup`` of label mobjects. Notes: The origin label ``0`` is omitted to avoid duplicate labels where the axes intersect.
def add_coordinates(self, x_values=None, y_values=None, **kwargs)Attach numeric coordinate labels to the x and y axes.
Optional explicit x-axis values.
Optional explicit y-axis values.
Label styling such as ``font_size`` and ``color``.
The plane instance for chaining.
class Octahedron(Polyhedron)Regular octahedron convenience polyhedron.
class Paragraph(VGroup)Vertical stack of text lines with alignment controls.
class ParametricSurface(Surface)Alias of :class:`Surface` kept for Manim API compatibility.
class PolarPlane(MathObject)Polar coordinate plane with radial and angular labeling helpers.
Maximum labeled radius value represented by the outer ring.
Rendered diameter of the plane in scene units.
Label style for angular coordinates, such as ``"PI radians"``.
Angular step between azimuth labels in radians.
Radial step between concentric coordinate labels.
Font size used for angular labels.
Optional style overrides for radial labels.
Optional style metadata for grid rendering.
Additional style or placement arguments.
plane = PolarPlane(radius_max=3, size=6, azimuth_step=PI / 6)def add(self, *objects)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def remove(self, *objects)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def coords_to_point(self, radius, azimuth)Convert polar coordinates into a scene-space point.
Radial distance in plane coordinates.
Polar angle in radians.
A 3D scene point lying on the plane.
def c2p(self, radius, azimuth)Alias for :meth:`coords_to_point` kept for coordinate-system compatibility.
def add_coordinates(self)Attach radial and azimuth coordinate labels to the polar plane.
The plane instance for chaining.
plane.add_coordinates()class Polyhedron(_ThreeDBase)General 3D mesh built from explicit vertices and polygon faces.
Iterable of 3D points.
Iterable of faces, each face being a list of vertex indices.
Additional style or placement arguments.
When ``vertices`` and ``faces`` are omitted, the runtime supplies a visible skewed triangular-prism placeholder mesh.
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,
)class Prism(_ThreeDBase)Axis-aligned rectangular prism centered at the local origin.
``(width, height, depth)`` tuple in scene units.
Additional style or placement arguments.
prism = Prism(dimensions=[1.8, 1.2, 1.0], color=PURPLE)class Sphere(_ThreeDBase)Triangulated sphere generated from latitude and longitude samples.
Sphere radius in scene units.
``(u_steps, v_steps)`` sampling density used to build the mesh.
Additional style or placement arguments.
globe = Sphere(radius=1.1, resolution=(18, 36), color=TEAL)class Surface(_ThreeDBase)Sampled parametric surface over a rectangular ``(u, v)`` domain.
Callable of ``(u, v)`` returning a 3D point.
Inclusive parameter interval for ``u``.
Inclusive parameter interval for ``v``.
``(u_steps, v_steps)`` mesh sampling density.
Additional style or placement arguments.
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],
)class SurfaceMesh(_ThreeDBase)Wireframe mesh extracted from a sampled surface.
Existing ``Surface`` or ``ParametricSurface`` to sample from.
Optional fallback resolution used when ``surface`` is omitted.
Additional style or placement arguments.
surf = Surface(lambda u, v: [u, v, sin(u) * cos(v)])
mesh = SurfaceMesh(surf, color=WHITE, stroke_width=1.2)class Table(VGroup)Simple table made of rectangle/text cells with ``get_rows()`` compatibility.
def get_rows(self)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
class Tetrahedron(Polyhedron)Regular tetrahedron convenience polyhedron.
class ThreeDAxes(_ThreeDBase)Three-dimensional Cartesian axes with coordinate conversion helpers.
``(min, max, step)`` tuple for the x-axis.
``(min, max, step)`` tuple for the y-axis.
``(min, max, step)`` tuple for the z-axis.
Rendered x-axis length in scene units.
Rendered y-axis length in scene units.
Rendered z-axis length in scene units.
Shared axis style configuration.
X-axis-specific style overrides.
Y-axis-specific style overrides.
Z-axis-specific style overrides.
Additional style or placement arguments.
axes = ThreeDAxes(
x_range=[-4, 4, 1],
y_range=[-3, 3, 1],
z_range=[-4, 4, 1],
)def add(self, *objects)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def remove(self, *objects)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def move_to(self, point_or_mobject, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def shift(self, vector)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def c2p(self, x, y, z=0)Convert 3D axis coordinates into scene points.
X-axis coordinate value.
Y-axis coordinate value.
Z-axis coordinate value.
A 3D point in scene coordinates.
point = axes.c2p(1.5, -2, 0.5)def coords_to_point(self, x, y, z=0)Alias for :meth:`c2p` kept for Manim compatibility.
def get_origin(self)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
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.
Callback mapping ``t`` to ``(x, y, z)`` axis coordinates.
``[t_min, t_max]`` or ``[t_min, t_max, step]`` domain.
Optional stroke color.
Optional stroke width.
Additional style arguments.
A ``VMobject`` whose points are already converted into scene-space coordinates using this axes instance.
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.
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.
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.
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.
def add_coordinates(self, x_values=None, y_values=None, z_values=None, **kwargs)Attach numeric coordinate labels to the visible 3D axes.
Optional explicit x-axis values or value-to-label mapping.
Optional explicit y-axis values or value-to-label mapping.
Optional explicit z-axis values or value-to-label mapping.
Label styling such as ``font_size``, ``color``, and ``buff``.
The axes instance for chaining. Notes: The origin label ``0`` is omitted so only one visual origin marker is shown where the axes intersect.
axes.add_coordinates(x_values=[-2, -1, 1, 2], z_values={1: "top"})class ThreeDCamera(_Camera)Perspective camera wrapper exposed by ``ThreeDScene.camera``.
class ThreeDScene(Scene)3D scene with perspective camera controls compatible with Manim-style APIs.
class OrbitScene(ThreeDScene):
def construct(self):
self.set_camera_orientation(phi=70 * DEGREES, theta=-45 * DEGREES)
self.add(ThreeDAxes(), Cube())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.
Polar angle of the camera.
Azimuthal angle of the camera.
Roll angle around the viewing axis.
Camera zoom factor.
Perspective focal distance.
Distance from the camera to the frame center.
Compatibility aliases such as ``distance``.
The scene instance for chaining.
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 one or more 3D camera properties over time.
Target polar angle.
Target azimuthal angle.
Target roll angle.
Target zoom factor.
Target focal distance.
Target camera distance.
Optional point the camera frame should move to.
Animation duration in seconds.
Optional easing callback.
Compatibility aliases such as ``distance``.
The scene instance for chaining.
self.move_camera(theta=-PI / 3, distance=7, run_time=1.2)def begin_ambient_camera_rotation(self, rate=0.02, **kwargs)Start continuous camera rotation around the vertical viewing axis.
Angular speed in radians per second.
Reserved compatibility keyword arguments.
The scene instance for chaining.
def stop_ambient_camera_rotation(self)Stop ambient camera rotation previously started by the scene.
class Title(VGroup)Minimal title helper aligned to the top edge like Manim's Title.
class Torus(_ThreeDBase)Donut-shaped surface parameterized by major and minor radii.
Distance from the torus center to the tube center.
Radius of the tube cross-section.
``(u_steps, v_steps)`` mesh sampling density.
Additional style or placement arguments.
torus = Torus(major_radius=1.4, minor_radius=0.45, color=PINK)class Vector3D(Arrow3D)Arrow that starts at the origin and points along a direction vector.
3D direction vector used as the arrow end point.
Additional style or placement arguments.
velocity = Vector3D([0.9, 0.7, 1.1], color=RED)def angle_of_vector(vector)Return the polar angle of a 2D vector in radians.
def ApplyFunction(func, mobject, run_time=None, **kwargs)Animate a mobject toward the result of applying a callback to it.
Callback that mutates and returns the target mobject state.
Source mobject.
Optional animation duration override.
Additional transform options.
def ApplyPointwiseFunctionToCenter(func, mobject, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def color_gradient(reference_colors, length_of_output)Interpolate a list of colors into a gradient of the requested length.
def CyclicReplace(*mobjects, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def MaintainPositionRelativeTo(mobject, tracked_mobject, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def Succession(*animations, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def SurroundingRectangleWithBuffer(mobject, buff=0.2, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def TransformMatchingShapes(mobject, target_mobject, run_time=None, **kwargs)Approximate Manim's shape-matching transform with a regular transform.
Source mobject.
Target mobject to transform into.
Optional animation duration override.
Additional transform options.
scene.play(TransformMatchingShapes(title_a, title_b))def TransformMatchingStrings(*args, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def TransformMatchingTex(*args, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def UpdateFromAlphaFunc(mobject, update_func, run_time=None, **kwargs)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
Minimal NumPy-compatible helpers exposed as the ``numpy`` shim.
src/runtime/python_stdlib/numpy/__init__.py
2.718281828459045Base of the natural logarithm.
3.141592653589793Ratio of a circle's circumference to its diameter.
6.283185307179586Full turn constant, equal to ``2 * pi``.
def abs_value(value)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def arange(start, stop=None, step=1)Return evenly spaced values in the half-open interval ``[start, stop)``.
First value, or the exclusive stop value if ``stop`` is omitted.
Exclusive upper bound.
Signed increment between values.
A list of scalar samples.
ticks = np.arange(0, 1.1, 0.1)def arctan_value(value)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def arctan2_value(y, x)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def around(value, decimals=0)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def array(value, dtype=None)Convert a value or nested sequence into a list-backed array shim.
Scalar or nested sequence to normalize.
Accepted for compatibility and currently ignored.
A list-backed array representation understood by the runtime.
pts = np.array([[0, 0, 0], [1, 1, 0]])def clip(value, min_value, max_value)Clamp scalars or nested lists into the provided numeric range.
Scalar or nested list to clamp.
Inclusive lower bound.
Inclusive upper bound.
A clamped value with the same basic shape as the input.
volume = np.clip(volume, 0, 1)def cos_value(value)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def linspace(start, stop, num=50)Return evenly spaced scalar samples between ``start`` and ``stop``.
First sample value.
Last sample value.
Number of requested samples.
A list of evenly spaced numeric samples.
ticks = np.linspace(0, TAU, 8)def roll(arr, shift, axis=0)Roll a 1D list-like sequence by ``shift`` positions.
Sequence to rotate.
Signed roll amount.
Accepted for compatibility and currently ignored.
A sequence with elements rotated by the requested shift.
rotated = np.roll([1, 2, 3, 4], 1)def round(value, decimals=0)Round scalars or nested sequences to a fixed precision.
Scalar or nested sequence to round.
Number of decimal places to preserve.
A rounded scalar or array-like wrapper.
points = np.round(np.linspace(0, 1, 5), 2)def sin_value(value)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def sqrt_value(value)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.
def tan_value(value)This symbol is indexed from the Python runtime source. Add a Google-style docstring in the Python stdlib to expand arguments, returns, raises, and examples.