A community-maintained Python framework for creating mathematical animations.
New feature: Allow overriding new-style method animations (#917)
Benjamin Hackldc726f4bc1f6
diff --git a/manim/mobject/mobject.py b/manim/mobject/mobject.pyindex a5fccd442..7aaa38dd6 100644--- a/manim/mobject/mobject.py+++ b/manim/mobject/mobject.py@@ -1,7 +1,7 @@"""Base classes for objects that can be displayed."""-__all__ = ["Mobject", "Group"]+__all__ = ["Mobject", "Group", "override_animate"]from functools import reduce@@ -28,7 +28,6 @@ from ..utils.space_ops import angle_of_vectorfrom ..utils.space_ops import get_normfrom ..utils.space_ops import rotation_matrix-# TODO: Explain array_attrs@@ -75,6 +74,11 @@ class Mobject(Container):self.play(my_mobject.animate.shift(RIGHT).rotate(PI))+ .. seealso::++ :meth:`~.Mobject.override_animate`++Examples--------@@ -1343,21 +1347,94 @@ class Group(Mobject):class _AnimationBuilder:- def __init__(self, mobject, generate_target=True):+ def __init__(self, mobject):self.mobject = mobject- if generate_target:- self.mobject.generate_target()+ self.overridden_animation = None+ self.mobject.generate_target()def __getattr__(self, method_name):method = getattr(self.mobject.target, method_name)+ if self.overridden_animation:+ raise NotImplementedError(+ "Method chaining is currently not supported for "+ "overridden animations"+ )+def update_target(*method_args, **method_kwargs):- method(*method_args, **method_kwargs)- return _AnimationBuilder(self.mobject, generate_target=False)+ if hasattr(method, "_override_animate"):+ self.overridden_animation = method._override_animate(+ self.mobject, *method_args, **method_kwargs+ )+ else:+ method(*method_args, **method_kwargs)+ return selfreturn update_targetdef build(self):from ..animation.transform import _MethodAnimation+ if self.overridden_animation:+ return self.overridden_animation+return _MethodAnimation(self.mobject)+++def override_animate(method):+ r"""Decorator for overriding method animations.++ This allows to specify a method (returning an :class:`~.Animation`)+ which is called when the decorated method is used with the ``.animate`` syntax+ for animating the application of a method.++ .. seealso::++ :prop:`~.Mobject.animate`++ .. note::++ Overridden methods cannot be combined with normal or other overridden+ methods using method chaining with the ``.animate`` syntax.+++ Examples+ --------++ .. manim:: AnimationOverrideExample++ from manim import Circle, Scene, ShowCreation, Text, Uncreate, VGroup++ class CircleWithContent(VGroup):+ def __init__(self, content):+ super().__init__()+ self.circle = Circle()+ self.content = content+ self.add(self.circle, content)+ content.move_to(self.circle.get_center())++ def clear_content(self):+ self.remove(self.content)+ self.content = None++ @override_animate(clear_content)+ def _clear_content_animation(self):+ anim = Uncreate(self.content)+ self.clear_content()+ return anim++ class AnimationOverrideExample(Scene):+ def construct(self):+ t = Text("hello!")+ my_mobject = CircleWithContent(t)+ self.play(ShowCreation(my_mobject))+ self.play(my_mobject.animate.clear_content())+ self.wait()++ """++ def decorator(animation_method):+ method._override_animate = animation_method+ return animation_method++ return decoratordiff --git a/tests/test_animate.py b/tests/test_animate.pynew file mode 100644index 000000000..b9f68695b--- /dev/null+++ b/tests/test_animate.py@@ -0,0 +1,47 @@+import numpy as np++from manim.mobject.mobject import override_animate+from manim.mobject.types.vectorized_mobject import VGroup+from manim.mobject.geometry import Dot, Line, Square+from manim.animation.creation import Uncreate+++def test_simple_animate():+ s = Square()+ scale_factor = 2+ anim = s.animate.scale(scale_factor).build()+ assert anim.mobject.target.get_width() == scale_factor * s.get_width()+++def test_chained_animate():+ s = Square()+ scale_factor = 2+ direction = np.array((1, 1, 0))+ anim = s.animate.scale(scale_factor).shift(direction).build()+ assert (+ anim.mobject.target.get_width() == scale_factor * s.get_width()+ and (anim.mobject.target.get_center() == direction).all()+ )+++def test_overridden_animate():+ class DotsWithLine(VGroup):+ def __init__(self):+ super().__init__()+ self.left_dot = Dot().shift((-1, 0, 0))+ self.right_dot = Dot().shift((1, 0, 0))+ self.line = Line(self.left_dot, self.right_dot)+ self.add(self.left_dot, self.right_dot, self.line)++ def remove_line(self):+ self.remove(self.line)++ @override_animate(remove_line)+ def _remove_line_animation(self):+ self.remove_line()+ return Uncreate(self.line)++ dots_with_line = DotsWithLine()+ anim = dots_with_line.animate.remove_line().build()+ assert len(dots_with_line.submobjects) == 2+ assert type(anim) is Uncreate