Merge pull request #80 from Person-93/deprecate-io-bundles

Deprecate rapier io bundles
idanarye · Jan 14, 2025 · 950e903 · 950e903
2 parents 3be4684 + 153e9fb
commit 950e903
Show file tree

Hide file tree

Showing 8 changed files with 14 additions and 14 deletions.
diff --git a/demos/src/bin/platformer_2d.rs b/demos/src/bin/platformer_2d.rs
@@ -165,15 +165,11 @@ fn setup_player(mut commands: Commands) {
     {
         cmd.insert(rapier::RigidBody::Dynamic);
         cmd.insert(rapier::Collider::capsule_y(0.5, 0.5));
-        // For Rapier, an "IO" bundle needs to be added so that Tnua will have all the components
-        // it needs to interact with Rapier.
-        cmd.insert(TnuaRapier2dIOBundle::default());
     }
     #[cfg(feature = "avian2d")]
     {
         cmd.insert(avian::RigidBody::Dynamic);
         cmd.insert(avian::Collider::capsule(0.5, 1.0));
-        // Avian does not need an "IO" bundle.
     }
 
     // `TnuaController` is Tnua's main interface with the user code. Read

diff --git a/demos/src/bin/platformer_3d.rs b/demos/src/bin/platformer_3d.rs
@@ -177,15 +177,11 @@ fn setup_player(mut commands: Commands, asset_server: Res<AssetServer>) {
     {
         cmd.insert(rapier::RigidBody::Dynamic);
         cmd.insert(rapier::Collider::capsule_y(0.5, 0.5));
-        // For Rapier, an "IO" bundle needs to be added so that Tnua will have all the components
-        // it needs to interact with Rapier.
-        cmd.insert(TnuaRapier3dIOBundle::default());
     }
     #[cfg(feature = "avian3d")]
     {
         cmd.insert(avian::RigidBody::Dynamic);
         cmd.insert(avian::Collider::capsule(0.5, 1.0));
-        // Avian does not need an "IO" bundle.
     }
 
     // `TnuaController` is Tnua's main interface with the user code. Read

diff --git a/demos/src/bin/shooter_like.rs b/demos/src/bin/shooter_like.rs
@@ -180,15 +180,11 @@ fn setup_player(mut commands: Commands, asset_server: Res<AssetServer>) {
     {
         cmd.insert(rapier::RigidBody::Dynamic);
         cmd.insert(rapier::Collider::capsule_y(0.5, 0.5));
-        // For Rapier, an "IO" bundle needs to be added so that Tnua will have all the components
-        // it needs to interact with Rapier.
-        cmd.insert(TnuaRapier3dIOBundle::default());
     }
     #[cfg(feature = "avian3d")]
     {
         cmd.insert(avian::RigidBody::Dynamic);
         cmd.insert(avian::Collider::capsule(0.5, 1.0));
-        // Avian does not need an "IO" bundle.
     }
 
     // `TnuaController` is Tnua's main interface with the user code. Read

diff --git a/examples/example.rs b/examples/example.rs
@@ -94,7 +94,6 @@ fn setup_player(
         // By locking the rotation we can prevent this.
         LockedAxes::ROTATION_LOCKED,
     ));
-    // NOTE: if this was Rapier, we'd also need `TnuaRapier3dIOBundle`. Avian does not need it.
 }
 
 fn apply_controls(keyboard: Res<ButtonInput<KeyCode>>, mut query: Query<&mut TnuaController>) {

diff --git a/examples/example_animating.rs b/examples/example_animating.rs
@@ -119,7 +119,6 @@ fn setup_player(mut commands: Commands, asset_server: Res<AssetServer>) {
         // By locking the rotation we can prevent this.
         LockedAxes::ROTATION_LOCKED.unlock_rotation_y(),
     ));
-    // NOTE: if this was Rapier, we'd also need `TnuaRapier3dIOBundle`. Avian does not need it.
 }
 
 // No Tnua-related setup here - this is just for dealing with Bevy's animation graph.

diff --git a/rapier2d/src/lib.rs b/rapier2d/src/lib.rs
@@ -47,6 +47,9 @@ impl Default for TnuaRapier2dPlugin {
 
 impl Plugin for TnuaRapier2dPlugin {
     fn build(&self, app: &mut App) {
+        app.register_required_components::<TnuaProximitySensor, Velocity>()
+            .register_required_components::<TnuaProximitySensor, ExternalForce>()
+            .register_required_components::<TnuaProximitySensor, ReadMassProperties>();
         app.configure_sets(
             self.schedule,
             TnuaSystemSet.before(PhysicsSet::SyncBackend).run_if(
@@ -70,6 +73,9 @@ impl Plugin for TnuaRapier2dPlugin {
 
 /// `bevy_rapier2d`-specific components required for Tnua to work.
 #[derive(Bundle, Default)]
+#[deprecated(
+    note = "All uses can be safely removed, components are added via bevy's required components"
+)]
 pub struct TnuaRapier2dIOBundle {
     pub velocity: Velocity,
     pub external_force: ExternalForce,

diff --git a/rapier3d/CHANGELOG.md b/rapier3d/CHANGELOG.md
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 NOTE: This changelog is shared between bevy-tnua-rapier2d and bevy-tnua-rapier3d.
 
 ## [Unreleased]
+### Deprecated
+- Deprecate `TnuaRapier3dIOBundle` in favor or bevy required components.
 
 ## 0.9.0 - 2024-12-13
 ### Changed

diff --git a/rapier3d/src/lib.rs b/rapier3d/src/lib.rs
@@ -47,6 +47,9 @@ impl Default for TnuaRapier3dPlugin {
 
 impl Plugin for TnuaRapier3dPlugin {
     fn build(&self, app: &mut App) {
+        app.register_required_components::<TnuaProximitySensor, Velocity>()
+            .register_required_components::<TnuaProximitySensor, ExternalForce>()
+            .register_required_components::<TnuaProximitySensor, ReadMassProperties>();
         app.configure_sets(
             self.schedule,
             TnuaSystemSet.before(PhysicsSet::SyncBackend).run_if(
@@ -70,6 +73,9 @@ impl Plugin for TnuaRapier3dPlugin {
 
 /// `bevy_rapier3d`-specific components required for Tnua to work.
 #[derive(Bundle, Default)]
+#[deprecated(
+    note = "All uses can be safely removed, components are added via bevy's required components"
+)]
 pub struct TnuaRapier3dIOBundle {
     pub velocity: Velocity,
     pub external_force: ExternalForce,