pub struct DVec2(/* private fields */);
Expand description
A 2-dimensional vector.
Implementations§
source§impl DVec2
impl DVec2
sourcepub fn select(mask: BVec2, if_true: DVec2, if_false: DVec2) -> DVec2
pub fn select(mask: BVec2, if_true: DVec2, if_false: DVec2) -> DVec2
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: Self) -> Self
pub fn min(self, other: Self) -> Self
Returns a vector containing the mininum 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 max(self, other: Self) -> Self
pub fn max(self, other: Self) -> Self
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: Self, max: Self) -> Self
pub fn clamp(self, min: Self, max: Self) -> Self
Component-wise clamping of values, similar to f32::clamp
.
Each element in min
must be less-or-equal to the corresponing 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 cmpeq(self, other: Self) -> BVec2
pub fn cmpeq(self, other: Self) -> BVec2
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: Self) -> BVec2
pub fn cmpne(self, other: Self) -> BVec2
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: Self) -> BVec2
pub fn cmpge(self, other: Self) -> BVec2
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: Self) -> BVec2
pub fn cmpgt(self, other: Self) -> BVec2
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: Self) -> BVec2
pub fn cmple(self, other: Self) -> BVec2
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: Self) -> BVec2
pub fn cmplt(self, other: Self) -> BVec2
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: &[f64]) -> Self
pub fn from_slice(slice: &[f64]) -> Self
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 [f64])
pub fn write_to_slice(self, slice: &mut [f64])
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) -> 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 perp_dot(self, other: DVec2) -> f64
pub fn perp_dot(self, other: DVec2) -> f64
The perpendicular dot product of self
and other
.
Also known as the wedge product, 2d cross product, and determinant.
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) -> BVec2
pub fn is_nan_mask(self) -> BVec2
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, other: Self) -> f64
pub fn distance(self, other: Self) -> f64
Computes the Euclidean distance between two points in space.
sourcepub fn distance_squared(self, other: Self) -> f64
pub fn distance_squared(self, other: Self) -> f64
Compute the squared euclidean distance between two points in space.
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_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 1e-6
.
sourcepub fn project_onto(self, other: Self) -> Self
pub fn project_onto(self, other: Self) -> Self
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: Self) -> Self
pub fn reject_from(self, other: Self) -> Self
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: Self) -> Self
pub fn project_onto_normalized(self, other: Self) -> Self
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: Self) -> Self
pub fn reject_from_normalized(self, other: Self) -> Self
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) -> 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 fract(self) -> Self
pub fn fract(self) -> Self
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) -> 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, other: Self, s: f64) -> Self
pub fn lerp(self, other: Self, s: f64) -> Self
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
.
sourcepub fn abs_diff_eq(self, other: Self, max_abs_diff: f64) -> bool
pub fn abs_diff_eq(self, other: Self, max_abs_diff: f64) -> 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: 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 angle_between(self, other: Self) -> f64
pub fn angle_between(self, other: Self) -> f64
Returns the angle (in radians) between self
and other
.
The input vectors do not need to be unit length however they must be non-zero.
Trait Implementations§
source§impl AddAssign<f64> for DVec2
impl AddAssign<f64> for DVec2
source§fn add_assign(&mut self, other: f64)
fn add_assign(&mut self, other: f64)
+=
operation. Read moresource§impl AddAssign for DVec2
impl AddAssign for DVec2
source§fn add_assign(&mut self, other: DVec2)
fn add_assign(&mut self, other: DVec2)
+=
operation. Read moresource§impl<'de> Deserialize<'de> for DVec2
impl<'de> Deserialize<'de> for DVec2
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<DVec2> for Standard
impl Distribution<DVec2> for Standard
source§impl DivAssign<f64> for DVec2
impl DivAssign<f64> for DVec2
source§fn div_assign(&mut self, other: f64)
fn div_assign(&mut self, other: f64)
/=
operation. Read moresource§impl DivAssign for DVec2
impl DivAssign for DVec2
source§fn div_assign(&mut self, other: DVec2)
fn div_assign(&mut self, other: DVec2)
/=
operation. Read moresource§impl MulAssign<f64> for DVec2
impl MulAssign<f64> for DVec2
source§fn mul_assign(&mut self, other: f64)
fn mul_assign(&mut self, other: f64)
*=
operation. Read moresource§impl MulAssign for DVec2
impl MulAssign for DVec2
source§fn mul_assign(&mut self, other: DVec2)
fn mul_assign(&mut self, other: DVec2)
*=
operation. Read moresource§impl PartialEq for DVec2
impl PartialEq for DVec2
source§impl SubAssign<f64> for DVec2
impl SubAssign<f64> for DVec2
source§fn sub_assign(&mut self, other: f64)
fn sub_assign(&mut self, other: f64)
-=
operation. Read moresource§impl SubAssign for DVec2
impl SubAssign for DVec2
source§fn sub_assign(&mut self, other: DVec2)
fn sub_assign(&mut self, other: DVec2)
-=
operation. Read more