Split RapierContext

CHANGELOG.md

@@ -23,18 +23,36 @@ which was its hardcoded behaviour.
 
 ### Modified
 
-- `RapierContext`, `RapierConfiguration` and `RenderToSimulationTime` are now a `Component` instead of resources.
-  - Rapier now supports multiple independent physics worlds, see example `multi_world3` for usage details.
+- Rapier now supports multiple independent physics contexts, see example `multi_contexts3` for usage details.
+  - Each entity managed by bevy_rapier has a `RapierContextEntityLink` pointing to the entity containing the components above.
+    - If you are building a library on top of `bevy_rapier` and would want to support multiple independent physics contexts too,
+  you can check out the details of [#545](https://github.com/dimforge/bevy_rapier/pull/545)
+  to find more information.
+  - Rapier now supports multiple independent physics contexts, see example `multi_contexts3` for usage details.
   - Migration guide:
     - `ResMut<mut RapierContext>` -> `WriteDefaultRapierContext`
     - `Res<RapierContext>` -> `ReadDefaultRapierContext`
     - Access to `RapierConfiguration` and `RenderToSimulationTime` should query for it
 on the responsible entity owning the `RenderContext`.
-  - If you are building a library on top of `bevy_rapier` and would want to support multiple independent physics worlds too,
+  - If you are building a library on top of `bevy_rapier` and would want to support multiple independent physics contexts too,
 you can check out the details of [#545](https://github.com/dimforge/bevy_rapier/pull/545)
 to get more context and information.
 - `colliders_with_aabb_intersecting_aabb` now takes `bevy::math::bounding::Aabb3d` (or `[..]::Aabb2d` in 2D) as parameter.
   - it is now accessible with `headless` feature enabled.
+- `RapierContext`, `RapierConfiguration` and `SimulationToRenderTime` are no longer `Resource`s.
+  - They have been split in multiple `Component`s:
+    - `RapierContextColliders`
+    - `RapierContextJoints`
+    - `RapierContextSimulation`
+    - `RapierRigidBodySet`
+    - `SimulationToRenderTime`
+    - `RapierConfiguration`
+  - Migration guide:
+    - `ResMut<mut RapierContext>` -> `WriteRapierContext`
+    - `Res<RapierContext>` -> `ReadRapierContext`
+    - Access to `RapierConfiguration` and `SimulationToRenderTime` should query for it
+  on the responsible entity owning the `RenderContext`.
+  - See [`ray_casting`](bevy_rapier3d/examples/ray_casting3.rs) example for a usage example.
 
 ## v0.27.0 (07 July 2024)
 

bevy_rapier2d/examples/debugdump2.rs

@@ -1,6 +1,6 @@
 //! Example using bevy_mod_debugdump to output a graph of systems execution order.
 //! run with:
-//! `cargo run --example debugdump2 > dump.dot  && dot -Tsvg dump.dot > dump.svg`
+//! `cargo run --example debugdump2 > dump.dot && dot -Tsvg dump.dot > dump.svg`
 
 use bevy::prelude::*;
 use bevy_mod_debugdump::{schedule_graph, schedule_graph_dot};

bevy_rapier2d/examples/testbed2.rs

@@ -204,11 +204,12 @@ fn main() {
             OnExit(Examples::PlayerMovement2),
             (
                 cleanup,
-                |mut rapier_config: Query<&mut RapierConfiguration>,
-                 ctxt: ReadDefaultRapierContext| {
+                |mut rapier_config: Query<&mut RapierConfiguration>, ctxt: ReadRapierContext| {
                     let mut rapier_config = rapier_config.single_mut();
-                    rapier_config.gravity =
-                        RapierConfiguration::new(ctxt.integration_parameters.length_unit).gravity;
+                    rapier_config.gravity = RapierConfiguration::new(
+                        ctxt.single().simulation.integration_parameters.length_unit,
+                    )
+                    .gravity;
                 },
             ),
         )

bevy_rapier3d/examples/joints3.rs

@@ -284,7 +284,7 @@ pub fn setup_physics(mut commands: Commands) {
 }
 
 pub fn print_impulse_revolute_joints(
-    context: ReadDefaultRapierContext,
+    context: ReadRapierContext,
     joints: Query<(Entity, &ImpulseJoint)>,
 ) {
     for (entity, impulse_joint) in joints.iter() {
@@ -293,7 +293,7 @@ pub fn print_impulse_revolute_joints(
                 println!(
                     "angle for {}: {:?}",
                     entity,
-                    context.impulse_revolute_joint_angle(entity),
+                    context.single().impulse_revolute_joint_angle(entity),
                 );
             }
             _ => {}

bevy_rapier3d/examples/multi_world3.rs → bevy_rapier3d/examples/multi_contexts3.rs

@@ -1,7 +1,7 @@
 use bevy::{input::common_conditions::input_just_pressed, prelude::*};
 use bevy_rapier3d::prelude::*;
 
-const N_WORLDS: usize = 2;
+const N_CONTEXTS: usize = 2;
 
 fn main() {
     App::new()
@@ -18,21 +18,21 @@ fn main() {
         ))
         .add_systems(
             Startup,
-            ((create_worlds, setup_physics).chain(), setup_graphics),
+            ((create_contexts, setup_physics).chain(), setup_graphics),
         )
         .add_systems(Update, move_platforms)
         .add_systems(
             Update,
-            change_world.run_if(input_just_pressed(KeyCode::KeyC)),
+            change_context.run_if(input_just_pressed(KeyCode::KeyC)),
         )
         .run();
 }
 
-fn create_worlds(mut commands: Commands) {
-    for i in 0..N_WORLDS {
-        let mut world = commands.spawn((RapierContext::default(), WorldId(i)));
+fn create_contexts(mut commands: Commands) {
+    for i in 0..N_CONTEXTS {
+        let mut context = commands.spawn((RapierContextBundle::default(), ContextId(i)));
         if i == 0 {
-            world.insert(DefaultRapierContext);
+            context.insert((DefaultRapierContext, RapierContextBundle::default()));
         }
     }
 }
@@ -46,7 +46,7 @@ fn setup_graphics(mut commands: Commands) {
 }
 
 #[derive(Component)]
-pub struct WorldId(pub usize);
+pub struct ContextId(pub usize);
 
 #[derive(Component)]
 struct Platform {
@@ -59,8 +59,8 @@ fn move_platforms(time: Res<Time>, mut query: Query<(&mut Transform, &Platform)>
     }
 }
 
-/// Demonstrates how easy it is to move one entity to another world.
-fn change_world(
+/// Demonstrates how easy it is to move one entity to another context.
+fn change_context(
     query_context: Query<Entity, With<DefaultRapierContext>>,
     mut query_links: Query<(Entity, &mut RapierContextEntityLink)>,
 ) {
@@ -70,12 +70,12 @@ fn change_world(
             continue;
         }
         link.0 = default_context;
-        println!("changing world of {} for world {}", e, link.0);
+        println!("changing context of {} for context {}", e, link.0);
     }
 }
 
 pub fn setup_physics(
-    context: Query<(Entity, &WorldId), With<RapierContext>>,
+    context: Query<(Entity, &ContextId), With<RapierContextSimulation>>,
     mut commands: Commands,
 ) {
     for (context_entity, id) in context.iter() {

bevy_rapier3d/examples/rapier_context_component.rs

@@ -0,0 +1,61 @@
+use bevy::prelude::*;
+use bevy_rapier3d::prelude::*;
+
+fn main() {
+    App::new()
+        .add_plugins((
+            DefaultPlugins,
+            RapierPhysicsPlugin::<NoUserData>::default(),
+            RapierDebugRenderPlugin::default(),
+        ))
+        .add_systems(Startup, (setup_physics, setup_graphics))
+        .add_systems(PostUpdate, display_nb_colliders)
+        .run();
+}
+
+/// Demonstrates how to access a more specific component of [`RapierContext`]
+fn display_nb_colliders(
+    query_context: Query<&RapierContextColliders, With<DefaultRapierContext>>,
+    mut exit: EventWriter<AppExit>,
+) {
+    let nb_colliders = query_context.single().colliders.len();
+    println!("There are {nb_colliders} colliders.");
+    if nb_colliders > 0 {
+        exit.send(AppExit::Success);
+    }
+}
+
+pub fn setup_physics(mut commands: Commands) {
+    /*
+     * Ground
+     */
+    let ground_size = 5.1;
+    let ground_height = 0.1;
+
+    let starting_y = -0.5 - ground_height;
+
+    commands.spawn((
+        TransformBundle::from(Transform::from_xyz(0.0, starting_y, 0.0)),
+        Collider::cuboid(ground_size, ground_height, ground_size),
+    ));
+
+    for _ in 0..3 {
+        /*
+         * Create the cubes
+         */
+
+        commands.spawn((
+            TransformBundle::default(),
+            RigidBody::Dynamic,
+            Collider::cuboid(0.5, 0.5, 0.5),
+        ));
+    }
+}
+
+fn setup_graphics(mut commands: Commands) {
+    commands.spawn(Camera3dBundle {
+        transform: Transform::from_xyz(0.0, 3.0, -10.0)
+            .looking_at(Vec3::new(0.0, 0.0, 0.0), Vec3::Y),
+        ..Default::default()
+    });
+}

bevy_rapier3d/examples/ray_casting3.rs

@@ -76,7 +76,7 @@ pub fn setup_physics(mut commands: Commands) {
 pub fn cast_ray(
     mut commands: Commands,
     windows: Query<&Window, With<PrimaryWindow>>,
-    rapier_context: ReadDefaultRapierContext,
+    rapier_context: ReadRapierContext,
     cameras: Query<(&Camera, &GlobalTransform)>,
 ) {
     let window = windows.single();
@@ -91,9 +91,9 @@ pub fn cast_ray(
         let Some(ray) = camera.viewport_to_world(camera_transform, cursor_position) else {
             return;
         };
-
+        let context = rapier_context.single();
         // Then cast the ray.
-        let hit = rapier_context.cast_ray(
+        let hit = context.cast_ray(
             ray.origin,
             ray.direction.into(),
             f32::MAX,

bevy_rapier_benches3d/src/lib.rs

@@ -9,7 +9,7 @@ use common::default_app;
 use common::wait_app_start;
 
 use bevy::prelude::*;
-use bevy_rapier3d::plugin::RapierContext;
+use bevy_rapier3d::plugin::context::RapierContextSimulation;
 
 pub fn custom_bencher(steps: usize, setup: impl Fn(&mut App)) {
     let mut app = default_app();
@@ -28,7 +28,7 @@ pub fn custom_bencher(steps: usize, setup: impl Fn(&mut App)) {
         let elapsed_time = timer_full_update.time() as f32;
         let rc = app
             .world_mut()
-            .query::<&RapierContext>()
+            .query::<&RapierContextSimulation>()
             .single(app.world());
         rapier_step_times.push(rc.pipeline.counters.step_time.time() as f32);
         total_update_times.push(elapsed_time);

src/control/character_controller.rs

@@ -2,7 +2,7 @@ use crate::geometry::{Collider, CollisionGroups, ShapeCastHit};
 use crate::math::{Real, Rot, Vect};
 use bevy::prelude::*;
 
-use crate::plugin::RapierContext;
+use crate::plugin::context::RapierContextColliders;
 pub use rapier::control::CharacterAutostep;
 pub use rapier::control::CharacterLength;
 use rapier::prelude::{ColliderSet, QueryFilterFlags};
@@ -26,7 +26,7 @@ pub struct CharacterCollision {
 
 impl CharacterCollision {
     pub(crate) fn from_raw(
-        ctxt: &RapierContext,
+        ctxt: &RapierContextColliders,
         c: &rapier::control::CharacterCollision,
     ) -> Option<Self> {
         Self::from_raw_with_set(&ctxt.colliders, c, true)
@@ -37,7 +37,7 @@ impl CharacterCollision {
         c: &rapier::control::CharacterCollision,
         details_always_computed: bool,
     ) -> Option<Self> {
-        RapierContext::collider_entity_with_set(colliders, c.handle).map(|entity| {
+        RapierContextColliders::collider_entity_with_set(colliders, c.handle).map(|entity| {
             CharacterCollision {
                 entity,
                 character_translation: c.character_pos.translation.vector.into(),

src/dynamics/revolute_joint.rs

@@ -1,11 +1,14 @@
 use crate::dynamics::{GenericJoint, GenericJointBuilder};
 use crate::math::{Real, Vect};
-use crate::plugin::RapierContext;
+use crate::plugin::context::RapierRigidBodySet;
 use bevy::prelude::Entity;
 use rapier::dynamics::{
     JointAxesMask, JointAxis, JointLimits, JointMotor, MotorModel, RigidBodyHandle, RigidBodySet,
 };
 
+#[cfg(doc)]
+use crate::prelude::RapierContext;
+
 use super::TypedJoint;
 
 #[cfg_attr(feature = "serde-serialize", derive(Serialize, Deserialize))]
@@ -147,7 +150,7 @@ impl RevoluteJoint {
     /// Similarly [`RapierContext::impulse_revolute_joint_angle`] only takes a single entity as argument to compute that angle.
     ///
     /// # Parameters
-    /// - `bodies` : the rigid body set from [`RapierContext`]
+    /// - `bodies` : the rigid body set from [`RapierRigidBodySet`]
     /// - `body1`: the first rigid-body attached to this revolute joint, obtained through [`rapier::dynamics::ImpulseJoint`] or [`rapier::dynamics::MultibodyJoint`].
     /// - `body2`: the second rigid-body attached to this revolute joint, obtained through [`rapier::dynamics::ImpulseJoint`] or [`rapier::dynamics::MultibodyJoint`].
     pub fn angle_from_handles(
@@ -167,13 +170,13 @@ impl RevoluteJoint {
     /// The angle along the free degree of freedom of this revolute joint in `[-π, π]`.
     ///
     /// # Parameters
-    /// - `bodies` : the rigid body set from [`RapierContext`]
+    /// - `bodies` : the rigid body set from [`RapierRigidBodySet`]
     /// - `body1`: the first rigid-body attached to this revolute joint.
     /// - `body2`: the second rigid-body attached to this revolute joint.
-    pub fn angle(&self, context: &RapierContext, body1: Entity, body2: Entity) -> f32 {
-        let rb1 = context.entity2body().get(&body1).unwrap();
-        let rb2 = context.entity2body().get(&body2).unwrap();
-        self.angle_from_handles(&context.bodies, *rb1, *rb2)
+    pub fn angle(&self, rigidbody_set: &RapierRigidBodySet, body1: Entity, body2: Entity) -> f32 {
+        let rb1 = rigidbody_set.entity2body().get(&body1).unwrap();
+        let rb2 = rigidbody_set.entity2body().get(&body2).unwrap();
+        self.angle_from_handles(&rigidbody_set.bodies, *rb1, *rb2)
     }
 }
 

src/lib.rs

@@ -72,6 +72,8 @@ pub mod prelude {
     pub use crate::geometry::*;
     pub use crate::math::*;
     pub use crate::pipeline::*;
+    pub use crate::plugin::context::systemparams::*;
+    pub use crate::plugin::context::*;
     pub use crate::plugin::*;
     #[cfg(any(feature = "debug-render-3d", feature = "debug-render-2d"))]
     pub use crate::render::*;

src/pipeline/events.rs

@@ -182,7 +182,7 @@ mod test {
             ));
             // 2 seconds should be plenty of time for the cube to fall on the
             // lowest collider.
-            for _ in 0..120 {
+            for _ in 0..1020 {
                 app.update();
             }
             let saved_collisions = app

src/pipeline/query_filter.rs

@@ -5,11 +5,11 @@ pub use rapier::pipeline::QueryFilterFlags;
 use crate::geometry::CollisionGroups;
 
 #[cfg(doc)]
-use crate::prelude::RapierContext;
+use crate::prelude::RapierRigidBodySet;
 
 /// A filter that describes what collider should be included or excluded from a scene query.
 ///
-/// For testing manually check [`RapierContext::with_query_filter`].
+/// For testing manually check [`RapierRigidBodySet::with_query_filter`].
 #[derive(Copy, Clone, Default)]
 pub struct QueryFilter<'a> {
     /// Flags indicating what particular type of colliders should be excluded.

src/plugin/configuration.rs

@@ -1,3 +1,5 @@
+//! Components used to configure a simulation run by rapier, these are not modified by bevy_rapier.
+
 use bevy::{
     prelude::{Component, Resource},
     reflect::Reflect,
@@ -8,13 +10,6 @@ use crate::math::{Real, Vect};
 #[cfg(doc)]
 use {crate::prelude::TransformInterpolation, rapier::dynamics::IntegrationParameters};
 
-/// Difference between simulation and rendering time
-#[derive(Component, Default, Reflect)]
-pub struct SimulationToRenderTime {
-    /// Difference between simulation and rendering time
-    pub diff: f32,
-}
-
 /// The different ways of adjusting the timestep length each frame.
 #[derive(Copy, Clone, Debug, PartialEq, Resource)]
 pub enum TimestepMode {