Skip to content

Updated documentation to specify angle unit #4

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

Open
mariapana wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

Updated documentation to specify angle unit #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa14eb0
Updated docs for angle from base/matrix.rs
mariapana Jan 21, 2024
b3ddaa1
Updated docs for from_euler_angles and euler_angles
mariapana Jan 21, 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
2 changes: 1 addition & 1 deletion src/base/matrix.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2131,7 +2131,7 @@ impl<T: Scalar + Field, S: RawStorage<T, U3>> Vector<T, U3, S> {
}

impl<T: SimdComplexField, R: Dim, C: Dim, S: Storage<T, R, C>> Matrix<T, R, C, S> {
/// The smallest angle between two vectors.
/// The smallest angle between two vectors. The value is expressed in radians.
#[inline]
#[must_use]
pub fn angle<R2: Dim, C2: Dim, SB>(&self, other: &Matrix<T, R2, C2, SB>) -> T::SimdRealField
Expand Down
4 changes: 4 additions & 0 deletions src/geometry/rotation_specialization.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,8 @@ where
}

/// Creates a new rotation from Euler angles.
///
/// Note that the angles are expressed in radians.
///
/// The primitive rotations are applied in order: 1 roll − 2 pitch − 3 yaw.
///
Expand Down Expand Up @@ -937,6 +939,8 @@ impl<T: SimdRealField> Rotation3<T> {
}

/// Euler angles corresponding to this rotation from a rotation.
///
/// Note that the angles are expressed in radians.
///
/// The angles are produced in the form (roll, pitch, yaw).
///
Expand Down