Effect controllers restructuring #1134
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
st-pasha
changed the title
spydon
approved these changes
Dec 2, 2021
luanpotter
reviewed
Dec 2, 2021
spydon
reviewed
Dec 2, 2021
packages/flame/lib/src/effects2/controllers/standard_controller.dart
Outdated
Show resolved
Hide resolved
st-pasha
commented
Dec 3, 2021
spydon
reviewed
Dec 3, 2021
packages/flame/lib/src/effects2/controllers/effect_controller.dart
Outdated
Show resolved
Hide resolved
erickzanardo
approved these changes
Dec 3, 2021
|
I'll merge this, and agree with Luan, great job! We still need to update the docs for the effects though, will you do that @st-pasha? |
|
yep |
9 tasks
spydon
pushed a commit
that referenced
this pull request
Dec 27, 2021
Added SequenceEffect, which performs a series of other effects.
The biggest challenge in implementing this feature came from the need to run the sequence in reverse, due to the alternate flag. This required that every effect and every controller supported running "back in time", which is not as simple as it sounds.
The following breaking changes were introduced:
The Effect class no longer supports .reverse() method and .isReversed flag.
This flag was added only 2 weeks ago (
Effect controllers restructuring #1134), with the idea that it will be necessary for the SequenceEffect. However, as it turned out, this flag is not as helpful as I thought it would be. In fact, given the user's ability to change it any point, it makes the implementation very error-prone.
To be clear, the ability for each effect to run in reverse remains -- only now it can no longer be triggered by the user manually. Instead, SequenceEffect triggers that ability itself at the alternation point. If there is demand in the future to manually force any effect to run backwards, we could restore this flag, but this would require thorough testing to make it work correctly.
Infinite effects now return duration = double.infinity instead of null, which seems more appropriate.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Given the new requirement that effect controllers must be able to run backwards in time, and owing to the considerable complexity this entails, this PRs decomposes effect controllers into multiple small building blocks. The main API of
EffectControllerremains mostly unchanged (with few new properties added), but the implementation of various effect controllers changes radically. In particular, there is no more classStandardEffectController. Instead, there are several smaller classes:LinearEffectController,CurvedEffectController,ReverseLinearEffectController,ReverseCurvedEffectController,DelayedEffectController,RepeatedEffectController,InfiniteEffectController,PauseEffectController,SequenceEffectController.In addition, factory constructor
EffectController()has exactly the same API as oldStandardEffectController, and can be used in its place.This new structure gives several advantages:
StandardEffectControllerwere producing an incomprehensible mess.SimpleEffectControlleris no longer needed, theEffectController()constructor will use as little or as many building blocks as necessary to create the effect controller.Checklist
///) and updated/added examples indoc/examples.flutter formatand theflutter analyzedoes not report any problems.[next]inCHANGELOG.md.Draftstatus, by clicking on theReady for reviewbutton in this PR.Breaking Change
CHANGELOG.md).