manim/docs/source/reference.rst
Sparsh Goenka 6c58f4a777
Added :class:.ChangeSpeed, an animation wrapper that allows to smoothly change the speed at which an animation is played (#2749)
* Added speedmodifier.py

* fix bugs, stable state

* rate_func, comments

* Add docs

* add `ChangedWait`

* run_time override for AnimationGroup

* fix AnimationGroup

* change example

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix docstrings

* small improvements

[pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

fix AnimationGroup

fix AnimationGroup...

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add_updater for changed speed

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* rename vars

* Remove `ChangedWait`,
Set default `rate_func` for `Wait` to `linear`

* fix `Succession`

* fix updaters

* fix docs

* rename vars

* [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: Benjamin Hackl <devel@benjamin-hackl.at>

* convert lambdas into funcs

* Add tests.

* reduced test run time and regenerated control data

* Update manim/animation/speedmodifier.py

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

* include new module in docbuild

* added module docstring

* fixed non-rendering examples in documentation

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
Co-authored-by: Tristan Schulz <mrdiverlp@gmail.com>
Co-authored-by: Benjamin Hackl <benjamin.hackl@aau.at>
2022-07-06 16:39:55 +02:00

112 lines
2.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/index`. 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.
Inheritance Graphs
------------------
Animations
**********
.. inheritance-diagram::
manim.animation.animation
manim.animation.changing
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.specialized
manim.animation.speedmodifier
manim.animation.transform
manim.animation.transform_matching_parts
manim.animation.updaters.mobject_update_utils
manim.animation.updaters.update
:parts: 1
:top-classes: manim.animation.animation.Animation
Cameras
*******
.. 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
Mobjects
********
.. inheritance-diagram::
manim.mobject.frame
manim.mobject.geometry.arc
manim.mobject.geometry.boolean_ops
manim.mobject.geometry.line
manim.mobject.geometry.polygram
manim.mobject.geometry.shape_matchers
manim.mobject.geometry.tips
manim.mobject.graph
manim.mobject.graphing.coordinate_systems
manim.mobject.graphing.functions
manim.mobject.graphing.number_line
manim.mobject.graphing.probability
manim.mobject.graphing.scale
manim.mobject.logo
manim.mobject.matrix
manim.mobject.mobject
manim.mobject.table
manim.mobject.three_d.polyhedra
manim.mobject.three_d.three_d_utils
manim.mobject.three_d.three_dimensions
manim.mobject.svg.brace
manim.mobject.svg.svg_mobject
manim.mobject.text.code_mobject
manim.mobject.text.numbers
manim.mobject.text.tex_mobject
manim.mobject.text.text_mobject
manim.mobject.types.image_mobject
manim.mobject.types.point_cloud_mobject
manim.mobject.types.vectorized_mobject
manim.mobject.value_tracker
manim.mobject.vector_field
:parts: 1
:top-classes: manim.mobject.mobject.Mobject
Scenes
******
.. inheritance-diagram::
manim.scene.moving_camera_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
Module Index
------------
.. toctree::
:maxdepth: 3
reference_index/animations
reference_index/cameras
reference_index/configuration
reference_index/mobjects
reference_index/scenes
reference_index/utilities_misc