Skip to content

Commit 114554b

Browse files
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 <[email protected]>
1 parent 90478cb commit 114554b

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/dynamics/rigid_body/forces.rs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,9 @@ impl ExternalForce {
154154
self
155155
}
156156

157-
/// Applies the given world-space `force` at a local `point`, which will also cause torque to be applied.
157+
/// Applies the given `force` at the specified `point`, which will also cause torque to be applied.
158+
///
159+
/// The force, point, and center of mass must be given in world space.
158160
pub fn apply_force_at_point(
159161
&mut self,
160162
force: Vector,
@@ -442,7 +444,9 @@ impl ExternalImpulse {
442444
self
443445
}
444446

445-
/// Applies the given world-space `impulse` at a local `point`, which will also cause an angular impulse to be applied.
447+
/// Applies the given `impulse` at the specified `point`, which will also cause an angular impulse to be applied.
448+
///
449+
/// The impulse, point, and center of mass must be given in world space.
446450
pub fn apply_impulse_at_point(
447451
&mut self,
448452
impulse: Vector,

0 commit comments

Comments
 (0)