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
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

use crate::{Duration, RouteIncomingMotion, RouteTransition, Timeline};

/// Paired outgoing and incoming timelines for switching between two routes.
///
/// ```
/// use aura_anim_iced::{
///     Duration, OPACITY, RouteIncomingMotion, RouteScreenTransition, Timeline,
///     Track,
/// };
///
/// #[derive(Debug, Clone, Copy, PartialEq, Eq)]
/// enum Route {
///     Home,
///     Details,
/// }
///
/// let transition = RouteScreenTransition::with_incoming_motion(
///     Route::Home,
///     Route::Details,
///     Timeline::track(
///         Track::from(OPACITY, 1.0)
///             .to(0.0)
///             .duration(Duration::from_millis(90.0)),
///     ),
///     RouteIncomingMotion::new(
///         iced::Vector::new(40.0, 0.0),
///         Duration::from_millis(150.0),
///     ),
/// );
///
/// assert_eq!(transition.from(), Route::Home);
/// assert_eq!(transition.to(), Route::Details);
/// assert_eq!(transition.total_duration(), Some(Duration::from_millis(150.0)));
/// assert_eq!(transition.outgoing_shorter(), Some(true));
/// ```
#[derive(Debug, Clone, PartialEq)]
pub struct RouteScreenTransition<R>
where
    R: Copy + Eq,
{
    from: R,
    to: R,
    outgoing: Timeline,
    incoming: Timeline,
}

impl<R> RouteScreenTransition<R>
where
    R: Copy + Eq,
{
    /// Creates a route screen transition with separate outgoing and incoming timelines.
    #[must_use]
    pub const fn new(from: R, to: R, outgoing: Timeline, incoming: Timeline) -> Self {
        Self {
            from,
            to,
            outgoing,
            incoming,
        }
    }

    /// Creates a route screen transition whose incoming screen fades and moves into place.
    #[must_use]
    pub fn with_incoming_motion(
        from: R,
        to: R,
        outgoing: Timeline,
        incoming: RouteIncomingMotion,
    ) -> Self {
        Self::new(from, to, outgoing, incoming.timeline())
    }

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

    /// Returns the route this transition targets.
    #[must_use]
    pub const fn to(&self) -> R {
        self.to
    }

    /// Returns the timeline registered for the outgoing screen.
    #[must_use]
    pub const fn outgoing(&self) -> &Timeline {
        &self.outgoing
    }

    /// Returns the timeline registered for the incoming screen.
    #[must_use]
    pub const fn incoming(&self) -> &Timeline {
        &self.incoming
    }

    /// Returns the finite screen transition duration, if both screen timelines are finite.
    #[must_use]
    pub fn total_duration(&self) -> Option<Duration> {
        Some(
            self.outgoing
                .total_duration()?
                .max(self.incoming.total_duration()?),
        )
    }

    /// Returns whether the outgoing screen finishes before the incoming screen reaches its end.
    #[must_use]
    pub fn outgoing_shorter(&self) -> Option<bool> {
        Some(self.outgoing.total_duration()? <= self.incoming.total_duration()?)
    }

    pub(crate) fn route_transition(&self) -> RouteTransition<R> {
        RouteTransition::new(
            self.from,
            self.to,
            Timeline::hold(self.total_duration().unwrap_or(Duration::ZERO)),
        )
    }
}