Reference

This reference manual details modules, functions, and variables included in Manim, describing what they are and what they do. For learning how to use Manim, see Tutorials. For a list of changes since the last release, see the Changelog.

Warning

The pages linked to here are currently a work in progress.

Mobjects

changing

Animation of a mobject boundary and tracing of points.

coordinate_systems

Mobjects that represent coordinate systems.

frame

Special rectangles.

functions

Mobjects representing function graphs.

geometry

Mobjects that are simple geometric shapes.

graph

Mobjects used to represent mathematical graphs (think graph theory, not plotting).

logo

Utilities for Manim’s logo and banner.

matrix

Mobjects representing matrices.

mobject

Base classes for objects that can be displayed.

mobject_update_utils

Utility functions for continuous animation of mobjects.

number_line

Mobject representing a number line.

numbers

Mobjects representing numbers.

probability

Mobjects representing objects from probability theory and statistics.

shape_matchers

Mobjects used to mark and annotate other mobjects.

three_d_utils

Utility functions for three-dimensional mobjects.

three_dimensions

Three-dimensional mobjects.

value_tracker

Mobjects that dynamically show the change of a variable.

vector_field

Mobjects representing vector fields.

brace

Mobject representing curly braces.

code_mobject

Mobject representing highlighted source code listings.

style_utils

Utility functions for parsing SVG styles.

svg_path

Mobjects generated from an SVG pathstring.

svg_mobject

Mobjects generated from an SVG file.

tex_mobject

Mobjects representing text rendered using LaTeX.

text_mobject

Mobjects used for displaying (non-LaTeX) text.

image_mobject

Mobjects representing raster images.

point_cloud_mobject

Mobjects representing point clouds.

vectorized_mobject

Mobjects that use vector graphics.

Scenes

graph_scene

A scene for plotting / graphing functions.

moving_camera_scene

A scene whose camera can be moved around.

reconfigurable_scene

sample_space_scene

A scene suitable for usage with SampleSpace.

scene

Basic canvas for animations.

scene_file_writer

The interface between scenes and ffmpeg.

three_d_scene

A scene suitable for rendering three-dimensional objects and animations.

vector_space_scene

A scene suitable for vector spaces.

zoomed_scene

A scene supporting zooming in on a specified section.

Animations

animation

Animate mobjects.

composition

Tools for displaying multiple animations at once.

creation

Animate the display or removal of a mobject from a scene.

fading

Fading in and out of view.

growing

Animations that grow mobjects.

indication

Animations drawing attention to particular mobjects.

movement

Animations related to movement.

numbers

Animations for changing numbers.

rotation

Animations related to rotation.

transform

Animations transforming one mobject into another.

transform_matching_parts

Animations that try to transform Mobjects while keeping track of identical parts.

update

Animations that update mobjects.

Cameras

camera

A camera converts the mobjects contained in a Scene into an array of pixels.

mapping_camera

A camera that allows mapping between objects.

moving_camera

A camera able to move through a scene.

multi_camera

A camera supporting multiple perspectives.

three_d_camera

A camera that can be positioned and oriented in three-dimensional space.

Configuration

_config

Set the global config and logger.

utils

Utilities to create and set the config.

main_utils

Utilities called from __main__.py to interact with the config.

logger_utils

Utilities to create and set the logger.

Utilities

bezier

Utility functions related to Bézier curves.

color

Utility functions for conversion between color models.

config_ops

Utilities that might be useful for configuration dictionaries.

hashing

Utilities for scene caching.

ipython_magic

Utilities for using Manim with IPython (in particular: Jupyter notebooks)

images

Image manipulation utilities.

iterables

Operations on iterables.

paths

Functions determining transformation paths between sets of points.

rate_functions

A selection of rate functions, i.e., speed curves for animations.

simple_functions

A collection of simple functions.

sounds

Sound-related utility functions.

space_ops

Utility functions for two- and three-dimensional vectors.

strings

String manipulation utilities.

tex

Utilities for processing LaTeX templates.

tex_templates

A library of LaTeX templates.

tex_file_writing

Interface for writing, compiling, and converting .tex files.

Other modules

constants

Constant definitions.

container

Abstract base class for several objects used by manim.