graphene/auto/

point3_d.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, Rect, Vec3};
use glib::translate::*;

glib::wrapper! {
    /// A point with three components: X, Y, and Z.
    pub struct Point3D(BoxedInline<ffi::graphene_point3d_t>);

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

impl Point3D {
    /// Computes the cross product of the two given [`Point3D`][crate::Point3D].
    /// ## `b`
    /// a [`Point3D`][crate::Point3D]
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// return location for the cross
    ///  product
    #[doc(alias = "graphene_point3d_cross")]
    #[must_use]
    pub fn cross(&self, b: &Point3D) -> Point3D {
        unsafe {
            let mut res = Point3D::uninitialized();
            ffi::graphene_point3d_cross(
                self.to_glib_none().0,
                b.to_glib_none().0,
                res.to_glib_none_mut().0,
            );
            res
        }
    }

    /// Computes the distance between the two given [`Point3D`][crate::Point3D].
    /// ## `b`
    /// a [`Point3D`][crate::Point3D]
    ///
    /// # Returns
    ///
    /// the distance between two points
    ///
    /// ## `delta`
    /// return location for the distance
    ///  components on the X, Y, and Z axis
    #[doc(alias = "graphene_point3d_distance")]
    pub fn distance(&self, b: &Point3D) -> (f32, Vec3) {
        unsafe {
            let mut delta = Vec3::uninitialized();
            let ret = ffi::graphene_point3d_distance(
                self.to_glib_none().0,
                b.to_glib_none().0,
                delta.to_glib_none_mut().0,
            );
            (ret, delta)
        }
    }

    /// Computes the dot product of the two given [`Point3D`][crate::Point3D].
    /// ## `b`
    /// a [`Point3D`][crate::Point3D]
    ///
    /// # Returns
    ///
    /// the value of the dot product
    #[doc(alias = "graphene_point3d_dot")]
    pub fn dot(&self, b: &Point3D) -> f32 {
        unsafe { ffi::graphene_point3d_dot(self.to_glib_none().0, b.to_glib_none().0) }
    }

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

    /// Linearly interpolates each component of `self` and `b` using the
    /// provided `factor`, and places the result in `res`.
    /// ## `b`
    /// a [`Point3D`][crate::Point3D]
    /// ## `factor`
    /// the interpolation factor
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// the return location for the
    ///  interpolated [`Point3D`][crate::Point3D]
    #[doc(alias = "graphene_point3d_interpolate")]
    #[must_use]
    pub fn interpolate(&self, b: &Point3D, factor: f64) -> Point3D {
        unsafe {
            let mut res = Point3D::uninitialized();
            ffi::graphene_point3d_interpolate(
                self.to_glib_none().0,
                b.to_glib_none().0,
                factor,
                res.to_glib_none_mut().0,
            );
            res
        }
    }

    /// Computes the length of the vector represented by the
    /// coordinates of the given [`Point3D`][crate::Point3D].
    ///
    /// # Returns
    ///
    /// the length of the vector represented by the point
    #[doc(alias = "graphene_point3d_length")]
    pub fn length(&self) -> f32 {
        unsafe { ffi::graphene_point3d_length(self.to_glib_none().0) }
    }

    /// Checks whether the two points are near each other, within
    /// an `epsilon` factor.
    /// ## `b`
    /// a [`Point3D`][crate::Point3D]
    /// ## `epsilon`
    /// fuzzyness factor
    ///
    /// # Returns
    ///
    /// `true` if the points are near each other
    #[doc(alias = "graphene_point3d_near")]
    pub fn near(&self, b: &Point3D, epsilon: f32) -> bool {
        unsafe { ffi::graphene_point3d_near(self.to_glib_none().0, b.to_glib_none().0, epsilon) }
    }

    /// Computes the normalization of the vector represented by the
    /// coordinates of the given [`Point3D`][crate::Point3D].
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// return location for the normalized
    ///  [`Point3D`][crate::Point3D]
    #[doc(alias = "graphene_point3d_normalize")]
    #[must_use]
    pub fn normalize(&self) -> Point3D {
        unsafe {
            let mut res = Point3D::uninitialized();
            ffi::graphene_point3d_normalize(self.to_glib_none().0, res.to_glib_none_mut().0);
            res
        }
    }

    /// Normalizes the coordinates of a [`Point3D`][crate::Point3D] using the
    /// given viewport and clipping planes.
    ///
    /// The coordinates of the resulting [`Point3D`][crate::Point3D] will be
    /// in the [ -1, 1 ] range.
    /// ## `viewport`
    /// a [`Rect`][crate::Rect] representing a viewport
    /// ## `z_near`
    /// the coordinate of the near clipping plane, or 0 for
    ///  the default near clipping plane
    /// ## `z_far`
    /// the coordinate of the far clipping plane, or 1 for the
    ///  default far clipping plane
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// the return location for the
    ///  normalized [`Point3D`][crate::Point3D]
    #[doc(alias = "graphene_point3d_normalize_viewport")]
    #[must_use]
    pub fn normalize_viewport(&self, viewport: &Rect, z_near: f32, z_far: f32) -> Point3D {
        unsafe {
            let mut res = Point3D::uninitialized();
            ffi::graphene_point3d_normalize_viewport(
                self.to_glib_none().0,
                viewport.to_glib_none().0,
                z_near,
                z_far,
                res.to_glib_none_mut().0,
            );
            res
        }
    }

    /// Scales the coordinates of the given [`Point3D`][crate::Point3D] by
    /// the given `factor`.
    /// ## `factor`
    /// the scaling factor
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// return location for the scaled point
    #[doc(alias = "graphene_point3d_scale")]
    #[must_use]
    pub fn scale(&self, factor: f32) -> Point3D {
        unsafe {
            let mut res = Point3D::uninitialized();
            ffi::graphene_point3d_scale(self.to_glib_none().0, factor, res.to_glib_none_mut().0);
            res
        }
    }

    /// Stores the coordinates of a [`Point3D`][crate::Point3D] into a
    /// [`Vec3`][crate::Vec3].
    ///
    /// # Returns
    ///
    ///
    /// ## `v`
    /// return location for a [`Vec3`][crate::Vec3]
    #[doc(alias = "graphene_point3d_to_vec3")]
    pub fn to_vec3(&self) -> Vec3 {
        unsafe {
            let mut v = Vec3::uninitialized();
            ffi::graphene_point3d_to_vec3(self.to_glib_none().0, v.to_glib_none_mut().0);
            v
        }
    }

    /// Retrieves a constant point with all three coordinates set to 0.
    ///
    /// # Returns
    ///
    /// a zero point
    #[doc(alias = "graphene_point3d_zero")]
    pub fn zero() -> Point3D {
        assert_initialized_main_thread!();
        unsafe { from_glib_none(ffi::graphene_point3d_zero()) }
    }
}

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

impl Eq for Point3D {}