use crate::{BVec4, Vec2, Vec3, Vec3A};
#[cfg(not(target_arch = "spirv"))]
use core::fmt;
use core::iter::{Product, Sum};
use core::{f32, ops::*};
#[cfg(feature = "libm")]
#[allow(unused_imports)]
use num_traits::Float;
#[inline(always)]
pub const fn vec4(x: f32, y: f32, z: f32, w: f32) -> Vec4 {
Vec4::new(x, y, z, w)
}
#[derive(Clone, Copy, PartialEq)]
#[cfg_attr(
any(
not(any(feature = "scalar-math", target_arch = "spirv")),
feature = "cuda"
),
repr(align(16))
)]
#[cfg_attr(not(target_arch = "spirv"), repr(C))]
#[cfg_attr(target_arch = "spirv", repr(simd))]
pub struct Vec4 {
pub x: f32,
pub y: f32,
pub z: f32,
pub w: f32,
}
impl Vec4 {
pub const ZERO: Self = Self::splat(0.0);
pub const ONE: Self = Self::splat(1.0);
pub const NEG_ONE: Self = Self::splat(-1.0);
pub const NAN: Self = Self::splat(f32::NAN);
pub const X: Self = Self::new(1.0, 0.0, 0.0, 0.0);
pub const Y: Self = Self::new(0.0, 1.0, 0.0, 0.0);
pub const Z: Self = Self::new(0.0, 0.0, 1.0, 0.0);
pub const W: Self = Self::new(0.0, 0.0, 0.0, 1.0);
pub const NEG_X: Self = Self::new(-1.0, 0.0, 0.0, 0.0);
pub const NEG_Y: Self = Self::new(0.0, -1.0, 0.0, 0.0);
pub const NEG_Z: Self = Self::new(0.0, 0.0, -1.0, 0.0);
pub const NEG_W: Self = Self::new(0.0, 0.0, 0.0, -1.0);
pub const AXES: [Self; 4] = [Self::X, Self::Y, Self::Z, Self::W];
#[inline(always)]
pub const fn new(x: f32, y: f32, z: f32, w: f32) -> Self {
Self { x, y, z, w }
}
#[inline]
pub const fn splat(v: f32) -> Self {
Self {
x: v,
y: v,
z: v,
w: v,
}
}
#[inline]
pub fn select(mask: BVec4, if_true: Self, if_false: Self) -> Self {
Self {
x: if mask.x { if_true.x } else { if_false.x },
y: if mask.y { if_true.y } else { if_false.y },
z: if mask.z { if_true.z } else { if_false.z },
w: if mask.w { if_true.w } else { if_false.w },
}
}
#[inline]
pub const fn from_array(a: [f32; 4]) -> Self {
Self::new(a[0], a[1], a[2], a[3])
}
#[inline]
pub const fn to_array(&self) -> [f32; 4] {
[self.x, self.y, self.z, self.w]
}
#[inline]
pub const fn from_slice(slice: &[f32]) -> Self {
Self::new(slice[0], slice[1], slice[2], slice[3])
}
#[inline]
pub fn write_to_slice(self, slice: &mut [f32]) {
slice[0] = self.x;
slice[1] = self.y;
slice[2] = self.z;
slice[3] = self.w;
}
#[inline]
pub fn truncate(self) -> Vec3 {
use crate::swizzles::Vec4Swizzles;
self.xyz()
}
#[inline]
pub fn dot(self, rhs: Self) -> f32 {
(self.x * rhs.x) + (self.y * rhs.y) + (self.z * rhs.z) + (self.w * rhs.w)
}
#[inline]
pub fn dot_into_vec(self, rhs: Self) -> Self {
Self::splat(self.dot(rhs))
}
#[inline]
pub fn min(self, rhs: Self) -> Self {
Self {
x: self.x.min(rhs.x),
y: self.y.min(rhs.y),
z: self.z.min(rhs.z),
w: self.w.min(rhs.w),
}
}
#[inline]
pub fn max(self, rhs: Self) -> Self {
Self {
x: self.x.max(rhs.x),
y: self.y.max(rhs.y),
z: self.z.max(rhs.z),
w: self.w.max(rhs.w),
}
}
#[inline]
pub fn clamp(self, min: Self, max: Self) -> Self {
glam_assert!(min.cmple(max).all(), "clamp: expected min <= max");
self.max(min).min(max)
}
#[inline]
pub fn min_element(self) -> f32 {
self.x.min(self.y.min(self.z.min(self.w)))
}
#[inline]
pub fn max_element(self) -> f32 {
self.x.max(self.y.max(self.z.max(self.w)))
}
#[inline]
pub fn cmpeq(self, rhs: Self) -> BVec4 {
BVec4::new(
self.x.eq(&rhs.x),
self.y.eq(&rhs.y),
self.z.eq(&rhs.z),
self.w.eq(&rhs.w),
)
}
#[inline]
pub fn cmpne(self, rhs: Self) -> BVec4 {
BVec4::new(
self.x.ne(&rhs.x),
self.y.ne(&rhs.y),
self.z.ne(&rhs.z),
self.w.ne(&rhs.w),
)
}
#[inline]
pub fn cmpge(self, rhs: Self) -> BVec4 {
BVec4::new(
self.x.ge(&rhs.x),
self.y.ge(&rhs.y),
self.z.ge(&rhs.z),
self.w.ge(&rhs.w),
)
}
#[inline]
pub fn cmpgt(self, rhs: Self) -> BVec4 {
BVec4::new(
self.x.gt(&rhs.x),
self.y.gt(&rhs.y),
self.z.gt(&rhs.z),
self.w.gt(&rhs.w),
)
}
#[inline]
pub fn cmple(self, rhs: Self) -> BVec4 {
BVec4::new(
self.x.le(&rhs.x),
self.y.le(&rhs.y),
self.z.le(&rhs.z),
self.w.le(&rhs.w),
)
}
#[inline]
pub fn cmplt(self, rhs: Self) -> BVec4 {
BVec4::new(
self.x.lt(&rhs.x),
self.y.lt(&rhs.y),
self.z.lt(&rhs.z),
self.w.lt(&rhs.w),
)
}
#[inline]
pub fn abs(self) -> Self {
Self {
x: self.x.abs(),
y: self.y.abs(),
z: self.z.abs(),
w: self.w.abs(),
}
}
#[inline]
pub fn signum(self) -> Self {
Self {
x: self.x.signum(),
y: self.y.signum(),
z: self.z.signum(),
w: self.w.signum(),
}
}
#[inline]
pub fn is_negative_bitmask(self) -> u32 {
(self.x.is_sign_negative() as u32)
| (self.y.is_sign_negative() as u32) << 1
| (self.z.is_sign_negative() as u32) << 2
| (self.w.is_sign_negative() as u32) << 3
}
#[inline]
pub fn is_finite(self) -> bool {
self.x.is_finite() && self.y.is_finite() && self.z.is_finite() && self.w.is_finite()
}
#[inline]
pub fn is_nan(self) -> bool {
self.x.is_nan() || self.y.is_nan() || self.z.is_nan() || self.w.is_nan()
}
#[inline]
pub fn is_nan_mask(self) -> BVec4 {
BVec4::new(
self.x.is_nan(),
self.y.is_nan(),
self.z.is_nan(),
self.w.is_nan(),
)
}
#[doc(alias = "magnitude")]
#[inline]
pub fn length(self) -> f32 {
self.dot(self).sqrt()
}
#[doc(alias = "magnitude2")]
#[inline]
pub fn length_squared(self) -> f32 {
self.dot(self)
}
#[inline]
pub fn length_recip(self) -> f32 {
self.length().recip()
}
#[inline]
pub fn distance(self, rhs: Self) -> f32 {
(self - rhs).length()
}
#[inline]
pub fn distance_squared(self, rhs: Self) -> f32 {
(self - rhs).length_squared()
}
#[must_use]
#[inline]
pub fn normalize(self) -> Self {
#[allow(clippy::let_and_return)]
let normalized = self.mul(self.length_recip());
glam_assert!(normalized.is_finite());
normalized
}
#[must_use]
#[inline]
pub fn try_normalize(self) -> Option<Self> {
let rcp = self.length_recip();
if rcp.is_finite() && rcp > 0.0 {
Some(self * rcp)
} else {
None
}
}
#[must_use]
#[inline]
pub fn normalize_or_zero(self) -> Self {
let rcp = self.length_recip();
if rcp.is_finite() && rcp > 0.0 {
self * rcp
} else {
Self::ZERO
}
}
#[inline]
pub fn is_normalized(self) -> bool {
(self.length_squared() - 1.0).abs() <= 1e-4
}
#[must_use]
#[inline]
pub fn project_onto(self, rhs: Self) -> Self {
let other_len_sq_rcp = rhs.dot(rhs).recip();
glam_assert!(other_len_sq_rcp.is_finite());
rhs * self.dot(rhs) * other_len_sq_rcp
}
#[must_use]
#[inline]
pub fn reject_from(self, rhs: Self) -> Self {
self - self.project_onto(rhs)
}
#[must_use]
#[inline]
pub fn project_onto_normalized(self, rhs: Self) -> Self {
glam_assert!(rhs.is_normalized());
rhs * self.dot(rhs)
}
#[must_use]
#[inline]
pub fn reject_from_normalized(self, rhs: Self) -> Self {
self - self.project_onto_normalized(rhs)
}
#[inline]
pub fn round(self) -> Self {
Self {
x: self.x.round(),
y: self.y.round(),
z: self.z.round(),
w: self.w.round(),
}
}
#[inline]
pub fn floor(self) -> Self {
Self {
x: self.x.floor(),
y: self.y.floor(),
z: self.z.floor(),
w: self.w.floor(),
}
}
#[inline]
pub fn ceil(self) -> Self {
Self {
x: self.x.ceil(),
y: self.y.ceil(),
z: self.z.ceil(),
w: self.w.ceil(),
}
}
#[inline]
pub fn fract(self) -> Self {
self - self.floor()
}
#[inline]
pub fn exp(self) -> Self {
Self::new(self.x.exp(), self.y.exp(), self.z.exp(), self.w.exp())
}
#[inline]
pub fn powf(self, n: f32) -> Self {
Self::new(
self.x.powf(n),
self.y.powf(n),
self.z.powf(n),
self.w.powf(n),
)
}
#[inline]
pub fn recip(self) -> Self {
Self {
x: self.x.recip(),
y: self.y.recip(),
z: self.z.recip(),
w: self.w.recip(),
}
}
#[doc(alias = "mix")]
#[inline]
pub fn lerp(self, rhs: Self, s: f32) -> Self {
self + ((rhs - self) * s)
}
#[inline]
pub fn abs_diff_eq(self, rhs: Self, max_abs_diff: f32) -> bool {
self.sub(rhs).abs().cmple(Self::splat(max_abs_diff)).all()
}
#[inline]
pub fn clamp_length(self, min: f32, max: f32) -> Self {
glam_assert!(min <= max);
let length_sq = self.length_squared();
if length_sq < min * min {
self * (length_sq.sqrt().recip() * min)
} else if length_sq > max * max {
self * (length_sq.sqrt().recip() * max)
} else {
self
}
}
pub fn clamp_length_max(self, max: f32) -> Self {
let length_sq = self.length_squared();
if length_sq > max * max {
self * (length_sq.sqrt().recip() * max)
} else {
self
}
}
pub fn clamp_length_min(self, min: f32) -> Self {
let length_sq = self.length_squared();
if length_sq < min * min {
self * (length_sq.sqrt().recip() * min)
} else {
self
}
}
#[inline]
pub fn mul_add(self, a: Self, b: Self) -> Self {
Self::new(
self.x.mul_add(a.x, b.x),
self.y.mul_add(a.y, b.y),
self.z.mul_add(a.z, b.z),
self.w.mul_add(a.w, b.w),
)
}
#[inline]
pub fn as_dvec4(&self) -> crate::DVec4 {
crate::DVec4::new(self.x as f64, self.y as f64, self.z as f64, self.w as f64)
}
#[inline]
pub fn as_ivec4(&self) -> crate::IVec4 {
crate::IVec4::new(self.x as i32, self.y as i32, self.z as i32, self.w as i32)
}
#[inline]
pub fn as_uvec4(&self) -> crate::UVec4 {
crate::UVec4::new(self.x as u32, self.y as u32, self.z as u32, self.w as u32)
}
}
impl Default for Vec4 {
#[inline(always)]
fn default() -> Self {
Self::ZERO
}
}
impl Div<Vec4> for Vec4 {
type Output = Self;
#[inline]
fn div(self, rhs: Self) -> Self {
Self {
x: self.x.div(rhs.x),
y: self.y.div(rhs.y),
z: self.z.div(rhs.z),
w: self.w.div(rhs.w),
}
}
}
impl DivAssign<Vec4> for Vec4 {
#[inline]
fn div_assign(&mut self, rhs: Self) {
self.x.div_assign(rhs.x);
self.y.div_assign(rhs.y);
self.z.div_assign(rhs.z);
self.w.div_assign(rhs.w);
}
}
impl Div<f32> for Vec4 {
type Output = Self;
#[inline]
fn div(self, rhs: f32) -> Self {
Self {
x: self.x.div(rhs),
y: self.y.div(rhs),
z: self.z.div(rhs),
w: self.w.div(rhs),
}
}
}
impl DivAssign<f32> for Vec4 {
#[inline]
fn div_assign(&mut self, rhs: f32) {
self.x.div_assign(rhs);
self.y.div_assign(rhs);
self.z.div_assign(rhs);
self.w.div_assign(rhs);
}
}
impl Div<Vec4> for f32 {
type Output = Vec4;
#[inline]
fn div(self, rhs: Vec4) -> Vec4 {
Vec4 {
x: self.div(rhs.x),
y: self.div(rhs.y),
z: self.div(rhs.z),
w: self.div(rhs.w),
}
}
}
impl Mul<Vec4> for Vec4 {
type Output = Self;
#[inline]
fn mul(self, rhs: Self) -> Self {
Self {
x: self.x.mul(rhs.x),
y: self.y.mul(rhs.y),
z: self.z.mul(rhs.z),
w: self.w.mul(rhs.w),
}
}
}
impl MulAssign<Vec4> for Vec4 {
#[inline]
fn mul_assign(&mut self, rhs: Self) {
self.x.mul_assign(rhs.x);
self.y.mul_assign(rhs.y);
self.z.mul_assign(rhs.z);
self.w.mul_assign(rhs.w);
}
}
impl Mul<f32> for Vec4 {
type Output = Self;
#[inline]
fn mul(self, rhs: f32) -> Self {
Self {
x: self.x.mul(rhs),
y: self.y.mul(rhs),
z: self.z.mul(rhs),
w: self.w.mul(rhs),
}
}
}
impl MulAssign<f32> for Vec4 {
#[inline]
fn mul_assign(&mut self, rhs: f32) {
self.x.mul_assign(rhs);
self.y.mul_assign(rhs);
self.z.mul_assign(rhs);
self.w.mul_assign(rhs);
}
}
impl Mul<Vec4> for f32 {
type Output = Vec4;
#[inline]
fn mul(self, rhs: Vec4) -> Vec4 {
Vec4 {
x: self.mul(rhs.x),
y: self.mul(rhs.y),
z: self.mul(rhs.z),
w: self.mul(rhs.w),
}
}
}
impl Add<Vec4> for Vec4 {
type Output = Self;
#[inline]
fn add(self, rhs: Self) -> Self {
Self {
x: self.x.add(rhs.x),
y: self.y.add(rhs.y),
z: self.z.add(rhs.z),
w: self.w.add(rhs.w),
}
}
}
impl AddAssign<Vec4> for Vec4 {
#[inline]
fn add_assign(&mut self, rhs: Self) {
self.x.add_assign(rhs.x);
self.y.add_assign(rhs.y);
self.z.add_assign(rhs.z);
self.w.add_assign(rhs.w);
}
}
impl Add<f32> for Vec4 {
type Output = Self;
#[inline]
fn add(self, rhs: f32) -> Self {
Self {
x: self.x.add(rhs),
y: self.y.add(rhs),
z: self.z.add(rhs),
w: self.w.add(rhs),
}
}
}
impl AddAssign<f32> for Vec4 {
#[inline]
fn add_assign(&mut self, rhs: f32) {
self.x.add_assign(rhs);
self.y.add_assign(rhs);
self.z.add_assign(rhs);
self.w.add_assign(rhs);
}
}
impl Add<Vec4> for f32 {
type Output = Vec4;
#[inline]
fn add(self, rhs: Vec4) -> Vec4 {
Vec4 {
x: self.add(rhs.x),
y: self.add(rhs.y),
z: self.add(rhs.z),
w: self.add(rhs.w),
}
}
}
impl Sub<Vec4> for Vec4 {
type Output = Self;
#[inline]
fn sub(self, rhs: Self) -> Self {
Self {
x: self.x.sub(rhs.x),
y: self.y.sub(rhs.y),
z: self.z.sub(rhs.z),
w: self.w.sub(rhs.w),
}
}
}
impl SubAssign<Vec4> for Vec4 {
#[inline]
fn sub_assign(&mut self, rhs: Vec4) {
self.x.sub_assign(rhs.x);
self.y.sub_assign(rhs.y);
self.z.sub_assign(rhs.z);
self.w.sub_assign(rhs.w);
}
}
impl Sub<f32> for Vec4 {
type Output = Self;
#[inline]
fn sub(self, rhs: f32) -> Self {
Self {
x: self.x.sub(rhs),
y: self.y.sub(rhs),
z: self.z.sub(rhs),
w: self.w.sub(rhs),
}
}
}
impl SubAssign<f32> for Vec4 {
#[inline]
fn sub_assign(&mut self, rhs: f32) {
self.x.sub_assign(rhs);
self.y.sub_assign(rhs);
self.z.sub_assign(rhs);
self.w.sub_assign(rhs);
}
}
impl Sub<Vec4> for f32 {
type Output = Vec4;
#[inline]
fn sub(self, rhs: Vec4) -> Vec4 {
Vec4 {
x: self.sub(rhs.x),
y: self.sub(rhs.y),
z: self.sub(rhs.z),
w: self.sub(rhs.w),
}
}
}
impl Rem<Vec4> for Vec4 {
type Output = Self;
#[inline]
fn rem(self, rhs: Self) -> Self {
Self {
x: self.x.rem(rhs.x),
y: self.y.rem(rhs.y),
z: self.z.rem(rhs.z),
w: self.w.rem(rhs.w),
}
}
}
impl RemAssign<Vec4> for Vec4 {
#[inline]
fn rem_assign(&mut self, rhs: Self) {
self.x.rem_assign(rhs.x);
self.y.rem_assign(rhs.y);
self.z.rem_assign(rhs.z);
self.w.rem_assign(rhs.w);
}
}
impl Rem<f32> for Vec4 {
type Output = Self;
#[inline]
fn rem(self, rhs: f32) -> Self {
Self {
x: self.x.rem(rhs),
y: self.y.rem(rhs),
z: self.z.rem(rhs),
w: self.w.rem(rhs),
}
}
}
impl RemAssign<f32> for Vec4 {
#[inline]
fn rem_assign(&mut self, rhs: f32) {
self.x.rem_assign(rhs);
self.y.rem_assign(rhs);
self.z.rem_assign(rhs);
self.w.rem_assign(rhs);
}
}
impl Rem<Vec4> for f32 {
type Output = Vec4;
#[inline]
fn rem(self, rhs: Vec4) -> Vec4 {
Vec4 {
x: self.rem(rhs.x),
y: self.rem(rhs.y),
z: self.rem(rhs.z),
w: self.rem(rhs.w),
}
}
}
#[cfg(not(target_arch = "spirv"))]
impl AsRef<[f32; 4]> for Vec4 {
#[inline]
fn as_ref(&self) -> &[f32; 4] {
unsafe { &*(self as *const Vec4 as *const [f32; 4]) }
}
}
#[cfg(not(target_arch = "spirv"))]
impl AsMut<[f32; 4]> for Vec4 {
#[inline]
fn as_mut(&mut self) -> &mut [f32; 4] {
unsafe { &mut *(self as *mut Vec4 as *mut [f32; 4]) }
}
}
impl Sum for Vec4 {
#[inline]
fn sum<I>(iter: I) -> Self
where
I: Iterator<Item = Self>,
{
iter.fold(Self::ZERO, Self::add)
}
}
impl<'a> Sum<&'a Self> for Vec4 {
#[inline]
fn sum<I>(iter: I) -> Self
where
I: Iterator<Item = &'a Self>,
{
iter.fold(Self::ZERO, |a, &b| Self::add(a, b))
}
}
impl Product for Vec4 {
#[inline]
fn product<I>(iter: I) -> Self
where
I: Iterator<Item = Self>,
{
iter.fold(Self::ONE, Self::mul)
}
}
impl<'a> Product<&'a Self> for Vec4 {
#[inline]
fn product<I>(iter: I) -> Self
where
I: Iterator<Item = &'a Self>,
{
iter.fold(Self::ONE, |a, &b| Self::mul(a, b))
}
}
impl Neg for Vec4 {
type Output = Self;
#[inline]
fn neg(self) -> Self {
Self {
x: self.x.neg(),
y: self.y.neg(),
z: self.z.neg(),
w: self.w.neg(),
}
}
}
impl Index<usize> for Vec4 {
type Output = f32;
#[inline]
fn index(&self, index: usize) -> &Self::Output {
match index {
0 => &self.x,
1 => &self.y,
2 => &self.z,
3 => &self.w,
_ => panic!("index out of bounds"),
}
}
}
impl IndexMut<usize> for Vec4 {
#[inline]
fn index_mut(&mut self, index: usize) -> &mut Self::Output {
match index {
0 => &mut self.x,
1 => &mut self.y,
2 => &mut self.z,
3 => &mut self.w,
_ => panic!("index out of bounds"),
}
}
}
#[cfg(not(target_arch = "spirv"))]
impl fmt::Display for Vec4 {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "[{}, {}, {}, {}]", self.x, self.y, self.z, self.w)
}
}
#[cfg(not(target_arch = "spirv"))]
impl fmt::Debug for Vec4 {
fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt.debug_tuple(stringify!(Vec4))
.field(&self.x)
.field(&self.y)
.field(&self.z)
.field(&self.w)
.finish()
}
}
impl From<[f32; 4]> for Vec4 {
#[inline]
fn from(a: [f32; 4]) -> Self {
Self::new(a[0], a[1], a[2], a[3])
}
}
impl From<Vec4> for [f32; 4] {
#[inline]
fn from(v: Vec4) -> Self {
[v.x, v.y, v.z, v.w]
}
}
impl From<(f32, f32, f32, f32)> for Vec4 {
#[inline]
fn from(t: (f32, f32, f32, f32)) -> Self {
Self::new(t.0, t.1, t.2, t.3)
}
}
impl From<Vec4> for (f32, f32, f32, f32) {
#[inline]
fn from(v: Vec4) -> Self {
(v.x, v.y, v.z, v.w)
}
}
impl From<(Vec3A, f32)> for Vec4 {
#[inline]
fn from((v, w): (Vec3A, f32)) -> Self {
v.extend(w)
}
}
impl From<(f32, Vec3A)> for Vec4 {
#[inline]
fn from((x, v): (f32, Vec3A)) -> Self {
Self::new(x, v.x, v.y, v.z)
}
}
impl From<(Vec3, f32)> for Vec4 {
#[inline]
fn from((v, w): (Vec3, f32)) -> Self {
Self::new(v.x, v.y, v.z, w)
}
}
impl From<(f32, Vec3)> for Vec4 {
#[inline]
fn from((x, v): (f32, Vec3)) -> Self {
Self::new(x, v.x, v.y, v.z)
}
}
impl From<(Vec2, f32, f32)> for Vec4 {
#[inline]
fn from((v, z, w): (Vec2, f32, f32)) -> Self {
Self::new(v.x, v.y, z, w)
}
}
impl From<(Vec2, Vec2)> for Vec4 {
#[inline]
fn from((v, u): (Vec2, Vec2)) -> Self {
Self::new(v.x, v.y, u.x, u.y)
}
}