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 how to control simulation parameters #91

Open
Jondolf opened this issue Mar 17, 2024 · 0 comments
Open

Document how to control simulation parameters #91

Jondolf opened this issue Mar 17, 2024 · 0 comments
Labels
D-Medium Medium difficulty documentation Improvements or additions to documentation M-Bevy about bevy_rapier crate M-JS about javascript integration M-Rust about rapier crate P-Medium Medium 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?

Simulation details like the timestep, solver iteration count, "slop" (allowed penetration), damping, and so on can be modified using the IntegrationParameters configuration. It is briefly mentioned in the "Simulation structures" section of the core Rapier docs, but it essentially just points to API docs, which doesn't really cover how the parameters can be accessed or modified. The descriptions of the properties are also rather brief and often not very user-friendly (What are PGS iterations? Or islands? How do CCD substeps differ from solver iterations?).

In addition, the docs for the Bevy plugin and JS bindings don't mention the integration parameters at all, and the way they are accessed is different from the core Rapier. For example, in the Bevy plugin, they are in the RapierContext resource (which is also not on the website except for the spatial query sections).

What solution would you like?

It would be very useful to have these kinds of simulation configuration options documented. It should cover how they can be accessed and modified, and how the most important options (like the timestep and solver iteration count) affect the simulation. These docs should exist for the Bevy plugin and JS bindings in addition to the core Rapier.

@Jondolf Jondolf changed the title Document how to control simulation detail Document how to control simulation parameters Mar 17, 2024
@Vrixyz Vrixyz added documentation Improvements or additions to documentation S-not-started Work has not started on it P-Medium Medium Priority M-Bevy about bevy_rapier crate M-Rust about rapier crate M-JS about javascript integration D-Medium Medium difficulty labels May 21, 2024
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 M-Bevy about bevy_rapier crate M-JS about javascript integration M-Rust about rapier crate P-Medium Medium Priority S-not-started Work has not started on it
Projects
None yet
Development

No branches or pull requests

2 participants