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

use super::{remove_leading_newlines, Sprite, TextAlign2D};
use crate::elements::{
    view::{Modifier, ViewElement},
    Pixel, Vec2D,
};

/// The `AnimatedSprite` struct contains a list of `String`s into which it indexes based on its [`current_frame`](AnimatedSprite::current_frame) property. You can cycle through frames with the [`AnimatedSprite::next_frame()`](AnimatedSprite::next_frame()) function
pub struct AnimatedSprite {
    /// The position from which the animated sprite will be drawn from
    pub pos: Vec2D,
    /// A collection of frames - ACII textures to be displayed by the `AnimatedSprite`
    pub frames: Vec<String>,
    /// The current frame being displayed. This will index directly into [`frames`](AnimatedSprite::frames)
    pub current_frame: usize,
    /// A raw [`Modifier`], determining the appearance of the `AnimatedSprite`
    pub modifier: Modifier,
    /// How the Sprite should align to the position
    pub align: TextAlign2D,
}

impl AnimatedSprite {
    /// Create a new `AnimatedSprite` struct. All newlines at the beginning of each texture will be removed
    #[must_use]
    pub fn new(pos: Vec2D, frames: &[&str], modifier: Modifier) -> Self {
        let processed_frames: Vec<String> = frames
            .iter()
            .map(|frame| remove_leading_newlines(frame))
            .collect();

        Self {
            pos,
            frames: processed_frames,
            current_frame: 0,
            modifier,
            align: TextAlign2D::default(),
        }
    }

    /// Go to the next frame of the `AnimatedSprite`'s frames. Will automatically wrap around at the end of the list
    pub fn next_frame(&mut self) {
        self.current_frame += 1;
        self.current_frame %= self.frames.len();
    }

    /// Returns true if the `current_frame` property is within range of the list of frames. Also returns false if the list of frames is empty
    #[must_use]
    pub fn is_within_frame_range(&self) -> bool {
        self.current_frame < self.frames.len()
    }
}

impl ViewElement for AnimatedSprite {
    fn active_pixels(&self) -> Vec<Pixel> {
        assert!(
            self.is_within_frame_range(),
            "AnimatedSprite tried indexing at {} in list of frames size {}",
            self.current_frame,
            self.frames.len()
        );

        Sprite::draw(self.pos, &self.frames[self.current_frame], self.modifier)
    }
}