lapix 0.1.1

Image editor backend library for pixel art
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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
use crate::color::{BLACK, TRANSPARENT};
use crate::util::{LoadProject, SaveProject};
use crate::{
    util, Action, AtomicAction, Bitmap, Canvas, CanvasEffect, Color, Error, Event, FreeImage,
    Layers, Palette, Point, Position, Rect, Result, Size, Tool,
};
use serde::{Deserialize, Serialize};

/// Represents a selection
#[derive(Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum Selection {
    /// A selected portion of the canvas, based on a rectangular area
    Canvas(Rect<i32>),
    // TODO: maybe this should contain the FreeImage
    /// A selected free image that is not part of the canvas until it's
    /// *anchored*
    FreeImage,
}

/// The state of the image editor's core. Most importantly, this contains all
/// the layers and images that are being drawn. This state can be modified
/// externally mainly by sending [`Event`]s via the [`execute`] method.
///
/// [`execute`]: State::execute
#[derive(Debug, Serialize, Deserialize)]
pub struct State<IMG> {
    layers: Layers<IMG>,
    #[serde(skip)]
    events: Vec<Event>,
    tool: Tool,
    main_color: Color,
    spritesheet: Size<u8>,
    palette: Palette,
    selection: Option<Selection>,
    free_image: Option<FreeImage<IMG>>,
    clipboard: Option<IMG>,
    #[serde(skip, default = "Vec::new")]
    reversals: Vec<Action<IMG>>,
    #[serde(skip, default = "Option::default")]
    cur_reversal: Option<Action<IMG>>,
    #[serde(skip, default = "Option::default")]
    load_project_fn: Option<LoadProject>,
    #[serde(skip, default = "Option::default")]
    save_project_fn: Option<SaveProject>,
}

impl<IMG: Bitmap + Serialize + for<'de> Deserialize<'de>> State<IMG> {
    /// Create a new default state for the editor, with a starting canvas size
    pub fn new(
        size: Size<i32>,
        load_project_fn: Option<LoadProject>,
        save_project_fn: Option<SaveProject>,
    ) -> Self {
        Self {
            layers: Layers::new(size),
            events: Vec::new(),
            tool: Tool::Brush,
            main_color: BLACK,
            spritesheet: Size::new(1, 1),
            palette: Palette::default(),
            selection: None,
            free_image: None,
            clipboard: None,
            reversals: Vec::new(),
            cur_reversal: None,
            load_project_fn,
            save_project_fn,
        }
    }

    fn start_action(&mut self) {
        self.cur_reversal = Some(Action::default());
    }

    fn add_to_action(&mut self, actions: Vec<AtomicAction<IMG>>) -> Result<()> {
        if self.cur_reversal.is_none() {
            self.start_action();
        }
        self.cur_reversal
            .as_mut()
            .ok_or(Error::ReversalNotSet)?
            .append(actions);

        Ok(())
    }

    fn end_action(&mut self) {
        if let Some(action) = self.cur_reversal.take() {
            self.reversals.push(action);
        }
    }

    fn single_action(&mut self, action: Action<IMG>) {
        self.end_action();
        self.reversals.push(action);
    }

    fn add_to_pixels_action(&mut self, actions: Vec<(Point<i32>, Color)>) -> Result<()> {
        let actions = AtomicAction::set_pixel_vec(self.layers.active_index(), actions);

        self.add_to_action(actions)
    }

    fn single_pixels_action(&mut self, actions: Vec<(Point<i32>, Color)>) {
        let actions = AtomicAction::set_pixel_vec(self.layers.active_index(), actions);
        self.single_action(actions.into());
    }

    /// Execute an [`Event`]. This is the main way of changing the editor's
    /// state, and probably the most central method of this library. A
    /// [`CanvasEffect`] is returned to communicate to the caller what kind of
    /// visual updates must be made.
    pub fn execute(&mut self, event: Event) -> Result<CanvasEffect> {
        if let Some(prev_event) = self.events.last() {
            if (prev_event == &event && !event.repeatable())
                || (event.same_variant(prev_event) && !event.type_repeatable())
            {
                return Ok(CanvasEffect::None);
            }
        }

        dbg!(&event);
        let t0 = std::time::SystemTime::now();

        if event.triggers_anchoring() {
            self.anchor()?;
        }

        let mut skip_event = false;

        match event.clone() {
            Event::ClearCanvas => {
                let img = self.canvas_mut().clear();
                let reversal = AtomicAction::SetLayerCanvas(self.layers.active_index(), img);
                self.start_action();
                self.add_to_action(vec![reversal])?;
                self.end_action();
            }
            Event::ResizeCanvas(size) => {
                self.start_action();
                let imgs = self.resize_canvas(size);
                self.add_to_action(
                    imgs.into_iter()
                        .enumerate()
                        .map(|(i, img)| AtomicAction::SetLayerCanvas(i, img))
                        .collect(),
                )?;
                self.end_action();
            }
            Event::LineStart(_) | Event::RectStart(_) => (),
            Event::BrushStart | Event::EraseStart => self.start_action(),
            Event::BrushEnd | Event::EraseEnd => self.end_action(),
            Event::LineEnd(p) => {
                let last_event = self.events.last();
                let p0 = match last_event {
                    Some(Event::LineStart(p0)) => *p0,
                    _ => return Err(Error::DrawingNotStarted),
                };
                let color = self.main_color;
                let reversals = self.canvas_mut().line(p0, p, color);
                self.single_pixels_action(reversals);
                self.free_image = None;
            }
            Event::RectEnd(p) => {
                let last_event = self.events.last();
                let p0: Point<i32> = match last_event {
                    Some(Event::RectStart(p0)) => *p0,
                    _ => return Err(Error::DrawingNotStarted),
                };
                let color = self.main_color;
                let reversals = self.canvas_mut().rectangle(p0, p, color);
                self.single_pixels_action(reversals);
                self.free_image = None;
            }
            Event::BrushStroke(p) => {
                let last_event = self.events.last();

                let reversals = match last_event {
                    Some(Event::BrushStroke(p0)) => {
                        let color = self.main_color;
                        let p0 = *p0;
                        self.canvas_mut().line(p0, p, color)
                    }
                    Some(Event::BrushStart) => {
                        let color = self.main_color;
                        self.canvas_mut().set_pixel(p, color).into_iter().collect()
                    }
                    _ => Vec::new(),
                };
                self.add_to_pixels_action(reversals)?;
            }
            Event::Erase(p) => {
                let last_event = self.events.last();

                let reversals = match last_event {
                    Some(Event::Erase(p0)) => {
                        let p0 = *p0;
                        self.canvas_mut().line(p0, p, TRANSPARENT)
                    }
                    Some(Event::EraseStart) => self
                        .canvas_mut()
                        .set_pixel(p, TRANSPARENT)
                        .into_iter()
                        .collect(),
                    _ => Vec::new(),
                };
                self.add_to_pixels_action(reversals)?;
            }
            Event::SetTool(tool) => self.tool = tool,
            Event::SetMainColor(color) => self.main_color = color,
            Event::Save(path) => self.save_image(path.to_string_lossy().as_ref())?,
            Event::OpenFile(path) => self.import_image(path.to_string_lossy().as_ref())?,
            Event::SaveProject(path) => {
                if let Some(f) = &self.save_project_fn {
                    let bytes = bincode::serialize(&self)?;
                    (f.0)(path, bytes);
                } else {
                    eprintln!("Bug: Missing save project function");
                }
            }
            Event::LoadProject(path) => {
                if let Some(f) = &self.load_project_fn {
                    let bytes = (f.0)(path);
                    let (save_fn, load_fn) =
                        (self.save_project_fn.take(), self.load_project_fn.take());
                    *self = bincode::deserialize(&bytes)?;
                    self.save_project_fn = save_fn;
                    self.load_project_fn = load_fn;
                } else {
                    eprintln!("Bug: Missing load project function");
                }
            }
            Event::LoadPalette(path) => {
                self.palette = Palette::from_file(path.to_string_lossy().as_ref())?
            }
            Event::AddToPalette(color) => self.palette.add_color(color),
            Event::RemoveFromPalette(color) => self.palette.remove_color(color),
            Event::Bucket(p) => {
                if self.canvas().is_in_bounds(p) {
                    let color = self.main_color;
                    let reversals = self.canvas_mut().bucket(p, color);
                    self.single_pixels_action(reversals);
                }
            }
            Event::ClearSelection => (),
            Event::StartSelection(_) => (),
            Event::EndSelection(p) => {
                let last_event = self.events.last();

                if let Some(Event::StartSelection(p0)) = last_event {
                    let size = p.abs_diff(*p0);
                    let corner = p.rect_min_corner(*p0);
                    let rect = Rect::new(corner.x, corner.y, size.x + 1, size.y + 1);
                    let r = rect.clip_to(self.canvas().rect());
                    self.set_selection(Some(Selection::Canvas(r)))?;
                }
            }
            Event::Copy => match self.selection {
                Some(Selection::Canvas(rect)) => {
                    self.clipboard = Some(self.canvas().img_from_area(rect))
                }
                Some(Selection::FreeImage) => {
                    self.clipboard = Some(
                        self.free_image
                            .as_ref()
                            .ok_or(Error::MissingFreeImage)?
                            .texture
                            .clone(),
                    )
                }
                None => (),
            },
            Event::DeleteSelection => match self.selection {
                Some(Selection::Canvas(rect)) => {
                    let reversals = self.canvas_mut().set_area(rect, TRANSPARENT);
                    self.single_pixels_action(reversals);
                }
                Some(Selection::FreeImage) => {
                    self.free_image = None;
                    self.set_selection(None)?;
                }
                _ => (),
            },
            Event::MoveStart(p) => match self.selection {
                Some(Selection::Canvas(_)) => {
                    self.free_image_from_selection(Some(p));
                }
                Some(Selection::FreeImage) => {
                    if let Some(free_image) = self.free_image.as_mut() {
                        free_image.pivot = Some(p - free_image.rect.pos());
                    }
                }
                None => skip_event = true,
            },
            Event::MoveEnd(p) => {
                let last_event = self.events.last();

                if let Some(Event::MoveStart(_)) = last_event {
                    self.move_free_image(p)?;
                } else {
                    skip_event = true;
                }
            }
            Event::Paste(p) => {
                if let Some(img) = self.clipboard.as_ref().cloned() {
                    let img = FreeImage::new(p, img);
                    self.free_image = Some(img);
                    self.set_selection(Some(Selection::FreeImage))?;
                }
            }
            Event::FlipHorizontal => {
                if let Some(Selection::Canvas(_)) = self.selection {
                    self.free_image_from_selection(None);
                }
                if let Some(free_img) = self.free_image.as_mut() {
                    free_img.flip_horizontally();
                }
            }
            Event::FlipVertical => {
                if let Some(Selection::Canvas(_)) = self.selection {
                    self.free_image_from_selection(None);
                }
                if let Some(free_img) = self.free_image.as_mut() {
                    free_img.flip_vertically();
                }
            }
            Event::ApplyTransform(t) => {
                if let Some(Selection::Canvas(_)) = self.selection {
                    self.free_image_from_selection(None);
                }

                let palette = self.palette().to_vec();
                if let Some(free_img) = self.free_image.as_mut() {
                    t.apply(&mut free_img.texture, palette);
                }
            }
            Event::NewLayerAbove => {
                self.layers.add_new_above();
                self.end_action();
                self.cur_reversal = Some(Action::default());
                let i = self.layers.count() - 1;
                self.cur_reversal
                    .as_mut()
                    .ok_or(Error::ReversalNotSet)?
                    .push(AtomicAction::DestroyLayer(i));
                self.end_action();
            }
            Event::NewLayerBelow => todo!(),
            Event::SwitchLayer(i) => self.layers.switch_to(i),
            Event::ChangeLayerVisibility(i, visible) => self.layers.set_visibility(i, visible),
            Event::ChangeLayerOpacity(i, alpha) => self.layers.set_opacity(i, alpha),
            // TODO: this should not only remove it, as we need to be able to
            // undo this
            Event::DeleteLayer(i) => {
                let img = self.layers.delete(i);
                self.end_action();
                self.cur_reversal = Some(Action::default());
                self.cur_reversal
                    .as_mut()
                    .ok_or(Error::ReversalNotSet)?
                    .push(AtomicAction::CreateLayer(i, img));
                self.end_action();
            }
            Event::MoveLayerDown(i) => self.layers.swap(i, i - 1),
            Event::MoveLayerUp(i) => self.layers.swap(i, i + 1),
            Event::SetSpritesheet(size) => self.set_spritesheet(size),
            Event::Undo => {
                // TODO: we should add UNDO to the events list
                #[allow(unused_must_use)]
                {
                    dbg!(t0.elapsed());
                }
                return Ok(self.undo());
            }
        }

        if event.clears_selection() {
            self.clear_selection()?;
        }

        #[allow(unused_must_use)]
        {
            dbg!(t0.elapsed());
        }

        if skip_event {
            println!("Event skipped");
            Ok(CanvasEffect::None)
        } else {
            let effect = event.canvas_effect();
            self.events.push(event);

            Ok(effect)
        }
    }

    fn resize_canvas(&mut self, size: Size<i32>) -> Vec<IMG> {
        self.layers.resize_all(size)
    }

    /// Get a mutable reference to the active [`Layer`]'s [`Canvas`]
    ///
    /// [`Layer`]: crate::Layer
    pub fn canvas_mut(&mut self) -> &mut Canvas<IMG> {
        self.layers.active_canvas_mut()
    }

    /// Get a reference to the active [`Layer`]'s [`Canvas`]
    ///
    /// [`Layer`]: crate::Layer
    pub fn canvas(&self) -> &Canvas<IMG> {
        self.layers.active_canvas()
    }

    /// Get a reference to the collection of [`Layers`]
    pub fn layers(&self) -> &Layers<IMG> {
        &self.layers
    }

    /// Get the currently selected [`Tool`]
    pub fn selected_tool(&self) -> Tool {
        self.tool
    }

    /// Get the main (selected) color. This is the color used by most tools
    /// when drawing
    pub fn main_color(&self) -> Color {
        self.main_color
    }

    /// Get the spritesheet dimensions (number of horizontal and vertical
    /// frames). For a static image (not an animation) it will be `(1, 1)`.
    pub fn spritesheet(&self) -> Size<u8> {
        self.spritesheet
    }

    /// Set the spritesheet dimensions (number of horizontal and vertical
    /// frames). For a static image (not an animation) it will be `(1, 1)`.
    fn set_spritesheet(&mut self, size: Size<u8>) {
        if self.canvas().width() % size.x as i32 != 0 || self.canvas().height() % size.y as i32 != 0
        {
            // TODO: relax this requirement
            eprintln!("WARN: Canvas size should be a multiple of the spritesheet size");
            return;
        }

        self.spritesheet = size;
    }

    /// Get the colors of the palette
    pub fn palette(&self) -> &[Color] {
        self.palette.colors()
    }

    /// Get the [`Selection`]
    pub fn selection(&self) -> Option<Selection> {
        self.selection
    }

    /// Get the [`FreeImage`]
    pub fn free_image(&self) -> Option<&FreeImage<IMG>> {
        self.free_image.as_ref()
    }

    /// Clear the [`Selection`]
    fn clear_selection(&mut self) -> Result<()> {
        self.set_selection(None)
    }

    /// Set the [`Selection`]
    fn set_selection(&mut self, selection: Option<Selection>) -> Result<()> {
        match selection {
            None => self.selection = None,
            s @ Some(Selection::Canvas(_)) => self.selection = s,
            s @ Some(Selection::FreeImage) => {
                if self.free_image.is_none() {
                    return Err(Error::MissingFreeImage);
                }
                self.selection = s;
            }
        }

        Ok(())
    }

    /// Anchor the [`FreeImage`] into the canvas.
    fn anchor(&mut self) -> Result<()> {
        if let Some(free_image) = self.free_image.take() {
            println!("Anchoring");
            let reversals = self.canvas_mut().paste_obj(&free_image);
            self.single_pixels_action(reversals);
            self.set_selection(Some(Selection::Canvas(
                free_image.rect.clip_to(self.canvas().rect()),
            )))?;
        }

        Ok(())
    }

    /// Undo the last undoable action. Returns the [`CanvasEffect`] to signal to
    /// the caller what needs to be updated visually
    fn undo(&mut self) -> CanvasEffect {
        if let Some(action) = self.reversals.pop() {
            return action.apply(&mut self.layers);
        }

        CanvasEffect::None
    }

    /// When drawing lines, rectangles, etc. or moving things, there are visible
    /// effects (e.g. a preview of the line or of the image being moved) that
    /// are not immediately represented in the canvas, but are stored as a
    /// [`FreeImage`] instead. This method must be called as often as possible
    /// whenever the mouse moves, in order to update this preview image.
    pub fn update_free_image(&mut self, mouse_canvas: Position<i32>) -> Result<()> {
        match self.events.last() {
            Some(Event::MoveStart(_)) => self.move_free_image(mouse_canvas)?,
            Some(Event::LineStart(p)) => self.update_line_preview(*p, mouse_canvas),
            Some(Event::RectStart(p)) => self.update_rect_preview(*p, mouse_canvas),
            _ => (),
        }

        Ok(())
    }

    fn move_free_image(&mut self, new: Position<i32>) -> Result<()> {
        if let Some(free_image) = self.free_image.as_mut() {
            free_image.move_by_pivot(new);
            self.set_selection(Some(Selection::FreeImage))?;
        }

        Ok(())
    }

    fn free_image_from_selection(&mut self, mouse_pos: Option<Point<i32>>) {
        if let Some(Selection::Canvas(rect)) = self.selection {
            self.free_image = Some(FreeImage::from_canvas_area(
                self.canvas(),
                rect,
                mouse_pos.map(|p| p - rect.pos()),
            ));
            let reversals = self.canvas_mut().set_area(rect, TRANSPARENT);
            self.single_pixels_action(reversals);
            self.selection = Some(Selection::FreeImage);
        }
    }

    fn update_line_preview(&mut self, p0: Point<i32>, p: Point<i32>) {
        self.free_image = Some(FreeImage::line_preview(p0, p, self.main_color()));
    }

    fn update_rect_preview(&mut self, p0: Point<i32>, p: Point<i32>) {
        self.free_image = Some(FreeImage::rect_preview(p0, p, self.main_color()));
    }

    fn save_image(&self, path: &str) -> Result<()> {
        let blended = self.layers.blended();

        util::save_image(blended, path)
    }

    fn import_image(&mut self, path: &str) -> Result<()> {
        let img = util::load_img_from_file(path)?;

        if img.width() as i32 > self.canvas().width()
            || img.height() as i32 > self.canvas().height()
        {
            self.resize_canvas((img.width() as i32, img.height() as i32).into());
        }

        let img: IMG = util::img_from_raw(img);
        let img = FreeImage::new(Point::ZERO, img);
        self.free_image = Some(img);
        self.set_selection(Some(Selection::FreeImage))?;

        Ok(())
    }
}