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

use super::{AnimationHandle, AnimationPlaybackState};
use crate::{property::PropertySnapshot, runtime::entry::ActiveAnimation, timing::Duration};

/// Output produced when an animation is registered with the runtime.
#[derive(Debug, Clone, PartialEq)]
pub struct AnimationRegistration {
    handle: AnimationHandle,
    state: AnimationPlaybackState,
    properties: Option<PropertySnapshot>,
    completed_at: Option<Duration>,
}

impl AnimationRegistration {
    pub(super) fn from_entry(entry: &ActiveAnimation) -> Self {
        Self {
            handle: entry.handle(),
            state: entry.state(),
            properties: entry.last_snapshot().cloned(),
            completed_at: entry.completed_at(),
        }
    }

    /// Returns the registered animation handle.
    #[must_use]
    pub const fn handle(&self) -> AnimationHandle {
        self.handle
    }

    /// Returns the initial playback state.
    #[must_use]
    pub const fn state(&self) -> AnimationPlaybackState {
        self.state
    }

    /// Returns the initial property snapshot produced during registration.
    #[must_use]
    pub const fn properties(&self) -> Option<&PropertySnapshot> {
        self.properties.as_ref()
    }

    /// Returns the completion timestamp for animations completed at registration.
    #[must_use]
    pub const fn completed_at(&self) -> Option<Duration> {
        self.completed_at
    }
}