aura-anim-iced 0.2.0

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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

use super::{AnimationHandle, AnimationPlaybackState};
use crate::runtime::{
    registry::AnimationRegistry,
    target::{AnimationTargetId, TargetedPropertySnapshot},
};
use crate::{property::PropertySnapshot, timing::Duration};

/// Output produced by one runtime tick.
#[derive(Debug, Clone, PartialEq)]
pub struct AnimationTick {
    timestamp: Duration,
    properties: TargetedPropertySnapshot,
    completed: Vec<AnimationHandle>,
}

impl AnimationTick {
    fn new(
        timestamp: Duration,
        properties: TargetedPropertySnapshot,
        completed: Vec<AnimationHandle>,
    ) -> Self {
        Self {
            timestamp,
            properties,
            completed,
        }
    }

    /// Returns the runtime timestamp used for this tick.
    #[must_use]
    pub const fn timestamp(&self) -> Duration {
        self.timestamp
    }

    /// Returns the target-scoped property snapshots for view code.
    #[must_use]
    pub fn properties(&self) -> &TargetedPropertySnapshot {
        &self.properties
    }

    /// Returns the property snapshot for a single target.
    #[must_use]
    pub fn properties_for(&self, target: AnimationTargetId) -> Option<&PropertySnapshot> {
        self.properties.get(target)
    }

    /// Returns handles completed and removed during this tick.
    #[must_use]
    pub fn completed(&self) -> &[AnimationHandle] {
        &self.completed
    }

    /// Returns whether this tick produced no property output.
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.properties.is_empty()
    }
}

pub(super) fn tick_registry(registry: &mut AnimationRegistry, now: Duration) -> AnimationTick {
    let mut properties = TargetedPropertySnapshot::new();
    let mut completed = Vec::new();
    let mut removed = Vec::new();

    for entry in registry.entries_mut().iter_mut() {
        let target = entry.target();
        let snapshot = match entry.state() {
            AnimationPlaybackState::Playing => {
                let delta = now.checked_sub(entry.last_tick()).unwrap_or(Duration::ZERO);
                entry.update_position(delta);
                entry.set_last_tick(now);

                if let Some(duration) = entry.source().total_duration()
                    && source_is_complete(duration, entry.position())
                {
                    entry.set_position(duration);
                    let snapshot = entry.source().completion_snapshot();

                    entry.set_last_snapshot(snapshot.clone());
                    entry.mark_completed(now);
                    completed.push(entry.handle());
                    removed.push(entry.handle());

                    snapshot
                } else {
                    let snapshot = entry.source().sample_at(entry.position());

                    entry.set_last_snapshot(snapshot.clone());

                    snapshot
                }
            }
            AnimationPlaybackState::Paused => {
                entry.set_last_tick(now);
                entry.last_snapshot().cloned()
            }
            AnimationPlaybackState::Canceled => {
                removed.push(entry.handle());
                None
            }
            AnimationPlaybackState::Completed => {
                completed.push(entry.handle());
                removed.push(entry.handle());
                None
            }
        };

        merge_snapshot(&mut properties, target, snapshot);
    }

    for handle in &removed {
        registry.remove_by_handle(*handle);
    }

    #[cfg(feature = "tracing")]
    tracing::trace!(
        target: "aura_anim_iced::runtime",
        timestamp_ms = now.as_millis(),
        output_targets = properties.targets().len(),
        completed = completed.len(),
        active = registry.active_count(),
        "runtime tick"
    );

    #[cfg(feature = "inspector")]
    tracing::debug!(
        target: "aura_anim_iced::inspector",
        timestamp_ms = now.as_millis(),
        output_targets = properties.targets().len(),
        completed = completed.len(),
        removed = removed.len(),
        active = registry.active_count(),
        "runtime inspector tick"
    );

    AnimationTick::new(now, properties, completed)
}

fn source_is_complete(total_duration: Duration, elapsed: Duration) -> bool {
    elapsed.as_millis() >= total_duration.as_millis()
}

fn merge_snapshot(
    properties: &mut TargetedPropertySnapshot,
    target: AnimationTargetId,
    snapshot: Option<PropertySnapshot>,
) {
    if let Some(snapshot) = snapshot {
        properties.merge(target, snapshot);
    }
}