[Merged by Bors] - animation player #4375

mockersf · 2022-03-31T12:16:27Z

Objective

Add a basic animation player
- Single track
- Not generic, can only animate Transforms
- With plenty of possible optimisations available
- Close-ish to Animation Primitives rfcs#49
https://discord.com/channels/691052431525675048/774027865020039209/958820063148929064

Solution

Can play animations
- looping or not
Can pause animations
Can seek in animation
Can alter speed of animation
I also removed the previous gltf animation example

animated_fox.mp4

crates/bevy_animation/src/lib.rs

examples/animation/animated_fox.rs

Co-authored-by: Jakob Hellermann <[email protected]>

crates/bevy_animation/src/lib.rs

examples/animation/animated_fox.rs

kirusfg · 2022-04-01T06:24:50Z

Regarding the keyframes, I thought of remembering the step_start and step_end keyframes and updating them if elapsed time is greater than that of step_end instead of traversing through all of them each frame. Do you think that is a good approach?

Choosing an arbitrary position on the track would still require some kind of traversal, I think.

CptPotato · 2022-04-01T10:45:59Z

Regarding the keyframes, I thought of remembering the step_start and step_end keyframes and updating them if elapsed time is greater than that of step_end instead of traversing through all of them each frame. Do you think that is a good approach?

Choosing an arbitrary position on the track would still require some kind of traversal, I think.

That's generally a good idea in my opinion 👍

To elaborate a bit more: From my experience, when working with animations finding the keyframe works very well with these two strategies:

for continuous playback start at the index of the last iteration (in this case step_start) and perform a linear search (forward or backward depending on playback direction) *
for seeking to arbitrary positions, binary search is a sensible default (though it could be optimized more when necessary)

* The cached value of step_start is tied to the "playback instance" so it would be stored as a part of the animation player

This assumes that the framerate of the keyframes isn't significantly higher than the playback speed.
There are also different approaches for cases where the keyframes occur at a fixed rate.

james7132 · 2022-04-01T16:13:41Z

A keyframe cursor is generally useful for linear playback which this player is mostly intended for. For a more realistic modern use case where we have multiple blended clips in any given state, random seeks become more common (think transitioned blending and arbitrary gameplay driven blend states), which is actually negatively impacted when using a cursor.

For this PR, I think it's fine to use as is but we may want to revisit if it's worth the complexity as we scale this.

…mations

cart · 2022-04-01T18:53:25Z

Awesome! Love the new user-facing api.

mockersf · 2022-04-01T19:00:19Z

Switched they keyframe lookup to a binary search.
I would prefer to avoid adding cursors for now, they are quite more complex, and we would need a way to address each curve independently as the cursors need to be by curve

cart · 2022-04-01T19:21:16Z

I'm down to optimize for implementation simplicity, given the timelines we're dealing with here.

cart

I think this is in a good spot for 0.7 and provides a reasonable starting point for future improvements. Well done!

crates/bevy_animation/src/lib.rs

cart · 2022-04-01T20:47:19Z

I'll hold off on other approvals for a day or so, then I'll merge.

tim-blackbird

Does this handle playing animations in reverse?

crates/bevy_animation/src/lib.rs

examples/animation/animated_fox.rs

mockersf · 2022-04-01T21:56:01Z

Does this handle playing animations in reverse?

now it does 👍

marko-lazic · 2022-04-01T22:36:55Z

examples/animation/animated_fox.rs

+) {
+    if !*done {
+        if let Ok(mut player) = player.get_single_mut() {
+            player.play_animation(animations.0[0].clone_weak()).repeat();


Hm... Looking from a use perspective AnimationPlayer would look prettier if it was just Animation.
system param
animations: Query<&mut Animation>,
then later
if let Ok(mut animation) = animations.get_single_mut() {
animation.play(fox_animations.0[0].clone_weak()).repeat();

I do like the bias toward "nicer names", but in this particular case, I think AnimationPlayer is the better name. It represents a thing that plays animation, not a thing that is Animation. I'm more open to renaming AnimationClip to Animation, but I'm also happy with the current name, for now.

Additionally, we have plans for a more general "bevy animation system". It probably makes sense to reserve the Animation name until we sort out how that fits in to this.

cart · 2022-04-02T22:35:46Z

bors r+

# Objective - Add a basic animation player - Single track - Not generic, can only animate `Transform`s - With plenty of possible optimisations available - Close-ish to bevyengine/rfcs#49 - https://discord.com/channels/691052431525675048/774027865020039209/958820063148929064 ## Solution - Can play animations - looping or not - Can pause animations - Can seek in animation - Can alter speed of animation - I also removed the previous gltf animation example https://user-images.githubusercontent.com/8672791/161051887-e79283f0-9803-448a-93d0-5f7a62acb02d.mp4

bors · 2022-04-02T22:56:30Z

Pull request successfully merged into main.

Build succeeded:

# Objective - Add a basic animation player - Single track - Not generic, can only animate `Transform`s - With plenty of possible optimisations available - Close-ish to bevyengine/rfcs#49 - https://discord.com/channels/691052431525675048/774027865020039209/958820063148929064 ## Solution - Can play animations - looping or not - Can pause animations - Can seek in animation - Can alter speed of animation - I also removed the previous gltf animation example https://user-images.githubusercontent.com/8672791/161051887-e79283f0-9803-448a-93d0-5f7a62acb02d.mp4

animation player

96d4489

github-actions bot added the S-Needs-Triage This issue needs to be labelled label Mar 31, 2022

clippy

b23b42a

mockersf added C-Feature A new feature, making something new possible A-Animation Make things move and change over time and removed S-Needs-Triage This issue needs to be labelled labels Mar 31, 2022

more clippy

fe3ff70

jakobhellermann suggested changes Mar 31, 2022

View reviewed changes

crates/bevy_animation/src/lib.rs Outdated Show resolved Hide resolved

examples/animation/animated_fox.rs Outdated Show resolved Hide resolved

case sensitivity

8058ade

Co-authored-by: Jakob Hellermann <[email protected]>

kirusfg reviewed Mar 31, 2022

View reviewed changes

crates/bevy_animation/src/lib.rs Show resolved Hide resolved

do not update the animation when paused unless manually updated

9fda643

cart reviewed Mar 31, 2022

View reviewed changes

examples/animation/animated_fox.rs Outdated Show resolved Hide resolved

mockersf added 4 commits April 1, 2022 19:58

binary search for the keyframe

d4b4601

new api for AnimationPlayer

191864c

add an AnimationPlayer automatically to a gltf scene if there are ani…

a811a3e

…mations

clippy again

184b43e

update comments

75f041f

system ordering

eecce26

cart approved these changes Apr 1, 2022

View reviewed changes

crates/bevy_animation/src/lib.rs Outdated Show resolved Hide resolved

plurals

0d7aea3

tim-blackbird suggested changes Apr 1, 2022

View reviewed changes

crates/bevy_animation/src/lib.rs Outdated Show resolved Hide resolved

crates/bevy_animation/src/lib.rs Outdated Show resolved Hide resolved

crates/bevy_animation/src/lib.rs Show resolved Hide resolved

examples/animation/animated_fox.rs Show resolved Hide resolved

work with negative elapsed time

e1a2c67

mockersf added 2 commits April 2, 2022 00:00

api improvement on play and stop_repeating

0f9f9bb

fix example

14d8509

marko-lazic reviewed Apr 1, 2022

View reviewed changes

tim-blackbird approved these changes Apr 2, 2022

View reviewed changes

alice-i-cecile added this to the Bevy 0.7 milestone Apr 2, 2022

bors bot changed the title ~~animation player~~ [Merged by Bors] - animation player Apr 2, 2022

bors bot closed this Apr 2, 2022

Kanabenki mentioned this pull request Sep 28, 2023

Tracking issue: deny missing docs, one crate at a time #3492

Open

45 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Merged by Bors] - animation player #4375

[Merged by Bors] - animation player #4375

mockersf commented Mar 31, 2022

kirusfg commented Apr 1, 2022

CptPotato commented Apr 1, 2022 •

edited

Loading

james7132 commented Apr 1, 2022

cart commented Apr 1, 2022

mockersf commented Apr 1, 2022

cart commented Apr 1, 2022

cart left a comment

cart commented Apr 1, 2022

tim-blackbird left a comment

mockersf commented Apr 1, 2022

marko-lazic Apr 1, 2022

cart Apr 2, 2022

cart commented Apr 2, 2022

bors bot commented Apr 2, 2022

[Merged by Bors] - animation player #4375

[Merged by Bors] - animation player #4375

Conversation

mockersf commented Mar 31, 2022

Objective

Solution

kirusfg commented Apr 1, 2022

CptPotato commented Apr 1, 2022 • edited Loading

james7132 commented Apr 1, 2022

cart commented Apr 1, 2022

mockersf commented Apr 1, 2022

cart commented Apr 1, 2022

cart left a comment

Choose a reason for hiding this comment

cart commented Apr 1, 2022

tim-blackbird left a comment

Choose a reason for hiding this comment

mockersf commented Apr 1, 2022

marko-lazic Apr 1, 2022

Choose a reason for hiding this comment

cart Apr 2, 2022

Choose a reason for hiding this comment

cart commented Apr 2, 2022

bors bot commented Apr 2, 2022

CptPotato commented Apr 1, 2022 •

edited

Loading