graphene/auto/

triangle.rs

// 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::{ffi, Box, Plane, Point3D, Vec2, Vec3};
use glib::translate::*;

glib::wrapper! {
    /// A triangle.
    pub struct Triangle(BoxedInline<ffi::graphene_triangle_t>);

    match fn {
        copy => |ptr| glib::gobject_ffi::g_boxed_copy(ffi::graphene_triangle_get_type(), ptr as *mut _) as *mut ffi::graphene_triangle_t,
        free => |ptr| glib::gobject_ffi::g_boxed_free(ffi::graphene_triangle_get_type(), ptr as *mut _),
        type_ => || ffi::graphene_triangle_get_type(),
    }
}

impl Triangle {
    /// Checks whether the given triangle `self` contains the point `p`.
    /// ## `p`
    /// a [`Point3D`][crate::Point3D]
    ///
    /// # Returns
    ///
    /// `true` if the point is inside the triangle
    #[doc(alias = "graphene_triangle_contains_point")]
    pub fn contains_point(&self, p: &Point3D) -> bool {
        unsafe { ffi::graphene_triangle_contains_point(self.to_glib_none().0, p.to_glib_none().0) }
    }

    #[doc(alias = "graphene_triangle_equal")]
    fn equal(&self, b: &Triangle) -> bool {
        unsafe { ffi::graphene_triangle_equal(self.to_glib_none().0, b.to_glib_none().0) }
    }

    /// Computes the area of the given [`Triangle`][crate::Triangle].
    ///
    /// # Returns
    ///
    /// the area of the triangle
    #[doc(alias = "graphene_triangle_get_area")]
    #[doc(alias = "get_area")]
    pub fn area(&self) -> f32 {
        unsafe { ffi::graphene_triangle_get_area(self.to_glib_none().0) }
    }

    /// Computes the [barycentric coordinates](http://en.wikipedia.org/wiki/Barycentric_coordinate_system)
    /// of the given point `p`.
    ///
    /// The point `p` must lie on the same plane as the triangle `self`; if the
    /// point is not coplanar, the result of this function is undefined.
    ///
    /// If we place the origin in the coordinates of the triangle's A point,
    /// the barycentric coordinates are `u`, which is on the AC vector; and `v`
    /// which is on the AB vector:
    ///
    /// ![](triangle-barycentric.png)
    ///
    /// The returned [`Vec2`][crate::Vec2] contains the following values, in order:
    ///
    ///  - `res.x = u`
    ///  - `res.y = v`
    /// ## `p`
    /// a [`Point3D`][crate::Point3D]
    ///
    /// # Returns
    ///
    /// `true` if the barycentric coordinates are valid
    ///
    /// ## `res`
    /// return location for the vector
    ///  with the barycentric coordinates
    #[doc(alias = "graphene_triangle_get_barycoords")]
    #[doc(alias = "get_barycoords")]
    pub fn barycoords(&self, p: Option<&Point3D>) -> Option<Vec2> {
        unsafe {
            let mut res = Vec2::uninitialized();
            let ret = ffi::graphene_triangle_get_barycoords(
                self.to_glib_none().0,
                p.to_glib_none().0,
                res.to_glib_none_mut().0,
            );
            if ret {
                Some(res)
            } else {
                None
            }
        }
    }

    /// Computes the bounding box of the given [`Triangle`][crate::Triangle].
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// return location for the box
    #[doc(alias = "graphene_triangle_get_bounding_box")]
    #[doc(alias = "get_bounding_box")]
    pub fn bounding_box(&self) -> Box {
        unsafe {
            let mut res = Box::uninitialized();
            ffi::graphene_triangle_get_bounding_box(
                self.to_glib_none().0,
                res.to_glib_none_mut().0,
            );
            res
        }
    }

    /// Computes the coordinates of the midpoint of the given [`Triangle`][crate::Triangle].
    ///
    /// The midpoint G is the [centroid](https://en.wikipedia.org/wiki/Centroid`Triangle_centroid`)
    /// of the triangle, i.e. the intersection of its medians.
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// return location for the coordinates of
    ///  the midpoint
    #[doc(alias = "graphene_triangle_get_midpoint")]
    #[doc(alias = "get_midpoint")]
    pub fn midpoint(&self) -> Point3D {
        unsafe {
            let mut res = Point3D::uninitialized();
            ffi::graphene_triangle_get_midpoint(self.to_glib_none().0, res.to_glib_none_mut().0);
            res
        }
    }

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

    /// Computes the plane based on the vertices of the given [`Triangle`][crate::Triangle].
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// return location for the plane
    #[doc(alias = "graphene_triangle_get_plane")]
    #[doc(alias = "get_plane")]
    pub fn plane(&self) -> Plane {
        unsafe {
            let mut res = Plane::uninitialized();
            ffi::graphene_triangle_get_plane(self.to_glib_none().0, res.to_glib_none_mut().0);
            res
        }
    }

    /// Retrieves the three vertices of the given [`Triangle`][crate::Triangle] and returns
    /// their coordinates as [`Point3D`][crate::Point3D].
    ///
    /// # Returns
    ///
    ///
    /// ## `a`
    /// return location for the coordinates
    ///  of the first vertex
    ///
    /// ## `b`
    /// return location for the coordinates
    ///  of the second vertex
    ///
    /// ## `c`
    /// return location for the coordinates
    ///  of the third vertex
    #[doc(alias = "graphene_triangle_get_points")]
    #[doc(alias = "get_points")]
    pub fn points(&self) -> (Point3D, Point3D, Point3D) {
        unsafe {
            let mut a = Point3D::uninitialized();
            let mut b = Point3D::uninitialized();
            let mut c = Point3D::uninitialized();
            ffi::graphene_triangle_get_points(
                self.to_glib_none().0,
                a.to_glib_none_mut().0,
                b.to_glib_none_mut().0,
                c.to_glib_none_mut().0,
            );
            (a, b, c)
        }
    }

    /// Computes the UV coordinates of the given point `p`.
    ///
    /// The point `p` must lie on the same plane as the triangle `self`; if the point
    /// is not coplanar, the result of this function is undefined. If `p` is [`None`],
    /// the point will be set in (0, 0, 0).
    ///
    /// The UV coordinates will be placed in the `res` vector:
    ///
    ///  - `res.x = u`
    ///  - `res.y = v`
    ///
    /// See also: [`barycoords()`][Self::barycoords()]
    /// ## `p`
    /// a [`Point3D`][crate::Point3D]
    /// ## `uv_a`
    /// the UV coordinates of the first point
    /// ## `uv_b`
    /// the UV coordinates of the second point
    /// ## `uv_c`
    /// the UV coordinates of the third point
    ///
    /// # Returns
    ///
    /// `true` if the coordinates are valid
    ///
    /// ## `res`
    /// a vector containing the UV coordinates
    ///  of the given point `p`
    #[doc(alias = "graphene_triangle_get_uv")]
    #[doc(alias = "get_uv")]
    pub fn uv(&self, p: Option<&Point3D>, uv_a: &Vec2, uv_b: &Vec2, uv_c: &Vec2) -> Option<Vec2> {
        unsafe {
            let mut res = Vec2::uninitialized();
            let ret = ffi::graphene_triangle_get_uv(
                self.to_glib_none().0,
                p.to_glib_none().0,
                uv_a.to_glib_none().0,
                uv_b.to_glib_none().0,
                uv_c.to_glib_none().0,
                res.to_glib_none_mut().0,
            );
            if ret {
                Some(res)
            } else {
                None
            }
        }
    }

    /// Retrieves the three vertices of the given [`Triangle`][crate::Triangle].
    ///
    /// # Returns
    ///
    ///
    /// ## `a`
    /// return location for the first vertex
    ///
    /// ## `b`
    /// return location for the second vertex
    ///
    /// ## `c`
    /// return location for the third vertex
    #[doc(alias = "graphene_triangle_get_vertices")]
    #[doc(alias = "get_vertices")]
    pub fn vertices(&self) -> (Vec3, Vec3, Vec3) {
        unsafe {
            let mut a = Vec3::uninitialized();
            let mut b = Vec3::uninitialized();
            let mut c = Vec3::uninitialized();
            ffi::graphene_triangle_get_vertices(
                self.to_glib_none().0,
                a.to_glib_none_mut().0,
                b.to_glib_none_mut().0,
                c.to_glib_none_mut().0,
            );
            (a, b, c)
        }
    }
}

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

impl Eq for Triangle {}