mirror of
https://github.com/bevyengine/bevy
synced 2024-11-14 17:07:47 +00:00
db5f80b2be
# Objective Added `AnimationPlayer` API UX improvements. - Succestor to https://github.com/bevyengine/bevy/pull/5912 - Fixes https://github.com/bevyengine/bevy/issues/5848 _(Credits to @asafigan for filing #5848, creating the initial pull request, and the discussion in #5912)_ ## Solution - Created `RepeatAnimation` enum to describe an animation repetition behavior. - Added `is_finished()`, `set_repeat()`, and `is_playback_reversed()` methods to the animation player. - ~~Made the animation clip optional as per the comment from #5912~~ > ~~My problem is that the default handle [used the initialize a `PlayingAnimation`] could actually refer to an actual animation if an AnimationClip is set for the default handle, which leads me to ask, "Should animation_clip should be an Option?"~~ - Added an accessor for the animation clip `animation_clip()` to the animation player. To determine if an animation is finished, we use the number of times the animation has completed and the repetition behavior. If the animation is playing in reverse then `elapsed < 0.0` counts as a completion. Otherwise, `elapsed > animation.duration` counts as a completion. This is what I would expect, personally. If there's any ambiguity, perhaps we could add some `AnimationCompletionBehavior`, to specify that kind of completion behavior to use. Update: Previously `PlayingAnimation::elapsed` was being used as the seek time into the animation clip. This was misleading because if you increased the speed of the animation it would also increase (or decrease) the elapsed time. In other words, the elapsed time was not actually the elapsed time. To solve this, we introduce `PlayingAnimation::seek_time` to serve as the value we manipulate the move between keyframes. Consequently, `elapsed()` now returns the actual elapsed time, and is not effected by the animation speed. Because `set_elapsed` was being used to manipulate the displayed keyframe, we introduce `AnimationPlayer::seek_to` and `AnimationPlayer::replay` to provide this functionality. ## Migration Guide - Removed `set_elapsed`. - Removed `stop_repeating` in favour of `AnimationPlayer::set_repeat(RepeatAnimation::Never)`. - Introduced `seek_to` to seek to a given timestamp inside of the animation. - Introduced `seek_time` accessor for the `PlayingAnimation::seek_to`. - Introduced `AnimationPlayer::replay` to reset the `PlayingAnimation` to a state where no time has elapsed. --------- Co-authored-by: Hennadii Chernyshchyk <genaloner@gmail.com> Co-authored-by: François <mockersf@gmail.com>
160 lines
4.7 KiB
Rust
160 lines
4.7 KiB
Rust
//! Plays animations from a skinned glTF.
|
|
|
|
use std::f32::consts::PI;
|
|
use std::time::Duration;
|
|
|
|
use bevy::pbr::CascadeShadowConfigBuilder;
|
|
use bevy::prelude::*;
|
|
use bevy_internal::animation::RepeatAnimation;
|
|
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins(DefaultPlugins)
|
|
.insert_resource(AmbientLight {
|
|
color: Color::WHITE,
|
|
brightness: 1.0,
|
|
})
|
|
.add_systems(Startup, setup)
|
|
.add_systems(
|
|
Update,
|
|
(setup_scene_once_loaded, keyboard_animation_control),
|
|
)
|
|
.run();
|
|
}
|
|
|
|
#[derive(Resource)]
|
|
struct Animations(Vec<Handle<AnimationClip>>);
|
|
|
|
fn setup(
|
|
mut commands: Commands,
|
|
asset_server: Res<AssetServer>,
|
|
mut meshes: ResMut<Assets<Mesh>>,
|
|
mut materials: ResMut<Assets<StandardMaterial>>,
|
|
) {
|
|
// Insert a resource with the current scene information
|
|
commands.insert_resource(Animations(vec![
|
|
asset_server.load("models/animated/Fox.glb#Animation2"),
|
|
asset_server.load("models/animated/Fox.glb#Animation1"),
|
|
asset_server.load("models/animated/Fox.glb#Animation0"),
|
|
]));
|
|
|
|
// Camera
|
|
commands.spawn(Camera3dBundle {
|
|
transform: Transform::from_xyz(100.0, 100.0, 150.0)
|
|
.looking_at(Vec3::new(0.0, 20.0, 0.0), Vec3::Y),
|
|
..default()
|
|
});
|
|
|
|
// Plane
|
|
commands.spawn(PbrBundle {
|
|
mesh: meshes.add(shape::Plane::from_size(500000.0).into()),
|
|
material: materials.add(Color::rgb(0.3, 0.5, 0.3).into()),
|
|
..default()
|
|
});
|
|
|
|
// Light
|
|
commands.spawn(DirectionalLightBundle {
|
|
transform: Transform::from_rotation(Quat::from_euler(EulerRot::ZYX, 0.0, 1.0, -PI / 4.)),
|
|
directional_light: DirectionalLight {
|
|
shadows_enabled: true,
|
|
..default()
|
|
},
|
|
cascade_shadow_config: CascadeShadowConfigBuilder {
|
|
first_cascade_far_bound: 200.0,
|
|
maximum_distance: 400.0,
|
|
..default()
|
|
}
|
|
.into(),
|
|
..default()
|
|
});
|
|
|
|
// Fox
|
|
commands.spawn(SceneBundle {
|
|
scene: asset_server.load("models/animated/Fox.glb#Scene0"),
|
|
..default()
|
|
});
|
|
|
|
println!("Animation controls:");
|
|
println!(" - spacebar: play / pause");
|
|
println!(" - arrow up / down: speed up / slow down animation playback");
|
|
println!(" - arrow left / right: seek backward / forward");
|
|
println!(" - digit 1 / 3 / 5: play the animation <digit> times");
|
|
println!(" - L: loop the animation forever");
|
|
println!(" - return: change animation");
|
|
}
|
|
|
|
// Once the scene is loaded, start the animation
|
|
fn setup_scene_once_loaded(
|
|
animations: Res<Animations>,
|
|
mut players: Query<&mut AnimationPlayer, Added<AnimationPlayer>>,
|
|
) {
|
|
for mut player in &mut players {
|
|
player.play(animations.0[0].clone_weak()).repeat();
|
|
}
|
|
}
|
|
|
|
fn keyboard_animation_control(
|
|
keyboard_input: Res<Input<KeyCode>>,
|
|
mut animation_players: Query<&mut AnimationPlayer>,
|
|
animations: Res<Animations>,
|
|
mut current_animation: Local<usize>,
|
|
) {
|
|
for mut player in &mut animation_players {
|
|
if keyboard_input.just_pressed(KeyCode::Space) {
|
|
if player.is_paused() {
|
|
player.resume();
|
|
} else {
|
|
player.pause();
|
|
}
|
|
}
|
|
|
|
if keyboard_input.just_pressed(KeyCode::Up) {
|
|
let speed = player.speed();
|
|
player.set_speed(speed * 1.2);
|
|
}
|
|
|
|
if keyboard_input.just_pressed(KeyCode::Down) {
|
|
let speed = player.speed();
|
|
player.set_speed(speed * 0.8);
|
|
}
|
|
|
|
if keyboard_input.just_pressed(KeyCode::Left) {
|
|
let elapsed = player.seek_time();
|
|
player.seek_to(elapsed - 0.1);
|
|
}
|
|
|
|
if keyboard_input.just_pressed(KeyCode::Right) {
|
|
let elapsed = player.seek_time();
|
|
player.seek_to(elapsed + 0.1);
|
|
}
|
|
|
|
if keyboard_input.just_pressed(KeyCode::Return) {
|
|
*current_animation = (*current_animation + 1) % animations.0.len();
|
|
player
|
|
.play_with_transition(
|
|
animations.0[*current_animation].clone_weak(),
|
|
Duration::from_millis(250),
|
|
)
|
|
.repeat();
|
|
}
|
|
|
|
if keyboard_input.just_pressed(KeyCode::Key1) {
|
|
player.set_repeat(RepeatAnimation::Count(1));
|
|
player.replay();
|
|
}
|
|
|
|
if keyboard_input.just_pressed(KeyCode::Key3) {
|
|
player.set_repeat(RepeatAnimation::Count(3));
|
|
player.replay();
|
|
}
|
|
|
|
if keyboard_input.just_pressed(KeyCode::Key5) {
|
|
player.set_repeat(RepeatAnimation::Count(5));
|
|
player.replay();
|
|
}
|
|
|
|
if keyboard_input.just_pressed(KeyCode::L) {
|
|
player.set_repeat(RepeatAnimation::Forever);
|
|
}
|
|
}
|
|
}
|