Animation

Qualified name: manim.animation.animation.Animation

class Animation(mobject=None, *args, use_override=True, **kwargs)[source]

Bases: object

An animation.

Animations have a fixed time span.

Parameters
  • mobject – The mobject to be animated. This is not required for all types of animations.

  • lag_ratio

    Defines the delay after which the animation is applied to submobjects. This lag is relative to the duration of the animation.

    This does not influence the total runtime of the animation. Instead the runtime of individual animations is adjusted so that the complete animation has the defined run time.

  • run_time – The duration of the animation in seconds.

  • rate_func

    The function defining the animation progress based on the relative runtime (see rate_functions) .

    For example rate_func(0.5) is the proportion of the animation that is done after half of the animations run time.

  • name – The name of the animation. This gets displayed while rendering the animation. Defaults to <class-name>(<Mobject-name>).

  • remover – Whether the given mobject should be removed from the scene after this animation.

  • suspend_mobject_updating – Whether updaters of the mobject should be suspended during the animation.

Examples

Example: LagRatios

from manim import *

class LagRatios(Scene):
    def construct(self):
        ratios = [0, 0.1, 0.5, 1, 2]  # demonstrated lag_ratios

        # Create dot groups
        group = VGroup(*[Dot() for _ in range(4)]).arrange_submobjects()
        groups = VGroup(*[group.copy() for _ in ratios]).arrange_submobjects(buff=1)
        self.add(groups)

        # Label groups
        self.add(Text("lag_ratio = ", font_size=36).next_to(groups, UP, buff=1.5))
        for group, ratio in zip(groups, ratios):
            self.add(Text(str(ratio), font_size=36).next_to(group, UP))

        #Animate groups with different lag_ratios
        self.play(AnimationGroup(*[
            group.animate(lag_ratio=ratio, run_time=1.5).shift(DOWN * 2)
            for group, ratio in zip(groups, ratios)
        ]))

        # lag_ratio also works recursively on nested submobjects:
        self.play(groups.animate(run_time=1, lag_ratio=0.1).shift(UP * 2))

Methods

begin

Begin the animation.

clean_up_from_scene

Clean up the Scene after finishing the animation.

copy

Create a copy of the animation.

create_starting_mobject

finish

Finish the animation.

get_all_families_zipped

get_all_mobjects

Get all mobjects involved in the animation.

get_all_mobjects_to_update

Get all mobjects to be updated during the animation.

get_rate_func

Get the rate function of the animation.

get_run_time

Get the run time of the animation.

get_sub_alpha

Get the animation progress of any submobjects subanimation.

interpolate

Set the animation progress.

interpolate_mobject

Interpolates the mobject of the Animation based on alpha value.

interpolate_submobject

is_remover

Test if a the animation is a remover.

set_name

Set the name of the animation.

set_rate_func

Set the rate function of the animation.

set_run_time

Set the run time of the animation.

update_mobjects

Updates things like starting_mobject, and (for Transforms) target_mobject.

begin()[source]

Begin the animation.

This method is called right as an animation is being played. As much initialization as possible, especially any mobject copying, should live in this method.

Return type

None

clean_up_from_scene(scene)[source]

Clean up the Scene after finishing the animation.

This includes to remove() the Animation’s Mobject if the animation is a remover.

Parameters

scene (Scene) – The scene the animation should be cleaned up from.

Return type

None

copy()[source]

Create a copy of the animation.

Returns

A copy of self

Return type

Animation

finish()[source]

Finish the animation.

This method gets called when the animation is over.

Return type

None

get_all_mobjects()[source]

Get all mobjects involved in the animation.

Ordering must match the ordering of arguments to interpolate_submobject

Returns

The sequence of mobjects.

Return type

Sequence[Mobject]

get_all_mobjects_to_update()[source]

Get all mobjects to be updated during the animation.

Returns

The list of mobjects to be updated during the animation.

Return type

List[Mobject]

get_rate_func()[source]

Get the rate function of the animation.

Returns

The rate function of the animation.

Return type

Callable[[float], float]

get_run_time()[source]

Get the run time of the animation.

Returns

The time the animation takes in seconds.

Return type

float

get_sub_alpha(alpha, index, num_submobjects)[source]

Get the animation progress of any submobjects subanimation.

Parameters
  • alpha (float) – The overall animation progress

  • index (int) – The index of the subanimation.

  • num_submobjects (int) – The total count of subanimations.

Returns

The progress of the subanimation.

Return type

float

interpolate(alpha)[source]

Set the animation progress.

This method gets called for every frame during an animation.

Parameters

alpha (float) – The relative time to set the aniamtion to, 0 meaning the start, 1 meaning the end.

Return type

None

interpolate_mobject(alpha)[source]

Interpolates the mobject of the Animation based on alpha value.

Parameters

alpha (float) – A float between 0 and 1 expressing the ratio to which the animation is completed. For example, alpha-values of 0, 0.5, and 1 correspond to the animation being completed 0%, 50%, and 100%, respectively.

Return type

None

is_remover()[source]

Test if a the animation is a remover.

Returns

True if the animation is a remover, False otherwise.

Return type

bool

set_name(name)[source]

Set the name of the animation.

Parameters

name (str) – The new name of the animation.

Returns

self

Return type

Animation

set_rate_func(rate_func)[source]

Set the rate function of the animation.

Parameters
  • run_time – The new time the animation should take in seconds.

  • rate_func (Callable[[float], float]) –

Returns

self

Return type

Animation

set_run_time(run_time)[source]

Set the run time of the animation.

Parameters
  • run_time (float) – The new time the animation should take in seconds.

  • note:: (.) – The run_time of an animation should not be changed while it is already running.

Returns

self

Return type

Animation

update_mobjects(dt)[source]

Updates things like starting_mobject, and (for Transforms) target_mobject. Note, since typically (always?) self.mobject will have its updating suspended during the animation, this will do nothing to self.mobject.

Parameters

dt (float) –

Return type

None