glam_det 2.0.0-beta.2

// 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 affine.rs.tera template. Edit the template, not the generated file.

use crate::{
    nums::{bool32x4, f32x4, num_traits::*},
    Affine2, Mat2x4, Mat3x4, Point2x4, Vec2x4,
};
use auto_ops_det::{impl_op_ex, impl_op_ex_commutative};
use core::ops::{self, Deref, DerefMut};

/// A 2D affine transform, which can represent translation, rotation, scaling and shear.
#[derive(Copy, Clone)]
#[repr(C)]
pub struct Affine2x4 {
    pub matrix2: Mat2x4,
    pub translation: Vec2x4,
}

impl Affine2x4 {
    /// The degenerate zero transform.
    ///
    /// This transforms any finite vector and point to zero.
    /// The zero transform is non-invertible.
    pub const ZERO: Self = Self {
        matrix2: Mat2x4::ZERO,
        translation: Vec2x4::ZERO,
    };

    /// The identity transform.
    ///
    /// Multiplying a vector with this returns the same vector.
    pub const IDENTITY: Self = Self {
        matrix2: Mat2x4::IDENTITY,
        translation: Vec2x4::ZERO,
    };

    /// Select lanes from two SOA `Affine2x4` to compose a new SOA `Affine2x4`.
    #[inline]
    pub fn lane_select(cond: bool32x4, if_true: Self, if_false: Self) -> Self {
        Self {
            matrix2: Mat2x4::lane_select(cond, if_true.matrix2, if_false.matrix2),
            translation: Vec2x4::lane_select(cond, if_true.translation, if_false.translation),
        }
    }

    /// Create a SOA `Affine2x4` with all lanes set to `m`.
    #[inline]
    pub fn splat_soa(m: Affine2) -> Self {
        Self {
            matrix2: Mat2x4::splat_soa(m.matrix2),
            translation: Vec2x4::splat_soa(m.translation),
        }
    }

    /// Extract a single lane from a SOA `Affine2x4`.
    ///
    /// # Panics
    ///
    /// Panics if `i` is larger than 3.
    #[inline]
    pub fn extract_lane(&self, i: usize) -> Affine2 {
        Affine2 {
            matrix2: self.matrix2.extract_lane(i),
            translation: self.translation.extract_lane(i),
        }
    }

    /// Replace a single lane in a SOA `Affine2x4`.
    ///
    /// # Panics
    ///
    /// Panics if `i` is larger than 3.
    #[inline]
    pub fn replace_lane(&mut self, i: usize, m: Affine2) {
        self.matrix2.replace_lane(i, m.matrix2);
        self.translation.replace_lane(i, m.translation);
    }

    /// Split a SOA `Affine2x4` into 4 `Affine2`.
    #[inline]
    pub fn split_soa(self) -> [Affine2; 4] {
        [
            self.extract_lane(0),
            self.extract_lane(1),
            self.extract_lane(2),
            self.extract_lane(3),
        ]
    }

    /// Compose a SOA `Affine2x4` from 4 `Affine2`.
    #[inline]
    pub fn compose_soa(a: &[Affine2; 4]) -> Affine2x4 {
        let mut v = Self::default();
        v.replace_lane(0, a[0]);
        v.replace_lane(1, a[1]);
        v.replace_lane(2, a[2]);
        v.replace_lane(3, a[3]);
        v
    }

    /// All NAN:s.
    pub const NAN: Self = Self {
        matrix2: Mat2x4::NAN,
        translation: Vec2x4::NAN,
    };

    /// Creates an affine transform from three column vectors.
    #[inline]
    pub const fn from_cols(x_axis: Vec2x4, y_axis: Vec2x4, z_axis: Vec2x4) -> Self {
        Self {
            matrix2: Mat2x4::from_cols(x_axis, y_axis),
            translation: z_axis,
        }
    }

    /// Creates an affine transform from a `[f32x4; 6]` array stored in column major order.
    #[inline]
    pub fn from_cols_array(m: &[f32x4; 6]) -> Self {
        Self {
            matrix2: Mat2x4::from_cols_slice(&m[0..4]),
            translation: Vec2x4::from_slice(&m[4..6]),
        }
    }

    /// Creates a `[f32x4; 6]` array storing data in column major order.
    #[inline]
    pub fn to_cols_array(&self) -> [f32x4; 6] {
        let x = &self.matrix2.x_axis;
        let y = &self.matrix2.y_axis;
        let z = &self.translation;
        [x.x, x.y, y.x, y.y, z.x, z.y]
    }

    /// Creates an affine transform from a `[[f32x4; 2]; 3]`
    /// 2D array stored in column major order.
    /// If your data is in row major order you will need to `transpose` the returned
    /// matrix.
    #[inline]
    pub fn from_cols_array_2d(m: &[[f32x4; 2]; 3]) -> Self {
        Self {
            matrix2: Mat2x4::from_cols(m[0].into(), m[1].into()),
            translation: m[2].into(),
        }
    }

    /// Creates a `[[f32x4; 2]; 3]` 2D array storing data in
    /// column major order.
    /// If you require data in row major order `transpose` the matrix first.
    #[inline]
    pub fn to_cols_array_2d(&self) -> [[f32x4; 2]; 3] {
        [
            self.matrix2.x_axis.into(),
            self.matrix2.y_axis.into(),
            self.translation.into(),
        ]
    }

    /// Creates an affine transform from the first 6 values in `slice`.
    ///
    /// # Panics
    ///
    /// Panics if `slice` is less than 6 elements long.
    #[inline]
    pub fn from_cols_slice(slice: &[f32x4]) -> Self {
        Self {
            matrix2: Mat2x4::from_cols_slice(&slice[0..4]),
            translation: Vec2x4::from_slice(&slice[4..6]),
        }
    }

    /// Writes the columns of `self` to the first 6 elements in `slice`.
    ///
    /// # Panics
    ///
    /// Panics if `slice` is less than 6 elements long.
    #[inline]
    pub fn write_cols_to_slice(self, slice: &mut [f32x4]) {
        self.matrix2.write_cols_to_slice(&mut slice[0..4]);
        self.translation.write_to_slice(&mut slice[4..6]);
    }

    /// Creates an affine transform that changes scale.
    /// Note that if any scale is zero the transform will be non-invertible.
    #[inline]
    pub fn from_scale(scale: Vec2x4) -> Self {
        Self {
            matrix2: Mat2x4::from_diagonal(scale),
            translation: Vec2x4::ZERO,
        }
    }

    /// Creates an affine transform from the given rotation `angle`.
    #[inline]
    pub fn from_angle(angle: f32x4) -> Self {
        Self {
            matrix2: Mat2x4::from_angle(angle),
            translation: Vec2x4::ZERO,
        }
    }

    /// Creates an affine transformation from the given 2D `translation`.
    #[inline]
    pub fn from_translation(translation: Vec2x4) -> Self {
        Self {
            matrix2: Mat2x4::IDENTITY,
            translation,
        }
    }

    /// Creates an affine transform from a 2x2 matrix (expressing scale, shear and rotation)
    #[inline]
    pub fn from_mat2(matrix2: Mat2x4) -> Self {
        Self {
            matrix2,
            translation: Vec2x4::ZERO,
        }
    }

    /// Creates an affine transform from a 2x2 matrix (expressing scale, shear and rotation) and a
    /// translation vector.
    ///
    /// Equivalent to
    /// `Affine2x4::from_translation(translation) * Affine2x4::from_mat2(mat2)`
    #[inline]
    pub fn from_mat2_translation(matrix2: Mat2x4, translation: Vec2x4) -> Self {
        Self {
            matrix2,
            translation,
        }
    }

    /// Creates an affine transform from the given 2D `scale`, rotation `angle` (in radians) and
    /// `translation`.
    ///
    /// Equivalent to `Affine2x4::from_translation(translation) *
    /// Affine2x4::from_angle(angle) * Affine2x4::from_scale(scale)`
    #[inline]
    pub fn from_scale_angle_translation(scale: Vec2x4, angle: f32x4, translation: Vec2x4) -> Self {
        let rotation = Mat2x4::from_angle(angle);
        Self {
            matrix2: Mat2x4::from_cols(rotation.x_axis * scale.x, rotation.y_axis * scale.y),
            translation,
        }
    }

    /// Creates an affine transform from the given 2D rotation `angle` (in radians) and
    /// `translation`.
    ///
    /// Equivalent to `Affine2x4::from_translation(translation) * Affine2x4::from_angle(angle)`
    #[inline]
    pub fn from_angle_translation(angle: f32x4, translation: Vec2x4) -> Self {
        Self {
            matrix2: Mat2x4::from_angle(angle),
            translation,
        }
    }

    /// The given `Mat3x4` must be an affine transform,
    #[inline]
    pub fn from_mat3(m: Mat3x4) -> Self {
        use crate::swizzles::Vec3Swizzles;
        Self {
            matrix2: Mat2x4::from_cols(m.x_axis.xy(), m.y_axis.xy()),
            translation: m.z_axis.xy(),
        }
    }

    /// Transforms the given 2D point, applying shear, scale, rotation and translation.
    #[inline]
    pub fn transform_point2(&self, rhs: Point2x4) -> Point2x4 {
        Point2x4(self.matrix2 * rhs.0 + self.translation)
    }

    /// Transforms the given 2D vector, applying shear, scale and rotation (but NOT
    /// translation).
    ///
    /// To also apply translation, use [`Self::transform_point2`] instead.
    #[inline]
    pub fn transform_vector2(&self, rhs: Vec2x4) -> Vec2x4 {
        self.matrix2 * rhs
    }

    /// Returns `true` if, and only if, all elements are finite.
    ///
    /// If any element is either `NaN`, positive or negative infinity, this will return
    /// `false`.
    #[inline]
    pub fn is_finite(&self) -> bool32x4 {
        self.matrix2.is_finite() & self.translation.is_finite()
    }

    /// Returns `true` if any elements are `NaN`.
    #[inline]
    pub fn is_nan(&self) -> bool32x4 {
        self.matrix2.is_nan() | self.translation.is_nan()
    }

    /// Returns true if the absolute difference of all elements between `self` and `rhs`
    /// is less than or equal to `max_abs_diff`.
    ///
    /// 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: f32x4) -> bool32x4 {
        self.matrix2.abs_diff_eq(rhs.matrix2, max_abs_diff)
            & self.translation.abs_diff_eq(rhs.translation, max_abs_diff)
    }

    /// Return the inverse of this transform.
    ///
    /// Note that if the transform is not invertible the result will be invalid.
    #[must_use]
    #[inline]
    pub fn inverse(&self) -> Self {
        let matrix2 = self.matrix2.inverse();
        // transform negative translation by the matrix inverse:
        let translation = -(matrix2 * self.translation);

        Self {
            matrix2,
            translation,
        }
    }
}

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

impl Deref for Affine2x4 {
    type Target = crate::deref::Cols3<Vec2x4>;
    #[inline]
    fn deref(&self) -> &Self::Target {
        unsafe { &*(self as *const Self as *const Self::Target) }
    }
}

impl DerefMut for Affine2x4 {
    #[inline]
    fn deref_mut(&mut self) -> &mut Self::Target {
        unsafe { &mut *(self as *mut Self as *mut Self::Target) }
    }
}

impl PartialEq for Affine2x4 {
    #[inline]
    fn eq(&self, rhs: &Self) -> bool {
        self.matrix2.eq(&rhs.matrix2) && self.translation.eq(&rhs.translation)
    }
}

#[cfg(not(target_arch = "spirv"))]
impl core::fmt::Debug for Affine2x4 {
    fn fmt(&self, fmt: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        fmt.debug_struct(stringify!(Affine2x4))
            .field("matrix2", &self.matrix2)
            .field("translation", &self.translation)
            .finish()
    }
}

#[cfg(not(target_arch = "spirv"))]
impl core::fmt::Display for Affine2x4 {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(
            f,
            "[{}, {}, {}]",
            self.matrix2.x_axis, self.matrix2.y_axis, self.translation
        )
    }
}

impl<'a> core::iter::Product<&'a Self> for Affine2x4 {
    fn product<I>(iter: I) -> Self
    where
        I: Iterator<Item = &'a Self>,
    {
        iter.fold(Self::IDENTITY, |a, &b| a * b)
    }
}

impl_op_ex!(*|a: &Affine2x4, b: &Affine2x4| -> Affine2x4 {
    Affine2x4 {
        matrix2: a.matrix2 * b.matrix2,
        translation: a.matrix2 * b.translation + a.translation,
    }
});

impl_op_ex_commutative!(*|a: &Affine2x4, b: f32x4| -> Affine2x4 {
    Affine2x4 {
        matrix2: a.matrix2 * b,
        translation: a.translation * b,
    }
});

impl_op_ex!(+ |a: &Affine2x4, b: &Affine2x4| -> Affine2x4 {
    Affine2x4 {
        matrix2: a.matrix2 + b.matrix2,
        translation: a.translation + b.translation,
    }
});

impl_op_ex!(-|a: &Affine2x4, b: &Affine2x4| -> Affine2x4 {
    Affine2x4 {
        matrix2: a.matrix2 - b.matrix2,
        translation: a.translation - b.translation,
    }
});

impl From<Affine2x4> for Mat3x4 {
    #[inline]
    fn from(m: Affine2x4) -> Mat3x4 {
        Self::from_cols(
            m.matrix2.x_axis.extend(f32x4::ZERO),
            m.matrix2.y_axis.extend(f32x4::ZERO),
            m.translation.extend(f32x4::ONE),
        )
    }
}

impl From<&Affine2x4> for Mat3x4 {
    #[inline]
    fn from(m: &Affine2x4) -> Mat3x4 {
        Self::from_cols(
            m.matrix2.x_axis.extend(f32x4::ZERO),
            m.matrix2.y_axis.extend(f32x4::ZERO),
            m.translation.extend(f32x4::ONE),
        )
    }
}

impl_op_ex!(*|a: &Affine2x4, b: &Mat3x4| -> Mat3x4 { Mat3x4::from(a) * b });
impl_op_ex!(*|a: &Mat3x4, b: &Affine2x4| -> Mat3x4 { a * Mat3x4::from(b) });
impl_op_ex!(*|a: &Affine2x4, b: &Vec2x4| -> Vec2x4 { a.matrix2 * b });
impl_op_ex!(*|a: &Affine2x4, b: &Point2x4| -> Point2x4 { a.transform_point2(*b) });