Update example in Readme #336
Conversation
fix dead link and update to current 3d_scene example
| Collider::compound(vec![( | ||
| Position(Vec3::ZERO), | ||
| Rotation(Quat::from_rotation_x(-std::f32::consts::FRAC_PI_2)), | ||
| Collider::cylinder(0.002, 4.0), | ||
| )]), |
There was a problem hiding this comment.
This is meant to be an extremely basic example that demonstrates the basic API, so this shouldn't be using a compound collider and Position and Rotation here. As you mentioned, it's needed since you rotate the circle mesh, which also rotates this cylinder, but it makes the example too confusing for an introductory example.
I'd just use the old cuboid/plane here, for both the mesh and collider, since it's a lot simpler. As mentioned above this example, this is a modified version of Bevy's example, so we can change some things. We could also just remove the link to the example completely and have this be a standalone thing
| commands.spawn(( | ||
| RigidBody::Dynamic, | ||
| AngularVelocity(Vec3::new(2.5, 3.4, 1.6)), | ||
| Collider::cuboid(1.0, 1.0, 1.0), | ||
| PbrBundle { | ||
| mesh: meshes.add(Cuboid::default()), | ||
| material: materials.add(Color::rgb(0.8, 0.7, 0.6)), | ||
| mesh: meshes.add(Cuboid::new(1.0, 1.0, 1.0)), |
There was a problem hiding this comment.
There's no need to change this imo
| mesh: meshes.add(Cuboid::new(1.0, 1.0, 1.0)), | |
| mesh: meshes.add(Cuboid::default()), |
| transform: Transform::from_xyz(0.0, 4.0, 0.0), | ||
| ..default() | ||
| }, | ||
| )); | ||
|
|
||
| // Light | ||
| // light |
There was a problem hiding this comment.
Nit, but I prefer to start comments with a capital letter, and have the extra newline between spawns, like what it was before. Bevy's own style guide says that comments should be capitalized, but it's contradicting itself in this example
| // light | |
| // Light |
(this would of course apply to all other comments here too)
Objective
The link in the current readme is broken and references an older version of the bevy 3d/3d_scene example.
Solution
This PR updates the readme example to be based on the new bevy example and fixes the link.
There may be a better way to rotate the cylinder collider than using Collider::compound that I'm not aware of, feel free to update this PR.