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

Document RapierContext resource for Bevy plugin #92

Open
Jondolf opened this issue Mar 17, 2024 · 1 comment
Open

Document RapierContext resource for Bevy plugin #92

Jondolf opened this issue Mar 17, 2024 · 1 comment
Labels
D-Medium Medium difficulty documentation Improvements or additions to documentation P-Low Low priority S-not-started Work has not started on it

Comments

@Jondolf
Copy link
Contributor

Jondolf commented Mar 17, 2024

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

The RapierContext resource is quite a critical part of bevy_rapier. It contains all of the simulation structures, rigid body and collider sets, and IntegrationParameters (also related: #91). It is also used for scene queries and for getting collider parents and contact pairs, and I believe it can even be used to manually step the simulation. Despite all this, it is not mentioned anywhere in the bevy_rapier usage docs except that it is used for scene queries.

It should really be documented to at least mention the things that it contains, and all of the core tasks that it can be used for, along with code examples.

What solution would you like?

Document RapierContext on the website. This could be a part of a "Simulation structures" section similar to the core Rapier, but with more code examples and concrete usage docs, or it could have its completely own section.

@Vrixyz Vrixyz added documentation Improvements or additions to documentation S-not-started Work has not started on it P-Medium Medium Priority D-Medium Medium difficulty P-Low Low priority and removed P-Medium Medium Priority labels May 21, 2024
@Vrixyz
Copy link

Vrixyz commented May 21, 2024

Definitely needed, but we might want to wait for dimforge/bevy_rapier#502 to be adressed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
D-Medium Medium difficulty documentation Improvements or additions to documentation P-Low Low priority S-not-started Work has not started on it
Projects
None yet
Development

No branches or pull requests

2 participants