add animation looping option

Author: baggepinnen

ext/Render.jl

@@ -131,6 +131,7 @@ function render(model, sol,
     timescale = 1.0,
     traces = nothing,
     display = false,
+    loop = 1,
     kwargs...
     )
     scene, fig = default_scene(x,y,z; lookat,up,show_axis)
@@ -150,7 +151,9 @@ function render(model, sol,
             Makie.lines!(scene, points)
         end
     end
-
+    if loop > 1
+        timevec = repeat(timevec, loop)
+    end
     if display
         Base.display(fig)
         sleep(2)
@@ -160,7 +163,7 @@ function render(model, sol,
                     Base.display(fig)
                 end
                 t[] = time/timescale
-                sleep(1/framerate)
+                sleep(max(0, 1/framerate))
             end
         end
         fn = fetch(fnt)
@@ -203,16 +206,16 @@ function render(model, sol, time::Real;
     fig, t
 end
 
-function Multibody.loop_render(model, sol; timescale = 1.0, framerate = 30, kwargs...)
+function Multibody.loop_render(model, sol; timescale = 1.0, framerate = 30, max_loop = 5, kwargs...)
     fig, t = render(model, sol, sol.t[1]; kwargs...)
     sleeptime = 1/framerate
     timevec = range(sol.t[1], sol.t[end]*timescale, step=sleeptime)
     display(fig)
     @async begin
-        for i = 1:5
+        for i = 1:max_loop
             for ti in timevec
                 execution_time = @elapsed t[] = ti
-                sleep(sleeptime - execution_time)
+                sleep(max(0, sleeptime - execution_time))
             end
         end
     end

src/Multibody.jl

@@ -12,7 +12,7 @@ export render, render!
 
 """
     scene, time = render(model, sol, t::Real; framerate = 30, traces = [])
-    path        = render(model, sol, timevec = range(sol.t[1], sol.t[end], step = 1 / framerate); framerate = 30, timescale=1, display=false)
+    path        = render(model, sol, timevec = range(sol.t[1], sol.t[end], step = 1 / framerate); framerate = 30, timescale=1, display=false, loop=1)
 
 Create a 3D animation of a multibody system
 
@@ -23,6 +23,7 @@ Create a 3D animation of a multibody system
 - `timevec`: If a vector of times is provided, an animation is created and the path to the file on disk is returned.
 - `framerate`: Number of frames per second.
 - `timescale`: Scaling of the time vector. This argument can be made to speed up animations (`timescale < 1`) or slow them down (`timescale > 1`). A value of `timescale = 2` will be 2x slower than real time.
+- `loop`: The animation will be looped this many times. Please note: looping the animation using this argument is only recommended when `display = true` for camera manipulation purposes. When the camera is not manipulated, looping the animation by other means is recommended to avoid an increase in the file size.
 - `filename` controls the name and the file type of the resulting animation
 - `traces`: An optional array of frames to show the trace of.
 
@@ -40,7 +41,7 @@ See also [`loop_render`](@ref)
 function render end
 
 """
-    loop_render(model, sol; framerate = 30, timescale = 1, kwargs...)
+    loop_render(model, sol; framerate = 30, timescale = 1, max_loop = 5, kwargs...)
 
 Similar to the method of [`render`](@ref) that produces an animation, but instead opens an interactive window where the time is automatically advanced in real time. This allows the user to manually manipulate the camera using the mouse is a live animation.
 """