aura-anim-iced 0.1.1

Iced-first animation primitives.
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

//! Iced integration helpers.

mod effect;

use iced::Subscription;
use std::time::{Duration as StdDuration, Instant};

use crate::runtime::{AnimationClock, AnimationRuntime, AnimationTick};

#[cfg(test)]
mod tests;

pub use effect::{EffectSnapshot, effect_snapshot, tick_effect_snapshot_for};

/// Returns whether the runtime should keep an Iced tick subscription active.
#[must_use]
pub fn should_subscribe<C>(runtime: &AnimationRuntime<C>) -> bool {
    runtime.should_subscribe()
}

/// Returns an Iced tick subscription while the runtime has playing animations.
///
/// # Example
///
/// ```
/// use std::time::Instant;
///
/// use aura_anim_iced::{AnimationRuntime, iced_ext};
///
/// #[derive(Debug, Clone)]
/// enum Message {
///     AnimationTick(Instant),
/// }
///
/// let runtime = AnimationRuntime::new();
/// let subscription = iced_ext::subscription(&runtime, Message::AnimationTick);
/// ```
pub fn subscription<Message, C>(
    runtime: &AnimationRuntime<C>,
    map_tick: impl Fn(Instant) -> Message + Clone + Send + Sync + 'static,
) -> Subscription<Message>
where
    Message: Send + 'static,
{
    if !runtime.should_subscribe() {
        return Subscription::none();
    }

    iced::time::every(std_tick_interval(runtime)).map(map_tick)
}

/// Routes an Iced tick message into the runtime and returns the sampled output.
pub fn update_tick<C>(runtime: &mut AnimationRuntime<C>, _tick: Instant) -> AnimationTick
where
    C: AnimationClock,
{
    runtime.tick()
}

fn std_tick_interval<C>(runtime: &AnimationRuntime<C>) -> StdDuration {
    let millis = runtime.motion_policy().tick_interval().as_millis();

    StdDuration::from_secs_f64((millis / 1000.0).max(0.0))
}