animato-timeline 0.4.0

Timeline, sequence, and stagger composition for the Animato animation library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

//! Stagger helper for offsetting many animations.

use crate::timeline::{At, Timeline};
use alloc::format;
use alloc::vec::Vec;
use animato_core::Playable;

/// Create a timeline where each animation starts `delay` seconds after the previous one.
///
/// Entries are labeled `item_0`, `item_1`, and so on.
pub fn stagger<A>(animations: Vec<A>, delay: f32) -> Timeline
where
    A: Playable + Send + 'static,
{
    let mut timeline = Timeline::new();
    let delay = delay.max(0.0);
    for (index, animation) in animations.into_iter().enumerate() {
        timeline = timeline.add(
            format!("item_{index}"),
            animation,
            At::Absolute(index as f32 * delay),
        );
    }
    timeline
}

#[cfg(test)]
mod tests {
    use super::*;
    use animato_core::Update;
    use animato_tween::Tween;

    #[test]
    fn stagger_offsets_entries() {
        let animations = alloc::vec![
            Tween::new(0.0_f32, 10.0).duration(1.0).build(),
            Tween::new(0.0_f32, 10.0).duration(1.0).build(),
            Tween::new(0.0_f32, 10.0).duration(1.0).build(),
        ];
        let mut timeline = stagger(animations, 0.25);
        timeline.play();
        timeline.update(0.5);

        assert_eq!(timeline.get::<Tween<f32>>("item_0").unwrap().value(), 5.0);
        assert_eq!(timeline.get::<Tween<f32>>("item_1").unwrap().value(), 2.5);
        assert_eq!(timeline.get::<Tween<f32>>("item_2").unwrap().value(), 0.0);
    }
}