Add Spritesheet::atlas_layout()

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## 0.4.0 - 2024-??-??
+## 0.4.0 - 2024-08-28
 
 This update simplifies the high-level API of the library.
 
@@ -14,6 +14,7 @@ To create a variant of a clip, just clone and reconfigure it before registering
 ### Added
 
 - Add with_xxx() methods to Clip and Animation to make it easier to set their parameters
+- Add Spritesheet::atlas_layout() to create a TextureAtlasLayout from a spritesheet
 
 ### Changed
 

README.md

@@ -70,13 +70,7 @@ fn setup(
 
     let texture = assets.load("character.png");
 
-    let layout = atlas_layouts.add(TextureAtlasLayout::from_grid(
-        UVec2::new(96, 96),
-        8,
-        8,
-        None,
-        None,
-    ));
+    let layout = atlas_layouts.add(spritesheet.atlas_layout(96, 96));
 
     commands.spawn((
         SpriteBundle {

benches/basic.rs

@@ -22,13 +22,7 @@ fn basic(c: &mut Criterion) {
                 .get_resource_mut::<Assets<TextureAtlasLayout>>()
                 .unwrap();
 
-            let layout = atlas_layouts.add(TextureAtlasLayout::from_grid(
-                UVec2::new(96, 96),
-                8,
-                8,
-                None,
-                None,
-            ));
+            let layout = atlas_layouts.add(Spritesheet::new(8, 8).atlas_layout(96, 96));
 
             let mut library = app
                 .world_mut()

examples/3d.rs

@@ -45,13 +45,7 @@ fn setup(
 
     let texture = assets.load("character.png");
 
-    let atlas_layout_handle = atlas_layouts.add(TextureAtlasLayout::from_grid(
-        UVec2::new(96, 96),
-        8,
-        8,
-        None,
-        None,
-    ));
+    let atlas_layout_handle = atlas_layouts.add(spritesheet.atlas_layout(96, 96));
 
     // Spawn 3D sprites
 

examples/basic.rs

@@ -60,13 +60,7 @@ fn spawn_sprite(
 
         let texture = assets.load("character.png");
 
-        let layout = atlas_layouts.add(TextureAtlasLayout::from_grid(
-            UVec2::new(96, 96),
-            8,
-            8,
-            None,
-            None,
-        ));
+        let layout = atlas_layouts.add(Spritesheet::new(8, 8).atlas_layout(96, 96));
 
         // Spawn a sprite with Bevy's built-in SpriteBundle
 

examples/character.rs

@@ -70,13 +70,7 @@ fn setup(
 
     let texture = assets.load("character.png");
 
-    let layout = atlas_layouts.add(TextureAtlasLayout::from_grid(
-        UVec2::new(96, 96),
-        8,
-        8,
-        None,
-        None,
-    ));
+    let layout = atlas_layouts.add(spritesheet.atlas_layout(96, 96));
 
     commands.spawn((
         SpriteBundle {

examples/composition.rs

@@ -61,13 +61,7 @@ fn setup(
 
     let texture = assets.load("character.png");
 
-    let layout = atlas_layouts.add(TextureAtlasLayout::from_grid(
-        UVec2::new(96, 96),
-        8,
-        8,
-        None,
-        None,
-    ));
+    let layout = atlas_layouts.add(spritesheet.atlas_layout(96, 96));
 
     commands.spawn((
         SpriteBundle {

examples/events.rs

@@ -87,13 +87,7 @@ fn setup(
 
     let texture = assets.load("character.png");
 
-    let layout = atlas_layouts.add(TextureAtlasLayout::from_grid(
-        UVec2::new(96, 96),
-        8,
-        8,
-        None,
-        None,
-    ));
+    let layout = atlas_layouts.add(spritesheet.atlas_layout(96, 96));
 
     commands.spawn((
         SpriteBundle {

examples/parameters.rs

@@ -26,18 +26,6 @@ fn setup(
 ) {
     commands.spawn(Camera2dBundle::default());
 
-    // Load assets for the sprite
-
-    let texture = assets.load("ball.png");
-
-    let layout = atlas_layouts.add(TextureAtlasLayout::from_grid(
-        UVec2::new(100, 20),
-        1,
-        30,
-        None,
-        None,
-    ));
-
     // Create a clip
 
     let spritesheet = Spritesheet::new(1, 30);
@@ -46,6 +34,12 @@ fn setup(
 
     let clip_id = library.register_clip(clip);
 
+    // Load assets for the sprites
+
+    let texture = assets.load("ball.png");
+
+    let layout = atlas_layouts.add(spritesheet.atlas_layout(96, 96));
+
     // Create an animated sprite for each parameter set
 
     let mut parameters = vec![

examples/stress.rs

@@ -75,13 +75,7 @@ fn setup(
 
     let texture = assets.load("character.png");
 
-    let layout = atlas_layouts.add(TextureAtlasLayout::from_grid(
-        UVec2::new(96, 96),
-        8,
-        8,
-        None,
-        None,
-    ));
+    let layout = atlas_layouts.add(spritesheet.atlas_layout(96, 96));
 
     for _ in 0..100_000 {
         let animation = animation_ids.choose(&mut rng).unwrap();

src/lib.rs

@@ -59,13 +59,7 @@
 //!
 //!     let texture = assets.load("character.png");
 //!
-//!     let layout = atlas_layouts.add(TextureAtlasLayout::from_grid(
-//!         UVec2::new(96, 96),
-//!         8,
-//!         8,
-//!         None,
-//!         None,
-//!     ));
+//!     let layout = atlas_layouts.add(spritesheet.atlas_layout(96, 96));
 //!
 //!     commands.spawn((
 //!         SpriteBundle {

src/spritesheet.rs

@@ -1,4 +1,4 @@
-use bevy::log::warn;
+use bevy::{log::warn, math::UVec2, sprite::TextureAtlasLayout};
 use std::ops::RangeBounds;
 
 use crate::CRATE_NAME;
@@ -448,4 +448,53 @@ impl Spritesheet {
 
         frames
     }
+
+    /// Creates a [TextureAtlasLayout] from the spritesheet.
+    ///
+    /// # Arguments
+    ///
+    /// * `frame_width` - the width of a single frame
+    /// * `frame_height` - the height of a single frame
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// # use bevy::prelude::*;
+    /// # use bevy_spritesheet_animation::prelude::*;
+    /// fn setup(
+    ///     mut commands: Commands,
+    ///     mut library: ResMut<AnimationLibrary>,
+    ///     mut atlas_layouts: ResMut<Assets<TextureAtlasLayout>>,
+    ///     assets: Res<AssetServer>,
+    /// #   animation_id: AnimationId
+    /// ) {
+    ///     let spritesheet = Spritesheet::new(8, 8);
+    ///
+    ///     // ... omitted: create an animation ...
+    ///
+    ///     let layout = atlas_layouts.add(spritesheet.atlas_layout(100, 200));
+    ///
+    ///     commands.spawn((
+    ///         SpriteBundle {
+    ///             texture: assets.load("character.png"),
+    ///             ..default()
+    ///         },
+    ///         TextureAtlas {
+    ///             layout,
+    ///             ..default()
+    ///         },
+    ///         // Add a SpritesheetAnimation component that references our animation
+    ///         SpritesheetAnimation::from_id(animation_id),
+    ///     ));
+    /// }
+    /// ```
+    pub fn atlas_layout(&self, frame_width: u32, frame_height: u32) -> TextureAtlasLayout {
+        TextureAtlasLayout::from_grid(
+            UVec2::new(frame_width, frame_height),
+            self.columns as u32,
+            self.rows as u32,
+            None,
+            None,
+        )
+    }
 }

tests/spritesheet.rs

@@ -1,3 +1,4 @@
+use bevy::prelude::*;
 use bevy_spritesheet_animation::prelude::*;
 
 #[test]
@@ -127,3 +128,27 @@ fn vertical_strip() {
     assert_eq!(sheet.vertical_strip(1, 1, 6), vec![5, 9, 2, 6, 10, 3]);
     assert_eq!(sheet.vertical_strip(3, 0, 1000), vec![3, 7, 11]);
 }
+
+#[test]
+fn atlas_layout() {
+    let sheet1 = Spritesheet::new(2, 3);
+    let layout1 = sheet1.atlas_layout(100, 200);
+
+    assert_eq!(layout1.size, UVec2::new(200, 600));
+    assert_eq!(layout1.textures.len(), 6);
+
+    assert_eq!(layout1.textures.get(0), Some(&URect::new(0, 0, 100, 200)));
+    assert_eq!(layout1.textures.get(1), Some(&URect::new(100, 0, 200, 200)));
+
+    assert_eq!(layout1.textures.get(2), Some(&URect::new(0, 200, 100, 400)));
+    assert_eq!(
+        layout1.textures.get(3),
+        Some(&URect::new(100, 200, 200, 400))
+    );
+
+    assert_eq!(layout1.textures.get(4), Some(&URect::new(0, 400, 100, 600)));
+    assert_eq!(
+        layout1.textures.get(5),
+        Some(&URect::new(100, 400, 200, 600))
+    );
+}