#[repr(C)]pub struct DVec3 {
pub x: f64,
pub y: f64,
pub z: f64,
}
Expand description
A 3-dimensional vector.
Fields§
§x: f64
§y: f64
§z: f64
Implementations§
source§impl DVec3
impl DVec3
sourcepub const NEG_INFINITY: Self = _
pub const NEG_INFINITY: Self = _
All f64::NEG_INFINITY
.
sourcepub fn select(mask: BVec3, if_true: Self, if_false: Self) -> Self
pub fn select(mask: BVec3, if_true: Self, if_false: Self) -> Self
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 const fn from_array(a: [f64; 3]) -> Self
pub const fn from_array(a: [f64; 3]) -> Self
Creates a new vector from an array.
sourcepub const fn from_slice(slice: &[f64]) -> Self
pub const fn from_slice(slice: &[f64]) -> Self
Creates a vector from the first 3 values in slice
.
§Panics
Panics if slice
is less than 3 elements long.
sourcepub fn write_to_slice(self, slice: &mut [f64])
pub fn write_to_slice(self, slice: &mut [f64])
Writes the elements of self
to the first 3 elements in slice
.
§Panics
Panics if slice
is less than 3 elements long.
sourcepub fn truncate(self) -> DVec2
pub fn truncate(self) -> DVec2
Creates a 2D vector from the x
and y
elements of self
, discarding z
.
Truncation may also be performed by using self.xy()
.
sourcepub fn dot_into_vec(self, rhs: Self) -> Self
pub fn dot_into_vec(self, rhs: Self) -> Self
Returns a vector where every component is the dot product of self
and rhs
.
sourcepub fn min(self, rhs: Self) -> Self
pub fn min(self, rhs: Self) -> Self
Returns a vector containing the minimum values for each element of self
and rhs
.
In other words this computes [self.x.min(rhs.x), self.y.min(rhs.y), ..]
.
sourcepub fn max(self, rhs: Self) -> Self
pub fn max(self, rhs: Self) -> Self
Returns a vector containing the maximum values for each element of self
and rhs
.
In other words this computes [self.x.max(rhs.x), self.y.max(rhs.y), ..]
.
sourcepub fn clamp(self, min: Self, max: Self) -> Self
pub fn clamp(self, min: Self, max: Self) -> Self
Component-wise clamping of values, similar to f64::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) -> f64
pub fn min_element(self) -> f64
Returns the horizontal minimum of self
.
In other words this computes min(x, y, ..)
.
sourcepub fn max_element(self) -> f64
pub fn max_element(self) -> f64
Returns the horizontal maximum of self
.
In other words this computes max(x, y, ..)
.
sourcepub fn element_sum(self) -> f64
pub fn element_sum(self) -> f64
Returns the sum of all elements of self
.
In other words, this computes self.x + self.y + ..
.
sourcepub fn element_product(self) -> f64
pub fn element_product(self) -> f64
Returns the product of all elements of self
.
In other words, this computes self.x * self.y * ..
.
sourcepub fn cmpeq(self, rhs: Self) -> BVec3
pub fn cmpeq(self, rhs: Self) -> BVec3
Returns a vector mask containing the result of a ==
comparison for each element of
self
and rhs
.
In other words, this computes [self.x == rhs.x, self.y == rhs.y, ..]
for all
elements.
sourcepub fn cmpne(self, rhs: Self) -> BVec3
pub fn cmpne(self, rhs: Self) -> BVec3
Returns a vector mask containing the result of a !=
comparison for each element of
self
and rhs
.
In other words this computes [self.x != rhs.x, self.y != rhs.y, ..]
for all
elements.
sourcepub fn cmpge(self, rhs: Self) -> BVec3
pub fn cmpge(self, rhs: Self) -> BVec3
Returns a vector mask containing the result of a >=
comparison for each element of
self
and rhs
.
In other words this computes [self.x >= rhs.x, self.y >= rhs.y, ..]
for all
elements.
sourcepub fn cmpgt(self, rhs: Self) -> BVec3
pub fn cmpgt(self, rhs: Self) -> BVec3
Returns a vector mask containing the result of a >
comparison for each element of
self
and rhs
.
In other words this computes [self.x > rhs.x, self.y > rhs.y, ..]
for all
elements.
sourcepub fn cmple(self, rhs: Self) -> BVec3
pub fn cmple(self, rhs: Self) -> BVec3
Returns a vector mask containing the result of a <=
comparison for each element of
self
and rhs
.
In other words this computes [self.x <= rhs.x, self.y <= rhs.y, ..]
for all
elements.
sourcepub fn cmplt(self, rhs: Self) -> BVec3
pub fn cmplt(self, rhs: Self) -> BVec3
Returns a vector mask containing the result of a <
comparison for each element of
self
and rhs
.
In other words this computes [self.x < rhs.x, self.y < rhs.y, ..]
for all
elements.
sourcepub fn abs(self) -> Self
pub fn abs(self) -> Self
Returns a vector containing the absolute value of each element of self
.
sourcepub fn signum(self) -> Self
pub fn signum(self) -> Self
Returns a vector with elements representing the sign of self
.
1.0
if the number is positive,+0.0
orINFINITY
-1.0
if the number is negative,-0.0
orNEG_INFINITY
NAN
if the number isNAN
sourcepub fn copysign(self, rhs: Self) -> Self
pub fn copysign(self, rhs: Self) -> Self
Returns a vector with signs of rhs
and the magnitudes of self
.
sourcepub fn is_negative_bitmask(self) -> u32
pub fn is_negative_bitmask(self) -> u32
Returns a bitmask with the lowest 3 bits set to the sign bits from the elements of self
.
A negative element results in a 1
bit and a positive element in a 0
bit. Element x
goes
into the first lowest bit, element y
into the second, etc.
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) -> f64
pub fn length_squared(self) -> f64
Computes the squared length of self
.
This is faster than length()
as it avoids a square root operation.
sourcepub fn length_recip(self) -> f64
pub fn length_recip(self) -> f64
Computes 1.0 / length()
.
For valid results, self
must not be of length zero.
sourcepub fn distance(self, rhs: Self) -> f64
pub fn distance(self, rhs: Self) -> f64
Computes the Euclidean distance between two points in space.
sourcepub fn distance_squared(self, rhs: Self) -> f64
pub fn distance_squared(self, rhs: Self) -> f64
Compute the squared euclidean distance between two points in space.
sourcepub fn div_euclid(self, rhs: Self) -> Self
pub fn div_euclid(self, rhs: Self) -> Self
Returns the element-wise quotient of [Euclidean division] of self
by rhs
.
sourcepub fn rem_euclid(self, rhs: Self) -> Self
pub fn rem_euclid(self, rhs: Self) -> Self
Returns the element-wise remainder of Euclidean division of self
by rhs
.
sourcepub fn normalize(self) -> Self
pub fn normalize(self) -> Self
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<Self>
pub fn try_normalize(self) -> Option<Self>
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(self, fallback: Self) -> Self
pub fn normalize_or(self, fallback: Self) -> Self
Returns self
normalized to length 1.0 if possible, else returns a
fallback value.
In particular, if the input is zero (or very close to zero), or non-finite, the result of this operation will be the fallback value.
See also Self::try_normalize()
.
sourcepub fn normalize_or_zero(self) -> Self
pub fn normalize_or_zero(self) -> Self
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 approximately 1e-4
.
sourcepub fn project_onto(self, rhs: Self) -> Self
pub fn project_onto(self, rhs: Self) -> Self
Returns the vector projection of self
onto rhs
.
rhs
must be of non-zero length.
§Panics
Will panic if rhs
is zero length when glam_assert
is enabled.
sourcepub fn reject_from(self, rhs: Self) -> Self
pub fn reject_from(self, rhs: Self) -> Self
Returns the vector rejection of self
from rhs
.
The vector rejection is the vector perpendicular to the projection of self
onto
rhs
, in rhs words the result of self - self.project_onto(rhs)
.
rhs
must be of non-zero length.
§Panics
Will panic if rhs
has a length of zero when glam_assert
is enabled.
sourcepub fn project_onto_normalized(self, rhs: Self) -> Self
pub fn project_onto_normalized(self, rhs: Self) -> Self
Returns the vector projection of self
onto rhs
.
rhs
must be normalized.
§Panics
Will panic if rhs
is not normalized when glam_assert
is enabled.
sourcepub fn reject_from_normalized(self, rhs: Self) -> Self
pub fn reject_from_normalized(self, rhs: Self) -> Self
Returns the vector rejection of self
from rhs
.
The vector rejection is the vector perpendicular to the projection of self
onto
rhs
, in rhs words the result of self - self.project_onto(rhs)
.
rhs
must be normalized.
§Panics
Will panic if rhs
is not normalized when glam_assert
is enabled.
sourcepub fn round(self) -> Self
pub fn round(self) -> Self
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) -> Self
pub fn floor(self) -> Self
Returns a vector containing the largest integer less than or equal to a number for each
element of self
.
sourcepub fn ceil(self) -> Self
pub fn ceil(self) -> Self
Returns a vector containing the smallest integer greater than or equal to a number for
each element of self
.
sourcepub fn trunc(self) -> Self
pub fn trunc(self) -> Self
Returns a vector containing the integer part each element of self
. This means numbers are
always truncated towards zero.
sourcepub fn fract(self) -> Self
pub fn fract(self) -> Self
Returns a vector containing the fractional part of the vector as self - self.trunc()
.
Note that this differs from the GLSL implementation of fract
which returns
self - self.floor()
.
Note that this is fast but not precise for large numbers.
sourcepub fn fract_gl(self) -> Self
pub fn fract_gl(self) -> Self
Returns a vector containing the fractional part of the vector as self - self.floor()
.
Note that this differs from the Rust implementation of fract
which returns
self - self.trunc()
.
Note that this is fast but not precise for large numbers.
sourcepub fn exp(self) -> Self
pub fn exp(self) -> Self
Returns a vector containing e^self
(the exponential function) for each element of
self
.
sourcepub fn powf(self, n: f64) -> Self
pub fn powf(self, n: f64) -> Self
Returns a vector containing each element of self
raised to the power of n
.
sourcepub fn recip(self) -> Self
pub fn recip(self) -> Self
Returns a vector containing the reciprocal 1.0/n
of each element of self
.
sourcepub fn lerp(self, rhs: Self, s: f64) -> Self
pub fn lerp(self, rhs: Self, s: f64) -> Self
Performs a linear interpolation between self
and rhs
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 rhs
. When s
is outside of range [0, 1]
, the result is linearly
extrapolated.
sourcepub fn move_towards(&self, rhs: Self, d: f64) -> Self
pub fn move_towards(&self, rhs: Self, d: f64) -> Self
Moves towards rhs
based on the value d
.
When d
is 0.0
, the result will be equal to self
. When d
is equal to
self.distance(rhs)
, the result will be equal to rhs
. Will not go past rhs
.
sourcepub fn midpoint(self, rhs: Self) -> Self
pub fn midpoint(self, rhs: Self) -> Self
Calculates the midpoint between self
and rhs
.
The midpoint is the average of, or halfway point between, two vectors.
a.midpoint(b)
should yield the same result as a.lerp(b, 0.5)
while being slightly cheaper to compute.
sourcepub fn abs_diff_eq(self, rhs: Self, max_abs_diff: f64) -> bool
pub fn abs_diff_eq(self, rhs: Self, max_abs_diff: f64) -> bool
Returns true if the absolute difference of all elements between self
and rhs
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: f64, max: f64) -> Self
pub fn clamp_length(self, min: f64, max: f64) -> Self
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: f64) -> Self
pub fn clamp_length_max(self, max: f64) -> Self
Returns a vector with a length no more than max
sourcepub fn clamp_length_min(self, min: f64) -> Self
pub fn clamp_length_min(self, min: f64) -> Self
Returns a vector with a length no less than min
sourcepub fn mul_add(self, a: Self, b: Self) -> Self
pub fn mul_add(self, a: Self, b: Self) -> Self
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, rhs: Self) -> f64
pub fn angle_between(self, rhs: Self) -> f64
Returns the angle (in radians) between two vectors.
The inputs do not need to be unit vectors however they must be non-zero.
sourcepub fn any_orthogonal_vector(&self) -> Self
pub fn any_orthogonal_vector(&self) -> Self
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) -> Self
pub fn any_orthonormal_vector(&self) -> Self
Returns any unit vector that is orthogonal to the given one.
The input vector must be unit length.
§Panics
Will panic if self
is not normalized when glam_assert
is enabled.
sourcepub fn any_orthonormal_pair(&self) -> (Self, Self)
pub fn any_orthonormal_pair(&self) -> (Self, Self)
Given a unit 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.
sourcepub fn as_i16vec3(&self) -> I16Vec3
pub fn as_i16vec3(&self) -> I16Vec3
Casts all elements of self
to i16
.
sourcepub fn as_u16vec3(&self) -> U16Vec3
pub fn as_u16vec3(&self) -> U16Vec3
Casts all elements of self
to u16
.
sourcepub fn as_i64vec3(&self) -> I64Vec3
pub fn as_i64vec3(&self) -> I64Vec3
Casts all elements of self
to i64
.
sourcepub fn as_u64vec3(&self) -> U64Vec3
pub fn as_u64vec3(&self) -> U64Vec3
Casts all elements of self
to u64
.
Trait Implementations§
source§impl AddAssign<f64> for DVec3
impl AddAssign<f64> for DVec3
source§fn add_assign(&mut self, rhs: f64)
fn add_assign(&mut self, rhs: f64)
+=
operation. Read moresource§impl AddAssign for DVec3
impl AddAssign for DVec3
source§fn add_assign(&mut self, rhs: Self)
fn add_assign(&mut self, rhs: Self)
+=
operation. Read moresource§impl<'de> Deserialize<'de> for DVec3
impl<'de> Deserialize<'de> for DVec3
source§fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
source§impl Distribution<DVec3> for Standard
impl Distribution<DVec3> for Standard
source§impl DivAssign<f64> for DVec3
impl DivAssign<f64> for DVec3
source§fn div_assign(&mut self, rhs: f64)
fn div_assign(&mut self, rhs: f64)
/=
operation. Read moresource§impl DivAssign for DVec3
impl DivAssign for DVec3
source§fn div_assign(&mut self, rhs: Self)
fn div_assign(&mut self, rhs: Self)
/=
operation. Read moresource§impl MulAssign<f64> for DVec3
impl MulAssign<f64> for DVec3
source§fn mul_assign(&mut self, rhs: f64)
fn mul_assign(&mut self, rhs: f64)
*=
operation. Read moresource§impl MulAssign for DVec3
impl MulAssign for DVec3
source§fn mul_assign(&mut self, rhs: Self)
fn mul_assign(&mut self, rhs: Self)
*=
operation. Read moresource§impl PartialEq for DVec3
impl PartialEq for DVec3
source§impl RemAssign<f64> for DVec3
impl RemAssign<f64> for DVec3
source§fn rem_assign(&mut self, rhs: f64)
fn rem_assign(&mut self, rhs: f64)
%=
operation. Read moresource§impl RemAssign for DVec3
impl RemAssign for DVec3
source§fn rem_assign(&mut self, rhs: Self)
fn rem_assign(&mut self, rhs: Self)
%=
operation. Read moresource§impl SubAssign<f64> for DVec3
impl SubAssign<f64> for DVec3
source§fn sub_assign(&mut self, rhs: f64)
fn sub_assign(&mut self, rhs: f64)
-=
operation. Read moresource§impl SubAssign for DVec3
impl SubAssign for DVec3
source§fn sub_assign(&mut self, rhs: DVec3)
fn sub_assign(&mut self, rhs: DVec3)
-=
operation. Read moresource§impl Vec3Swizzles for DVec3
impl Vec3Swizzles for DVec3
type Vec2 = DVec2
type Vec4 = DVec4
fn xx(self) -> DVec2
fn xy(self) -> DVec2
fn xz(self) -> DVec2
fn yx(self) -> DVec2
fn yy(self) -> DVec2
fn yz(self) -> DVec2
fn zx(self) -> DVec2
fn zy(self) -> DVec2
fn zz(self) -> DVec2
fn xxx(self) -> DVec3
fn xxy(self) -> DVec3
fn xxz(self) -> DVec3
fn xyx(self) -> DVec3
fn xyy(self) -> DVec3
fn xyz(self) -> DVec3
fn xzx(self) -> DVec3
fn xzy(self) -> DVec3
fn xzz(self) -> DVec3
fn yxx(self) -> DVec3
fn yxy(self) -> DVec3
fn yxz(self) -> DVec3
fn yyx(self) -> DVec3
fn yyy(self) -> DVec3
fn yyz(self) -> DVec3
fn yzx(self) -> DVec3
fn yzy(self) -> DVec3
fn yzz(self) -> DVec3
fn zxx(self) -> DVec3
fn zxy(self) -> DVec3
fn zxz(self) -> DVec3
fn zyx(self) -> DVec3
fn zyy(self) -> DVec3
fn zyz(self) -> DVec3
fn zzx(self) -> DVec3
fn zzy(self) -> DVec3
fn zzz(self) -> DVec3
fn xxxx(self) -> DVec4
fn xxxy(self) -> DVec4
fn xxxz(self) -> DVec4
fn xxyx(self) -> DVec4
fn xxyy(self) -> DVec4
fn xxyz(self) -> DVec4
fn xxzx(self) -> DVec4
fn xxzy(self) -> DVec4
fn xxzz(self) -> DVec4
fn xyxx(self) -> DVec4
fn xyxy(self) -> DVec4
fn xyxz(self) -> DVec4
fn xyyx(self) -> DVec4
fn xyyy(self) -> DVec4
fn xyyz(self) -> DVec4
fn xyzx(self) -> DVec4
fn xyzy(self) -> DVec4
fn xyzz(self) -> DVec4
fn xzxx(self) -> DVec4
fn xzxy(self) -> DVec4
fn xzxz(self) -> DVec4
fn xzyx(self) -> DVec4
fn xzyy(self) -> DVec4
fn xzyz(self) -> DVec4
fn xzzx(self) -> DVec4
fn xzzy(self) -> DVec4
fn xzzz(self) -> DVec4
fn yxxx(self) -> DVec4
fn yxxy(self) -> DVec4
fn yxxz(self) -> DVec4
fn yxyx(self) -> DVec4
fn yxyy(self) -> DVec4
fn yxyz(self) -> DVec4
fn yxzx(self) -> DVec4
fn yxzy(self) -> DVec4
fn yxzz(self) -> DVec4
fn yyxx(self) -> DVec4
fn yyxy(self) -> DVec4
fn yyxz(self) -> DVec4
fn yyyx(self) -> DVec4
fn yyyy(self) -> DVec4
fn yyyz(self) -> DVec4
fn yyzx(self) -> DVec4
fn yyzy(self) -> DVec4
fn yyzz(self) -> DVec4
fn yzxx(self) -> DVec4
fn yzxy(self) -> DVec4
fn yzxz(self) -> DVec4
fn yzyx(self) -> DVec4
fn yzyy(self) -> DVec4
fn yzyz(self) -> DVec4
fn yzzx(self) -> DVec4
fn yzzy(self) -> DVec4
fn yzzz(self) -> DVec4
fn zxxx(self) -> DVec4
fn zxxy(self) -> DVec4
fn zxxz(self) -> DVec4
fn zxyx(self) -> DVec4
fn zxyy(self) -> DVec4
fn zxyz(self) -> DVec4
fn zxzx(self) -> DVec4
fn zxzy(self) -> DVec4
fn zxzz(self) -> DVec4
fn zyxx(self) -> DVec4
fn zyxy(self) -> DVec4
fn zyxz(self) -> DVec4
fn zyyx(self) -> DVec4
fn zyyy(self) -> DVec4
fn zyyz(self) -> DVec4
fn zyzx(self) -> DVec4
fn zyzy(self) -> DVec4
fn zyzz(self) -> DVec4
fn zzxx(self) -> DVec4
fn zzxy(self) -> DVec4
fn zzxz(self) -> DVec4
fn zzyx(self) -> DVec4
fn zzyy(self) -> DVec4
fn zzyz(self) -> DVec4
fn zzzx(self) -> DVec4
fn zzzy(self) -> DVec4
fn zzzz(self) -> DVec4
impl Copy for DVec3
impl Pod for DVec3
impl StructuralPartialEq for DVec3
Auto Trait Implementations§
impl Freeze for DVec3
impl RefUnwindSafe for DVec3
impl Send for DVec3
impl Sync for DVec3
impl Unpin for DVec3
impl UnwindSafe for DVec3
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CheckedBitPattern for Twhere
T: AnyBitPattern,
impl<T> CheckedBitPattern for Twhere
T: AnyBitPattern,
§type Bits = T
type Bits = T
Self
must have the same layout as the specified Bits
except for
the possible invalid bit patterns being checked during
is_valid_bit_pattern
.source§fn is_valid_bit_pattern(_bits: &T) -> bool
fn is_valid_bit_pattern(_bits: &T) -> bool
bits
as &Self
.