WIP

Author: merwaaan

examples/3d.rs

@@ -41,7 +41,7 @@ fn spawn_sprites(
 
     let animation_handle = animations.add(animation);
 
-    // Create an image and a texture atlas like you would for any Bevy sprite
+    // Create an image and a texture atlas like you would for 2D sprites
 
     let image = assets.load("character.png");
 
@@ -164,9 +164,11 @@ struct Orbit {
 }
 
 fn orbit(time: Res<Time>, mut query: Query<(&Orbit, &mut Transform)>) {
+    let secs_elapsed = time.elapsed_secs();
+
     for (orbit, mut transform) in &mut query {
-        transform.translation.x = (orbit.start_angle + time.elapsed_secs()).cos() * 1500.0;
-        transform.translation.z = (orbit.start_angle + time.elapsed_secs()).sin() * 1500.0;
+        transform.translation.x = (orbit.start_angle + secs_elapsed).cos() * 1500.0;
+        transform.translation.z = (orbit.start_angle + secs_elapsed).sin() * 1500.0;
     }
 }
 

examples/basic.rs

@@ -12,17 +12,21 @@ fn main() {
         // Add the plugin to enable animations.
         // This makes the Assets<Animation> resource available to your systems.
         .add_plugins(SpritesheetAnimationPlugin)
+        // For that example's sake, we split the setup in two separate systems to show how to retrieve animations with animation sets
         .add_systems(
             Startup,
             (create_animation, spawn_sprite.after(create_animation)),
         )
         .run();
 }
 
-#[derive(Resource)]
-struct MyAnimation {
-    handle: Handle<Animation>,
-}
+// Define an animation set to refer to our animation across systems.
+//
+// This is not mandatory at all.
+// However it is convenient for accessing
+animation_set!(MyAnimation [
+  anim run
+]);
 
 fn create_animation(mut commands: Commands, mut animations: ResMut<Assets<Animation>>) {
     commands.spawn(Camera2d);
@@ -42,33 +46,29 @@ fn create_animation(mut commands: Commands, mut animations: ResMut<Assets<Animat
 
     let animation = Animation::from_clip(clip);
 
-    // Name the animation to retrieve it from other systems
-
     let animation_handle = animations.add(animation);
 
+    // Store the animation to retrieve it from other systems
+
     commands.insert_resource(MyAnimation {
-        handle: animation_handle,
+        run: animation_handle,
     });
 }
 
-// We split the setup in two separate systems to show how to retrieve animations from their name
-
 fn spawn_sprite(
     mut commands: Commands,
     assets: Res<AssetServer>,
     mut atlas_layouts: ResMut<Assets<TextureAtlasLayout>>,
     my_animation: Res<MyAnimation>,
 ) {
-    // Retrieve our animation from the library
-
     // Create an image and a texture atlas like you would for any Bevy sprite
     //
-    // However, here we use the Spritesheet helper to easily generate the atlas.
+    // Here we use the Spritesheet helper to easily generate the atlas.
     // This is optional and you may prefer to build the atlas manually.
 
     let image = assets.load("character.png");
 
-    let spritesheet = Spritesheet::new(8, 8);
+    let spritesheet = Spritesheet::new(8, 8); // TODO weird to have to recreate it
 
     let atlas = TextureAtlas {
         layout: atlas_layouts.add(spritesheet.atlas_layout(96, 96)),
@@ -79,6 +79,6 @@ fn spawn_sprite(
 
     commands.spawn((
         Sprite::from_atlas_image(image, atlas),
-        SpritesheetAnimation::new(my_animation.handle.clone()),
+        SpritesheetAnimation::new(my_animation.run.clone()),
     ));
 }

examples/character.rs

@@ -1,7 +1,7 @@
-// This example shows how to create controllable character with multiple animations.
+// This example shows how to create a controllable character with multiple animations.
 //
-// - We'll create a few animations for our character (idle, run, shoot) in a setup system
-// - We'll move the character with the keyboard and switch between animations in another system
+// - We create a few animations for our character (idle, run, shoot) in a Startup system
+// - We move the character with the keyboard and switch between animations in an Update system
 
 #[path = "./common/mod.rs"]
 pub mod common;
@@ -20,34 +20,11 @@ fn main() {
         .run();
 }
 
-#[derive(Resource)]
-struct MyAnimations {
-    idle: Handle<Animation>,
-    run: Handle<Animation>,
-    shoot: Handle<Animation>,
-}
-
-// macro_rules! declare_animation_set_field_type {
-//     ($x:ident) => {
-//         Handle<Animation>
-//     };
-
-//     ($x:ident ?) => {
-//         Option<Handle<u8>>
-//     };
-// }
-
-// macro_rules! declare_animation_set {
-//     ($name:ident [ $($field:ident $(?)?),* ]) => {
-//         #[derive(Resource, Default)]
-//         pub struct $name {
-//             $(
-//                 pub $field: declare_animation_set_field_type!($field),
-//             )*
-//         }
-//     };
-// }
-// declare_animation_set!(MyAnimations [ idle, run, shoot? ]);
+animation_set!(MyAnimations [
+    anim idle,
+    anim run,
+    anim shoot
+]);
 
 fn spawn_character(
     mut commands: Commands,
@@ -85,6 +62,8 @@ fn spawn_character(
 
     let shoot_animation_handle = animations.add(shoot_animation);
 
+    // Store the animation set as a resource
+
     commands.insert_resource(MyAnimations {
         idle: idle_animation_handle.clone(),
         run: run_animation_handle.clone(),
@@ -96,7 +75,7 @@ fn spawn_character(
     let image = assets.load("character.png");
 
     let atlas = TextureAtlas {
-        layout: atlas_layouts.add(Spritesheet::new(8, 8).atlas_layout(96, 96)),
+        layout: atlas_layouts.add(spritesheet.atlas_layout(96, 96)),
         ..default()
     };
 
@@ -129,13 +108,13 @@ fn control_character(
     const CHARACTER_SPEED: f32 = 150.0;
 
     for (entity, mut sprite, mut animation, mut transform, shooting) in &mut characters {
-        // Except if they're shooting, in which case we wait for the animation to end
+        // If they're shooting, do nothing and wait for the animation to end
 
         if shooting.is_some() {
             continue;
         }
 
-        // Shoot
+        // Shoot with the spacebar
         if keyboard.pressed(KeyCode::Space) {
             // Set the animation
 
@@ -145,15 +124,17 @@ fn control_character(
 
             commands.entity(entity).insert(Shooting);
         }
-        // Move left or right
+        // Run with the arrows
         else if keyboard.pressed(KeyCode::ArrowLeft) || keyboard.pressed(KeyCode::ArrowRight) {
             // Set the animation
+            //
+            // Only if not already running as we don't want to reset the animation in that case
 
             if animation.animation != my_animations.run {
                 animation.switch(my_animations.run.clone());
             }
 
-            // Move
+            // Move the entity and flip it horizontally depending on the direction
 
             let translation = Vec3::X * time.delta_secs() * CHARACTER_SPEED;
 
@@ -168,6 +149,8 @@ fn control_character(
         // Idle
         else {
             // Set the animation
+            //
+            // Only if not already idle as we don't want to reset the animation in that case
 
             if animation.animation != my_animations.idle {
                 animation.switch(my_animations.idle.clone());

examples/common/mod.rs

@@ -5,6 +5,7 @@ use rand::Rng;
 const DEFAULT_WINDOW_WIDTH: f32 = 1280.0;
 const DEFAULT_WINDOW_HEIGHT: f32 = 720.0;
 
+// TODO move to single example using it
 /// Returns the screen-space position of the nth item in a grid
 pub fn grid_position(columns: u32, rows: u32, n: usize) -> Vec3 {
     const MARGIN: f32 = 100.0;
@@ -25,6 +26,7 @@ pub fn grid_position(columns: u32, rows: u32, n: usize) -> Vec3 {
     )
 }
 
+// TODO move to single example using it
 /// Returns a random screen-space position
 pub fn random_position() -> Vec3 {
     let mut rng = rand::rng();

examples/composition.rs

@@ -1,4 +1,4 @@
-// This example shows how to create more sophisticated animations made of multiple clips.
+// This example shows how to create composite animations made of multiple clips.
 
 #[path = "./common/mod.rs"]
 pub mod common;
@@ -30,7 +30,7 @@ fn spawn_character(
     // - run 5 times
     // - shoot once
     //
-    // The whole animation will repeat 5 times
+    // The whole animation will repeat 2 times
 
     let spritesheet = Spritesheet::new(8, 8);
 
@@ -47,8 +47,7 @@ fn spawn_character(
         .with_repetitions(1);
 
     let animation = Animation::from_clips([idle_clip, run_clip, shoot_clip])
-        // Let's repeat it a few times and then stop
-        .with_repetitions(AnimationRepeat::Times(5));
+        .with_repetitions(AnimationRepeat::Times(2));
 
     let animation_handle = animations.add(animation);
 
@@ -57,7 +56,7 @@ fn spawn_character(
     let image = assets.load("character.png");
 
     let atlas = TextureAtlas {
-        layout: atlas_layouts.add(Spritesheet::new(8, 8).atlas_layout(96, 96)),
+        layout: atlas_layouts.add(spritesheet.atlas_layout(96, 96)),
         ..default()
     };
 

examples/cursor.rs

@@ -1,4 +1,4 @@
-// This example shows how to create a animated cursor.
+// This example shows how to create an animated cursor.
 //
 // The 'custom_cursor' feature must be enabled for custom cursors to be animated (enabled by default).
 

examples/events.rs

@@ -44,12 +44,11 @@ fn main() {
         .run();
 }
 
-#[derive(Resource)]
-struct MyAnimations {
-    left_foot_touches_ground_marker: MarkerId,
-    right_foot_touches_ground_marker: MarkerId,
-    bullet_out_marker: MarkerId,
-}
+animation_set!(MyMarkers [
+  marker left_foot_touches_ground_marker,
+  marker right_foot_touches_ground_marker,
+  marker bullet_out_marker
+]);
 
 fn spawn_character(
     mut commands: Commands,
@@ -89,7 +88,7 @@ fn spawn_character(
 
     // TODO doc
 
-    commands.insert_resource(MyAnimations {
+    commands.insert_resource(MyMarkers {
         left_foot_touches_ground_marker,
         right_foot_touches_ground_marker,
         bullet_out_marker,
@@ -100,7 +99,7 @@ fn spawn_character(
     let image = assets.load("character.png");
 
     let atlas = TextureAtlas {
-        layout: atlas_layouts.add(Spritesheet::new(8, 8).atlas_layout(96, 96)),
+        layout: atlas_layouts.add(spritesheet.atlas_layout(96, 96)),
         ..default()
     };
 
@@ -221,7 +220,7 @@ fn spawn_visual_effects(
     mut meshes: ResMut<Assets<Mesh>>,
     mut materials: ResMut<Assets<ColorMaterial>>,
     mut messages: MessageReader<AnimationEvent>,
-    my_animations: Res<MyAnimations>,
+    my_animations: Res<MyMarkers>,
 ) {
     for event in messages.read() {
         if let AnimationEvent::MarkerHit { marker_id, .. } = event {

examples/headless.rs

@@ -31,7 +31,7 @@ fn spawn_animation(mut commands: Commands, mut animations: ResMut<Assets<Animati
 
     // Spawn an entity with a SpritesheetAnimation component that references our animation
     //
-    // We dont even need a Sprite since we aren't rendering anything
+    // We don't even need a Sprite since we aren't rendering anything
 
     commands.spawn(SpritesheetAnimation::new(animation_handle));
 }

examples/parameters.rs

@@ -1,4 +1,4 @@
-// This example shows the effect of each animation parameter.
+// This example shows the effect of different animation parameters.
 
 #[path = "./common/mod.rs"]
 pub mod common;
@@ -28,7 +28,7 @@ fn spawn_animations(
 ) {
     commands.spawn(Camera2d);
 
-    // Create a clip
+    // Create a clip that we'll reuse for each animation
 
     let spritesheet = Spritesheet::new(1, 30);
 
@@ -73,6 +73,7 @@ fn spawn_animations(
     ];
 
     // Easing
+
     for variety in [
         EasingVariety::Quadratic,
         EasingVariety::Cubic,

examples/progress.rs

@@ -1,4 +1,4 @@
-// This example shows how to control the progress of an animation.
+// This example shows how to query and control the progress of an animation.
 
 #[path = "./common/mod.rs"]
 pub mod common;
@@ -41,7 +41,7 @@ fn spawn_character(
     let image = assets.load("character.png");
 
     let atlas = TextureAtlas {
-        layout: atlas_layouts.add(Spritesheet::new(8, 8).atlas_layout(96, 96)),
+        layout: atlas_layouts.add(spritesheet.atlas_layout(96, 96)),
         ..default()
     };
 
@@ -63,19 +63,19 @@ fn control_animation(
     mut sprites: Query<&mut SpritesheetAnimation>,
 ) {
     for mut sprite in &mut sprites {
-        // Pause the current animation
+        // Play/Pause the animation
 
         if keyboard.just_pressed(KeyCode::KeyP) {
             sprite.playing = !sprite.playing;
         }
 
-        // Reset the current animation
+        // Reset the animation
 
         if keyboard.just_pressed(KeyCode::KeyR) {
             sprite.reset();
         }
 
-        // Go to a specific frame of the current animation
+        // Go to a specific frame of the animation
 
         let keys = [
             KeyCode::Numpad0,
@@ -93,3 +93,5 @@ fn control_animation(
         }
     }
 }
+
+// TODO print frame index