use-ui-motion 0.1.0

Motion semantics primitives for RustUse UI
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

#![forbid(unsafe_code)]
#![doc = include_str!("../README.md")]

/// Motion duration in milliseconds.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd)]
pub struct MotionDuration(u32);

impl MotionDuration {
    pub fn from_millis(value: u32) -> Self {
        Self(value)
    }

    pub fn millis(self) -> u32 {
        self.0
    }

    pub fn is_instant(self) -> bool {
        self.0 == 0
    }
}

/// Semantic motion curve.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd)]
pub enum MotionCurve {
    Linear,
    Ease,
    EaseIn,
    EaseOut,
    EaseInOut,
}

/// User motion preference.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd)]
pub enum MotionPreference {
    NoPreference,
    Reduced,
}

impl MotionPreference {
    pub fn allows_motion(self) -> bool {
        matches!(self, Self::NoPreference)
    }
}

/// Easing metadata.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct Easing {
    curve: MotionCurve,
    duration: MotionDuration,
}

impl Easing {
    pub fn new(curve: MotionCurve, duration: MotionDuration) -> Self {
        Self { curve, duration }
    }

    pub fn curve(self) -> MotionCurve {
        self.curve
    }

    pub fn duration(self) -> MotionDuration {
        self.duration
    }
}

/// Transition intent.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd)]
pub enum TransitionKind {
    Enter,
    Exit,
    Move,
    Resize,
    Fade,
    Scale,
}

/// Runtime-independent animation state labels.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd)]
pub enum AnimationState {
    Idle,
    Pending,
    Running,
    Paused,
    Finished,
    Cancelled,
}

impl AnimationState {
    pub fn is_terminal(self) -> bool {
        matches!(self, Self::Finished | Self::Cancelled)
    }
}

#[cfg(test)]
mod tests {
    use super::{AnimationState, Easing, MotionCurve, MotionDuration, MotionPreference};

    #[test]
    fn checks_motion_helpers() {
        let duration = MotionDuration::from_millis(150);
        let easing = Easing::new(MotionCurve::EaseOut, duration);

        assert_eq!(duration.millis(), 150);
        assert!(!duration.is_instant());
        assert!(MotionDuration::from_millis(0).is_instant());
        assert_eq!(easing.curve(), MotionCurve::EaseOut);
        assert_eq!(easing.duration(), duration);
    }

    #[test]
    fn checks_motion_preference_and_state() {
        assert!(MotionPreference::NoPreference.allows_motion());
        assert!(!MotionPreference::Reduced.allows_motion());
        assert!(AnimationState::Finished.is_terminal());
        assert!(!AnimationState::Running.is_terminal());
    }
}