Documentation

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.

Generated from Python source

API Reference

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.

Manim Core

manim

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

src/runtime/python_stdlib/manim/_core.py

15 constants38 classes95 functions

Constants

15

BLACK

constant
"#000000"

Neutral black color constant used for fills and backgrounds.

BLUE

constant
"#3b82f6"

Primary blue color constant used by many examples and defaults.

DEGREES

constant
PI / 180

Conversion factor from degrees to radians.

DOWN

constant
(0, -1, 0)

Unit vector that points downward in scene coordinates.

E

constant
2.718281828459045

Base of the natural logarithm.

GREEN

constant
"#22c55e"

Primary green color constant used by many examples and defaults.

LEFT

constant
(-1, 0, 0)

Unit vector that points left in scene coordinates.

ORIGIN

constant
(0, 0, 0)

Origin point for the default scene coordinate system.

PI

constant
3.141592653589793

Ratio of a circle's circumference to its diameter.

RED

constant
"#ef4444"

Primary red color constant used by many examples and defaults.

RIGHT

constant
(1, 0, 0)

Unit vector that points right in scene coordinates.

TAU

constant
6.283185307179586

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

UP

constant
(0, 1, 0)

Unit vector that points upward in scene coordinates.

WHITE

constant
"#ffffff"

Neutral white color constant used for strokes and text.

YELLOW

constant
"#eab308"

Primary yellow color constant used for highlights and labels.

Classes

38

AnimationProxy

class
class AnimationProxy

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.

Methods
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.

Arrow

class
class Arrow(MathObject)

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

Arguments
start

Start point of the arrow shaft.

end

End point of the arrow shaft.

kwargs

Additional style or placement arguments.

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

Axes

class
class Axes(MathObject)

Coordinate axes with configurable ranges and visual lengths.

Arguments
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.

Examples
axes = Axes(x_range=[0, 4, 1], y_range=[0, 3, 1]).to_edge(DOWN, buff=0.6)
Methods
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.

BackgroundAudioBlock

class
class BackgroundAudioBlock

Context manager for syncing background audio timing

Brace

class
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.

Methods
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.

Circle

class
class Circle(MathObject)

Circular outline or filled shape with Manim-style defaults.

Arguments
radius

Circle radius in scene units.

kwargs

Additional style or placement arguments.

Examples
circle = Circle(radius=1.5, color=BLUE)
Methods
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.

DashedLine

class
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.

DecimalNumber

class
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.

Methods
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.

Dot

class
class Dot(Circle)

Filled circular point marker.

FunctionGraph

class
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.

Group

class
class Group(MathObject)

Container that groups child mobjects without changing their types.

Methods
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.

ImageMobject

class
class ImageMobject(MathObject)

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

Arguments
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.

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

ImplicitFunction

class
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.

Line

class
class Line(MathObject)

Straight segment defined by explicit start and end points.

Arguments
start

Start point of the segment.

end

End point of the segment.

kwargs

Additional style or placement arguments.

MathObject

class
class MathObject

Base class for drawable objects in the Manim Web runtime.

Methods
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.

Arguments
point_or_mobject

Target point or mobject to align to.

kwargs

Accepted for API compatibility.

Returns

The mutated mobject so calls can be chained.

def shift(self, vector)

Translate the object by a vector in scene coordinates.

Arguments
vector

Translation vector expressed in scene coordinates.

Returns

The mutated mobject so calls can be chained.

def scale(self, factor, about_point=None)

Scale the object, optionally around an explicit pivot.

Arguments
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.

def rotate(self, angle, axis=OUT, about_point=None)

Rotate the object, optionally around an explicit pivot.

Arguments
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.

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.

Arguments
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.

def to_edge(self, edge, buff=0.5)

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

Arguments
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.

def to_corner(self, corner, buff=0.5)

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

Arguments
corner

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

buff

Margin to keep from the corner.

Returns

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.

Arguments
query_time

Optional timeline time to sample against.

Returns

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.

Arguments
dim

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

Returns

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``.

Arguments
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.

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.

MathTex

class
class MathTex(Tex)

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

Arguments
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.

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

Mobject

class
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.

NumberLine

class
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.

NumberPlane

class
class NumberPlane(MathObject)

Cartesian grid with helpers for converting coordinates to points.

Arguments
x_range

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

y_range

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

kwargs

Additional style or placement arguments.

Examples
plane = NumberPlane().scale(0.9)
dot = Dot(plane.c2p(2, 1))
Methods
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.

ParametricFunction

class
class ParametricFunction(MathObject)

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

Polygon

class
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.

Rectangle

class
class Rectangle(MathObject)

Axis-aligned rectangle parameterized by width and height.

Arguments
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.

RegularPolygon

class
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.

RoundedRectangle

class
class RoundedRectangle(Rectangle)

Rectangle variant with rounded corners.

Scene

class
class Scene

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

Arguments
duration

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

fps

Target frames per second for preview and export.

width

Output width in pixels.

height

Output height in pixels.

backgroundColor

Scene background color.

showGrid

Whether to show the debug grid in supported viewers.

Examples
scene = Scene(width=1280, height=720, fps=30)
scene.add(Text("Hello"))
scene.wait(1)
Methods
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.

Arguments
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)
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.

Arguments
objs

Mobjects to register and make visible.

Returns

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.

Arguments
duration

Number of seconds to advance the scene clock.

Returns

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.

Square

class
class Square(MathObject)

Square mobject sampled densely for smoother morphing.

Arguments
side_length

Edge length in scene units.

kwargs

Additional style or placement arguments.

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

SurroundingRectangle

class
class SurroundingRectangle(Rectangle)

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

SVGMobject

class
class SVGMobject(ImageMobject)

SVG-backed image mobject.

Tex

class
class Tex(MathObject)

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

Arguments
tex

TeX source string.

fontSize

Text size in pixels.

font_size

Snake-case alias for ``fontSize``.

kwargs

Additional style or placement arguments.

Text

class
class Text(MathObject)

Plain text mobject rendered with the runtime text renderer.

Arguments
text

Display string.

fontSize

Text size in pixels.

font_size

Snake-case alias for ``fontSize``.

kwargs

Additional style or placement arguments.

Examples
title = Text("Polar Symmetry", font_size=48, color=BLUE)
Methods
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.

TracedPath

class
class TracedPath(VMobject)

Continuously trace points returned by a callback over time.

Methods
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.

Triangle

class
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.

ValueTracker

class
class ValueTracker(MathObject)

Numeric container used to drive animations and redraw callbacks.

Arguments
value

Initial numeric value.

kwargs

Additional mobject configuration.

Examples
tracker = ValueTracker(0)
scene.play(tracker.animate.set_value(10))
Methods
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.

Vector

class
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.

VGroup

class
class VGroup(Group)

Group variant used for vectorized collections of mobjects.

VMobject

class
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.

Methods
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.

VoiceoverBlock

class
class VoiceoverBlock

Context manager for syncing animations with voiceover timing

VoiceoverScene

class
class VoiceoverScene(Scene)

Scene subclass with voiceover and background-audio helper blocks.

Examples
class Demo(VoiceoverScene):
def construct(self):
with self.play_voiceover_block("intro"):
self.play(Write(Text("Narrated scene")))
Methods
def add_voiceover(self, voiceover_id, text, duration)

Register a voiceover with its text and duration.

Arguments
voiceover_id

Unique identifier for this voiceover

text

The voiceover text/description

duration

Duration in seconds

def set_voiceovers(self, voiceover_map)

Set multiple voiceovers at once.

Arguments
voiceover_map

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

Functions

95

AddTextLetterByLetter

function
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.

always_redraw

function
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.

Arguments
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()))

AnimationGroup

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

Run multiple animations together as a grouped unit.

Arguments
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))

ApplyMethod

function
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.

ApplyPointwiseFunction

function
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.

bounce

function
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.

BraceBetweenPoints

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

Create a brace between two points

ceil

function
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.

ClockwiseTransform

function
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.

cos

function
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.

CounterclockwiseTransform

function
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.

Create

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

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

Arguments
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)

degrees_to_rad

function
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.

double_smooth

function
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.

ease_in

function
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.

ease_in_back

function
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.

ease_in_bounce

function
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.

ease_in_circ

function
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.

ease_in_cubic

function
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.

ease_in_elastic

function
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.

ease_in_expo

function
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.

ease_in_out

function
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.

ease_in_out_back

function
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.

ease_in_out_bounce

function
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.

ease_in_out_circ

function
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.

ease_in_out_cubic

function
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.

ease_in_out_elastic

function
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.

ease_in_out_expo

function
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.

ease_in_out_quad

function
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.

ease_in_out_quart

function
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.

ease_in_out_quint

function
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.

ease_in_out_sine

function
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.

ease_in_quad

function
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.

ease_in_quart

function
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.

ease_in_quint

function
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.

ease_in_sine

function
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.

ease_out

function
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.

ease_out_back

function
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.

ease_out_bounce

function
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.

ease_out_circ

function
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.

ease_out_cubic

function
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.

ease_out_elastic

function
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.

ease_out_expo

function
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.

ease_out_quad

function
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.

ease_out_quart

function
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.

ease_out_quint

function
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.

ease_out_sine

function
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.

elastic

function
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.

exponential_decay

function
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.

FadeIn

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

Animate a mobject from invisible to visible.

Arguments
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
def FadeOut(obj, run_time=None, **kwargs)

Animate a mobject from visible to invisible.

Flash

function
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.

floor

function
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.

FocusOn

function
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.

get_image_asset

function
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.

get_images_map

function
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.

GrowArrow

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

Animate an arrow-like mobject growing into view.

Arguments
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
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.

GrowFromPoint

function
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.

Indicate

function
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.

interpolate_color

function
def interpolate_color(colora, colorb, amount)

Linearly interpolate between two colors.

LaggedStart

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

Run multiple animations with a staggered start offset.

LaggedStartMap

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

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

Arguments
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``.

linear

function
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.

lingering

function
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.

MoveAlongPath

function
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.

MoveTo

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

Animate a move to a target point.

Arguments
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
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.

not_quite_there

function
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.

radians

function
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.

ReplacementTransform

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

Transform one mobject into another while conceptually replacing it.

Rotate

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

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

Arguments
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))

running_start

function
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.

rush_from

function
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.

rush_into

function
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.

Scale

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

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

Arguments
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
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.

Shift

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

Animate a translation by a vector.

ShrinkToCenter

function
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.

sin

function
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.

slow_into

function
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.

smooth

function
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.

sqrt

function
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.

squish_rate_func

function
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.

tan

function
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.

there_and_back

function
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.

there_and_back_with_pause

function
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.

Transform

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

Morph one mobject or group into another target state.

Arguments
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
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.

Uncreate

function
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.

Unwrite

function
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.

Wait

function
def Wait(run_time=1, **kwargs)

Consume time inside animation groups without mutating scene objects.

wiggle

function
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.

Wiggle

function
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.

Write

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

Animate text or strokes with a writing-style reveal.

Arguments
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")))

Manim Compatibility

manim.compat

Compatibility helpers and Manim-style convenience shims.

src/runtime/python_stdlib/manim/_patches.py

3 constants36 classes12 functions

Constants

3

BOLD

constant
"bold"

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

ITALIC

constant
"italic"

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

NORMAL

constant
"normal"

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

Classes

36

Arrow3D

class
class Arrow3D(Line3D)

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

Arguments
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.

ArrowTriangleFilledTip

class
class ArrowTriangleFilledTip(Polygon)

Filled triangular arrow tip sized with Manim-like defaults.

BackgroundRectangle

class
class BackgroundRectangle(SurroundingRectangle)

Filled rectangle sized to sit behind another mobject.

CameraFrame

class
class CameraFrame(_CameraFrame)

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

Code

class
class Code(VGroup)

Manim-like code block with language-aware token colors and optional line numbers.

Color

class
class Color

Lightweight color wrapper used by compatibility properties.

Methods
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.

Cone

class
class Cone(_ThreeDBase)

Circular cone with a capped base.

Arguments
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.

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

Cross

class
class Cross(VGroup)

Simple diagonal cross mark used for highlights and failure indicators.

Cube

class
class Cube(_ThreeDBase)

Axis-aligned cube centered at the local origin.

Arguments
side_length

Edge length of the cube in scene units.

kwargs

Additional style or placement arguments.

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

CubicBezier

class
class CubicBezier(MathObject)

Cubic Bezier curve defined by four control points.

Cylinder

class
class Cylinder(_ThreeDBase)

Circular cylinder with top and bottom caps.

Arguments
radius

Radius of the cylinder body.

height

Total cylinder height.

resolution

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

kwargs

Additional style or placement arguments.

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

Dodecahedron

class
class Dodecahedron(Polyhedron)

Regular dodecahedron convenience polyhedron.

Dot3D

class
class Dot3D(_ThreeDBase)

Small filled 3D marker positioned at a single point.

Arguments
point

Center point in scene coordinates.

radius

Rendered radius of the dot.

kwargs

Additional style or placement arguments.

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

Icosahedron

class
class Icosahedron(Polyhedron)

Regular icosahedron convenience polyhedron.

Integer

class
class Integer(DecimalNumber)

Integer-valued number mobject with animate/set_value support.

Methods
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.

Line3D

class
class Line3D(_ThreeDBase)

Straight 3D segment between explicit start and end points.

Arguments
start

Segment start point.

end

Segment end point.

kwargs

Additional style or placement arguments.

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

MarkupText

class
class MarkupText(Text)

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

Matrix

class
class Matrix(VGroup)

Minimal matrix helper that arranges entries in rows with brackets.

NumberPlane

class
class NumberPlane(Axes)

Cartesian grid plane with vector and coordinate-label helpers.

Arguments
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.

Examples
plane = NumberPlane(x_range=[-4, 4, 1], y_range=[-3, 3, 1])
Methods
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.

Arguments
coords

Target coordinate pair.

kwargs

Additional ``Arrow`` styling arguments.

Returns

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.

Arguments
num_inserted_curves

Metadata hint describing the requested curve density.

Returns

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.

Arguments
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.

def add_coordinates(self, x_values=None, y_values=None, **kwargs)

Attach numeric coordinate labels to the x and y axes.

Arguments
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.

Octahedron

class
class Octahedron(Polyhedron)

Regular octahedron convenience polyhedron.

Paragraph

class
class Paragraph(VGroup)

Vertical stack of text lines with alignment controls.

ParametricSurface

class
class ParametricSurface(Surface)

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

PolarPlane

class
class PolarPlane(MathObject)

Polar coordinate plane with radial and angular labeling helpers.

Arguments
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.

Examples
plane = PolarPlane(radius_max=3, size=6, azimuth_step=PI / 6)
Methods
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.

Arguments
radius

Radial distance in plane coordinates.

azimuth

Polar angle in radians.

Returns

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.

Returns

The plane instance for chaining.

Examples
plane.add_coordinates()

Polyhedron

class
class Polyhedron(_ThreeDBase)

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

Arguments
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.

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

class
class Prism(_ThreeDBase)

Axis-aligned rectangular prism centered at the local origin.

Arguments
dimensions

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

kwargs

Additional style or placement arguments.

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

Sphere

class
class Sphere(_ThreeDBase)

Triangulated sphere generated from latitude and longitude samples.

Arguments
radius

Sphere radius in scene units.

resolution

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

kwargs

Additional style or placement arguments.

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

Surface

class
class Surface(_ThreeDBase)

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

Arguments
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.

kwargs

Additional style or placement arguments.

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],
)

SurfaceMesh

class
class SurfaceMesh(_ThreeDBase)

Wireframe mesh extracted from a sampled surface.

Arguments
surface

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

resolution

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

kwargs

Additional style or placement arguments.

Examples
surf = Surface(lambda u, v: [u, v, sin(u) * cos(v)])
mesh = SurfaceMesh(surf, color=WHITE, stroke_width=1.2)

Table

class
class Table(VGroup)

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

Methods
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.

Tetrahedron

class
class Tetrahedron(Polyhedron)

Regular tetrahedron convenience polyhedron.

ThreeDAxes

class
class ThreeDAxes(_ThreeDBase)

Three-dimensional Cartesian axes with coordinate conversion helpers.

Arguments
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.

Examples
axes = ThreeDAxes(
x_range=[-4, 4, 1],
y_range=[-3, 3, 1],
z_range=[-4, 4, 1],
)
Methods
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.

Arguments
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)
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.

Arguments
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.

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.

Arguments
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"})

ThreeDCamera

class
class ThreeDCamera(_Camera)

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

ThreeDScene

class
class ThreeDScene(Scene)

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

Examples
class OrbitScene(ThreeDScene):
def construct(self):
self.set_camera_orientation(phi=70 * DEGREES, theta=-45 * DEGREES)
self.add(ThreeDAxes(), Cube())
Methods
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.

Arguments
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.

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.

Arguments
phi

Target polar angle.

theta

Target azimuthal angle.

gamma

Target roll angle.

zoom

Target zoom factor.

focal_distance

Target focal distance.

distance

Target camera distance.

frame_center

Optional point the camera frame should move to.

run_time

Animation duration in seconds.

rate_func

Optional easing callback.

kwargs

Compatibility aliases such as ``distance``.

Returns

The scene instance for chaining.

Examples
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.

Arguments
rate

Angular speed in radians per second.

kwargs

Reserved compatibility keyword arguments.

Returns

The scene instance for chaining.

def stop_ambient_camera_rotation(self)

Stop ambient camera rotation previously started by the scene.

Title

class
class Title(VGroup)

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

Torus

class
class Torus(_ThreeDBase)

Donut-shaped surface parameterized by major and minor radii.

Arguments
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.

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

Vector3D

class
class Vector3D(Arrow3D)

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

Arguments
direction

3D direction vector used as the arrow end point.

kwargs

Additional style or placement arguments.

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

Functions

12

angle_of_vector

function
def angle_of_vector(vector)

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

ApplyFunction

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

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

Arguments
func

Callback that mutates and returns the target mobject state.

mobject

Source mobject.

run_time

Optional animation duration override.

kwargs

Additional transform options.

ApplyPointwiseFunctionToCenter

function
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.

color_gradient

function
def color_gradient(reference_colors, length_of_output)

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

CyclicReplace

function
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.

MaintainPositionRelativeTo

function
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.

Succession

function
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.

SurroundingRectangleWithBuffer

function
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.

TransformMatchingShapes

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

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

Arguments
mobject

Source mobject.

target_mobject

Target mobject to transform into.

run_time

Optional animation duration override.

kwargs

Additional transform options.

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

TransformMatchingStrings

function
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.

TransformMatchingTex

function
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.

UpdateFromAlphaFunc

function
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.

NumPy Shim

numpy

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

src/runtime/python_stdlib/numpy/__init__.py

3 constants0 classes14 functions

Constants

3

e

constant
2.718281828459045

Base of the natural logarithm.

pi

constant
3.141592653589793

Ratio of a circle's circumference to its diameter.

tau

constant
6.283185307179586

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

Functions

14

abs_value

function
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.

arange

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

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

Arguments
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
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.

arctan2_value

function
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.

around

function
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.

array

function
def array(value, dtype=None)

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

Arguments
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
def clip(value, min_value, max_value)

Clamp scalars or nested lists into the provided numeric range.

Arguments
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
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.

linspace

function
def linspace(start, stop, num=50)

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

Arguments
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
def roll(arr, shift, axis=0)

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

Arguments
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
def round(value, decimals=0)

Round scalars or nested sequences to a fixed precision.

Arguments
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
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.

sqrt_value

function
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.

tan_value

function
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.