pub struct Vec3A(_);
Expand description
A 3-dimensional vector with SIMD support.
This type is 16 byte aligned. A SIMD vector type is used for storage on supported platforms for
better performance than the Vec3
type.
It is possible to convert between Vec3
and Vec3A
types using From
trait implementations.
Implementations§
source§impl Vec3A
impl Vec3A
sourcepub const X: Vec3A = Self::new(1.0, 0.0, 0.0)
pub const X: Vec3A = Self::new(1.0, 0.0, 0.0)
A unit-length vector pointing along the positive X axis.
sourcepub const Y: Vec3A = Self::new(0.0, 1.0, 0.0)
pub const Y: Vec3A = Self::new(0.0, 1.0, 0.0)
A unit-length vector pointing along the positive Y axis.
sourcepub const Z: Vec3A = Self::new(0.0, 0.0, 1.0)
pub const Z: Vec3A = Self::new(0.0, 0.0, 1.0)
A unit-length vector pointing along the positive Z axis.
sourcepub const NEG_X: Vec3A = Self::new(-1.0, 0.0, 0.0)
pub const NEG_X: Vec3A = Self::new(-1.0, 0.0, 0.0)
A unit-length vector pointing along the negative X axis.
sourcepub const NEG_Y: Vec3A = Self::new(0.0, -1.0, 0.0)
pub const NEG_Y: Vec3A = Self::new(0.0, -1.0, 0.0)
A unit-length vector pointing along the negative Y axis.
sourcepub const NEG_Z: Vec3A = Self::new(0.0, 0.0, -1.0)
pub const NEG_Z: Vec3A = Self::new(0.0, 0.0, -1.0)
A unit-length vector pointing along the negative Z axis.
sourcepub fn select(mask: BVec3A, if_true: Vec3A, if_false: Vec3A) -> Vec3A
pub fn select(mask: BVec3A, if_true: Vec3A, if_false: Vec3A) -> Vec3A
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: [f32; 3]) -> Vec3A
pub const fn from_array(a: [f32; 3]) -> Vec3A
Creates a new vector from an array.
sourcepub const fn from_slice(slice: &[f32]) -> Vec3A
pub const fn from_slice(slice: &[f32]) -> Vec3A
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 [f32])
pub fn write_to_slice(self, slice: &mut [f32])
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) -> Vec2
pub fn truncate(self) -> Vec2
Creates a 2D vector from the x
and y
elements of self
, discarding z
.
Truncation may also be performed by using self.xy()
or Vec2::from()
.
sourcepub fn dot_into_vec(self, rhs: Vec3A) -> Vec3A
pub fn dot_into_vec(self, rhs: Vec3A) -> Vec3A
Returns a vector where every component is the dot product of self
and rhs
.
sourcepub fn min(self, rhs: Vec3A) -> Vec3A
pub fn min(self, rhs: Vec3A) -> Vec3A
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: Vec3A) -> Vec3A
pub fn max(self, rhs: Vec3A) -> Vec3A
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: Vec3A, max: Vec3A) -> Vec3A
pub fn clamp(self, min: Vec3A, max: Vec3A) -> Vec3A
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, rhs: Vec3A) -> BVec3A
pub fn cmpeq(self, rhs: Vec3A) -> BVec3A
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: Vec3A) -> BVec3A
pub fn cmpne(self, rhs: Vec3A) -> BVec3A
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: Vec3A) -> BVec3A
pub fn cmpge(self, rhs: Vec3A) -> BVec3A
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: Vec3A) -> BVec3A
pub fn cmpgt(self, rhs: Vec3A) -> BVec3A
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: Vec3A) -> BVec3A
pub fn cmple(self, rhs: Vec3A) -> BVec3A
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: Vec3A) -> BVec3A
pub fn cmplt(self, rhs: Vec3A) -> BVec3A
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) -> Vec3A
pub fn abs(self) -> Vec3A
Returns a vector containing the absolute value of each element of self
.
sourcepub fn signum(self) -> Vec3A
pub fn signum(self) -> Vec3A
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 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) -> BVec3A
pub fn is_nan_mask(self) -> BVec3A
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, rhs: Vec3A) -> f32
pub fn distance(self, rhs: Vec3A) -> f32
Computes the Euclidean distance between two points in space.
sourcepub fn distance_squared(self, rhs: Vec3A) -> f32
pub fn distance_squared(self, rhs: Vec3A) -> f32
Compute the squared euclidean distance between two points in space.
sourcepub fn normalize(self) -> Vec3A
pub fn normalize(self) -> Vec3A
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<Vec3A>
pub fn try_normalize(self) -> Option<Vec3A>
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) -> Vec3A
pub fn normalize_or_zero(self) -> Vec3A
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, rhs: Vec3A) -> Vec3A
pub fn project_onto(self, rhs: Vec3A) -> Vec3A
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: Vec3A) -> Vec3A
pub fn reject_from(self, rhs: Vec3A) -> Vec3A
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: Vec3A) -> Vec3A
pub fn project_onto_normalized(self, rhs: Vec3A) -> Vec3A
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: Vec3A) -> Vec3A
pub fn reject_from_normalized(self, rhs: Vec3A) -> Vec3A
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) -> Vec3A
pub fn round(self) -> Vec3A
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) -> Vec3A
pub fn floor(self) -> Vec3A
Returns a vector containing the largest integer less than or equal to a number for each
element of self
.
sourcepub fn ceil(self) -> Vec3A
pub fn ceil(self) -> Vec3A
Returns a vector containing the smallest integer greater than or equal to a number for
each element of self
.
sourcepub fn fract(self) -> Vec3A
pub fn fract(self) -> Vec3A
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) -> Vec3A
pub fn exp(self) -> Vec3A
Returns a vector containing e^self
(the exponential function) for each element of
self
.
sourcepub fn powf(self, n: f32) -> Vec3A
pub fn powf(self, n: f32) -> Vec3A
Returns a vector containing each element of self
raised to the power of n
.
sourcepub fn recip(self) -> Vec3A
pub fn recip(self) -> Vec3A
Returns a vector containing the reciprocal 1.0/n
of each element of self
.
sourcepub fn lerp(self, rhs: Vec3A, s: f32) -> Vec3A
pub fn lerp(self, rhs: Vec3A, s: f32) -> Vec3A
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 abs_diff_eq(self, rhs: Vec3A, max_abs_diff: f32) -> bool
pub fn abs_diff_eq(self, rhs: Vec3A, max_abs_diff: f32) -> 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: f32, max: f32) -> Vec3A
pub fn clamp_length(self, min: f32, max: f32) -> Vec3A
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) -> Vec3A
pub fn clamp_length_max(self, max: f32) -> Vec3A
Returns a vector with a length no more than max
sourcepub fn clamp_length_min(self, min: f32) -> Vec3A
pub fn clamp_length_min(self, min: f32) -> Vec3A
Returns a vector with a length no less than min
sourcepub fn mul_add(self, a: Vec3A, b: Vec3A) -> Vec3A
pub fn mul_add(self, a: Vec3A, b: Vec3A) -> Vec3A
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: Vec3A) -> f32
pub fn angle_between(self, rhs: Vec3A) -> 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) -> Vec3A
pub fn any_orthogonal_vector(&self) -> Vec3A
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) -> Vec3A
pub fn any_orthonormal_vector(&self) -> Vec3A
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) -> (Vec3A, Vec3A)
pub fn any_orthonormal_pair(&self) -> (Vec3A, Vec3A)
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<Vec3A> for Vec3A
impl AddAssign<Vec3A> for Vec3A
source§fn add_assign(&mut self, rhs: Vec3A)
fn add_assign(&mut self, rhs: Vec3A)
+=
operation. Read moresource§impl AddAssign<f32> for Vec3A
impl AddAssign<f32> for Vec3A
source§fn add_assign(&mut self, rhs: f32)
fn add_assign(&mut self, rhs: f32)
+=
operation. Read moresource§impl DivAssign<Vec3A> for Vec3A
impl DivAssign<Vec3A> for Vec3A
source§fn div_assign(&mut self, rhs: Vec3A)
fn div_assign(&mut self, rhs: Vec3A)
/=
operation. Read moresource§impl DivAssign<f32> for Vec3A
impl DivAssign<f32> for Vec3A
source§fn div_assign(&mut self, rhs: f32)
fn div_assign(&mut self, rhs: f32)
/=
operation. Read moresource§impl MulAssign<Vec3A> for Vec3A
impl MulAssign<Vec3A> for Vec3A
source§fn mul_assign(&mut self, rhs: Vec3A)
fn mul_assign(&mut self, rhs: Vec3A)
*=
operation. Read moresource§impl MulAssign<f32> for Vec3A
impl MulAssign<f32> for Vec3A
source§fn mul_assign(&mut self, rhs: f32)
fn mul_assign(&mut self, rhs: f32)
*=
operation. Read moresource§impl RemAssign<Vec3A> for Vec3A
impl RemAssign<Vec3A> for Vec3A
source§fn rem_assign(&mut self, rhs: Vec3A)
fn rem_assign(&mut self, rhs: Vec3A)
%=
operation. Read moresource§impl RemAssign<f32> for Vec3A
impl RemAssign<f32> for Vec3A
source§fn rem_assign(&mut self, rhs: f32)
fn rem_assign(&mut self, rhs: f32)
%=
operation. Read moresource§impl SubAssign<Vec3A> for Vec3A
impl SubAssign<Vec3A> for Vec3A
source§fn sub_assign(&mut self, rhs: Vec3A)
fn sub_assign(&mut self, rhs: Vec3A)
-=
operation. Read moresource§impl SubAssign<f32> for Vec3A
impl SubAssign<f32> for Vec3A
source§fn sub_assign(&mut self, rhs: f32)
fn sub_assign(&mut self, rhs: f32)
-=
operation. Read more