opensource/manim-slides
1
0
Fork 0
mirror of https://github.com/jeertmans/manim-slides.git synced 2025-08-06 14:19:52 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
manim-slides/docs/source/reference/api.md
Jérome Eertmans 802f6406ae refactor(lib): change how manim API is imported (#285) 
* refactor(lib): change how manim API is imported

* chore(lib): delete old files

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

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

* wip: moving all commands

* adding animations

* fix tests

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

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

* fix mypy

* fixes

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

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

* trying to fix docs

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

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

* wip: docs

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

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

* make it work

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

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

* wip test

* tests are working

* improving docs

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

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

* fix index

* docs: nicer shift

* docs: nicer quickstart example

* fix tests

* change tests

* move coverage to test workflow

* fix(tests): remove resolve

* strict resolve

* change local path test

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

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

* documented changes

* cleanup docs

* cleanup files

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

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

* fix(ci): set type

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-10-17 16:06:19 +02:00

868 B
Raw Blame History

Application Programming Interface

Manim Slides' API is very limited: it simply consists of two classes, Slide and ThreeDSlide, which are subclasses of Scene and ThreeDScene from Manim.

Therefore, we only document here the methods we think the end-user will ever use, not the methods used internally when rendering.

Slide

.. autoclass:: manim_slides.slide.Slide
    :members:
        add_to_canvas,
        canvas,
        canvas_mobjects,
        end_loop,
        mobjects_without_canvas,
        next_slide,
        remove_from_canvas,
        start_loop,
        wait_time_between_slides,
        wipe,
        zoom,

3D Slide

.. autoclass:: manim_slides.slide.ThreeDSlide
    :members:

Animations

.. automodule:: manim_slides.slide.animation
    :members:
        Wipe,
        Zoom,