| # Reference Manual |
|
|
| 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](tutorials/index.md). For a list of changes since the last release, see |
| the [Changelog](changelog.md). |
|
|
| #### WARNING |
| The pages linked to here are currently a work in progress. |
|
|
| ## Inheritance Graphs |
|
|
| ### Animations |
|
|
| ### Cameras |
|
|
| ### Mobjects |
|
|
| ### Scenes |
|
|
| ## Module Index |
|
|
| * [Animations](reference_index/animations.md) |
| * [animation](reference/manim.animation.animation.md) |
| * [Add](reference/manim.animation.animation.Add.md) |
| * [Animation](reference/manim.animation.animation.Animation.md) |
| * [Wait](reference/manim.animation.animation.Wait.md) |
| * [`override_animation()`](reference/manim.animation.animation.md#manim.animation.animation.override_animation) |
| * [`prepare_animation()`](reference/manim.animation.animation.md#manim.animation.animation.prepare_animation) |
| * [changing](reference/manim.animation.changing.md) |
| * [AnimatedBoundary](reference/manim.animation.changing.AnimatedBoundary.md) |
| * [TracedPath](reference/manim.animation.changing.TracedPath.md) |
| * [composition](reference/manim.animation.composition.md) |
| * [AnimationGroup](reference/manim.animation.composition.AnimationGroup.md) |
| * [LaggedStart](reference/manim.animation.composition.LaggedStart.md) |
| * [LaggedStartMap](reference/manim.animation.composition.LaggedStartMap.md) |
| * [Succession](reference/manim.animation.composition.Succession.md) |
| * [creation](reference/manim.animation.creation.md) |
| * [AddTextLetterByLetter](reference/manim.animation.creation.AddTextLetterByLetter.md) |
| * [AddTextWordByWord](reference/manim.animation.creation.AddTextWordByWord.md) |
| * [Create](reference/manim.animation.creation.Create.md) |
| * [DrawBorderThenFill](reference/manim.animation.creation.DrawBorderThenFill.md) |
| * [RemoveTextLetterByLetter](reference/manim.animation.creation.RemoveTextLetterByLetter.md) |
| * [ShowIncreasingSubsets](reference/manim.animation.creation.ShowIncreasingSubsets.md) |
| * [ShowPartial](reference/manim.animation.creation.ShowPartial.md) |
| * [ShowSubmobjectsOneByOne](reference/manim.animation.creation.ShowSubmobjectsOneByOne.md) |
| * [SpiralIn](reference/manim.animation.creation.SpiralIn.md) |
| * [TypeWithCursor](reference/manim.animation.creation.TypeWithCursor.md) |
| * [Uncreate](reference/manim.animation.creation.Uncreate.md) |
| * [UntypeWithCursor](reference/manim.animation.creation.UntypeWithCursor.md) |
| * [Unwrite](reference/manim.animation.creation.Unwrite.md) |
| * [Write](reference/manim.animation.creation.Write.md) |
| * [fading](reference/manim.animation.fading.md) |
| * [FadeIn](reference/manim.animation.fading.FadeIn.md) |
| * [FadeOut](reference/manim.animation.fading.FadeOut.md) |
| * [growing](reference/manim.animation.growing.md) |
| * [GrowArrow](reference/manim.animation.growing.GrowArrow.md) |
| * [GrowFromCenter](reference/manim.animation.growing.GrowFromCenter.md) |
| * [GrowFromEdge](reference/manim.animation.growing.GrowFromEdge.md) |
| * [GrowFromPoint](reference/manim.animation.growing.GrowFromPoint.md) |
| * [SpinInFromNothing](reference/manim.animation.growing.SpinInFromNothing.md) |
| * [indication](reference/manim.animation.indication.md) |
| * [ApplyWave](reference/manim.animation.indication.ApplyWave.md) |
| * [Blink](reference/manim.animation.indication.Blink.md) |
| * [Circumscribe](reference/manim.animation.indication.Circumscribe.md) |
| * [Flash](reference/manim.animation.indication.Flash.md) |
| * [FocusOn](reference/manim.animation.indication.FocusOn.md) |
| * [Indicate](reference/manim.animation.indication.Indicate.md) |
| * [ShowPassingFlash](reference/manim.animation.indication.ShowPassingFlash.md) |
| * [ShowPassingFlashWithThinningStrokeWidth](reference/manim.animation.indication.ShowPassingFlashWithThinningStrokeWidth.md) |
| * [Wiggle](reference/manim.animation.indication.Wiggle.md) |
| * [movement](reference/manim.animation.movement.md) |
| * [ComplexHomotopy](reference/manim.animation.movement.ComplexHomotopy.md) |
| * [Homotopy](reference/manim.animation.movement.Homotopy.md) |
| * [MoveAlongPath](reference/manim.animation.movement.MoveAlongPath.md) |
| * [PhaseFlow](reference/manim.animation.movement.PhaseFlow.md) |
| * [SmoothedVectorizedHomotopy](reference/manim.animation.movement.SmoothedVectorizedHomotopy.md) |
| * [numbers](reference/manim.animation.numbers.md) |
| * [ChangeDecimalToValue](reference/manim.animation.numbers.ChangeDecimalToValue.md) |
| * [ChangingDecimal](reference/manim.animation.numbers.ChangingDecimal.md) |
| * [rotation](reference/manim.animation.rotation.md) |
| * [Rotate](reference/manim.animation.rotation.Rotate.md) |
| * [Rotating](reference/manim.animation.rotation.Rotating.md) |
| * [specialized](reference/manim.animation.specialized.md) |
| * [Broadcast](reference/manim.animation.specialized.Broadcast.md) |
| * [speedmodifier](reference/manim.animation.speedmodifier.md) |
| * [ChangeSpeed](reference/manim.animation.speedmodifier.ChangeSpeed.md) |
| * [transform](reference/manim.animation.transform.md) |
| * [ApplyComplexFunction](reference/manim.animation.transform.ApplyComplexFunction.md) |
| * [ApplyFunction](reference/manim.animation.transform.ApplyFunction.md) |
| * [ApplyMatrix](reference/manim.animation.transform.ApplyMatrix.md) |
| * [ApplyMethod](reference/manim.animation.transform.ApplyMethod.md) |
| * [ApplyPointwiseFunction](reference/manim.animation.transform.ApplyPointwiseFunction.md) |
| * [ApplyPointwiseFunctionToCenter](reference/manim.animation.transform.ApplyPointwiseFunctionToCenter.md) |
| * [ClockwiseTransform](reference/manim.animation.transform.ClockwiseTransform.md) |
| * [CounterclockwiseTransform](reference/manim.animation.transform.CounterclockwiseTransform.md) |
| * [CyclicReplace](reference/manim.animation.transform.CyclicReplace.md) |
| * [FadeToColor](reference/manim.animation.transform.FadeToColor.md) |
| * [FadeTransform](reference/manim.animation.transform.FadeTransform.md) |
| * [FadeTransformPieces](reference/manim.animation.transform.FadeTransformPieces.md) |
| * [MoveToTarget](reference/manim.animation.transform.MoveToTarget.md) |
| * [ReplacementTransform](reference/manim.animation.transform.ReplacementTransform.md) |
| * [Restore](reference/manim.animation.transform.Restore.md) |
| * [ScaleInPlace](reference/manim.animation.transform.ScaleInPlace.md) |
| * [ShrinkToCenter](reference/manim.animation.transform.ShrinkToCenter.md) |
| * [Swap](reference/manim.animation.transform.Swap.md) |
| * [Transform](reference/manim.animation.transform.Transform.md) |
| * [TransformAnimations](reference/manim.animation.transform.TransformAnimations.md) |
| * [TransformFromCopy](reference/manim.animation.transform.TransformFromCopy.md) |
| * [transform_matching_parts](reference/manim.animation.transform_matching_parts.md) |
| * [TransformMatchingAbstractBase](reference/manim.animation.transform_matching_parts.TransformMatchingAbstractBase.md) |
| * [TransformMatchingShapes](reference/manim.animation.transform_matching_parts.TransformMatchingShapes.md) |
| * [TransformMatchingTex](reference/manim.animation.transform_matching_parts.TransformMatchingTex.md) |
| * [updaters](reference/manim.animation.updaters.md) |
| * [Modules](reference/manim.animation.updaters.md#modules) |
| * [Cameras](reference_index/cameras.md) |
| * [camera](reference/manim.camera.camera.md) |
| * [BackgroundColoredVMobjectDisplayer](reference/manim.camera.camera.BackgroundColoredVMobjectDisplayer.md) |
| * [Camera](reference/manim.camera.camera.Camera.md) |
| * [mapping_camera](reference/manim.camera.mapping_camera.md) |
| * [MappingCamera](reference/manim.camera.mapping_camera.MappingCamera.md) |
| * [OldMultiCamera](reference/manim.camera.mapping_camera.OldMultiCamera.md) |
| * [SplitScreenCamera](reference/manim.camera.mapping_camera.SplitScreenCamera.md) |
| * [moving_camera](reference/manim.camera.moving_camera.md) |
| * [MovingCamera](reference/manim.camera.moving_camera.MovingCamera.md) |
| * [multi_camera](reference/manim.camera.multi_camera.md) |
| * [MultiCamera](reference/manim.camera.multi_camera.MultiCamera.md) |
| * [three_d_camera](reference/manim.camera.three_d_camera.md) |
| * [ThreeDCamera](reference/manim.camera.three_d_camera.ThreeDCamera.md) |
| * [Configuration](reference_index/configuration.md) |
| * [Module Index](reference_index/configuration.md#module-index) |
| * [\_config](reference/manim._config.md) |
| * [utils](reference/manim._config.utils.md) |
| * [logger_utils](reference/manim._config.logger_utils.md) |
| * [Mobjects](reference_index/mobjects.md) |
| * [frame](reference/manim.mobject.frame.md) |
| * [FullScreenRectangle](reference/manim.mobject.frame.FullScreenRectangle.md) |
| * [ScreenRectangle](reference/manim.mobject.frame.ScreenRectangle.md) |
| * [geometry](reference/manim.mobject.geometry.md) |
| * [Modules](reference/manim.mobject.geometry.md#modules) |
| * [graph](reference/manim.mobject.graph.md) |
| * [`NxGraph`](reference/manim.mobject.graph.md#manim.mobject.graph.NxGraph) |
| * [DiGraph](reference/manim.mobject.graph.DiGraph.md) |
| * [GenericGraph](reference/manim.mobject.graph.GenericGraph.md) |
| * [Graph](reference/manim.mobject.graph.Graph.md) |
| * [LayoutFunction](reference/manim.mobject.graph.LayoutFunction.md) |
| * [graphing](reference/manim.mobject.graphing.md) |
| * [Modules](reference/manim.mobject.graphing.md#modules) |
| * [logo](reference/manim.mobject.logo.md) |
| * [ManimBanner](reference/manim.mobject.logo.ManimBanner.md) |
| * [matrix](reference/manim.mobject.matrix.md) |
| * [DecimalMatrix](reference/manim.mobject.matrix.DecimalMatrix.md) |
| * [IntegerMatrix](reference/manim.mobject.matrix.IntegerMatrix.md) |
| * [Matrix](reference/manim.mobject.matrix.Matrix.md) |
| * [MobjectMatrix](reference/manim.mobject.matrix.MobjectMatrix.md) |
| * [`get_det_text()`](reference/manim.mobject.matrix.md#manim.mobject.matrix.get_det_text) |
| * [`matrix_to_mobject()`](reference/manim.mobject.matrix.md#manim.mobject.matrix.matrix_to_mobject) |
| * [`matrix_to_tex_string()`](reference/manim.mobject.matrix.md#manim.mobject.matrix.matrix_to_tex_string) |
| * [mobject](reference/manim.mobject.mobject.md) |
| * [`TimeBasedUpdater`](reference/manim.mobject.mobject.md#manim.mobject.mobject.TimeBasedUpdater) |
| * [`NonTimeBasedUpdater`](reference/manim.mobject.mobject.md#manim.mobject.mobject.NonTimeBasedUpdater) |
| * [`Updater`](reference/manim.mobject.mobject.md#manim.mobject.mobject.Updater) |
| * [Group](reference/manim.mobject.mobject.Group.md) |
| * [Mobject](reference/manim.mobject.mobject.Mobject.md) |
| * [`override_animate()`](reference/manim.mobject.mobject.md#manim.mobject.mobject.override_animate) |
| * [svg](reference/manim.mobject.svg.md) |
| * [Modules](reference/manim.mobject.svg.md#modules) |
| * [table](reference/manim.mobject.table.md) |
| * [DecimalTable](reference/manim.mobject.table.DecimalTable.md) |
| * [IntegerTable](reference/manim.mobject.table.IntegerTable.md) |
| * [MathTable](reference/manim.mobject.table.MathTable.md) |
| * [MobjectTable](reference/manim.mobject.table.MobjectTable.md) |
| * [Table](reference/manim.mobject.table.Table.md) |
| * [text](reference/manim.mobject.text.md) |
| * [Modules](reference/manim.mobject.text.md#modules) |
| * [three_d](reference/manim.mobject.three_d.md) |
| * [Modules](reference/manim.mobject.three_d.md#modules) |
| * [types](reference/manim.mobject.types.md) |
| * [Modules](reference/manim.mobject.types.md#modules) |
| * [utils](reference/manim.mobject.utils.md) |
| * [`get_mobject_class()`](reference/manim.mobject.utils.md#manim.mobject.utils.get_mobject_class) |
| * [`get_point_mobject_class()`](reference/manim.mobject.utils.md#manim.mobject.utils.get_point_mobject_class) |
| * [`get_vectorized_mobject_class()`](reference/manim.mobject.utils.md#manim.mobject.utils.get_vectorized_mobject_class) |
| * [value_tracker](reference/manim.mobject.value_tracker.md) |
| * [ComplexValueTracker](reference/manim.mobject.value_tracker.ComplexValueTracker.md) |
| * [ValueTracker](reference/manim.mobject.value_tracker.ValueTracker.md) |
| * [vector_field](reference/manim.mobject.vector_field.md) |
| * [ArrowVectorField](reference/manim.mobject.vector_field.ArrowVectorField.md) |
| * [StreamLines](reference/manim.mobject.vector_field.StreamLines.md) |
| * [VectorField](reference/manim.mobject.vector_field.VectorField.md) |
| * [Scenes](reference_index/scenes.md) |
| * [moving_camera_scene](reference/manim.scene.moving_camera_scene.md) |
| * [MovingCameraScene](reference/manim.scene.moving_camera_scene.MovingCameraScene.md) |
| * [section](reference/manim.scene.section.md) |
| * [DefaultSectionType](reference/manim.scene.section.DefaultSectionType.md) |
| * [Section](reference/manim.scene.section.Section.md) |
| * [scene](reference/manim.scene.scene.md) |
| * [`SceneInteractAction`](reference/manim.scene.scene.md#manim.scene.scene.SceneInteractAction) |
| * [RerunSceneHandler](reference/manim.scene.scene.RerunSceneHandler.md) |
| * [Scene](reference/manim.scene.scene.Scene.md) |
| * [SceneInteractContinue](reference/manim.scene.scene.SceneInteractContinue.md) |
| * [SceneInteractRerun](reference/manim.scene.scene.SceneInteractRerun.md) |
| * [scene_file_writer](reference/manim.scene.scene_file_writer.md) |
| * [SceneFileWriter](reference/manim.scene.scene_file_writer.SceneFileWriter.md) |
| * [`convert_audio()`](reference/manim.scene.scene_file_writer.md#manim.scene.scene_file_writer.convert_audio) |
| * [`to_av_frame_rate()`](reference/manim.scene.scene_file_writer.md#manim.scene.scene_file_writer.to_av_frame_rate) |
| * [three_d_scene](reference/manim.scene.three_d_scene.md) |
| * [SpecialThreeDScene](reference/manim.scene.three_d_scene.SpecialThreeDScene.md) |
| * [ThreeDScene](reference/manim.scene.three_d_scene.ThreeDScene.md) |
| * [vector_space_scene](reference/manim.scene.vector_space_scene.md) |
| * [LinearTransformationScene](reference/manim.scene.vector_space_scene.LinearTransformationScene.md) |
| * [VectorScene](reference/manim.scene.vector_space_scene.VectorScene.md) |
| * [zoomed_scene](reference/manim.scene.zoomed_scene.md) |
| * [ZoomedScene](reference/manim.scene.zoomed_scene.ZoomedScene.md) |
| * [Utilities and other modules](reference_index/utilities_misc.md) |
| * [Module Index](reference_index/utilities_misc.md#module-index) |
| * [bezier](reference/manim.utils.bezier.md) |
| * [cli](reference/manim.cli.md) |
| * [color](reference/manim.utils.color.md) |
| * [commands](reference/manim.utils.commands.md) |
| * [config_ops](reference/manim.utils.config_ops.md) |
| * [constants](reference/manim.constants.md) |
| * [data_structures](reference/manim.data_structures.md) |
| * [debug](reference/manim.utils.debug.md) |
| * [deprecation](reference/manim.utils.deprecation.md) |
| * [docbuild](reference/manim.utils.docbuild.md) |
| * [hashing](reference/manim.utils.hashing.md) |
| * [images](reference/manim.utils.images.md) |
| * [ipython_magic](reference/manim.utils.ipython_magic.md) |
| * [iterables](reference/manim.utils.iterables.md) |
| * [paths](reference/manim.utils.paths.md) |
| * [rate_functions](reference/manim.utils.rate_functions.md) |
| * [simple_functions](reference/manim.utils.simple_functions.md) |
| * [sounds](reference/manim.utils.sounds.md) |
| * [space_ops](reference/manim.utils.space_ops.md) |
| * [testing](reference/manim.utils.testing.md) |
| * [tex](reference/manim.utils.tex.md) |
| * [tex_file_writing](reference/manim.utils.tex_file_writing.md) |
| * [tex_templates](reference/manim.utils.tex_templates.md) |
| * [typing](reference/manim.typing.md) |
|
|
