Update AnimatableProperty
documentation, reduce crate dependencies
#18543
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.
Objective
bevy_animation
dependency onbevy_render
.Narrative
I'm trying to make
bevy_animation
independent ofbevy_render
. The documentation forbevy_animation::AnimatableProperty
is one of the last few dependencies. It usesbevy_render::Projection
to demonstrate animating an arbitrary value, but I thought that could be easily swapped for something else.I then realised that the rest of the documentation was a bit out of date. Originally
AnimatableProperty
was the only way to animate a property and so the documentation was quite detailed. But over time the crate has gained more documentation and other ways to hook up properties, leaving parts of the docs stale or covered elsewhere. So I've slimmed down theAnimatableProperty
docs and added a link to the main alternative (animated_field
).I've probably swung too far towards brevity, so I can build them back up if preferred. Also the example is kinda contrived and doesn't show the range of
AnimatableProperty
, like being able to choose different components. And finally the memes might be a bit stale?Showcase
Testing