glam_det 2.0.0

// Copyright (C) 2020-2025 glam-det authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Generated from vec.rs.tera template. Edit the template, not the generated file.

use crate::{BVec3, Vec3};

#[cfg(not(target_arch = "spirv"))]
use core::fmt;
use core::ops::*;

use crate::nums::*;

use auto_ops_det::{impl_op_ex, impl_op_ex_commutative};
use core::ops;

union VecUnionCast {
    v: Vec3,
    uv: UnitVec3,
}

impl Vec3 {
    #[inline]
    pub fn as_unit_vec3_unchecked(self) -> UnitVec3 {
        unsafe { VecUnionCast { v: self }.uv }
    }
}

impl UnitVec3 {
    #[inline]
    pub fn as_vec3(self) -> Vec3 {
        unsafe { VecUnionCast { uv: self }.v }
    }
}

/// A 3-dimensionalunit vector.
#[derive(Clone, Copy, PartialEq)]
#[cfg_attr(not(target_arch = "spirv"), repr(C))]
#[cfg_attr(target_arch = "spirv", repr(simd))]
pub struct UnitVec3 {
    pub x: f32,
    pub y: f32,
    pub z: f32,
}

impl UnitVec3 {
    /// A unit-length vector pointing along the positive X axis.
    pub const X: Self = Self::new_unchecked(1.0_f32, 0.0_f32, 0.0_f32);

    /// A unit-length vector pointing along the positive Y axis.
    pub const Y: Self = Self::new_unchecked(0.0_f32, 1.0_f32, 0.0_f32);

    /// A unit-length vector pointing along the positive Z axis.
    pub const Z: Self = Self::new_unchecked(0.0_f32, 0.0_f32, 1.0_f32);

    /// A unit-length vector pointing along the negative X axis.
    pub const NEG_X: Self = Self::new_unchecked(-1.0_f32, 0.0_f32, 0.0_f32);

    /// A unit-length vector pointing along the negative Y axis.
    pub const NEG_Y: Self = Self::new_unchecked(0.0_f32, -1.0_f32, 0.0_f32);

    /// A unit-length vector pointing along the negative Z axis.
    pub const NEG_Z: Self = Self::new_unchecked(0.0_f32, 0.0_f32, -1.0_f32);

    /// The unit axes.
    pub const AXES: [Self; 3] = [Self::X, Self::Y, Self::Z];

    /// Creates a new unit vector without checking if it is normalized.
    #[inline]
    pub const fn new_unchecked(x: f32, y: f32, z: f32) -> Self {
        Self { x, y, z }
    }

    /// Creates a new unit vector after normalizing the parameters.
    ///
    /// For valid results, vector represented by the parameters must _not_ be of length zero, nor very close to zero.
    ///
    /// See also [`Vec3::normalize`].
    ///
    /// # Panics
    ///
    /// Will panic if vector represented by the parameters is zero length when `glam_assert` is enabled.
    #[inline]
    pub fn new_normalized(x: f32, y: f32, z: f32) -> Self {
        Vec3::new(x, y, z).normalize().as_unit_vec3_unchecked()
    }

    /// 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`.
    #[inline]
    pub fn select(mask: BVec3, if_true: Self, if_false: Self) -> Vec3 {
        Vec3::select(mask, if_true.as_vec3(), if_false.as_vec3())
    }

    /// Creates a new vector from an array.
    #[inline]
    pub const fn from_array_unchecked(a: [f32; 3]) -> Self {
        Self::new_unchecked(a[0], a[1], a[2])
    }

    /// `[x, y, z]`
    #[inline]
    pub const fn to_array(&self) -> [f32; 3] {
        [self.x, self.y, self.z]
    }

    /// Creates a vector from the first 3 values in `slice`.
    ///
    /// # Panics
    ///
    /// Panics if `slice` is less than 3 elements long.
    #[inline]
    pub const fn from_slice_unchecked(slice: &[f32]) -> Self {
        Self::new_unchecked(slice[0], slice[1], slice[2])
    }

    /// Writes the elements of `self` to the first 3 elements in `slice`.
    ///
    /// # Panics
    ///
    /// Panics if `slice` is less than 3 elements long.
    #[inline]
    pub fn write_to_slice(self, slice: &mut [f32]) {
        slice[0] = self.x;
        slice[1] = self.y;
        slice[2] = self.z;
    }

    /// Computes the dot product of `self` and `rhs`.
    #[inline]
    pub(crate) fn dot(self, rhs: Self) -> f32 {
        self.as_vec3().dot(rhs.as_vec3())
    }

    /// Computes the cross product of `self` and `rhs`.
    #[inline]
    pub(crate) fn cross(self, rhs: Self) -> Vec3 {
        self.as_vec3().cross(rhs.as_vec3())
    }

    /// Returns the horizontal minimum of `self`.
    ///
    /// In other words this computes `min(x, y, ..)`.
    #[inline]
    pub fn min_element(self) -> f32 {
        self.as_vec3().min_element()
    }

    /// Returns the horizontal maximum of `self`.
    ///
    /// In other words this computes `max(x, y, ..)`.
    #[inline]
    pub fn max_element(self) -> f32 {
        self.as_vec3().max_element()
    }

    /// 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.
    #[inline]
    pub fn cmpeq(self, rhs: Self) -> BVec3 {
        self.as_vec3().cmpeq(rhs.as_vec3())
    }

    /// 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.
    #[inline]
    pub fn cmpne(self, rhs: Self) -> BVec3 {
        self.as_vec3().cmpne(rhs.as_vec3())
    }

    /// 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.
    #[inline]
    pub fn cmpge(self, rhs: Self) -> BVec3 {
        self.as_vec3().cmpge(rhs.as_vec3())
    }

    /// 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.
    #[inline]
    pub fn cmpgt(self, rhs: Self) -> BVec3 {
        self.as_vec3().cmpgt(rhs.as_vec3())
    }

    /// 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.
    #[inline]
    pub fn cmple(self, rhs: Self) -> BVec3 {
        self.as_vec3().cmple(rhs.as_vec3())
    }

    /// 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.
    #[inline]
    pub fn cmplt(self, rhs: Self) -> BVec3 {
        self.as_vec3().cmple(rhs.as_vec3())
    }

    /// Returns a vector containing the absolute value of each element of `self`.
    #[inline]
    pub fn abs(self) -> Self {
        self.as_vec3().abs().as_unit_vec3_unchecked()
    }

    /// Returns a vector with elements representing the sign of `self`.
    ///
    /// - `1.0` if the number is positive, `+0.0` or `INFINITY`
    /// - `-1.0` if the number is negative, `-0.0` or `NEG_INFINITY`
    /// - `NAN` if the number is `NAN`
    #[inline]
    pub fn signum(self) -> Vec3 {
        self.as_vec3().signum()
    }

    /// Computes the Euclidean distance between two points in space.
    #[inline]
    pub fn distance(self, rhs: Self) -> f32 {
        self.as_vec3().distance(rhs.as_vec3())
    }

    /// Compute the squared euclidean distance between two points in space.
    #[inline]
    pub fn distance_squared(self, rhs: Self) -> f32 {
        self.as_vec3().distance_squared(rhs.as_vec3())
    }

    /// Returns the vector projection of `self` onto `rhs`.
    #[must_use]
    #[inline]
    pub fn project_onto(self, rhs: Self) -> Vec3 {
        rhs.as_vec3() * self.dot(rhs)
    }

    /// Returns the vector rejection of `self` from `rhs`.
    #[must_use]
    #[inline]
    pub fn reject_from(self, rhs: Self) -> Vec3 {
        self.as_vec3() - self.project_onto(rhs)
    }

    /// 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.
    #[doc(alias = "mix")]
    #[inline]
    pub fn lerp(self, rhs: Self, s: f32) -> Vec3 {
        self.as_vec3().lerp(rhs.as_vec3(), s)
    }

    /// 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 depends on
    /// the values being compared against.
    ///
    /// For more see
    /// [comparing floating point numbers](https://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/).
    #[inline]
    pub fn abs_diff_eq(self, rhs: Self, max_abs_diff: f32) -> bool {
        Vec3::abs_diff_eq(self.as_vec3(), rhs.as_vec3(), max_abs_diff)
    }

    /// 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.
    #[inline]
    pub fn mul_add(self, a: Self, b: Self) -> Vec3 {
        self.as_vec3().mul_add(a.as_vec3(), b.as_vec3())
    }

    /// Returns the angle (in radians) between two vectors.
    #[inline]
    pub fn angle_between(self, rhs: Self) -> f32 {
        use crate::FloatEx;
        self.dot(rhs).acos_approx()
    }

    /// Returns someunit vector that is orthogonal to the given one.
    #[inline]
    pub fn any_orthogonal_vector(&self) -> Self {
        // From https://graphics.pixar.com/library/OrthonormalB/paper.pdf
        let sign = 1.0_f32.copysignf(self.z);
        let a = -1.0_f32 / (sign + self.z);
        let b = self.x * self.y * a;
        Self::new_unchecked(b, sign + self.y * self.y * a, -self.y)
    }

    /// 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.
    #[inline]
    pub fn any_orthogonal_pair(&self) -> (Self, Self) {
        // From https://graphics.pixar.com/library/OrthonormalB/paper.pdf
        let sign = 1.0_f32.copysignf(self.z);
        let a = -1.0_f32 / (sign + self.z);
        let b = self.x * self.y * a;
        (
            Self::new_unchecked(
                1.0_f32 + sign * self.x * self.x * a,
                sign * b,
                -sign * self.x,
            ),
            Self::new_unchecked(b, sign + self.y * self.y * a, -self.y),
        )
    }
}

impl Default for UnitVec3 {
    #[inline]
    fn default() -> Self {
        Self::X
    }
}

impl Neg for UnitVec3 {
    type Output = Self;
    #[inline]
    fn neg(self) -> Self {
        self.as_vec3().neg().as_unit_vec3_unchecked()
    }
}

impl_op_ex!(/ |a: &UnitVec3, b: &UnitVec3| -> Vec3 {
    a.as_vec3() / b.as_vec3()
});

impl_op_ex!(/ |a: &UnitVec3, b: &f32| -> Vec3 {
    a.as_vec3() / b
});

impl_op_ex!(/ |a: &f32, b: &UnitVec3| -> Vec3 {
    a / b.as_vec3()
});

impl_op_ex_commutative!(/ |a: &UnitVec3, b: &Vec3| -> Vec3 {
    a.as_vec3() / b
});

impl_op_ex!(*|a: &UnitVec3, b: &UnitVec3| -> Vec3 { a.as_vec3() * b.as_vec3() });

impl_op_ex!(*|a: &UnitVec3, b: &f32| -> Vec3 { a.as_vec3() * b });

impl_op_ex!(*|a: &f32, b: &UnitVec3| -> Vec3 { a * b.as_vec3() });

impl_op_ex_commutative!(*|a: &UnitVec3, b: &Vec3| -> Vec3 { a.as_vec3() * b });

impl_op_ex!(+ |a: &UnitVec3, b: &UnitVec3| -> Vec3 {
    a.as_vec3() + b.as_vec3()
});

impl_op_ex!(+ |a: &UnitVec3, b: &f32| -> Vec3 {
    a.as_vec3() + b
});

impl_op_ex!(+ |a: &f32, b: &UnitVec3| -> Vec3 {
    a + b.as_vec3()
});

impl_op_ex_commutative!(+ |a: &UnitVec3, b: &Vec3| -> Vec3 {
    a.as_vec3() + b
});

impl_op_ex!(-|a: &UnitVec3, b: &UnitVec3| -> Vec3 { a.as_vec3() - b.as_vec3() });

impl_op_ex!(-|a: &UnitVec3, b: &f32| -> Vec3 { a.as_vec3() - b });

impl_op_ex!(-|a: &f32, b: &UnitVec3| -> Vec3 { a - b.as_vec3() });

impl_op_ex_commutative!(-|a: &UnitVec3, b: &Vec3| -> Vec3 { a.as_vec3() - b });

impl_op_ex!(% |a: &UnitVec3, b: &UnitVec3| -> Vec3 {
    a.as_vec3() % b.as_vec3()
});

impl_op_ex!(% |a: &UnitVec3, b: &f32| -> Vec3 {
    a.as_vec3() % b
});

impl_op_ex!(% |a: &f32, b: &UnitVec3| -> Vec3 {
    a % b.as_vec3()
});

impl_op_ex_commutative!(% |a: &UnitVec3, b: &Vec3| -> Vec3 {
    a.as_vec3() % b
});

impl Index<usize> for UnitVec3 {
    type Output = f32;
    #[inline]
    fn index(&self, index: usize) -> &Self::Output {
        match index {
            0 => &self.x,
            1 => &self.y,
            2 => &self.z,
            _ => panic!("index out of bounds"),
        }
    }
}

#[cfg(not(target_arch = "spirv"))]
impl fmt::Display for UnitVec3 {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "[{}, {}, {}]", self.x, self.y, self.z)
    }
}

#[cfg(not(target_arch = "spirv"))]
impl fmt::Debug for UnitVec3 {
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
        fmt.debug_tuple(stringify!(UnitVec3))
            .field(&self.x)
            .field(&self.y)
            .field(&self.z)
            .finish()
    }
}

impl From<UnitVec3> for [f32; 3] {
    #[inline]
    fn from(v: UnitVec3) -> Self {
        v.as_vec3().into()
    }
}

impl From<UnitVec3> for (f32, f32, f32) {
    #[inline]
    fn from(v: UnitVec3) -> Self {
        v.as_vec3().into()
    }
}

#[cfg(not(target_arch = "spirv"))]
impl AsRef<[f32; 3]> for UnitVec3 {
    #[inline]
    fn as_ref(&self) -> &[f32; 3] {
        unsafe { &*(self as *const UnitVec3 as *const [f32; 3]) }
    }
}