From 114554bf61320e03d778c5d8ca67e9ae381476c5 Mon Sep 17 00:00:00 2001 From: Johannes Vollmer <32042925+johannesvollmer@users.noreply.github.com> Date: Sun, 8 Dec 2024 17:31:07 +0100 Subject: [PATCH] fix documentation for apply_force_at_point (local vs world space) (#430) fix documentation for apply_force_at_point. fixes #428 no code-changes at all, so no breaking changes. --------- Co-authored-by: Joona Aalto --- src/dynamics/rigid_body/forces.rs | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/dynamics/rigid_body/forces.rs b/src/dynamics/rigid_body/forces.rs index d71bd66c..2116077e 100644 --- a/src/dynamics/rigid_body/forces.rs +++ b/src/dynamics/rigid_body/forces.rs @@ -154,7 +154,9 @@ impl ExternalForce { self } - /// Applies the given world-space `force` at a local `point`, which will also cause torque to be applied. + /// Applies the given `force` at the specified `point`, which will also cause torque to be applied. + /// + /// The force, point, and center of mass must be given in world space. pub fn apply_force_at_point( &mut self, force: Vector, @@ -442,7 +444,9 @@ impl ExternalImpulse { self } - /// Applies the given world-space `impulse` at a local `point`, which will also cause an angular impulse to be applied. + /// Applies the given `impulse` at the specified `point`, which will also cause an angular impulse to be applied. + /// + /// The impulse, point, and center of mass must be given in world space. pub fn apply_impulse_at_point( &mut self, impulse: Vector,