osb 0.3.0

A fast, fully-fledged, scalable and secure implementation of the .osb storyboard file format
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171

use crate::easing::Easing;
use crate::utils::Number;
use crate::Event;

/// `Fade` event
pub enum Fade {
    Static(usize, i32, Number),
    Dynamic(usize, Easing, i32, i32, Number, Number),
}

impl Event for Fade {
    fn to_line(&self) -> String {
        match self {
            Fade::Static(depth, time, value) => {
                format!(
                    "{} F,{},{},,{}",
                    " ".repeat(*depth),
                    Easing::Linear.id(),
                    time,
                    value
                )
            }
            Fade::Dynamic(depth, easing, start_time, end_time, start_value, end_value) => {
                format!(
                    "{} F,{},{},{},{},{}",
                    " ".repeat(*depth),
                    easing.id(),
                    start_time,
                    end_time,
                    start_value,
                    end_value
                )
            }
        }
    }

    fn set_depth(&mut self, depth: usize) {
        match self {
            Fade::Static(ref mut current_depth, ..) => *current_depth = depth,
            Fade::Dynamic(ref mut current_depth, ..) => *current_depth = depth,
        }
    }

    fn get_start_time(&self) -> i32 {
        match self {
            Fade::Static(_, start_time, _) => *start_time,
            Fade::Dynamic(_, _, start_time, ..) => *start_time,
        }
    }

    fn get_end_time(&self) -> i32 {
        match self {
            Fade::Static(_, end_time, _) => *end_time,
            Fade::Dynamic(_, _, _, end_time, ..) => *end_time,
        }
    }
}

/// Creates a static `Fade` event with the timestamp and the opacity of the element
///
/// Uses a `Linear` easing
///
/// Example:
/// ```
/// use osb::Sprite;
///
/// let time = 0;
/// let opacity = 1;
///
/// let mut sprite = Sprite::new("res/sprite.png");
/// sprite.fade_((time, opacity));
/// ```
impl<T> Into<Fade> for (i32, T)
where
    T: Into<Number>,
{
    fn into(self) -> Fade {
        Fade::Static(0, self.0, self.1.into())
    }
}

/// Creates a dynamic `Fade` event with the timestamps and the opacity of the element
///
/// Uses a `Linear` easing
///
/// Example:
/// ```
/// use osb::Sprite;
///
/// let start_time = 0;
/// let end_time = 1000;
/// let start_opacity = 0;
/// let end_opacity = 1;
///
/// let mut sprite = Sprite::new("res/sprite.png");
/// sprite.fade_((start_time, end_time, start_opacity, end_opacity));
/// ```
impl<T, U> Into<Fade> for (i32, i32, T, U)
where
    T: Into<Number>,
    U: Into<Number>,
{
    fn into(self) -> Fade {
        Fade::Dynamic(
            0,
            Easing::Linear,
            self.0,
            self.1,
            self.2.into(),
            self.3.into(),
        )
    }
}

/// Creates a dynamic `Fade` event with the easing, the timestamps and the opacity of the element
///
/// Example:
/// ```
/// use osb::{Easing, Sprite};
///
/// let easing = Easing::Out;
/// let start_time = 0;
/// let end_time = 1000;
/// let start_opacity = 0;
/// let end_opacity = 1;
///
/// let mut sprite = Sprite::new("res/sprite.png");
/// sprite.fade_((easing, start_time, end_time, start_opacity, end_opacity));
/// ```
impl<T, U> Into<Fade> for (Easing, i32, i32, T, U)
where
    T: Into<Number>,
    U: Into<Number>,
{
    fn into(self) -> Fade {
        Fade::Dynamic(0, self.0, self.1, self.2, self.3.into(), self.4.into())
    }
}

#[cfg(test)]
mod tests {
    use crate::{event::*, Easing};

    #[test]
    fn to_line_static() {
        let fade_event: Fade = (0, 1).into();
        assert_eq!(fade_event.to_line(), " F,0,0,,1");

        let mut fade_event_depth: Fade = (0, 1).into();
        fade_event_depth.set_depth(2);
        assert_eq!(fade_event_depth.to_line(), "   F,0,0,,1");
    }

    #[test]
    fn to_line_dynamic() {
        let fade_event: Fade = (0, 1000, 0, 1).into();
        assert_eq!(fade_event.to_line(), " F,0,0,1000,0,1");

        let fade_event_easing: Fade = (Easing::QuadOut, 0, 1000, 0, 1).into();
        assert_eq!(fade_event_easing.to_line(), " F,4,0,1000,0,1");
    }

    #[test]
    fn to_line_dynamic_float() {
        let fade_event: Fade = (0, 1000, 0.25, 0.75).into();
        assert_eq!(fade_event.to_line(), " F,0,0,1000,0.25,0.75");

        let fade_event_easing: Fade = (Easing::QuadOut, 0, 1000, 0.25, 0.75).into();
        assert_eq!(fade_event_easing.to_line(), " F,4,0,1000,0.25,0.75");
    }
}