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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248

use crate::easing::Easing;
use crate::utils::{Number, Vec2};
use crate::Event;

/// `Move` event
pub enum Move {
    Static(usize, i32, Vec2),
    Dynamic(usize, Easing, i32, i32, Vec2, Vec2),
}

impl Event for Move {
    fn to_line(&self) -> String {
        match self {
            Move::Static(depth, time, pos) => {
                format!(
                    "{} M,{},{},,{},{}",
                    " ".repeat(*depth),
                    Easing::Linear.id(),
                    time,
                    pos.x,
                    pos.y
                )
            }
            Move::Dynamic(depth, easing, start_time, end_time, start_pos, end_pos) => {
                format!(
                    "{} M,{},{},{},{},{},{},{}",
                    " ".repeat(*depth),
                    easing.id(),
                    start_time,
                    end_time,
                    start_pos.x,
                    start_pos.y,
                    end_pos.x,
                    end_pos.y
                )
            }
        }
    }

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

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

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

/// Creates a static `Move` event with the timestamp and the position of the element
///
/// Uses a `Linear` easing
///
/// Example:
/// ```
/// use osb::{utils::Vec2, Sprite};
///
/// let time = 0;
/// let pos = Vec2::from(320, 240);
///
/// let mut sprite = Sprite::new("res/sprite.png");
/// sprite.move_((time, pos));
/// ```
impl Into<Move> for (i32, Vec2) {
    fn into(self) -> Move {
        Move::Static(0, self.0, self.1)
    }
}

/// Creates a static `Move` event with the timestamp and the position of the element
///
/// Uses a `Linear` easing
///
/// Example:
/// ```
/// use osb::Sprite;
///
/// let time = 0;
/// let x = 320;
/// let y = 240;
///
/// let mut sprite = Sprite::new("res/sprite.png");
/// sprite.move_((time, x, y));
/// ```
impl<T, U> Into<Move> for (i32, T, U)
where
    T: Into<Number>,
    U: Into<Number>,
{
    fn into(self) -> Move {
        Move::Static(0, self.0, Vec2::from(self.1, self.2))
    }
}

/// Creates a dynamic `Move` event with the timestamps and the positions of the element
///
/// Uses a `Linear` easing
///
/// Example:
/// ```
/// use osb::{utils::Vec2, Sprite};
///
/// let start_time = 0;
/// let end_time = 1000;
/// let start_pos = Vec2::from(0, 0);
/// let end_pos = Vec2::from(320, 240);
///
/// let mut sprite = Sprite::new("res/sprite.png");
/// sprite.move_((start_time, end_time, start_pos, end_pos));
/// ```
impl Into<Move> for (i32, i32, Vec2, Vec2) {
    fn into(self) -> Move {
        Move::Dynamic(0, Easing::Linear, self.0, self.1, self.2, self.3)
    }
}

/// Creates a dynamic `Move` event with the timestamps and the positions of the element
///
/// Uses a `Linear` easing
///
/// Example:
/// ```
/// use osb::Sprite;
///
/// let start_time = 0;
/// let end_time = 1000;
/// let start_x = 0;
/// let start_y = 0;
/// let end_x = 320;
/// let end_y = 240;
///
/// let mut sprite = Sprite::new("res/sprite.png");
/// sprite.move_((start_time, end_time, start_x, start_y, end_x, end_y));
/// ```
impl<T, U, V, W> Into<Move> for (i32, i32, T, U, V, W)
where
    T: Into<Number>,
    U: Into<Number>,
    V: Into<Number>,
    W: Into<Number>,
{
    fn into(self) -> Move {
        Move::Dynamic(
            0,
            Easing::Linear,
            self.0,
            self.1,
            Vec2::from(self.2, self.3),
            Vec2::from(self.4, self.5),
        )
    }
}

/// Creates a dynamic `Move` event with the easing, the timestamps and the positions of the element
///
/// Example:
/// ```
/// use osb::{utils::Vec2, Easing, Sprite};
///
/// let easing = Easing::Out;
/// let start_time = 0;
/// let end_time = 1000;
/// let start_pos = Vec2::from(0, 0);
/// let end_pos = Vec2::from(320, 240);
///
/// let mut sprite = Sprite::new("res/sprite.png");
/// sprite.move_((easing, start_time, end_time, start_pos, end_pos));
/// ```
impl Into<Move> for (Easing, i32, i32, Vec2, Vec2) {
    fn into(self) -> Move {
        Move::Dynamic(0, self.0, self.1, self.2, self.3, self.4)
    }
}

/// Creates a dynamic `Move` event with the timestamps and the positions of the element
///
/// Example:
/// ```
/// use osb::{Easing, Sprite};
///
/// let easing = Easing::Out;
/// let start_time = 0;
/// let end_time = 1000;
/// let start_x = 0;
/// let start_y = 0;
/// let end_x = 320;
/// let end_y = 240;
///
/// let mut sprite = Sprite::new("res/sprite.png");
/// sprite.move_((easing, start_time, end_time, start_x, start_y, end_x, end_y));
/// ```
impl<T, U, V, W> Into<Move> for (Easing, i32, i32, T, U, V, W)
where
    T: Into<Number>,
    U: Into<Number>,
    V: Into<Number>,
    W: Into<Number>,
{
    fn into(self) -> Move {
        Move::Dynamic(
            0,
            self.0,
            self.1,
            self.2,
            Vec2::from(self.3, self.4),
            Vec2::from(self.5, self.6),
        )
    }
}

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

    #[test]
    fn to_line_static() {
        let move_event_neg: Move = (-100, -320, -240).into();
        assert_eq!(move_event_neg.to_line(), " M,0,-100,,-320,-240");

        let mut move_event_depth: Move = (100, 0, 0).into();
        move_event_depth.set_depth(2);
        assert_eq!(move_event_depth.to_line(), "   M,0,100,,0,0");

        let move_event_vec2: Move = (0, 1000, Vec2::new(), Vec2::new()).into();
        assert_eq!(move_event_vec2.to_line(), " M,0,0,1000,0,0,0,0");
    }

    #[test]
    fn to_line_dynamic() {
        let move_event: Move = (0, 1000, 0, 0, 320, 240).into();
        assert_eq!(move_event.to_line(), " M,0,0,1000,0,0,320,240");

        let move_event_easing: Move = (Easing::QuadOut, 0, 1000, 0, 0, 320, 240).into();
        assert_eq!(move_event_easing.to_line(), " M,4,0,1000,0,0,320,240");
    }
}