aura-anim-iced 0.2.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

use std::sync::Arc;

use crate::Timeline;

/// Animation timeline for moving between two application states.
#[derive(Debug, Clone, PartialEq)]
pub struct StateTransition<S>
where
    S: Copy + Eq,
{
    from: S,
    to: S,
    timeline: Arc<Timeline>,
}

impl<S> StateTransition<S>
where
    S: Copy + Eq,
{
    /// Creates a state transition backed by a timeline.
    #[must_use]
    pub fn new(from: S, to: S, timeline: Timeline) -> Self {
        Self {
            from,
            to,
            timeline: Arc::new(timeline),
        }
    }

    /// Returns the state this transition starts from.
    #[must_use]
    pub const fn from(&self) -> S {
        self.from
    }

    /// Returns the state this transition ends at.
    #[must_use]
    pub const fn to(&self) -> S {
        self.to
    }

    /// Returns the timeline registered when this transition starts.
    #[must_use]
    pub fn timeline(&self) -> &Timeline {
        &self.timeline
    }

    pub(crate) fn timeline_arc(&self) -> Arc<Timeline> {
        Arc::clone(&self.timeline)
    }
}