pub struct Vec3(/* private fields */);Expand description
A 3-dimensional vector without SIMD support.
Implementations§
Source§impl Vec3
impl Vec3
Sourcepub fn truncate(self) -> Vec2
pub fn truncate(self) -> Vec2
Creates a Vec2 from the x and y elements of self, discarding z.
Truncation may also be performed by using self.xy() or Vec2::from().
Sourcepub fn select(mask: BVec3, if_true: Vec3, if_false: Vec3) -> Vec3
pub fn select(mask: BVec3, if_true: Vec3, if_false: Vec3) -> Vec3
Creates a vector from the elements in if_true and if_false, selecting which to use
for each element of self.
A true element in the mask uses the corresponding element from if_true, and false
uses the element from if_false.
Sourcepub fn min(self, other: Vec3) -> Vec3
pub fn min(self, other: Vec3) -> Vec3
Returns a vector containing the minimum values for each element of self and other.
In other words this computes [self.x.min(other.x), self.y.min(other.y), ..].
Sourcepub fn max(self, other: Vec3) -> Vec3
pub fn max(self, other: Vec3) -> Vec3
Returns a vector containing the maximum values for each element of self and other.
In other words this computes [self.x.max(other.x), self.y.max(other.y), ..].
Sourcepub fn clamp(self, min: Vec3, max: Vec3) -> Vec3
pub fn clamp(self, min: Vec3, max: Vec3) -> Vec3
Component-wise clamping of values, similar to f32::clamp.
Each element in min must be less-or-equal to the corresponding element in max.
§Panics
Will panic if min is greater than max when glam_assert is enabled.
Sourcepub fn min_element(self) -> f32
pub fn min_element(self) -> f32
Returns the horizontal minimum of self.
In other words this computes min(x, y, ..).
Sourcepub fn max_element(self) -> f32
pub fn max_element(self) -> f32
Returns the horizontal maximum of self.
In other words this computes max(x, y, ..).
Sourcepub fn cmpeq(self, other: Vec3) -> BVec3
pub fn cmpeq(self, other: Vec3) -> BVec3
Returns a vector mask containing the result of a == comparison for each element of
self and other.
In other words, this computes [self.x == other.x, self.y == other.y, ..] for all
elements.
Sourcepub fn cmpne(self, other: Vec3) -> BVec3
pub fn cmpne(self, other: Vec3) -> BVec3
Returns a vector mask containing the result of a != comparison for each element of
self and other.
In other words this computes [self.x != other.x, self.y != other.y, ..] for all
elements.
Sourcepub fn cmpge(self, other: Vec3) -> BVec3
pub fn cmpge(self, other: Vec3) -> BVec3
Returns a vector mask containing the result of a >= comparison for each element of
self and other.
In other words this computes [self.x >= other.x, self.y >= other.y, ..] for all
elements.
Sourcepub fn cmpgt(self, other: Vec3) -> BVec3
pub fn cmpgt(self, other: Vec3) -> BVec3
Returns a vector mask containing the result of a > comparison for each element of
self and other.
In other words this computes [self.x > other.x, self.y > other.y, ..] for all
elements.
Sourcepub fn cmple(self, other: Vec3) -> BVec3
pub fn cmple(self, other: Vec3) -> BVec3
Returns a vector mask containing the result of a <= comparison for each element of
self and other.
In other words this computes [self.x <= other.x, self.y <= other.y, ..] for all
elements.
Sourcepub fn cmplt(self, other: Vec3) -> BVec3
pub fn cmplt(self, other: Vec3) -> BVec3
Returns a vector mask containing the result of a < comparison for each element of
self and other.
In other words this computes [self.x < other.x, self.y < other.y, ..] for all
elements.
Sourcepub fn from_slice(slice: &[f32]) -> Vec3
pub fn from_slice(slice: &[f32]) -> Vec3
Creates a vector from the first N values in slice.
§Panics
Panics if slice is less than N elements long.
Sourcepub fn write_to_slice(self, slice: &mut [f32])
pub fn write_to_slice(self, slice: &mut [f32])
Writes the elements of self to the first N elements in slice.
§Panics
Panics if slice is less than N elements long.
Sourcepub fn abs(self) -> Vec3
pub fn abs(self) -> Vec3
Returns a vector containing the absolute value of each element of self.
Sourcepub fn signum(self) -> Vec3
pub fn signum(self) -> Vec3
Returns a vector with elements representing the sign of self.
1.0if the number is positive,+0.0orINFINITY-1.0if the number is negative,-0.0orNEG_INFINITYNANif the number isNAN
Sourcepub fn is_finite(self) -> bool
pub fn is_finite(self) -> bool
Returns true if, and only if, all elements are finite. If any element is either
NaN, positive or negative infinity, this will return false.
Sourcepub fn is_nan_mask(self) -> BVec3
pub fn is_nan_mask(self) -> BVec3
Performs is_nan on each element of self, returning a vector mask of the results.
In other words, this computes [x.is_nan(), y.is_nan(), z.is_nan(), w.is_nan()].
Sourcepub fn length_squared(self) -> f32
pub fn length_squared(self) -> f32
Computes the squared length of self.
This is faster than length() as it avoids a square root operation.
Sourcepub fn length_recip(self) -> f32
pub fn length_recip(self) -> f32
Computes 1.0 / length().
For valid results, self must not be of length zero.
Sourcepub fn distance(self, other: Vec3) -> f32
pub fn distance(self, other: Vec3) -> f32
Computes the Euclidean distance between two points in space.
Sourcepub fn distance_squared(self, other: Vec3) -> f32
pub fn distance_squared(self, other: Vec3) -> f32
Compute the squared euclidean distance between two points in space.
Sourcepub fn normalize(self) -> Vec3
pub fn normalize(self) -> Vec3
Returns self normalized to length 1.0.
For valid results, self must not be of length zero, nor very close to zero.
See also Self::try_normalize and Self::normalize_or_zero.
Panics
Will panic if self is zero length when glam_assert is enabled.
Sourcepub fn try_normalize(self) -> Option<Vec3>
pub fn try_normalize(self) -> Option<Vec3>
Returns self normalized to length 1.0 if possible, else returns None.
In particular, if the input is zero (or very close to zero), or non-finite,
the result of this operation will be None.
See also Self::normalize_or_zero.
Sourcepub fn normalize_or_zero(self) -> Vec3
pub fn normalize_or_zero(self) -> Vec3
Returns self normalized to length 1.0 if possible, else returns zero.
In particular, if the input is zero (or very close to zero), or non-finite, the result of this operation will be zero.
See also Self::try_normalize.
Sourcepub fn is_normalized(self) -> bool
pub fn is_normalized(self) -> bool
Returns whether self is length 1.0 or not.
Uses a precision threshold of 1e-6.
Sourcepub fn project_onto(self, other: Vec3) -> Vec3
pub fn project_onto(self, other: Vec3) -> Vec3
Returns the vector projection of self onto other.
other must be of non-zero length.
§Panics
Will panic if other is zero length when glam_assert is enabled.
Sourcepub fn reject_from(self, other: Vec3) -> Vec3
pub fn reject_from(self, other: Vec3) -> Vec3
Returns the vector rejection of self from other.
The vector rejection is the vector perpendicular to the projection of self onto
other, in other words the result of self - self.project_onto(other).
other must be of non-zero length.
§Panics
Will panic if other has a length of zero when glam_assert is enabled.
Sourcepub fn project_onto_normalized(self, other: Vec3) -> Vec3
pub fn project_onto_normalized(self, other: Vec3) -> Vec3
Returns the vector projection of self onto other.
other must be normalized.
§Panics
Will panic if other is not normalized when glam_assert is enabled.
Sourcepub fn reject_from_normalized(self, other: Vec3) -> Vec3
pub fn reject_from_normalized(self, other: Vec3) -> Vec3
Returns the vector rejection of self from other.
The vector rejection is the vector perpendicular to the projection of self onto
other, in other words the result of self - self.project_onto(other).
other must be normalized.
§Panics
Will panic if other is not normalized when glam_assert is enabled.
Sourcepub fn round(self) -> Vec3
pub fn round(self) -> Vec3
Returns a vector containing the nearest integer to a number for each element of self.
Round half-way cases away from 0.0.
Sourcepub fn floor(self) -> Vec3
pub fn floor(self) -> Vec3
Returns a vector containing the largest integer less than or equal to a number for each
element of self.
Sourcepub fn ceil(self) -> Vec3
pub fn ceil(self) -> Vec3
Returns a vector containing the smallest integer greater than or equal to a number for
each element of self.
Sourcepub fn fract(self) -> Vec3
pub fn fract(self) -> Vec3
Returns a vector containing the fractional part of the vector, e.g. self - self.floor().
Note that this is fast but not precise for large numbers.
Sourcepub fn exp(self) -> Vec3
pub fn exp(self) -> Vec3
Returns a vector containing e^self (the exponential function) for each element of
self.
Sourcepub fn powf(self, n: f32) -> Vec3
pub fn powf(self, n: f32) -> Vec3
Returns a vector containing each element of self raised to the power of n.
Sourcepub fn recip(self) -> Vec3
pub fn recip(self) -> Vec3
Returns a vector containing the reciprocal 1.0/n of each element of self.
Sourcepub fn lerp(self, other: Vec3, s: f32) -> Vec3
pub fn lerp(self, other: Vec3, s: f32) -> Vec3
Performs a linear interpolation between self and other based on the value s.
When s is 0.0, the result will be equal to self. When s is 1.0, the result
will be equal to other. When s is outside of range [0,1], the result is linearly
extrapolated.
Sourcepub fn abs_diff_eq(self, other: Vec3, max_abs_diff: f32) -> bool
pub fn abs_diff_eq(self, other: Vec3, max_abs_diff: f32) -> bool
Returns true if the absolute difference of all elements between self and other is
less than or equal to max_abs_diff.
This can be used to compare if two vectors contain similar elements. It works best when
comparing with a known value. The max_abs_diff that should be used used depends on
the values being compared against.
For more see comparing floating point numbers.
Sourcepub fn clamp_length(self, min: f32, max: f32) -> Vec3
pub fn clamp_length(self, min: f32, max: f32) -> Vec3
Returns a vector with a length no less than min and no more than max
§Panics
Will panic if min is greater than max when glam_assert is enabled.
Sourcepub fn clamp_length_max(self, max: f32) -> Vec3
pub fn clamp_length_max(self, max: f32) -> Vec3
Returns a vector with a length no more than max
Sourcepub fn clamp_length_min(self, min: f32) -> Vec3
pub fn clamp_length_min(self, min: f32) -> Vec3
Returns a vector with a length no less than min
Sourcepub fn mul_add(self, a: Vec3, b: Vec3) -> Vec3
pub fn mul_add(self, a: Vec3, b: Vec3) -> Vec3
Fused multiply-add. Computes (self * a) + b element-wise with only one rounding
error, yielding a more accurate result than an unfused multiply-add.
Using mul_add may be more performant than an unfused multiply-add if the target
architecture has a dedicated fma CPU instruction. However, this is not always true,
and will be heavily dependant on designing algorithms with specific target hardware in
mind.
Sourcepub fn angle_between(self, other: Vec3) -> f32
pub fn angle_between(self, other: Vec3) -> f32
Returns the angle (in radians) between two vectors.
The input vectors do not need to be unit length however they must be non-zero.
Sourcepub fn any_orthogonal_vector(&self) -> Vec3
pub fn any_orthogonal_vector(&self) -> Vec3
Returns some vector that is orthogonal to the given one.
The input vector must be finite and non-zero.
The output vector is not necessarily unit-length.
For that use Self::any_orthonormal_vector instead.
Sourcepub fn any_orthonormal_vector(&self) -> Vec3
pub fn any_orthonormal_vector(&self) -> Vec3
Returns any unit-length vector that is orthogonal to the given one. The input vector must be finite and non-zero.
§Panics
Will panic if self is not normalized when glam_assert is enabled.
Sourcepub fn any_orthonormal_pair(&self) -> (Vec3, Vec3)
pub fn any_orthonormal_pair(&self) -> (Vec3, Vec3)
Given a unit-length vector return two other vectors that together form an orthonormal basis. That is, all three vectors are orthogonal to each other and are normalized.
§Panics
Will panic if self is not normalized when glam_assert is enabled.
Trait Implementations§
Source§impl AddAssign<f32> for Vec3
impl AddAssign<f32> for Vec3
Source§fn add_assign(&mut self, other: f32)
fn add_assign(&mut self, other: f32)
+= operation. Read moreSource§impl AddAssign for Vec3
impl AddAssign for Vec3
Source§fn add_assign(&mut self, other: Vec3)
fn add_assign(&mut self, other: Vec3)
+= operation. Read moreSource§impl DivAssign<f32> for Vec3
impl DivAssign<f32> for Vec3
Source§fn div_assign(&mut self, other: f32)
fn div_assign(&mut self, other: f32)
/= operation. Read moreSource§impl DivAssign for Vec3
impl DivAssign for Vec3
Source§fn div_assign(&mut self, other: Vec3)
fn div_assign(&mut self, other: Vec3)
/= operation. Read moreSource§impl MulAssign<f32> for Vec3
impl MulAssign<f32> for Vec3
Source§fn mul_assign(&mut self, other: f32)
fn mul_assign(&mut self, other: f32)
*= operation. Read moreSource§impl MulAssign for Vec3
impl MulAssign for Vec3
Source§fn mul_assign(&mut self, other: Vec3)
fn mul_assign(&mut self, other: Vec3)
*= operation. Read moreSource§impl RemAssign<f32> for Vec3
impl RemAssign<f32> for Vec3
Source§fn rem_assign(&mut self, other: f32)
fn rem_assign(&mut self, other: f32)
%= operation. Read moreSource§impl RemAssign for Vec3
impl RemAssign for Vec3
Source§fn rem_assign(&mut self, other: Vec3)
fn rem_assign(&mut self, other: Vec3)
%= operation. Read moreSource§impl SubAssign<f32> for Vec3
impl SubAssign<f32> for Vec3
Source§fn sub_assign(&mut self, other: f32)
fn sub_assign(&mut self, other: f32)
-= operation. Read moreSource§impl SubAssign for Vec3
impl SubAssign for Vec3
Source§fn sub_assign(&mut self, other: Vec3)
fn sub_assign(&mut self, other: Vec3)
-= operation. Read more