Allow negative `speed_scale` in AnimatedSprite2D & 3D #65148

Mickeon · 2022-08-31T14:35:18Z

This PR unlocks AnimatedSprite2D and AnimatedSprite3D's speed_scale, allowing it to go below 0.
If the speed_scale is set to a negative value, the animation plays backwards.
The second parameter of play(), backwards, works as before. If set to true, and speed_scale is negative, the animation plays forward. As such, this is barely if not a compatibility-breaking change, unless users were relying on the previous clamping.

It also slightly tweaks the internal code, as a follow-up from #64155.
I may do something more drastic later on, because the internals of this class look somewhat archaic, and there actually are some bugs and odd inconsistencies only some users like me may notice.

May need some testing regarding signal emissions.

Note: Having a method returning (speed_scale < 0.0) may still be beneficial for less math-leaning users and for readability purposes, but I'm not sure. Perhaps too situational.

~~The second parameter of play(), backwards, now reverses the current speed_scale when necessary.~~
This is no longer the case. The speed_scale Because of it, the true "direction" still cannot be known.
~~Closes godotengine/godot-proposals#5286 (see comments).~~
~~Closes godotengine/godot-proposals#4506.~~
~~Supersedes #41821.~~

Mickeon · 2022-09-07T14:51:20Z

@Calinou Upon reevaluation, I have to unfortunately say that this is at least slightly compatibility breaking, even if welcome. Thinking of situations where the scale of an animation's speed changes dynamically (e.g. running animation dependent on speed), where it is constantly set to a certain positive value, which means that unlike the previous behaviour, if the animation is by chance also reversed, it would snap back to not being so upon setting the property.

Edit: accidentally closed.

scene/2d/animated_sprite_2d.cpp

TokageItLab

I don't know if it should finish when animation reach first frame with speed_scale is negative in the case where there is no loop and backward == false.
FYI, in AnimationTree it will not be finish, but in AnimationPlayer it probably will be finish.

scene/2d/animated_sprite_2d.cpp

dalexeev · 2022-09-10T11:03:04Z

@Mickeon Sorry, I inadvertently implemented the same changes as you in a larger PR. I haven't looked at your PRs. For example, I fixed the processing logic differently (and more compactly).

Mickeon · 2022-09-10T11:07:12Z

It doesn't necessarily supersede it, but because both this and the mentioned PR are contested changes, it would be better to implement one thing at the time, then rebase if necessary.

Mickeon · 2022-09-12T12:36:05Z

This PR has been rebased and it now applies to AnimatedSprite3D as well, now that it can, since #64155.

kleonc · 2022-09-12T13:56:06Z

I don't know if it should finish when animation reach first frame with speed_scale is negative in the case where there is no loop and backward == false.

@TokageItLab I think this implementation doesn't allow such situation, speed_scale < 0 if and only if backwards == true. It's ensured in the set_speed_scale/play methods.

dalexeev · 2022-09-12T14:17:45Z

Sorry if I sound rude or arrogant, but in #65609 these issues are already resolved, these PRs overlap quite a lot. Things that are in this PR but not in #65609 are general edits like !frames.is_valid() -> frames.is_null(). I'm not opposed to this PR being merged, it just doesn't seem to make much sense to me. My patch size won't decrease much even if this PR gets merged.

kleonc

Checked the code, LGTM (and I do like the feature).

scene/2d/animated_sprite_2d.cpp

doc/classes/AnimatedSprite2D.xml

kleonc · 2022-09-12T14:46:11Z

Sorry if I sound rude or arrogant, but in #65609 these issues are already resolved, these PRs overlap quite a lot. Things that are in this PR but not in #65609 are general edits like !frames.is_valid() -> frames.is_null(). I'm not opposed to this PR being merged, it just doesn't seem to make much sense to me. My patch size won't decrease much even if this PR gets merged.

@dalexeev Personally I prefer few separate small PRs over a single all-in-one PR. It's just simpler to review such changes / harder to miss something. It's not like the features in your PR rely on each other, they can be introduced separately. I'm not suggesting it just for the sake of separating things. One feature might be welcomed but the other might be unwanted for whatever reason. Separating things makes it easier to discuss/approve specific parts (in some cases it might actually fasten the whole process).
And of course part of your PR is already made in here so it's kinda a partially duplicate. But I do like the "Add support for individual frame duration to SpriteFrames." part, just haven't looked at it properly yet.

Mickeon · 2022-09-12T17:39:13Z

At this point do you think it would be a bad idea to remove the second parameter of play(), add play_backwards() and have both do and document the sign inversion on speed_scale when necessary?

I mean, see if something else is off in this PR, then it can be merged and I can see later on. A Proposal would be very appropriate for this discussion.

scene/2d/animated_sprite_2d.cpp

scene/3d/sprite_3d.cpp

kleonc

Mainly typos.

doc/classes/AnimatedSprite2D.xml

doc/classes/AnimatedSprite3D.xml

scene/2d/animated_sprite_2d.cpp

Mickeon · 2022-09-13T10:20:38Z

Removed every "frame check" early return during iteration because frame is always clamped appropriately to at least be above 0.

scene/2d/animated_sprite_2d.cpp

Mickeon · 2022-09-13T10:37:54Z

I know I am the only person on Earth interested on this Node, and I do really really love to improve on it, but it'd be a good idea to merge this one and seeing how to go from there. I implied it before, but I would like to make a bunch of PRs about it

If the `speed_scale` is set to a negative value, the animation plays in reverse. The second parameter of `play()` still reverses as before. if `speed_scale` and the second parameter of `play()` is true, the animation plays forward. Also updates the documentation to better describe the pausing and playing behaviour.

TokageItLab

LGTM, thanks for nice job!

scene/2d/animated_sprite_2d.cpp

akien-mga · 2022-09-16T07:44:23Z

Thanks!

Mickeon requested review from a team as code owners August 31, 2022 14:35

Mickeon force-pushed the animated-sprite-negative-speed-scale branch from 4196a43 to f9a04e1 Compare August 31, 2022 14:40

Calinou added enhancement topic:animation topic:2d labels Aug 31, 2022

Calinou added this to the 4.0 milestone Aug 31, 2022

This was referenced Sep 1, 2022

Rework AnimatedTexture's fps into speed_scale #65188

Merged

Add the ability to set the duration of individual AnimatedSprite frames godotengine/godot-proposals#2214

Closed

Mickeon closed this Sep 7, 2022

Mickeon reopened this Sep 7, 2022

YuriSizov reviewed Sep 7, 2022

View reviewed changes

scene/2d/animated_sprite_2d.cpp Outdated Show resolved Hide resolved

TokageItLab reviewed Sep 8, 2022

View reviewed changes

TokageItLab requested changes Sep 8, 2022

View reviewed changes

scene/2d/animated_sprite_2d.cpp Outdated Show resolved Hide resolved

Mickeon mentioned this pull request Sep 8, 2022

Harmonise AnimatedSprite3D and its 2D counterpart #64155

Merged

Mickeon requested a review from TokageItLab September 8, 2022 18:23

dalexeev mentioned this pull request Sep 10, 2022

AnimatedSprite{2D,3D} improvements #65609

Merged

Mickeon force-pushed the animated-sprite-negative-speed-scale branch 2 times, most recently from d55afd5 to 9918baf Compare September 12, 2022 12:33

Mickeon requested a review from a team as a code owner September 12, 2022 12:33

Mickeon changed the title ~~Allow negative speed_scale in AnimatedSprite2D & refactoring~~ Allow negative speed_scale in AnimatedSprite2D & 3D Sep 12, 2022

kleonc added the breaks compat label Sep 12, 2022

kleonc approved these changes Sep 12, 2022

View reviewed changes

scene/2d/animated_sprite_2d.cpp Outdated Show resolved Hide resolved

doc/classes/AnimatedSprite2D.xml Outdated Show resolved Hide resolved

TokageItLab requested changes Sep 12, 2022

View reviewed changes

scene/2d/animated_sprite_2d.cpp Outdated Show resolved Hide resolved

Mickeon force-pushed the animated-sprite-negative-speed-scale branch from 5de67e7 to baa3e61 Compare September 12, 2022 17:48

TokageItLab reviewed Sep 12, 2022

View reviewed changes

scene/2d/animated_sprite_2d.cpp Outdated Show resolved Hide resolved

Mickeon force-pushed the animated-sprite-negative-speed-scale branch from baa3e61 to e98240e Compare September 12, 2022 18:36

TokageItLab approved these changes Sep 12, 2022

View reviewed changes

TokageItLab requested a review from YuriSizov September 12, 2022 18:42

Ehsan1388 mentioned this pull request Sep 12, 2022

Checked the code, LGTM (and I do like the feature). Ehsan1388/README.me#3

Open

akien-mga reviewed Sep 13, 2022

View reviewed changes

scene/3d/sprite_3d.cpp Outdated Show resolved Hide resolved

Mickeon force-pushed the animated-sprite-negative-speed-scale branch from e98240e to 34f6561 Compare September 13, 2022 08:41

akien-mga approved these changes Sep 13, 2022

View reviewed changes

kleonc requested changes Sep 13, 2022

View reviewed changes

Mickeon force-pushed the animated-sprite-negative-speed-scale branch from 34f6561 to 0e11850 Compare September 13, 2022 09:44

TokageItLab reviewed Sep 13, 2022

View reviewed changes

scene/2d/animated_sprite_2d.cpp Outdated Show resolved Hide resolved

kleonc approved these changes Sep 13, 2022

View reviewed changes

Mickeon force-pushed the animated-sprite-negative-speed-scale branch from 0e11850 to 4dd34df Compare September 13, 2022 10:20

TokageItLab requested changes Sep 13, 2022

View reviewed changes

scene/2d/animated_sprite_2d.cpp Outdated Show resolved Hide resolved

scene/2d/animated_sprite_2d.cpp Outdated Show resolved Hide resolved

Mickeon force-pushed the animated-sprite-negative-speed-scale branch from 4dd34df to 58ee128 Compare September 13, 2022 10:36

Mickeon force-pushed the animated-sprite-negative-speed-scale branch from 58ee128 to 8142bc4 Compare September 13, 2022 10:41

TokageItLab approved these changes Sep 13, 2022

View reviewed changes

KoBeWi reviewed Sep 13, 2022

View reviewed changes

scene/2d/animated_sprite_2d.cpp Show resolved Hide resolved

TokageItLab requested a review from akien-mga September 15, 2022 19:29

akien-mga merged commit 16d4439 into godotengine:master Sep 16, 2022

Mickeon mentioned this pull request Sep 17, 2022

AnimatedSprite: Remove play()'s backwards, add methods to compensate #65973

Closed

Mickeon deleted the animated-sprite-negative-speed-scale branch September 23, 2022 05:55

Mickeon mentioned this pull request Nov 19, 2022

Add a Godot 3 to Godot 4 upgrade guide godotengine/godot-docs#6393

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow negative `speed_scale` in AnimatedSprite2D & 3D #65148

Allow negative `speed_scale` in AnimatedSprite2D & 3D #65148

Mickeon commented Aug 31, 2022 •

edited

Loading

Mickeon commented Sep 7, 2022 •

edited

Loading

TokageItLab left a comment •

edited

Loading

dalexeev commented Sep 10, 2022

Mickeon commented Sep 10, 2022

Mickeon commented Sep 12, 2022

kleonc commented Sep 12, 2022

dalexeev commented Sep 12, 2022

kleonc left a comment

kleonc commented Sep 12, 2022

Mickeon commented Sep 12, 2022

kleonc left a comment

Mickeon commented Sep 13, 2022 •

edited

Loading

Mickeon commented Sep 13, 2022 •

edited

Loading

TokageItLab left a comment

akien-mga commented Sep 16, 2022

Allow negative speed_scale in AnimatedSprite2D & 3D #65148

Allow negative speed_scale in AnimatedSprite2D & 3D #65148

Conversation

Mickeon commented Aug 31, 2022 • edited Loading

Mickeon commented Sep 7, 2022 • edited Loading

TokageItLab left a comment • edited Loading

Choose a reason for hiding this comment

dalexeev commented Sep 10, 2022

Mickeon commented Sep 10, 2022

Mickeon commented Sep 12, 2022

kleonc commented Sep 12, 2022

dalexeev commented Sep 12, 2022

kleonc left a comment

Choose a reason for hiding this comment

kleonc commented Sep 12, 2022

Mickeon commented Sep 12, 2022

kleonc left a comment

Choose a reason for hiding this comment

Mickeon commented Sep 13, 2022 • edited Loading

Mickeon commented Sep 13, 2022 • edited Loading

TokageItLab left a comment

Choose a reason for hiding this comment

akien-mga commented Sep 16, 2022

Allow negative `speed_scale` in AnimatedSprite2D & 3D #65148

Allow negative `speed_scale` in AnimatedSprite2D & 3D #65148

Mickeon commented Aug 31, 2022 •

edited

Loading

Mickeon commented Sep 7, 2022 •

edited

Loading

TokageItLab left a comment •

edited

Loading

Mickeon commented Sep 13, 2022 •

edited

Loading

Mickeon commented Sep 13, 2022 •

edited

Loading