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

Thoughts from a newb on the getting started documentation #7

Open
sdfgeoff opened this issue Apr 10, 2021 · 0 comments
Open

Thoughts from a newb on the getting started documentation #7

sdfgeoff opened this issue Apr 10, 2021 · 0 comments
Labels
D-Hard Need technical or domain specific knowledge, or special coordination documentation Improvements or additions to documentation enhancement New feature or request P-Low Low priority S-not-started Work has not started on it

Comments

@sdfgeoff
Copy link

sdfgeoff commented Apr 10, 2021

I have been starting to use Rapier for a project, and thought I would write down some of the sticking-points regarding the getting started guide. I am something of a newbie at rust and at physics engines, so feel free to close this issue if you think it is off-topic or if I am being to noobish.


The rust user guide for how to use bevy ends with the main loops being:

loop {
        pipeline.step(
            &gravity,
            &integration_parameters,
            &mut broad_phase,
            &mut narrow_phase,
            &mut bodies,
            &mut colliders,
            &mut joints,
            &mut ccd_solver,
            &physics_hooks,
            &event_handler
        );
    }

for all the demos.

As a new user of rapier, I was initially confused how to get information back out of the engine (aka what do I do with a body handle). Perhaps extending the first example with:

println!(bodies.get(body_handle).position())

I initially found attaching collision shapes to rigid bodies fairly confusing: To me a CollisionSet was a just set of collision shapes - the same as the RigidBodySet is just a set of rigid bodies. This isn't helped by the getting started guide stating

A collider set is a container that maps a unique handle to a collider:

Perhaps a simple change to:

A collider set is a container that maps a unique handle to a collider and maps colliders to rigid bodies


Do you think it is worth me creating a PR with these changes?


Side note, why does every rust project have a bunch of documentation outside cargo-doc? It means I have to learn dozens of different static site generators to make PR's on them, and it's out-of-sync with the codebase, not auto-tested etc. etc.
Have you considering moving the pure-rust documentation into the crates module-level docs? There is a lot of stuff that can be directly copy-pasted from one to the other. Is it worth creating a bunch of PR's on the main Rapier repo doing this?

sebcrozet added a commit that referenced this issue Jul 3, 2022
@Vrixyz Vrixyz added documentation Improvements or additions to documentation enhancement New feature or request S-not-started Work has not started on it P-Low Low priority D-Hard Need technical or domain specific knowledge, or special coordination labels May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
D-Hard Need technical or domain specific knowledge, or special coordination documentation Improvements or additions to documentation enhancement New feature or request P-Low Low priority S-not-started Work has not started on it
Projects
None yet
Development

No branches or pull requests

2 participants