forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Mention of Vec normalization for Dir::new (#13483)

Browse Source 
# Objective

- Fixes #13429 .

## Solution

- Improved docs for methods `new`, `new_and_length` of `Dir2`, `Dir3`,
`Dir3A`.
This commit is contained in:
Vitaliy Sapronenko 2024-05-23 18:20:21 +03:00 committed by GitHub
parent bd5148e0f5
commit da1e6e63ff
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
crates/bevy_math/src/direction.rs
View File

@ -95,7 +95,7 @@ impl Dir2 {
/// The directional axes. /// The directional axes.
pub const AXES: [Self; 2] = [Self::X, Self::Y]; pub const AXES: [Self; 2] = [Self::X, Self::Y];
/// Create a direction from a finite, nonzero [`Vec2`]. /// Create a direction from a finite, nonzero [`Vec2`], normalizing it.
/// ///
/// Returns [`Err(InvalidDirectionError)`](InvalidDirectionError) if the length /// Returns [`Err(InvalidDirectionError)`](InvalidDirectionError) if the length
/// of the given vector is zero (or very close to zero), infinite, or `NaN`. /// of the given vector is zero (or very close to zero), infinite, or `NaN`.
@ -118,7 +118,8 @@ impl Dir2 {
Self(value) Self(value)
} }
/// Create a direction from a finite, nonzero [`Vec2`], also returning its original length. /// Create a direction from a finite, nonzero [`Vec2`], normalizing it and
/// also returning its original length.
/// ///
/// Returns [`Err(InvalidDirectionError)`](InvalidDirectionError) if the length /// Returns [`Err(InvalidDirectionError)`](InvalidDirectionError) if the length
/// of the given vector is zero (or very close to zero), infinite, or `NaN`. /// of the given vector is zero (or very close to zero), infinite, or `NaN`.
@ -288,7 +289,7 @@ impl Dir3 {
/// The directional axes. /// The directional axes.
pub const AXES: [Self; 3] = [Self::X, Self::Y, Self::Z]; pub const AXES: [Self; 3] = [Self::X, Self::Y, Self::Z];
/// Create a direction from a finite, nonzero [`Vec3`]. /// Create a direction from a finite, nonzero [`Vec3`], normalizing it.
/// ///
/// Returns [`Err(InvalidDirectionError)`](InvalidDirectionError) if the length /// Returns [`Err(InvalidDirectionError)`](InvalidDirectionError) if the length
/// of the given vector is zero (or very close to zero), infinite, or `NaN`. /// of the given vector is zero (or very close to zero), infinite, or `NaN`.
@ -311,7 +312,8 @@ impl Dir3 {
Self(value) Self(value)
} }
/// Create a direction from a finite, nonzero [`Vec3`], also returning its original length. /// Create a direction from a finite, nonzero [`Vec3`], normalizing it and
/// also returning its original length.
/// ///
/// Returns [`Err(InvalidDirectionError)`](InvalidDirectionError) if the length /// Returns [`Err(InvalidDirectionError)`](InvalidDirectionError) if the length
/// of the given vector is zero (or very close to zero), infinite, or `NaN`. /// of the given vector is zero (or very close to zero), infinite, or `NaN`.
@ -488,7 +490,7 @@ impl Dir3A {
/// The directional axes. /// The directional axes.
pub const AXES: [Self; 3] = [Self::X, Self::Y, Self::Z]; pub const AXES: [Self; 3] = [Self::X, Self::Y, Self::Z];
/// Create a direction from a finite, nonzero [`Vec3A`]. /// Create a direction from a finite, nonzero [`Vec3A`], normalizing it.
/// ///
/// Returns [`Err(InvalidDirectionError)`](InvalidDirectionError) if the length /// Returns [`Err(InvalidDirectionError)`](InvalidDirectionError) if the length
/// of the given vector is zero (or very close to zero), infinite, or `NaN`. /// of the given vector is zero (or very close to zero), infinite, or `NaN`.
@ -511,7 +513,8 @@ impl Dir3A {
Self(value) Self(value)
} }
/// Create a direction from a finite, nonzero [`Vec3A`], also returning its original length. /// Create a direction from a finite, nonzero [`Vec3A`], normalizing it and
/// also returning its original length.
/// ///
/// Returns [`Err(InvalidDirectionError)`](InvalidDirectionError) if the length /// Returns [`Err(InvalidDirectionError)`](InvalidDirectionError) if the length
/// of the given vector is zero (or very close to zero), infinite, or `NaN`. /// of the given vector is zero (or very close to zero), infinite, or `NaN`.