Support running an animation N times (djeedai#19)

Remove `TweeningType` and split its functionalities between a new `RepeatCount`
controlling the number of repeats of an animation on one hand, and
`RepeatStrategy` controlling the way an animation restarts after a loop ended
on the other hand. This allows more granular control on the type of playback.

Remove the `tweening_type` parameter from `Tween<T>::new()` and replace it with
builder methods `with_repeat_count()` and `with_repeat_strategy()`.

Remove `is_looping()` from all tweenables, which was not implemented for most
of them anyway.

Author: SUPERCILEX

CHANGELOG.md

@@ -7,16 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Add `is_forward()` and `is_backward()` convenience helpers to `TweeningDirection`.
-- Add `Tween::set_direction()` and `Tween::with_direction()` which allow configuring the playback direction of a tween, allowing to play it backward from end to start.
-- Support dynamically changing an animation's speed with `Animator::set_speed`
-- Add `AnimationSystem` label to tweening tick systems
-- A `BoxedTweenable` type to make working with `Box<dyn Tweenable + ...>` easier
+- Added `is_forward()` and `is_backward()` convenience helpers to `TweeningDirection`.
+- Added `Tween::set_direction()` and `Tween::with_direction()` which allow configuring the playback direction of a tween, allowing to play it backward from end to start.
+- Added support for dynamically changing an animation's speed with `Animator::set_speed`.
+- Added `AnimationSystem` label to tweening tick systems.
+- Added `BoxedTweenable` type to make working with `Box<dyn Tweenable + ...>` easier.
+- Added `RepeatCount` and `RepeatStrategy` for more granular control over animation looping.
+- Added `with_repeat_count()` and `with_repeat_strategy()` builder methods to `Tween<T>`.
 
 ### Changed
 
-- Double boxing in `Sequence` and `Tracks` was fixed. As a result, any custom tweenables
+- Double boxing in `Sequence` and `Tracks` was fixed. As a result, any custom tweenables.
   should implement `From` for `BoxedTweenable` to make those APIs easier to use.
+- Removed the `tweening_type` parameter from the signature of `Tween<T>::new()`; use `with_repeat_count()` and `with_repeat_strategy()` instead.
+
+### Removed
+
+- Removed `Tweenable::is_looping()`, which was not implemented for most tweenables.
+- Removed `TweeningType` in favor of `RepeatCount` and `RepeatStrategy`.
 
 ## [0.4.0] - 2022-04-16
 

examples/colormaterial_color.rs

@@ -77,13 +77,14 @@ fn setup(
 
         let tween = Tween::new(
             *ease_function,
-            TweeningType::PingPong,
             Duration::from_secs(1),
             ColorMaterialColorLens {
                 start: Color::RED,
                 end: Color::BLUE,
             },
-        );
+        )
+        .with_repeat_count(RepeatCount::Infinite)
+        .with_repeat_strategy(RepeatStrategy::MirroredRepeat);
 
         commands
             .spawn_bundle(MaterialMesh2dBundle {

examples/menu.rs

@@ -50,7 +50,6 @@ fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
         start_time_ms += 500;
         let tween_scale = Tween::new(
             EaseFunction::BounceOut,
-            TweeningType::Once,
             Duration::from_secs(2),
             TransformScaleLens {
                 start: Vec3::splat(0.01),

examples/sequence.rs

@@ -1,6 +1,8 @@
+use std::time::Duration;
+
 use bevy::prelude::*;
+
 use bevy_tweening::{lens::*, *};
-use std::time::Duration;
 
 fn main() {
     App::default()
@@ -107,19 +109,31 @@ fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
         Vec3::new(margin, screen_y - margin, 0.),
         Vec3::new(margin, margin, 0.),
     ];
-    // Build a sequence from an iterator over a Tweenable (here, a Tween<Transform>)
+    // Build a sequence from an iterator over a Tweenable (here, a
+    // Tracks<Transform>)
     let seq = Sequence::new(dests.windows(2).enumerate().map(|(index, pair)| {
-        Tween::new(
-            EaseFunction::QuadraticInOut,
-            TweeningType::Once,
-            Duration::from_secs(1),
-            TransformPositionLens {
-                start: pair[0] - center,
-                end: pair[1] - center,
-            },
-        )
-        // Get an event after each segment
-        .with_completed_event(index as u64)
+        Tracks::new([
+            Tween::new(
+                EaseFunction::QuadraticInOut,
+                Duration::from_millis(250),
+                TransformRotateZLens {
+                    start: 0.,
+                    end: 180_f32.to_radians(),
+                },
+            )
+            .with_repeat_count(RepeatCount::Finite(4))
+            .with_repeat_strategy(RepeatStrategy::MirroredRepeat),
+            Tween::new(
+                EaseFunction::QuadraticInOut,
+                Duration::from_secs(1),
+                TransformPositionLens {
+                    start: pair[0] - center,
+                    end: pair[1] - center,
+                },
+            )
+            // Get an event after each segment
+            .with_completed_event(index as u64),
+        ])
     }));
 
     commands
@@ -138,7 +152,6 @@ fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
     // scaling size at the same time.
     let tween_move = Tween::new(
         EaseFunction::QuadraticInOut,
-        TweeningType::Once,
         Duration::from_secs(1),
         TransformPositionLens {
             start: Vec3::new(-200., 100., 0.),
@@ -148,7 +161,6 @@ fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
     .with_completed_event(99); // Get an event once move completed
     let tween_rotate = Tween::new(
         EaseFunction::QuadraticInOut,
-        TweeningType::Once,
         Duration::from_secs(1),
         TransformRotationLens {
             start: Quat::IDENTITY,
@@ -157,7 +169,6 @@ fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
     );
     let tween_scale = Tween::new(
         EaseFunction::QuadraticInOut,
-        TweeningType::Once,
         Duration::from_secs(1),
         TransformScaleLens {
             start: Vec3::ONE,

examples/sprite_color.rs

@@ -61,13 +61,14 @@ fn setup(mut commands: Commands) {
     ] {
         let tween = Tween::new(
             *ease_function,
-            TweeningType::PingPong,
             std::time::Duration::from_secs(1),
             SpriteColorLens {
                 start: Color::RED,
                 end: Color::BLUE,
             },
-        );
+        )
+        .with_repeat_count(RepeatCount::Infinite)
+        .with_repeat_strategy(RepeatStrategy::MirroredRepeat);
 
         commands
             .spawn_bundle(SpriteBundle {

examples/text_color.rs

@@ -68,14 +68,15 @@ fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
     ] {
         let tween = Tween::new(
             *ease_function,
-            TweeningType::PingPong,
             std::time::Duration::from_secs(1),
             TextColorLens {
                 start: Color::RED,
                 end: Color::BLUE,
                 section: 0,
             },
-        );
+        )
+        .with_repeat_count(RepeatCount::Infinite)
+        .with_repeat_strategy(RepeatStrategy::MirroredRepeat);
 
         commands
             .spawn_bundle(TextBundle {

examples/transform_rotation.rs

@@ -77,13 +77,14 @@ fn setup(mut commands: Commands) {
     ] {
         let tween = Tween::new(
             *ease_function,
-            TweeningType::PingPong,
             std::time::Duration::from_secs(1),
             TransformRotationLens {
                 start: Quat::IDENTITY,
                 end: Quat::from_axis_angle(Vec3::Z, std::f32::consts::PI / 2.),
             },
-        );
+        )
+        .with_repeat_count(RepeatCount::Infinite)
+        .with_repeat_strategy(RepeatStrategy::MirroredRepeat);
 
         commands
             .spawn_bundle((

examples/transform_translation.rs

@@ -76,13 +76,14 @@ fn setup(mut commands: Commands) {
     ] {
         let tween = Tween::new(
             *ease_function,
-            TweeningType::PingPong,
             std::time::Duration::from_secs(1),
             TransformPositionLens {
                 start: Vec3::new(x, screen_y, 0.),
                 end: Vec3::new(x, -screen_y, 0.),
             },
-        );
+        )
+        .with_repeat_count(RepeatCount::Infinite)
+        .with_repeat_strategy(RepeatStrategy::MirroredRepeat);
 
         commands
             .spawn_bundle(SpriteBundle {

examples/ui_position.rs

@@ -76,7 +76,6 @@ fn setup(mut commands: Commands) {
     ] {
         let tween = Tween::new(
             *ease_function,
-            TweeningType::PingPong,
             std::time::Duration::from_secs(1),
             UiPositionLens {
                 start: Rect {
@@ -92,7 +91,9 @@ fn setup(mut commands: Commands) {
                     bottom: Val::Auto,
                 },
             },
-        );
+        )
+        .with_repeat_count(RepeatCount::Infinite)
+        .with_repeat_strategy(RepeatStrategy::MirroredRepeat);
 
         commands
             .spawn_bundle(NodeBundle {