// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::Matrix;
use crate::Point3D;
use crate::Vec3;
use crate::Vec4;
use glib::translate::*;

glib::wrapper! {
    /// A 2D plane that extends infinitely in a 3D volume.
    ///
    /// The contents of the `graphene_plane_t` are private, and should not be
    /// modified directly.
    #[derive(Debug, PartialOrd, Ord, Hash)]
    pub struct Plane(Boxed<ffi::graphene_plane_t>);

    match fn {
        copy => |ptr| glib::gobject_ffi::g_boxed_copy(ffi::graphene_plane_get_type(), ptr as *mut _) as *mut ffi::graphene_plane_t,
        free => |ptr| glib::gobject_ffi::g_boxed_free(ffi::graphene_plane_get_type(), ptr as *mut _),
        init => |_ptr| (),
        clear => |_ptr| (),
        type_ => || ffi::graphene_plane_get_type(),
    }
}

impl Plane {
    /// Computes the distance of `point` from a [`Plane`][crate::Plane].
    /// ## `point`
    /// a [`Point3D`][crate::Point3D]
    ///
    /// # Returns
    ///
    /// the distance of the given [`Point3D`][crate::Point3D] from the plane
    #[doc(alias = "graphene_plane_distance")]
    pub fn distance(&self, point: &Point3D) -> f32 {
        unsafe { ffi::graphene_plane_distance(self.to_glib_none().0, point.to_glib_none().0) }
    }

    /// Checks whether the two given [`Plane`][crate::Plane] are equal.
    /// ## `b`
    /// a [`Plane`][crate::Plane]
    ///
    /// # Returns
    ///
    /// `true` if the given planes are equal
    #[doc(alias = "graphene_plane_equal")]
    fn equal(&self, b: &Plane) -> bool {
        unsafe {
            from_glib(ffi::graphene_plane_equal(
                self.to_glib_none().0,
                b.to_glib_none().0,
            ))
        }
    }

    /// Retrieves the distance along the normal vector of the
    /// given [`Plane`][crate::Plane] from the origin.
    ///
    /// # Returns
    ///
    /// the constant value of the plane
    #[doc(alias = "graphene_plane_get_constant")]
    #[doc(alias = "get_constant")]
    pub fn constant(&self) -> f32 {
        unsafe { ffi::graphene_plane_get_constant(self.to_glib_none().0) }
    }

    /// Retrieves the normal vector pointing towards the origin of the
    /// given [`Plane`][crate::Plane].
    ///
    /// # Returns
    ///
    ///
    /// ## `normal`
    /// return location for the normal vector
    #[doc(alias = "graphene_plane_get_normal")]
    #[doc(alias = "get_normal")]
    pub fn normal(&self) -> Vec3 {
        unsafe {
            let mut normal = Vec3::uninitialized();
            ffi::graphene_plane_get_normal(self.to_glib_none().0, normal.to_glib_none_mut().0);
            normal
        }
    }

    /// Initializes the given [`Plane`][crate::Plane] using the given `normal` vector
    /// and `constant` values.
    /// ## `normal`
    /// a unit length normal vector defining the plane
    ///  pointing towards the origin; if unset, we use the X axis by default
    /// ## `constant`
    /// the distance from the origin to the plane along the
    ///  normal vector; the sign determines the half-space occupied by the
    ///  plane
    ///
    /// # Returns
    ///
    /// the initialized plane
    #[doc(alias = "graphene_plane_init")]
    pub fn init(&mut self, normal: Option<&Vec3>, constant: f32) {
        unsafe {
            ffi::graphene_plane_init(self.to_glib_none_mut().0, normal.to_glib_none().0, constant);
        }
    }

    /// Initializes the given [`Plane`][crate::Plane] using the normal
    /// vector and constant of another [`Plane`][crate::Plane].
    /// ## `src`
    /// a [`Plane`][crate::Plane]
    ///
    /// # Returns
    ///
    /// the initialized plane
    #[doc(alias = "graphene_plane_init_from_plane")]
    pub fn init_from_plane(&mut self, src: &Plane) {
        unsafe {
            ffi::graphene_plane_init_from_plane(self.to_glib_none_mut().0, src.to_glib_none().0);
        }
    }

    /// Initializes the given [`Plane`][crate::Plane] using the given normal vector
    /// and an arbitrary co-planar point.
    /// ## `normal`
    /// a normal vector defining the plane pointing towards the origin
    /// ## `point`
    /// a [`Point3D`][crate::Point3D]
    ///
    /// # Returns
    ///
    /// the initialized plane
    #[doc(alias = "graphene_plane_init_from_point")]
    pub fn init_from_point(&mut self, normal: &Vec3, point: &Point3D) {
        unsafe {
            ffi::graphene_plane_init_from_point(
                self.to_glib_none_mut().0,
                normal.to_glib_none().0,
                point.to_glib_none().0,
            );
        }
    }

    /// Initializes the given [`Plane`][crate::Plane] using the 3 provided co-planar
    /// points.
    ///
    /// The winding order is counter-clockwise, and determines which direction
    /// the normal vector will point.
    /// ## `a`
    /// a [`Point3D`][crate::Point3D]
    /// ## `b`
    /// a [`Point3D`][crate::Point3D]
    /// ## `c`
    /// a [`Point3D`][crate::Point3D]
    ///
    /// # Returns
    ///
    /// the initialized plane
    #[doc(alias = "graphene_plane_init_from_points")]
    pub fn init_from_points(&mut self, a: &Point3D, b: &Point3D, c: &Point3D) {
        unsafe {
            ffi::graphene_plane_init_from_points(
                self.to_glib_none_mut().0,
                a.to_glib_none().0,
                b.to_glib_none().0,
                c.to_glib_none().0,
            );
        }
    }

    /// Initializes the given [`Plane`][crate::Plane] using the components of
    /// the given [`Vec4`][crate::Vec4] vector.
    /// ## `src`
    /// a [`Vec4`][crate::Vec4] containing the normal vector in its first
    ///  three components, and the distance in its fourth component
    ///
    /// # Returns
    ///
    /// the initialized plane
    #[doc(alias = "graphene_plane_init_from_vec4")]
    pub fn init_from_vec4(&mut self, src: &Vec4) {
        unsafe {
            ffi::graphene_plane_init_from_vec4(self.to_glib_none_mut().0, src.to_glib_none().0);
        }
    }

    /// Negates the normal vector and constant of a [`Plane`][crate::Plane], effectively
    /// mirroring the plane across the origin.
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// return location for the negated plane
    #[doc(alias = "graphene_plane_negate")]
    pub fn negate(&self) -> Plane {
        unsafe {
            let mut res = Plane::uninitialized();
            ffi::graphene_plane_negate(self.to_glib_none().0, res.to_glib_none_mut().0);
            res
        }
    }

    /// Normalizes the vector of the given [`Plane`][crate::Plane],
    /// and adjusts the constant accordingly.
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// return location for the normalized plane
    #[doc(alias = "graphene_plane_normalize")]
    pub fn normalize(&self) -> Plane {
        unsafe {
            let mut res = Plane::uninitialized();
            ffi::graphene_plane_normalize(self.to_glib_none().0, res.to_glib_none_mut().0);
            res
        }
    }

    /// Transforms a [`Plane`][crate::Plane] `self` using the given `matrix`
    /// and `normal_matrix`.
    ///
    /// If `normal_matrix` is [`None`], a transformation matrix for the plane
    /// normal will be computed from `matrix`. If you are transforming
    /// multiple planes using the same `matrix` it's recommended to compute
    /// the normal matrix beforehand to avoid incurring in the cost of
    /// recomputing it every time.
    /// ## `matrix`
    /// a [`Matrix`][crate::Matrix]
    /// ## `normal_matrix`
    /// a [`Matrix`][crate::Matrix]
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// the transformed plane
    #[doc(alias = "graphene_plane_transform")]
    pub fn transform(&self, matrix: &Matrix, normal_matrix: Option<&Matrix>) -> Plane {
        unsafe {
            let mut res = Plane::uninitialized();
            ffi::graphene_plane_transform(
                self.to_glib_none().0,
                matrix.to_glib_none().0,
                normal_matrix.to_glib_none().0,
                res.to_glib_none_mut().0,
            );
            res
        }
    }
}

impl PartialEq for Plane {
    #[inline]
    fn eq(&self, other: &Self) -> bool {
        self.equal(other)
    }
}

impl Eq for Plane {}