A community-maintained Python framework for creating mathematical animations.
Add documentation and testing for Transform's path_func behavior (#2771)
Simeon Widdisbcb5233259c3
diff --git a/manim/animation/transform.py b/manim/animation/transform.pyindex 624d36f00..77bed1def 100644--- a/manim/animation/transform.py+++ b/manim/animation/transform.py@@ -46,6 +46,36 @@ if TYPE_CHECKING:class Transform(Animation):+ """A Transform transforms a Mobject into a target Mobject.++ Parameters+ ----------+ mobject+ The :class:`.Mobject` to be transformed. It will be mutated to become the ``target_mobject``.+ target_mobject+ The target of the transformation.+ path_func+ A function defining the path that the points of the ``mobject`` are being moved+ along until they match the points of the ``target_mobject``, see :mod:`.utils.paths`.+ path_arc+ The arc angle (in radians) that the points of ``mobject`` will follow to reach+ the points of the target if using a circular path arc, see ``path_arc_centers``.+ path_arc_axis+ The axis to rotate along if using a circular path arc, see ``path_arc_centers``.+ path_arc_centers+ The center of the circular arcs along which the points of ``mobject`` are+ moved by the transformation.++ If this is set and ``path_func`` is not set, then a ``path_along_circles`` path will be generated+ using the ``path_arc`` parameters and stored in ``path_func``. If ``path_func`` is set, this and the+ other ``path_arc`` fields are set as attributes, but a ``path_func`` is not generated from it.+ replace_mobject_with_target_in_scene+ Controls which mobject is replaced when the transformation is complete.++ If set to True, ``mobject`` will be removed from the scene and ``target_mobject`` will+ replace it. Otherwise, ``target_mobject`` is never added and ``mobject`` just takes its shape.+ """+def __init__(self,mobject: Mobject | None,@@ -61,14 +91,16 @@ class Transform(Animation):self.path_arc_centers: np.ndarray = path_arc_centersself.path_arc: float = path_arc- if self.path_arc_centers is not None:+ # path_func is a property a few lines below so it doesn't need to be set in any case+ if path_func is not None:+ self.path_func: Callable = path_func+ elif self.path_arc_centers is not None:self.path_func = path_along_circles(path_arc,self.path_arc_centers,self.path_arc_axis,)- self.path_func: Callable | None = path_funcself.replace_mobject_with_target_in_scene: bool = (replace_mobject_with_target_in_scene)diff --git a/tests/test_graphical_units/control_data/transform/TransformWithConflictingPaths.npz b/tests/test_graphical_units/control_data/transform/TransformWithConflictingPaths.npznew file mode 100644index 000000000..541684c6fBinary files /dev/null and b/tests/test_graphical_units/control_data/transform/TransformWithConflictingPaths.npz differdiff --git a/tests/test_graphical_units/control_data/transform/TransformWithPathArcCenters.npz b/tests/test_graphical_units/control_data/transform/TransformWithPathArcCenters.npznew file mode 100644index 000000000..3a0bc9a55Binary files /dev/null and b/tests/test_graphical_units/control_data/transform/TransformWithPathArcCenters.npz differdiff --git a/tests/test_graphical_units/control_data/transform/TransformWithPathFunc.npz b/tests/test_graphical_units/control_data/transform/TransformWithPathFunc.npznew file mode 100644index 000000000..541684c6fBinary files /dev/null and b/tests/test_graphical_units/control_data/transform/TransformWithPathFunc.npz differdiff --git a/tests/test_graphical_units/test_transform.py b/tests/test_graphical_units/test_transform.pyindex aa13c3dcc..aa5e74047 100644--- a/tests/test_graphical_units/test_transform.py+++ b/tests/test_graphical_units/test_transform.py@@ -163,3 +163,39 @@ def test_ReplacementTransform(scene):v2 = Vector()v3 = Line()scene.play(ReplacementTransform(VGroup(v1, v2), v3))+++@frames_comparison(last_frame=False)+def test_TransformWithPathFunc(scene):+ dots_start = VGroup(*[Dot(LEFT, color=BLUE), Dot(3 * RIGHT, color=RED)])+ dots_end = VGroup(*[Dot(LEFT + 2 * DOWN, color=BLUE), Dot(2 * UP, color=RED)])+ scene.play(Transform(dots_start, dots_end, path_func=clockwise_path()))+++@frames_comparison(last_frame=False)+def test_TransformWithPathArcCenters(scene):+ dots_start = VGroup(*[Dot(LEFT, color=BLUE), Dot(3 * RIGHT, color=RED)])+ dots_end = VGroup(*[Dot(LEFT + 2 * DOWN, color=BLUE), Dot(2 * UP, color=RED)])+ scene.play(+ Transform(+ dots_start,+ dots_end,+ path_arc=2 * PI,+ path_arc_centers=ORIGIN,+ )+ )+++@frames_comparison(last_frame=False)+def test_TransformWithConflictingPaths(scene):+ dots_start = VGroup(*[Dot(LEFT, color=BLUE), Dot(3 * RIGHT, color=RED)])+ dots_end = VGroup(*[Dot(LEFT + 2 * DOWN, color=BLUE), Dot(2 * UP, color=RED)])+ scene.play(+ Transform(+ dots_start,+ dots_end,+ path_func=clockwise_path(),+ path_arc=2 * PI,+ path_arc_centers=ORIGIN,+ )+ )