feat: add labels to created colliders (#100)

Author: mbrea-c

assets/skeleton_colliders/human.coll.ron

@@ -21,6 +21,8 @@
                 translation: (0.0, 0.25, -0.025),
             ),
             offset_mode: Global,
+            label: "shin",
+            use_suffixes: true,
         ),
     ],
     skeleton: "skeletons/human.skn.ron",
@@ -34,4 +36,8 @@
         mode: MirrorX,
     ),
     symmetry_enabled: true,
+    default_layer_membership: 1,
+    default_layer_filter: 0,
+    suffix: ".R",
+    mirror_suffix: ".L",
 )

crates/bevy_animation_graph/src/core/animated_scene/mod.rs

@@ -214,6 +214,9 @@ fn process_scene_into_animscn(
                             .into(),
                     },
                     offset_mode: cfg.offset_mode,
+                    label: cfg.label.clone(),
+                    use_suffixes: cfg.use_suffixes,
+                    is_mirrored: true,
                 };
                 let mirror_bone_collider_list = foreach_bone.entry(mirror_bone_id).or_default();
                 mirror_bone_collider_list.push(mirror_cfg);
@@ -233,6 +236,8 @@ fn process_scene_into_animscn(
             use avian3d::prelude::{ColliderConstructor, CollisionLayers};
 
             let cfg_to_bundle = |cfg: ColliderConfig| {
+                use crate::core::colliders::core::ColliderLabel;
+
                 (
                     cfg.local_transform(default_transforms),
                     match cfg.shape {
@@ -262,6 +267,19 @@ fn process_scene_into_animscn(
                             skeleton_colliders.default_layer_filter,
                         )
                     },
+                    ColliderLabel(if cfg.use_suffixes {
+                        format!(
+                            "{}{}",
+                            cfg.label.clone(),
+                            if cfg.is_mirrored {
+                                &skeleton_colliders.mirror_suffix
+                            } else {
+                                &skeleton_colliders.suffix
+                            }
+                        )
+                    } else {
+                        cfg.label.clone()
+                    }),
                 )
             };
 

crates/bevy_animation_graph/src/core/colliders/core.rs

@@ -1,5 +1,6 @@
 use bevy::{
     asset::{Asset, Handle},
+    ecs::{component::Component, reflect::ReflectComponent},
     math::{
         Isometry3d, Vec3,
         primitives::{Capsule3d, Cuboid, Sphere},
@@ -46,6 +47,10 @@ pub enum ColliderOffsetMode {
     Global,
 }
 
+#[derive(Component, Default, Clone, Reflect, PartialEq, Eq)]
+#[reflect(Component)]
+pub struct ColliderLabel(pub String);
+
 #[derive(Debug, Clone, Reflect)]
 pub struct ColliderConfig {
     pub id: SkeletonColliderId,
@@ -56,6 +61,14 @@ pub struct ColliderConfig {
     pub attached_to: BoneId,
     pub offset: Isometry3d,
     pub offset_mode: ColliderOffsetMode,
+    /// Label that will be attached to the created collider in a [`ColliderLabel`] component.
+    pub label: String,
+    /// Whether to apply suffixes to this collider and its mirror
+    pub use_suffixes: bool,
+    /// Whether this collider resulting from mirroring another collider.
+    ///
+    /// Should always be false on manually created colliders
+    pub is_mirrored: bool,
 }
 
 impl ColliderConfig {
@@ -83,6 +96,9 @@ impl Default for ColliderConfig {
             attached_to: BoneId::default(),
             offset: Isometry3d::default(),
             offset_mode: ColliderOffsetMode::default(),
+            label: "".to_string(),
+            use_suffixes: false,
+            is_mirrored: false,
         }
     }
 }
@@ -100,6 +116,11 @@ pub struct SkeletonColliders {
     pub default_layer_membership: u32,
     /// Default physics layer filters if not overriden
     pub default_layer_filter: u32,
+
+    /// Suffix optionally applied to collider labels
+    pub suffix: String,
+    /// Suffix optionally applied to collider labels corresponding to mirrored colliders
+    pub mirror_suffix: String,
 }
 
 impl SkeletonColliders {

crates/bevy_animation_graph/src/core/colliders/serial.rs

@@ -23,6 +23,10 @@ pub struct ColliderConfigSerial {
     pub offset: Isometry3d,
     #[serde(default)]
     pub offset_mode: ColliderOffsetMode,
+    #[serde(default)]
+    pub label: String,
+    #[serde(default)]
+    pub use_suffixes: bool,
 }
 
 #[derive(Debug, Clone, Default, Reflect, Serialize, Deserialize)]
@@ -34,6 +38,14 @@ pub struct SkeletonCollidersSerial {
     pub symmetry: SymmetryConfigSerial,
     #[serde(default)]
     pub symmetry_enabled: bool,
+    #[serde(default)]
+    default_layer_membership: u32,
+    #[serde(default)]
+    default_layer_filter: u32,
+    #[serde(default)]
+    suffix: String,
+    #[serde(default)]
+    mirror_suffix: String,
 }
 
 impl SkeletonCollidersSerial {
@@ -50,6 +62,8 @@ impl SkeletonCollidersSerial {
                 offset: config.offset,
                 id: config.id,
                 offset_mode: config.offset_mode,
+                label: config.label.clone(),
+                use_suffixes: config.use_suffixes,
             };
 
             colliders.push(config_serial);
@@ -60,6 +74,10 @@ impl SkeletonCollidersSerial {
             skeleton: value.skeleton.path()?.to_owned(),
             symmetry: SymmetryConfigSerial::from_value(&value.symmetry),
             symmetry_enabled: value.symmetry_enabled,
+            default_layer_membership: value.default_layer_membership,
+            default_layer_filter: value.default_layer_filter,
+            suffix: value.suffix.clone(),
+            mirror_suffix: value.mirror_suffix.clone(),
         })
     }
 
@@ -78,6 +96,10 @@ impl SkeletonCollidersSerial {
         colliders.skeleton = skeleton_handle;
         colliders.symmetry = self.symmetry.to_value().ok()?;
         colliders.symmetry_enabled = self.symmetry_enabled;
+        colliders.default_layer_membership = self.default_layer_membership;
+        colliders.default_layer_filter = self.default_layer_filter;
+        colliders.suffix = self.suffix.clone();
+        colliders.mirror_suffix = self.mirror_suffix.clone();
 
         for config_serial in &self.colliders {
             let config = ColliderConfig {
@@ -89,6 +111,9 @@ impl SkeletonCollidersSerial {
                 offset: config_serial.offset,
                 id: config_serial.id,
                 offset_mode: config_serial.offset_mode,
+                label: config_serial.label.clone(),
+                use_suffixes: config_serial.use_suffixes,
+                is_mirrored: false,
             };
 
             colliders.add_collider(config);

crates/bevy_animation_graph/src/core/plugin.rs

@@ -15,6 +15,7 @@ use super::{
     state_machine::high_level::{StateMachine, loader::StateMachineLoader},
     systems::{animation_player, animation_player_deferred_gizmos},
 };
+use crate::core::colliders::core::ColliderLabel;
 use crate::nodes::blend_space_node::BlendSpaceNode;
 use crate::nodes::{
     AbsF32, AddF32, BlendMode, BlendNode, BlendSyncMode, ChainNode, ClampF32, ClipNode, CompareF32,
@@ -129,6 +130,7 @@ impl AnimationGraphPlugin {
             .register_type::<BlendMode>()
             .register_type::<BlendSyncMode>()
             .register_type::<GlobalTransition>()
+            .register_type::<ColliderLabel>()
             .register_type::<()>()
             .register_type_data::<(), ReflectDefault>();
     }

crates/bevy_animation_graph_editor/src/ui/actions/colliders.rs

@@ -156,3 +156,31 @@ impl UpdateDefaultLayers {
         skeleton_colliders.default_layer_filter = input.layer_filter;
     }
 }
+
+pub struct UpdateSuffixes {
+    pub colliders: Handle<SkeletonColliders>,
+    pub suffix: String,
+    pub mirror_suffix: String,
+}
+
+impl DynamicAction for UpdateSuffixes {
+    fn handle(self: Box<Self>, world: &mut World) {
+        run_handler(world, "Could not update suffixes config")(Self::system, *self)
+    }
+}
+
+impl UpdateSuffixes {
+    pub fn system(
+        In(input): In<Self>,
+        mut skeleton_collider_assets: ResMut<Assets<SkeletonColliders>>,
+        mut dirty_assets: ResMut<DirtyAssets>,
+    ) {
+        let Some(skeleton_colliders) = skeleton_collider_assets.get_mut(&input.colliders) else {
+            return;
+        };
+
+        dirty_assets.add(input.colliders);
+        skeleton_colliders.suffix = input.suffix;
+        skeleton_colliders.mirror_suffix = input.mirror_suffix;
+    }
+}

crates/bevy_animation_graph_editor/src/ui/editor_windows/skeleton_preview.rs

@@ -41,8 +41,8 @@ use crate::{
         PartOfSubScene, PreviewScene, SubSceneConfig, SubSceneSyncAction,
         actions::{
             colliders::{
-                CreateOrEditCollider, DeleteCollider, UpdateDefaultLayers, UpdateSymmetryConfig,
-                UpdateSymmetryEnabled,
+                CreateOrEditCollider, DeleteCollider, UpdateDefaultLayers, UpdateSuffixes,
+                UpdateSymmetryConfig, UpdateSymmetryEnabled,
             },
             window::DynWindowAction,
         },
@@ -250,6 +250,31 @@ impl SkeletonCollidersPreviewWindow {
                     layer_filter,
                 });
             }
+
+            let mut suffix = skeleton_colliders.suffix.clone();
+            let mut mirror_suffix = skeleton_colliders.mirror_suffix.clone();
+            let mut changed = false;
+
+            ui.horizontal(|ui| {
+                ui.label("Suffix");
+                if ui.text_edit_singleline(&mut suffix).changed() {
+                    changed = true;
+                }
+            });
+            ui.horizontal(|ui| {
+                ui.label("Mirror suffix");
+                if ui.text_edit_singleline(&mut mirror_suffix).changed() {
+                    changed = true
+                }
+            });
+
+            if changed {
+                ctx.editor_actions.dynamic(UpdateSuffixes {
+                    colliders: target.clone(),
+                    suffix,
+                    mirror_suffix,
+                });
+            }
         });
 
         ui.separator();
@@ -488,6 +513,11 @@ impl SkeletonCollidersPreviewWindow {
                 config.shape = new_shape;
             }
 
+            ui.horizontal(|ui| {
+                ui.label("Label");
+                ui.text_edit_singleline(&mut config.label);
+            });
+            ui.checkbox(&mut config.use_suffixes, "Use suffixes");
             ui.label("Physics layers");
             ui.checkbox(&mut config.override_layers, "Override global");
             ui.horizontal(|ui| {

examples/human_colliders/examples/human_colliders.rs

@@ -2,9 +2,11 @@ extern crate bevy;
 extern crate bevy_animation_graph;
 
 use avian3d::PhysicsPlugins;
-use avian3d::prelude::PhysicsDebugPlugin;
+use avian3d::prelude::{PhysicsDebugPlugin, SpatialQuery, SpatialQueryFilter};
+use bevy::window::PrimaryWindow;
 use bevy::{pbr::CascadeShadowConfigBuilder, prelude::*};
 use bevy_animation_graph::core::animated_scene::AnimatedSceneInstance;
+use bevy_animation_graph::core::colliders::core::ColliderLabel;
 use bevy_animation_graph::prelude::*;
 use std::f32::consts::PI;
 
@@ -24,7 +26,7 @@ fn main() {
         })
         .insert_resource(Params::default())
         .add_systems(Startup, setup)
-        .add_systems(Update, keyboard_animation_control)
+        .add_systems(Update, (keyboard_animation_control, raycast_ui))
         .run();
 }
 
@@ -88,6 +90,9 @@ fn setup(
         Human,
     ));
 
+    // Collider label text
+    commands.spawn(Text::new(""));
+
     println!("Controls:");
     println!("\tSPACE: Play/Pause animation");
     println!("\tR: Reset animation");
@@ -144,3 +149,35 @@ fn keyboard_animation_control(
     player.set_input_parameter("target_speed", params.speed.into());
     player.set_input_parameter("target_direction", params.direction.into());
 }
+
+fn raycast_ui(
+    spatial_query: SpatialQuery,
+    main_camera: Single<(&Camera, &GlobalTransform)>,
+    main_window: Single<&Window, With<PrimaryWindow>>,
+    collider_label_query: Query<&ColliderLabel>,
+    debug_text: Single<(&mut Text, &mut Node)>,
+) {
+    let (camera, camera_transform) = main_camera.into_inner();
+    let cursor = main_window.cursor_position().unwrap_or_default();
+    let Ok(ray) = camera.viewport_to_world(camera_transform, cursor) else {
+        return;
+    };
+
+    let (mut debug_text, mut debug_node) = debug_text.into_inner();
+
+    if let Some(hit) = spatial_query.cast_ray(
+        ray.origin,
+        ray.direction,
+        100000.,
+        true,
+        &SpatialQueryFilter::DEFAULT,
+    ) && let Ok(label) = collider_label_query.get(hit.entity)
+    {
+        debug_text.0 = label.0.clone();
+        debug_node.position_type = PositionType::Absolute;
+        debug_node.top = Val::Px(cursor.y - 5.);
+        debug_node.left = Val::Px(cursor.x + 5.);
+    } else {
+        debug_text.0 = "".into();
+    }
+}