Merge pull request #138 from chris-greening/add-animate-feature

Add animate repeat feature
chris-greening · Apr 7, 2023 · 92ce83c · 92ce83c
2 parents 4a01aeb + d9b4427
commit 92ce83c
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 14 deletions.
diff --git a/setup.py b/setup.py
@@ -7,7 +7,7 @@
 
 setuptools.setup(
     name="spyrograph",
-    version="0.22.1",
+    version="0.23.0",
     author="Chris Greening",
     author_email="chris@christophergreening.com",
     description="Library for drawing spirographs in Python",

diff --git a/spyrograph/core/_misc.py b/spyrograph/core/_misc.py
@@ -82,17 +82,20 @@ def _draw_animation(
         screen_color: str = "white", exit_on_click: bool = False,
         color: str = "black", width: Number = 1,
         frame_pause: Number = 0.1, screen: "turtle.Screen" = None,
-        screen_coords = (0, 0), padding: Number = 100
+        screen_coords = (0, 0), padding: Number = 100, repeat: bool = False
     ) -> None:
-    for shape in shapes_arr:
-        if screen is not None:
-            turtles.shape_turtle.clear()
-        screen, turtles = shape.trace(
-            screen = screen, screen_size = screen_size,
-            screen_color = screen_color,
-            color = color, width=width, screen_coords=screen_coords,
-            padding=padding
-        )
-        time.sleep(frame_pause)
+    while True:
+        for shape in shapes_arr:
+            if screen is not None:
+                turtles.shape_turtle.clear()
+            screen, turtles = shape.trace(
+                screen = screen, screen_size = screen_size,
+                screen_color = screen_color,
+                color = color, width=width, screen_coords=screen_coords,
+                padding=padding
+            )
+            time.sleep(frame_pause)
+        if not repeat:
+            break
     if exit_on_click:
         turtle.Screen().exitonclick()
diff --git a/spyrograph/core/_trochoid.py b/spyrograph/core/_trochoid.py
@@ -369,7 +369,7 @@ def animate(
             screen_color: str = "white", exit_on_click: bool = False,
             color: str = "black", width: Number = 1,
             frame_pause: Number = 0.1, screen: "turtle.Screen" = None, screen_coords = (0, 0),
-            padding: Number = 100
+            padding: Number = 100, repeat: bool = False
         ) -> List["_Trochoid"]:
         """
         Animate a sequence of _Trochoid shapes with varying input parameters,
@@ -420,6 +420,9 @@ def animate(
             Existing turtle screen.
         padding : Number
             Padding on the outside of the image
+        repeat : bool, optional
+            If True, infinitely repeat the animation so it starts over from the
+            beginning, default is False.
 
         Returns
         -------
@@ -442,7 +445,7 @@ def animate(
             shapes_arr=shapes_arr, screen_size=screen_size,
             screen_color=screen_color, exit_on_click=exit_on_click, color=color,
             width=width, frame_pause=frame_pause, screen=screen,
-            screen_coords=screen_coords, padding=padding
+            screen_coords=screen_coords, padding=padding, repeat=repeat
         )
         return shapes_arr