feat: add sprite animator component #1455
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 2064036:
|
… while maintaining aspect ratio
|
🎉 This PR is included in version 9.69.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Why
Added a Sprite animator component that is extends the default Three Sprite to allow the playback of sprite-sheets, either image only ones or JSON-Array / JSON-Hash ones. https://gamedev.stackexchange.com/a/116000
What
Created a component that enhances the default Three Sprite element by parsing the texture image and/or the accompanied JSON file in order to create a series of standalone frames. Those frames are used as a cutoff texture on the Sprite which they progress through useFrame and thus creating the animation.
By using JSON enhanced spritesheets the user can include multiple animations (e.g. Idle, Walk, Run) on the same spritesheet, and control which one is the component currently playing. The playback can change on runtime so it is possible to create a whole character animation set with only one
SpriteAnimatorcomponent and a single spritesheet image.The component also includes a number of utility event callbacks (onStart, onEnd, onFrame) and properties to fine tune the playback and give more control over the animation and its states.
Checklist
I have included a Codesandbox link that showcases image only spritesheet and JSON enhanced spritesheet as well as interaction with the sprite and alternation of sprite frames set.