Skip to content

Rename AnimationGraph #16280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

BenjaminBrienen
Copy link
Contributor

@BenjaminBrienen BenjaminBrienen commented Nov 7, 2024

Objective

Fixes #15604

Solution

Replace "AnimationGraph" with "BlendGraph". Rename "animatable" to "blendable" accordingly.

TODO: Update the comments. I see a lot of "// animation graph". I'll do this once this is blessed and the scope has been determined.

Testing

Simple refactor can be evaluated by CI

Migration Guide

I'll create this once this has been blessed.

@BenjaminBrienen
Copy link
Contributor Author

The scope of this task needs to be precisely defined. What other types should be renamed for clarity? Should the term "blend" be used in documentation as well?

@BenjaminBrienen BenjaminBrienen self-assigned this Nov 7, 2024
@BenjaminBrienen BenjaminBrienen added C-Usability A targeted quality-of-life change that makes Bevy easier to use A-Animation Make things move and change over time X-Controversial There is active debate or serious implications around merging this PR D-Straightforward Simple bug fixes and API improvements, docs, test and examples S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Nov 7, 2024
@alice-i-cecile alice-i-cecile added this to the 0.16 milestone Nov 7, 2024
@hukasu
Copy link
Contributor

hukasu commented Dec 7, 2024

Shouldn't the name of the file also be renamed from animatable.rs to blendable.rs?

And what about the extension of the AnimationGraphAssetLoader from .animgraph to .blendgraph?

@BenjaminBrienen
Copy link
Contributor Author

Good ideas, thanks.

@BenjaminBrienen BenjaminBrienen added S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Dec 7, 2024
@alice-i-cecile alice-i-cecile added S-Needs-SME Decision or review from an SME is required and removed S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged labels Dec 31, 2024
Copy link
Contributor

@pcwalton pcwalton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have any problem with this.

Copy link
Contributor

@mweatherley mweatherley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine with this, but there are still a bunch of places in animatable.rs and animation_curves.rs where "animatable" should be changed to "blendable" (including the name of the former module, probably).

@alice-i-cecile alice-i-cecile removed this from the 0.16 milestone Mar 9, 2025
@alice-i-cecile alice-i-cecile added S-Adopt-Me The original PR author has no intent to complete this work. Pick me up! X-Contentious There are nontrivial implications that should be thought through and removed X-Controversial There is active debate or serious implications around merging this PR S-Needs-SME Decision or review from an SME is required labels Mar 9, 2025
@alice-i-cecile
Copy link
Member

Marking as Adopt-Me: I still think this is a good change (and there's support from animation experts), but there's more work to do here and a boatload of merge conflicts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Animation Make things move and change over time C-Usability A targeted quality-of-life change that makes Bevy easier to use D-Straightforward Simple bug fixes and API improvements, docs, test and examples S-Adopt-Me The original PR author has no intent to complete this work. Pick me up! X-Contentious There are nontrivial implications that should be thought through
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename AnimationGraph to something like BlendGraph or BlendTree
5 participants