Allow playing Animations asynchronously using OpenGLRenderer #1528

AntonBallmaier · 2021-05-17T00:32:48Z

Changelog / Overview

Scene.play can take a new keyword argument run_async. If True this will start the animation and return to executing Scene.construct immediately. This feature is only availably using the OpenGLRenderer.

Motivation

see #1488
closes #1267

Explanation for Changes

Documentation Reference

Testing Status

Further Comments

I would like to add an example to the docs, but as far as I know we cannot render OpenGl-videos to the docs, right?

Checklist

I have read the Contributing Guidelines
I have written a descriptive PR title (see top of PR template for examples)
I have written a changelog entry for the PR or deem it unnecessary
My new functions/classes either have a docstring or are private
My new functions/classes have tests added and (optional) examples in the docs
My new documentation builds, looks correctly formatted, and adds no additional build warnings

Reviewer Checklist

The PR title is descriptive enough
The PR is labeled correctly
The changelog entry is completed if necessary
Newly added functions/classes either have a docstring or are private
Newly added functions/classes have tests added and (optional) examples in the docs
Newly added documentation builds, looks correctly formatted, and adds no additional build warnings

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

TRoboto · 2021-05-17T13:28:35Z

I've tried to play your example #1267, with preview enabled, after converting it to OpenGL, but it didn't work as it should. When I write to a file, I receive this error.

ValueError: write to closed file

Find the scene below. Note that you should temporarily change this line to lines = OpenGLVGroup() in order for it to work.

class UsingUpdater(Scene):
    def construct(self):
        # Setup
        dots = OpenGLVGroup(
            *[
                Dot(RIGHT * random.randrange(-6, 6) + UP * random.randrange(-2, 2))
                for i in range(10)
            ]
        )
        line = Line(UP * 3, DOWN * 3).align_on_border(LEFT)
        self.add(dots)
        self.play(Create(line))

        # Updater
        def flash_hit_dots(mob):
            for dot in dots:
                if dot.get_center()[0] < mob.get_center()[0] and not hasattr(
                    dot, "marked"
                ):
                    self.play(Flash(dot, run_time=0.5))
                    dot.marked = True

        line.add_updater(flash_hit_dots)

        # Animate Line
        self.play(line.animate.align_on_border(RIGHT), run_time=5)
        self.wait()

AntonBallmaier · 2021-05-17T14:23:31Z

I've tried to play your example #1267, with preview enabled, after converting it to OpenGL, but it didn't work as it should. When I write to a file, I receive this error.
ValueError: write to closed file

That is the error that one gets without the changes I made. Have you made sure that you are actually running the code on the branch of this PR? I just tested the same code and don't get that error.

Find the scene below. Note that you should temporarily change this line to lines = OpenGLVGroup() in order for it to work.

class UsingUpdater(Scene):
    def construct(self):
        # Setup
        dots = OpenGLVGroup(
            *[
                Dot(RIGHT * random.randrange(-6, 6) + UP * random.randrange(-2, 2))
                for i in range(10)
            ]
        )
        line = Line(UP * 3, DOWN * 3).align_on_border(LEFT)
        self.add(dots)
        self.play(Create(line))

        # Updater
        def flash_hit_dots(mob):
            for dot in dots:
                if dot.get_center()[0] < mob.get_center()[0] and not hasattr(
                    dot, "marked"
                ):
                    self.play(Flash(dot, run_time=0.5))
                    dot.marked = True

        line.add_updater(flash_hit_dots)

        # Animate Line
        self.play(line.animate.align_on_border(RIGHT), run_time=5)
        self.wait()

I tested the code and had to make a tiny adjustment for it to work:

class UsingUpdater(Scene):
    def construct(self):
        # Setup
        dots = OpenGLVGroup(
            *[
                Dot(RIGHT * random.randrange(-6, 6) + UP * random.randrange(-2, 2))
                for i in range(10)
            ]
        )
        line = Line(UP * 3, DOWN * 3).align_on_border(LEFT)
        self.add(dots)

        # Updater
        def flash_hit_dots(mob):
            for dot in dots:
                if dot.get_center()[0] < line.get_center()[0] and not hasattr(
                    dot, "marked"
                ):
                    self.play(Flash(dot, run_time=0.5, rate_func=rush_from))
                    dot.marked = True

        line.add_updater(flash_hit_dots)

        # Animate Line
        self.play(line.animate.align_on_border(RIGHT), run_time=5)
        self.wait()

Resulting in:

UsingUpdater.mp4

TRoboto · 2021-05-17T16:38:37Z

The old scene still doesn't work but with your edits, it does. When the mob argument is used inside the updater function, everything breaks. Is this supposed to happen?

AntonBallmaier · 2021-05-17T18:08:14Z

The old scene still doesn't work but with your edits, it does. When the mob argument is used inside the updater function, everything breaks. Is this supposed to happen?

Definitely not, and I ~~will open~~ have opened an issue addressing that bug. It is however ~~(as far as I can tell)~~ (for sure) not related to this PR. See #1536 :) Thanks for the tip making me look into this 👍

manim/scene/scene.py

TRoboto · 2021-05-17T20:53:00Z

Definitely not, and I ~~will open~~ have opened an issue addressing that bug. It is however ~~(as far as I can tell)~~ (for sure) not related to this PR. See #1536 :) Thanks for the tip making me look into this +1

Thank you for the unstoppable contributions, your work is astonishing. This PR LGTM now.

huguesdevimeux

So, that's a great addition. I left some comments.
This crucially needs two things to my eyes :

Comments of the logic ; there are parts that are kind of obscure and need explanation.
This needs test, I think both graphical and units. You could use mocks to test, I think.

Aside, that's (again!) a great contribution !

huguesdevimeux · 2021-05-27T11:30:02Z

manim/scene/scene.py

@@ -946,6 +1032,7 @@ def play_internal(self, skip_rendering=False):
            named parameters affecting what was passed in ``args``,
            e.g. ``run_time``, ``lag_ratio`` and so on.
        """
+        self.sync_play_running = True


I think using a decorator here would make sense and would improve readability imo

huguesdevimeux · 2021-05-27T11:34:21Z

manim/scene/scene.py

+        """
+        mobject = animation.mobject
+
+        animation.suspend_mobject_updating = False


Question : why ?

huguesdevimeux · 2021-05-27T11:40:04Z

manim/scene/scene.py

+            animation.update_mobjects(dt)
+            update.total_time += dt
+
+        update.total_time = 0


Coment : Although I undestand what you're doing here, I'm not really a big fan of adding attributes to functions.
Why not turing update into a proper class with a __call__ method ?

huguesdevimeux · 2021-05-27T11:53:20Z

manim/scene/scene.py

+        if self.sync_play_running:
+            if run_async is None:
+                run_async = True
+            if not run_async:
+                raise ValueError(
+                    "Cannot start a synchronous animation while another is running."
+                )
+        elif run_async is None:
+            run_async = False
+
+        if run_async:
+            animations = self.compile_animations(*animations, **kwargs)
+
+            self.add_mobjects_from_animations(animations)
+            for animation in animations:
+                self._turn_animation_to_updater(animation)
+            return


I believe the whole logic can be simplified.
You could do instead

<run_sync is False by default) if self.sync_play_running run_sync = False if config[blabla] = blab else run_sync if not run_sync: # ValueError blabla # and then the play logic (inside l 899). # here (outside the if) the normal play logic.

What do you think ?

Darylgolden · 2021-09-22T10:55:44Z

Hi, can I check on the status of this PR?

MrDiver · 2022-06-18T18:02:23Z

Closing this for now because there is no activity. We can come back to this. The issue is on the project board and the PR is linked!

AntonBallmaier and others added 5 commits May 17, 2021 01:27

remove turn_animation_into_updater and reuse logic

514a3a3

fix bug

928abf1

add Scene.play docs

e38b1d7

add docs to _turn_animation_to_updater

03271d5

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

682a100

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

AntonBallmaier added the new feature Enhancement specifically adding a new feature (feature request should be used for issues instead) label May 17, 2021

AntonBallmaier requested a review from behackl May 17, 2021 10:12

Merge branch 'master' into async_play

e3c0647

Merge branch 'master' into async_play

d7766b4

TRoboto reviewed May 17, 2021

View reviewed changes

manim/scene/scene.py Outdated Show resolved Hide resolved

AntonBallmaier added 2 commits May 17, 2021 23:49

fix typo

236ea3e

Merge branch 'master' into async_play

0a7b668

AntonBallmaier requested review from huguesdevimeux and removed request for behackl May 27, 2021 11:15

huguesdevimeux requested changes May 27, 2021

View reviewed changes

Merge branch 'main' into async_play

8e1da5f

MrDiver closed this Jun 18, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow playing Animations asynchronously using OpenGLRenderer #1528

Allow playing Animations asynchronously using OpenGLRenderer #1528

AntonBallmaier commented May 17, 2021 •

edited

Loading

TRoboto commented May 17, 2021

AntonBallmaier commented May 17, 2021 •

edited

Loading

TRoboto commented May 17, 2021

AntonBallmaier commented May 17, 2021 •

edited

Loading

TRoboto commented May 17, 2021

huguesdevimeux left a comment •

edited

Loading

huguesdevimeux May 27, 2021

huguesdevimeux May 27, 2021

huguesdevimeux May 27, 2021

huguesdevimeux May 27, 2021

Darylgolden commented Sep 22, 2021

MrDiver commented Jun 18, 2022

Allow playing Animations asynchronously using OpenGLRenderer #1528

Allow playing Animations asynchronously using OpenGLRenderer #1528

Conversation

AntonBallmaier commented May 17, 2021 • edited Loading

Changelog / Overview

Motivation

Explanation for Changes

Testing Status

Further Comments

Checklist

Reviewer Checklist

TRoboto commented May 17, 2021

AntonBallmaier commented May 17, 2021 • edited Loading

TRoboto commented May 17, 2021

AntonBallmaier commented May 17, 2021 • edited Loading

TRoboto commented May 17, 2021

huguesdevimeux left a comment • edited Loading

Choose a reason for hiding this comment

huguesdevimeux May 27, 2021

Choose a reason for hiding this comment

huguesdevimeux May 27, 2021

Choose a reason for hiding this comment

huguesdevimeux May 27, 2021

Choose a reason for hiding this comment

huguesdevimeux May 27, 2021

Choose a reason for hiding this comment

Darylgolden commented Sep 22, 2021

MrDiver commented Jun 18, 2022

AntonBallmaier commented May 17, 2021 •

edited

Loading

AntonBallmaier commented May 17, 2021 •

edited

Loading

AntonBallmaier commented May 17, 2021 •

edited

Loading

huguesdevimeux left a comment •

edited

Loading