bones_render 0.2.0

//! Sprite rendering components.

use crate::prelude::*;

/// Image asset type, contains no data, but [`Handle<Image>`] is still useful because it uniquely
/// represents an image that may be rendered outside of the core.
#[derive(Copy, Clone, TypeUlid, Debug, Default)]
#[ulid = "01GNJGPQ8TKA234G1EA510BD96"]
pub struct Image;

/// An atlas image asset type, contains no data, but [`Handle<Atlas>`] is still useful becaause it
/// uniquely represents an atlas asset that may be rendered outside of the core.
#[derive(Copy, Clone, TypeUlid, Debug, Default)]
#[ulid = "01GNYXD7FVC46C7A3273HMEBRA"]
pub struct Atlas;

/// A 2D sprite component
#[derive(Clone, TypeUlid, Debug, Default)]
#[ulid = "01GNJXPWZKS6BHJEG1SX5B93DA"]
pub struct Sprite {
    /// The sprite's color tint
    pub color: Color,
    /// The sprite image handle.
    pub image: Handle<Image>,
    /// Whether or not the flip the sprite horizontally.
    pub flip_x: bool,
    /// Whether or not the flip the sprite vertically.
    pub flip_y: bool,
}

/// An animated sprite component.
///
/// Represents one or more [`Atlas`]s stacked on top of each other, and possibly animated through a
/// range of frames out of the atlas.
#[derive(Debug, Default, Clone, TypeUlid)]
#[ulid = "01GNYXFHC6T3NS061GMVFBXFYE"]
pub struct AtlasSprite {
    /// The sprite's color tint
    pub color: Color,
    /// This is the current index in the animation, with an `idx` of `0` meaning that the index in
    /// the sprite sheet will be `start`.
    ///
    /// If the idx is greater than `end - start`, then the animation will loop around.
    pub index: usize,
    /// The atlas handle.
    pub atlas: Handle<Atlas>,
    /// Whether or not the flip the sprite horizontally.
    pub flip_x: bool,
    /// Whether or not the flip the sprite vertically.
    pub flip_y: bool,
}

impl AtlasSprite {
    /// Create a new [`AtlasSprite`] from the given atlas handle.
    pub fn new(atlas: Handle<Atlas>) -> Self {
        Self {
            atlas,
            color: Color::WHITE,
            ..default()
        }
    }
}