graphene/auto/

ray.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, Sphere, Triangle, Vec3};
use glib::translate::*;

glib::wrapper! {
    /// A ray emitted from an origin in a given direction.
    ///
    /// The contents of the [`Ray`][crate::Ray] structure are private, and should not
    /// be modified directly.
    pub struct Ray(BoxedInline<ffi::graphene_ray_t>);

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

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

    /// Computes the point on the given [`Ray`][crate::Ray] that is closest to the
    /// given point `p`.
    /// ## `p`
    /// a [`Point3D`][crate::Point3D]
    ///
    /// # Returns
    ///
    ///
    /// ## `res`
    /// return location for the closest point3d
    #[doc(alias = "graphene_ray_get_closest_point_to_point")]
    #[doc(alias = "get_closest_point_to_point")]
    pub fn closest_point_to_point(&self, p: &Point3D) -> Point3D {
        unsafe {
            let mut res = Point3D::uninitialized();
            ffi::graphene_ray_get_closest_point_to_point(
                self.to_glib_none().0,
                p.to_glib_none().0,
                res.to_glib_none_mut().0,
            );
            res
        }
    }

    /// Retrieves the direction of the given [`Ray`][crate::Ray].
    ///
    /// # Returns
    ///
    ///
    /// ## `direction`
    /// return location for the direction
    #[doc(alias = "graphene_ray_get_direction")]
    #[doc(alias = "get_direction")]
    pub fn direction(&self) -> Vec3 {
        unsafe {
            let mut direction = Vec3::uninitialized();
            ffi::graphene_ray_get_direction(self.to_glib_none().0, direction.to_glib_none_mut().0);
            direction
        }
    }

    /// Computes the distance of the origin of the given [`Ray`][crate::Ray] from the
    /// given plane.
    ///
    /// If the ray does not intersect the plane, this function returns `INFINITY`.
    /// ## `p`
    /// a [`Plane`][crate::Plane]
    ///
    /// # Returns
    ///
    /// the distance of the origin of the ray from the plane
    #[doc(alias = "graphene_ray_get_distance_to_plane")]
    #[doc(alias = "get_distance_to_plane")]
    pub fn distance_to_plane(&self, p: &Plane) -> f32 {
        unsafe {
            ffi::graphene_ray_get_distance_to_plane(self.to_glib_none().0, p.to_glib_none().0)
        }
    }

    /// Computes the distance of the closest approach between the
    /// given [`Ray`][crate::Ray] `self` and the point `p`.
    ///
    /// The closest approach to a ray from a point is the distance
    /// between the point and the projection of the point on the
    /// ray itself.
    /// ## `p`
    /// a [`Point3D`][crate::Point3D]
    ///
    /// # Returns
    ///
    /// the distance of the point
    #[doc(alias = "graphene_ray_get_distance_to_point")]
    #[doc(alias = "get_distance_to_point")]
    pub fn distance_to_point(&self, p: &Point3D) -> f32 {
        unsafe {
            ffi::graphene_ray_get_distance_to_point(self.to_glib_none().0, p.to_glib_none().0)
        }
    }

    /// Retrieves the origin of the given [`Ray`][crate::Ray].
    ///
    /// # Returns
    ///
    ///
    /// ## `origin`
    /// return location for the origin
    #[doc(alias = "graphene_ray_get_origin")]
    #[doc(alias = "get_origin")]
    pub fn origin(&self) -> Point3D {
        unsafe {
            let mut origin = Point3D::uninitialized();
            ffi::graphene_ray_get_origin(self.to_glib_none().0, origin.to_glib_none_mut().0);
            origin
        }
    }

    /// Retrieves the coordinates of a point at the distance `t` along the
    /// given [`Ray`][crate::Ray].
    /// ## `t`
    /// the distance along the ray
    ///
    /// # Returns
    ///
    ///
    /// ## `position`
    /// return location for the position
    #[doc(alias = "graphene_ray_get_position_at")]
    #[doc(alias = "get_position_at")]
    pub fn position_at(&self, t: f32) -> Point3D {
        unsafe {
            let mut position = Point3D::uninitialized();
            ffi::graphene_ray_get_position_at(
                self.to_glib_none().0,
                t,
                position.to_glib_none_mut().0,
            );
            position
        }
    }

    /// Checks whether the given [`Ray`][crate::Ray] `self` intersects the
    /// given [`Box`][crate::Box] `b`.
    ///
    /// See also: [`intersect_box()`][Self::intersect_box()]
    /// ## `b`
    /// a [`Box`][crate::Box]
    ///
    /// # Returns
    ///
    /// `true` if the ray intersects the box
    #[doc(alias = "graphene_ray_intersects_box")]
    pub fn intersects_box(&self, b: &Box) -> bool {
        unsafe { ffi::graphene_ray_intersects_box(self.to_glib_none().0, b.to_glib_none().0) }
    }

    /// Checks if the given [`Ray`][crate::Ray] `self` intersects the
    /// given [`Sphere`][crate::Sphere] `s`.
    ///
    /// See also: [`intersect_sphere()`][Self::intersect_sphere()]
    /// ## `s`
    /// a [`Sphere`][crate::Sphere]
    ///
    /// # Returns
    ///
    /// `true` if the ray intersects the sphere
    #[doc(alias = "graphene_ray_intersects_sphere")]
    pub fn intersects_sphere(&self, s: &Sphere) -> bool {
        unsafe { ffi::graphene_ray_intersects_sphere(self.to_glib_none().0, s.to_glib_none().0) }
    }

    /// Checks whether the given [`Ray`][crate::Ray] `self` intersects the
    /// given [`Triangle`][crate::Triangle] `b`.
    ///
    /// See also: [`intersect_triangle()`][Self::intersect_triangle()]
    /// ## `t`
    /// a [`Triangle`][crate::Triangle]
    ///
    /// # Returns
    ///
    /// `true` if the ray intersects the triangle
    #[doc(alias = "graphene_ray_intersects_triangle")]
    pub fn intersects_triangle(&self, t: &Triangle) -> bool {
        unsafe { ffi::graphene_ray_intersects_triangle(self.to_glib_none().0, t.to_glib_none().0) }
    }
}

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

impl Eq for Ray {}