feat: Cleanup editor UI for CollidableComponents (#2700)

Author: Eideren

sources/engine/Stride.BepuPhysics/Stride.BepuPhysics/BodyComponent.cs

@@ -46,6 +46,7 @@ public class BodyComponent : CollidableComponent
     /// <summary>
     /// When kinematic is set, the object will not be affected by physics forces like gravity or collisions but will still push away bodies it collides with.
     /// </summary>
+    [Display(category: CategoryForces)]
     public bool Kinematic
     {
         get => _kinematic;
@@ -67,6 +68,7 @@ public bool Kinematic
 
     /// <summary> Whether gravity should affect the simulation's <see cref="BepuSimulation.PoseGravity"/> </summary>
     /// <remarks> Gravity is always active if <see cref="BepuSimulation.UsePerBodyAttributes"/> is false </remarks>
+    [Display(category: CategoryForces)]
     public bool Gravity
     {
         get => _gravity;
@@ -80,28 +82,13 @@ public bool Gravity
         }
     }
 
-    /// <summary>
-    /// Controls whether and how the motion of this body is smoothed out between physics update
-    /// </summary>
-    public InterpolationMode InterpolationMode
-    {
-        get => _interpolationMode;
-        set
-        {
-            if (_interpolationMode == InterpolationMode.None && value != InterpolationMode.None)
-                Simulation?.RegisterInterpolated(this);
-            if (_interpolationMode != InterpolationMode.None && value == InterpolationMode.None)
-                Simulation?.UnregisterInterpolated(this);
-            _interpolationMode = value;
-        }
-    }
-
     /// <summary>
     /// Whether the object's path or only its destination is checked for collision when moving, prevents objects from passing through each other at higher speed
     /// </summary>
     /// <remarks>
     /// This property is a shortcut to the <see cref="ContinuousDetection"/>.<see cref="ContinuousDetection.Mode"/> property
     /// </remarks>
+    [Display(category: CategoryForces)]
     public ContinuousDetectionMode ContinuousDetectionMode
     {
         get => _continuous.Mode;
@@ -120,10 +107,28 @@ public ContinuousDetectionMode ContinuousDetectionMode
         }
     }
 
+    /// <summary>
+    /// Controls whether and how the motion of this body is smoothed out between physics update
+    /// </summary>
+    [Display(category: CategoryForces)]
+    public InterpolationMode InterpolationMode
+    {
+        get => _interpolationMode;
+        set
+        {
+            if (_interpolationMode == InterpolationMode.None && value != InterpolationMode.None)
+                Simulation?.RegisterInterpolated(this);
+            if (_interpolationMode != InterpolationMode.None && value == InterpolationMode.None)
+                Simulation?.UnregisterInterpolated(this);
+            _interpolationMode = value;
+        }
+    }
+
     /// <summary>
     /// Threshold of squared combined velocity under which the body is allowed to go to sleep.
     /// Setting this to a negative value guarantees the body cannot go to sleep without user action.
     /// </summary>
+    [Display(category: CategoryActivity)]
     public float SleepThreshold
     {
         get => _sleepThreshold;
@@ -147,6 +152,7 @@ public float SleepThreshold
     /// The number of time steps that the body must be under the sleep threshold before the body becomes a sleeping candidate.
     /// Note that the body is not guaranteed to go to sleep immediately after meeting this minimum.
     /// </summary>
+    [Display(category: CategoryActivity)]
     public byte MinimumTimestepCountUnderThreshold
     {
         get => _minimumTimestepCountUnderThreshold;

sources/engine/Stride.BepuPhysics/Stride.BepuPhysics/CollidableComponent.cs

@@ -18,10 +18,19 @@
 
 namespace Stride.BepuPhysics;
 
+[CategoryOrder(5, CategoryCollider)]
+[CategoryOrder(10, CategoryForces, Expand = ExpandRule.Once)]
+[CategoryOrder(15, CategoryContacts, Expand = ExpandRule.Once)]
+[CategoryOrder(20, CategoryActivity, Expand = ExpandRule.Once)]
 [DataContract(Inherited = true)]
 [DefaultEntityComponentProcessor(typeof(CollidableProcessor), ExecutionMode = ExecutionMode.Runtime)]
 public abstract class CollidableComponent : EntityComponent
 {
+    public const string CategoryCollider = "Collider";
+    public const string CategoryForces = "Forces";
+    public const string CategoryContacts = "Contacts";
+    public const string CategoryActivity = "Activity";
+
     private static uint IdCounter;
     private static uint VersioningCounter;
 
@@ -62,7 +71,8 @@ public abstract class CollidableComponent : EntityComponent
     /// <remarks>
     /// Changing this value will reset some of the internal physics state of this body
     /// </remarks>
-    [Display(Expand = ExpandRule.Always)]
+    [NotNull]
+    [Display(category: CategoryCollider, Expand = ExpandRule.Always)]
     public required ICollider Collider
     {
         get
@@ -92,6 +102,7 @@ public required ICollider Collider
     /// but the integrator timestep is only 60hz,
     /// the unrepresentable motion will get damped out and the body won't bounce as much.
     /// </remarks>
+    [Display(category: CategoryForces)]
     public float SpringFrequency
     {
         get
@@ -108,6 +119,7 @@ public float SpringFrequency
     /// <summary>
     /// The amount of energy/velocity lost when this collidable bounces off
     /// </summary>
+    [Display(category: CategoryForces)]
     public float SpringDampingRatio
     {
         get
@@ -121,6 +133,7 @@ public float SpringDampingRatio
         }
     }
 
+    [Display(category: CategoryForces)]
     public float FrictionCoefficient
     {
         get => _frictionCoefficient;
@@ -134,6 +147,7 @@ public float FrictionCoefficient
     /// <summary>
     /// The maximum speed this object will exit out of the collision when overlapping another collidable
     /// </summary>
+    [Display(category: CategoryForces)]
     public float MaximumRecoveryVelocity
     {
         get => _maximumRecoveryVelocity;
@@ -144,12 +158,33 @@ public float MaximumRecoveryVelocity
         }
     }
 
+    /// <summary>
+    /// Which simulation this object is assigned to
+    /// </summary>
+    [NotNull]
+    [DefaultValueIsSceneBased]
+    [Display(category: CategoryContacts)]
+    public ISimulationSelector SimulationSelector
+    {
+        get
+        {
+            return _simulationSelector;
+        }
+        set
+        {
+            _simulationSelector = value;
+            if (Processor is not null)
+                ReAttach(_simulationSelector.Pick(Processor.BepuConfiguration, Entity));
+        }
+    }
+
     /// <summary>
     /// Controls how this object interacts with other objects, allow or prevent collisions between
     /// it and other groups based on how <see cref="BepuSimulation.CollisionMatrix"/> is set up.
     /// </summary>
     [DefaultValue(CollisionLayer.Layer0)]
     [DataAlias("CollisionMask")]
+    [Display(category: CategoryContacts)]
     public CollisionLayer CollisionLayer
     {
         get => _collisionLayer;
@@ -162,6 +197,7 @@ public CollisionLayer CollisionLayer
 
     /// <inheritdoc cref="Stride.BepuPhysics.Definitions.CollisionGroup"/>
     [DataAlias("FilterByDistance")]
+    [Display(category: CategoryContacts)]
     public CollisionGroup CollisionGroup
     {
         get => _collisionGroup;
@@ -172,27 +208,10 @@ public CollisionGroup CollisionGroup
         }
     }
 
-    /// <summary>
-    /// Which simulation this object is assigned to
-    /// </summary>
-    [DefaultValueIsSceneBased]
-    public ISimulationSelector SimulationSelector
-    {
-        get
-        {
-            return _simulationSelector;
-        }
-        set
-        {
-            _simulationSelector = value;
-            if (Processor is not null)
-                ReAttach(_simulationSelector.Pick(Processor.BepuConfiguration, Entity));
-        }
-    }
-
     /// <summary>
     /// Provides the ability to collect and mutate contact data when this object collides with other objects.
     /// </summary>
+    [Display(category: CategoryContacts)]
     public IContactEventHandler? ContactEventHandler
     {
         get

sources/engine/Stride.BepuPhysics/Stride.BepuPhysics/Definitions/Colliders/CompoundCollider.cs

@@ -7,6 +7,7 @@
 using Stride.Core;
 using Stride.Core.Mathematics;
 using Stride.BepuPhysics.Systems;
+using Stride.Core.Annotations;
 using NRigidPose = BepuPhysics.RigidPose;
 
 namespace Stride.BepuPhysics.Definitions.Colliders;
@@ -18,6 +19,7 @@ public sealed class CompoundCollider : ICollider
     private readonly ListOfColliders _colliders;
     private CollidableComponent? _component;
 
+    [MemberCollection(NotNullItems = true)]
     [DataMember]
     public IList<ColliderBase> Colliders => _colliders;