Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix documentation for apply_force_at_point (local vs world space) #430

Merged
merged 3 commits into from
Dec 8, 2024
Merged

fix documentation for apply_force_at_point (local vs world space) #430

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5c3ee85
fix documentation - local vs world space in apply_force_at_point
johannesvollmer Jul 16, 2024
91f4768
Merge branch 'main' into main
Jondolf Dec 8, 2024
c62f637
Tweak docs and add them for `ExternalImpulse` too
Jondolf Dec 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/dynamics/rigid_body/forces.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down
Loading