Merge pull request #52 from dimforge/set_mass

Add the ability to set the mass and mass properties of the rigid-body built with the RigidBodyBuilder

src/dynamics/mass_properties.rs

@@ -25,8 +25,11 @@ pub struct MassProperties {
 }
 
 impl MassProperties {
+    /// Initializes the mass properties with the given center-of-mass, mass, and angular inertia.
+    ///
+    /// The center-of-mass is specified in the local-space of the rigid-body.
     #[cfg(feature = "dim2")]
-    pub(crate) fn new(local_com: Point<f32>, mass: f32, principal_inertia: f32) -> Self {
+    pub fn new(local_com: Point<f32>, mass: f32, principal_inertia: f32) -> Self {
         let inv_mass = utils::inv(mass);
         let inv_principal_inertia_sqrt = utils::inv(principal_inertia.sqrt());
         Self {
@@ -36,13 +39,23 @@ impl MassProperties {
         }
     }
 
+    /// Initializes the mass properties from the given center-of-mass, mass, and principal angular inertia.
+    ///
+    /// The center-of-mass is specified in the local-space of the rigid-body.
+    /// The principal angular inertia are the angular inertia along the coordinate axes in the local-space
+    /// of the rigid-body.
     #[cfg(feature = "dim3")]
-    pub(crate) fn new(local_com: Point<f32>, mass: f32, principal_inertia: AngVector<f32>) -> Self {
+    pub fn new(local_com: Point<f32>, mass: f32, principal_inertia: AngVector<f32>) -> Self {
         Self::with_principal_inertia_frame(local_com, mass, principal_inertia, Rotation::identity())
     }
 
+    /// Initializes the mass properties from the given center-of-mass, mass, and principal angular inertia.
+    ///
+    /// The center-of-mass is specified in the local-space of the rigid-body.
+    /// The principal angular inertia are the angular inertia along the coordinate axes defined by
+    /// the `principal_inertia_local_frame` expressed in the local-space of the rigid-body.
     #[cfg(feature = "dim3")]
-    pub(crate) fn with_principal_inertia_frame(
+    pub fn with_principal_inertia_frame(
         local_com: Point<f32>,
         mass: f32,
         principal_inertia: AngVector<f32>,

src/dynamics/rigid_body.rs

@@ -344,6 +344,7 @@ pub struct RigidBodyBuilder {
     linvel: Vector<f32>,
     angvel: AngVector<f32>,
     body_status: BodyStatus,
+    mass_properties: MassProperties,
     can_sleep: bool,
     user_data: u128,
 }
@@ -356,6 +357,7 @@ impl RigidBodyBuilder {
             linvel: Vector::zeros(),
             angvel: na::zero(),
             body_status,
+            mass_properties: MassProperties::zero(),
             can_sleep: true,
             user_data: 0,
         }
@@ -411,6 +413,36 @@ impl RigidBodyBuilder {
         self
     }
 
+    /// Sets the mass properties of the rigid-body being built.
+    ///
+    /// Note that the final mass properties of the rigid-bodies depends
+    /// on the initial mass-properties of the rigid-body (set by this method)
+    /// to which is added the contributions of all the colliders with non-zero density
+    /// attached to this rigid-body.
+    ///
+    /// Therefore, if you want your provided mass properties to be the final
+    /// mass properties of your rigid-body, don't attach colliders to it, or
+    /// only attach colliders with densities equal to zero.
+    pub fn mass_properties(mut self, props: MassProperties) -> Self {
+        self.mass_properties = props;
+        self
+    }
+
+    /// Sets the mass of the rigid-body being built.
+    ///
+    /// Note that the final mass of the rigid-bodies depends
+    /// on the initial mass of the rigid-body (set by this method)
+    /// to which is added the contributions of all the colliders with non-zero density
+    /// attached to this rigid-body.
+    ///
+    /// Therefore, if you want your provided mass to be the final
+    /// mass of your rigid-body, don't attach colliders to it, or
+    /// only attach colliders with densities equal to zero.
+    pub fn mass(mut self, mass: f32) -> Self {
+        self.mass_properties.inv_mass = crate::utils::inv(mass);
+        self
+    }
+
     /// Sets the initial linear velocity of the rigid-body to be created.
     #[cfg(feature = "dim2")]
     pub fn linvel(mut self, x: f32, y: f32) -> Self {
@@ -446,6 +478,7 @@ impl RigidBodyBuilder {
         rb.angvel = self.angvel;
         rb.body_status = self.body_status;
         rb.user_data = self.user_data;
+        rb.mass_properties = self.mass_properties;
 
         if !self.can_sleep {
             rb.activation.threshold = -1.0;