mirror of
https://github.com/ManimCommunity/manim.git
synced 2026-06-22 10:01:47 +00:00
71b86d5dfa* test * revert test changes * finish draft implementation * use @wrapss to remove docs problems * reduce complexity and add doc deprecation * Docs deprecated_params * add decoratos to __init__ * Add decorators to documentation * Finish detailed docs * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Apply suggestions from code review Co-authored-by: Naveen M K <naveen@syrusdark.website> * change since/until/message param docs * Mark get_callable_info and deprecation_text_component as private * change how until is included in warning messages * Add The to prameter descriptions * is deprecated => has been deprecated * Fix typo * fix typo * make params docs more readable * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * make redirections docs clearer * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Fix typo * fix typo * fix typo * is_are => has_have_been * fix typo (at this point I am questioning my ability to type prameter) * update deprendency list * order dependencies * update examples * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix dependeny problem * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix duplicate problem * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * change decorator version * updated lock file * enhance function / method separation * fix typo and double underscores * rename message_ and replacement_ * Change warning to custom admonition * remove [] as default parameters * Remove "" around type * fix typo * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix bug and move to inspect * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * doc string => docstring * rename to deprecate * change module docstring * change to deprecation.py * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * some sugesstions * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * remove tests again * Rename decorators.py to deprecate.py * Update poetry.lock * Test if deprecated class outputs the correct warning when used * Rename deprecate to deprecation * Fix typos * Shorten conditional for msg * Shorten conditional for since * Shorten conditional for until * Specify decorator arguments in test * Add tests for since and until arguments * Add test for since and until as arguments * Add test for msg argument for class * Add test for replacement argument for class * Remove unneeded docstring in deprecated class * Add test for deprecate method, no args * Update docstring examples, move deprecated method outside class * Add test for method in class, since and message args * Add test for deprecating nested class * Add test for deprecated method in nested class * Test deprecation of nested function * Test param deprecation, only params argument * Test deprecation of single method param * Rename single param test method name * Fix deprecated_params docstring whitespace * Test parameter redirection using tuple * Update warning msgs in deprecated_params docstring * Test parameter redirection using lambda function * Test param redirection from many to one * Test param redirection from one to many * Update Top.foo to deprecate with message * handle empty docstrings * fix typo * Update poetry.lock * Update poetry.lock * Deprecate ShowCreation using decorator to test the docs * Test docstring for deprecated class * Test docstring for Bar and Baz classes * Test docstrings for the rest of the classes * Test docstrings for Top methods * Test docstrings for Top.Nested * Test docstring for nested method * Move deprecations to deprecation system * Some more deprecations * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix version numbering inconsistancies * Fix naming issue and MetaClass handling * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * restart CI Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Naveen M K <naveen@syrusdark.website> Co-authored-by: Ricky Chon <rickychon99@gmail.com> Co-authored-by: Jan-Hendrik Müller <44469195+kolibril13@users.noreply.github.com>
232 lines
4.9 KiB
ReStructuredText
232 lines
4.9 KiB
ReStructuredText
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 :doc:`tutorials`. For a list of changes since the last release, see
|
|
the :doc:`changelog`.
|
|
|
|
.. warning:: The pages linked to here are currently a work in progress.
|
|
|
|
.. currentmodule:: manim
|
|
|
|
********
|
|
Mobjects
|
|
********
|
|
|
|
.. autosummary::
|
|
:toctree: reference
|
|
|
|
~mobject.changing
|
|
~mobject.coordinate_systems
|
|
~mobject.frame
|
|
~mobject.functions
|
|
~mobject.geometry
|
|
~mobject.graph
|
|
~mobject.logo
|
|
~mobject.matrix
|
|
~mobject.mobject
|
|
~mobject.mobject_update_utils
|
|
~mobject.number_line
|
|
~mobject.numbers
|
|
~mobject.polyhedra
|
|
~mobject.probability
|
|
~mobject.shape_matchers
|
|
~mobject.three_d_utils
|
|
~mobject.three_dimensions
|
|
~mobject.value_tracker
|
|
~mobject.vector_field
|
|
~mobject.svg.brace
|
|
~mobject.svg.code_mobject
|
|
~mobject.svg.style_utils
|
|
~mobject.svg.svg_path
|
|
~mobject.svg.svg_mobject
|
|
~mobject.svg.tex_mobject
|
|
~mobject.svg.text_mobject
|
|
~mobject.types.image_mobject
|
|
~mobject.types.point_cloud_mobject
|
|
~mobject.types.vectorized_mobject
|
|
|
|
**Mobject** Inheritance Graph
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. inheritance-diagram::
|
|
manim.mobject.changing
|
|
manim.mobject.coordinate_systems
|
|
manim.mobject.frame
|
|
manim.mobject.functions
|
|
manim.mobject.geometry
|
|
manim.mobject.graph
|
|
manim.mobject.logo
|
|
manim.mobject.matrix
|
|
manim.mobject.mobject
|
|
manim.mobject.mobject_update_utils
|
|
manim.mobject.number_line
|
|
manim.mobject.numbers
|
|
manim.mobject.probability
|
|
manim.mobject.shape_matchers
|
|
manim.mobject.three_d_utils
|
|
manim.mobject.three_dimensions
|
|
manim.mobject.value_tracker
|
|
manim.mobject.vector_field
|
|
manim.mobject.svg.brace
|
|
manim.mobject.svg.code_mobject
|
|
manim.mobject.svg.style_utils
|
|
manim.mobject.svg.svg_path
|
|
manim.mobject.svg.svg_mobject
|
|
manim.mobject.svg.tex_mobject
|
|
manim.mobject.svg.text_mobject
|
|
manim.mobject.types.image_mobject
|
|
manim.mobject.types.point_cloud_mobject
|
|
manim.mobject.types.vectorized_mobject
|
|
:parts: 1
|
|
:top-classes: manim.mobject.mobject.Mobject
|
|
|
|
|
|
|
|
******
|
|
Scenes
|
|
******
|
|
|
|
.. autosummary::
|
|
:toctree: reference
|
|
|
|
~scene.graph_scene
|
|
~scene.moving_camera_scene
|
|
~scene.reconfigurable_scene
|
|
~scene.sample_space_scene
|
|
~scene.scene
|
|
~scene.scene_file_writer
|
|
~scene.three_d_scene
|
|
~scene.vector_space_scene
|
|
~scene.zoomed_scene
|
|
|
|
**Scene** Inheritance Graph
|
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. inheritance-diagram::
|
|
manim.scene.graph_scene
|
|
manim.scene.moving_camera_scene
|
|
manim.scene.reconfigurable_scene
|
|
manim.scene.sample_space_scene
|
|
manim.scene.scene
|
|
manim.scene.scene_file_writer
|
|
manim.scene.three_d_scene
|
|
manim.scene.vector_space_scene
|
|
manim.scene.zoomed_scene
|
|
:parts: 1
|
|
:top-classes: manim.scene.scene.Scene, manim.scene.scene.RerunSceneHandler
|
|
|
|
|
|
**********
|
|
Animations
|
|
**********
|
|
|
|
.. autosummary::
|
|
:toctree: reference
|
|
|
|
~animation.animation
|
|
~animation.composition
|
|
~animation.creation
|
|
~animation.fading
|
|
~animation.growing
|
|
~animation.indication
|
|
~animation.movement
|
|
~animation.numbers
|
|
~animation.rotation
|
|
~animation.transform
|
|
~animation.transform_matching_parts
|
|
~animation.update
|
|
|
|
**Animation** Inheritance Graph
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. inheritance-diagram::
|
|
manim.animation.animation
|
|
manim.animation.composition
|
|
manim.animation.creation
|
|
manim.animation.fading
|
|
manim.animation.growing
|
|
manim.animation.indication
|
|
manim.animation.movement
|
|
manim.animation.numbers
|
|
manim.animation.rotation
|
|
manim.animation.transform
|
|
manim.animation.transform_matching_parts
|
|
manim.animation.update
|
|
:parts: 1
|
|
:top-classes: manim.animation.animation.Animation
|
|
|
|
|
|
*******
|
|
Cameras
|
|
*******
|
|
|
|
.. autosummary::
|
|
:toctree: reference
|
|
|
|
~camera.camera
|
|
~camera.mapping_camera
|
|
~camera.moving_camera
|
|
~camera.multi_camera
|
|
~camera.three_d_camera
|
|
|
|
**Camera** Inheritance Graph
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. inheritance-diagram::
|
|
manim.camera.camera
|
|
manim.camera.mapping_camera
|
|
manim.camera.moving_camera
|
|
manim.camera.multi_camera
|
|
manim.camera.three_d_camera
|
|
:parts: 1
|
|
:top-classes: manim.camera.camera.Camera, manim.mobject.mobject.Mobject
|
|
|
|
*************
|
|
Configuration
|
|
*************
|
|
|
|
.. autosummary::
|
|
:toctree: reference
|
|
|
|
~_config
|
|
~_config.utils
|
|
~_config.logger_utils
|
|
|
|
|
|
*********
|
|
Utilities
|
|
*********
|
|
|
|
.. autosummary::
|
|
:toctree: reference
|
|
|
|
~utils.bezier
|
|
~utils.color
|
|
~utils.config_ops
|
|
~utils.deprecation
|
|
~utils.hashing
|
|
~utils.ipython_magic
|
|
~utils.images
|
|
~utils.iterables
|
|
~utils.paths
|
|
~utils.rate_functions
|
|
~utils.simple_functions
|
|
~utils.sounds
|
|
~utils.space_ops
|
|
~utils.strings
|
|
~utils.tex
|
|
~utils.tex_templates
|
|
~utils.tex_file_writing
|
|
|
|
|
|
*************
|
|
Other modules
|
|
*************
|
|
|
|
.. autosummary::
|
|
:toctree: reference
|
|
|
|
constants
|
|
container
|