Skip to content
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

Better documentation for Transform and GlobalTransform #1599

Closed
alice-i-cecile opened this issue Mar 8, 2021 · 0 comments
Closed

Better documentation for Transform and GlobalTransform #1599

alice-i-cecile opened this issue Mar 8, 2021 · 0 comments
Labels
C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy
Milestone

Comments

@alice-i-cecile
Copy link
Member

What problem does this solve or what need does it fill?

Transforms are commonly used by almost all users of Bevy, including beginners. They have some unintuitive and undocumented behavior however, especially regarding Transform vs. GlobalTransform and how all this relates to parent-child object hierarachies.

What solution would you like?

Clearly document:

  1. What Transform and GlobalTransform are.
  2. Their basic usage.
  3. Which one you should use in which cases.
  4. How they interact with parents / children.
  5. How and when the transform hierarchy is updated.
  6. If [Merged by Bors] - Reliable change detection #1471 has not yet been merged, the perils of Changed in the transform hierarchy updater.

What alternative(s) have you considered?

Safer, clearer API. This is hard to do without losing performance, see #1460.

Additional context

Other approaches to solve this confusion was discussed at length in #1460, and better documentation was proposed as a good stopgap until a clear improvement is reached.

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy labels Mar 8, 2021
@alice-i-cecile alice-i-cecile added this to the Bevy 0.5 milestone Mar 8, 2021
@bors bors bot closed this as completed in 348e2a3 Mar 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants