graphene/
plane.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
// Take a look at the license at the top of the repository in the LICENSE file.

use std::fmt;

use glib::translate::*;

use crate::{ffi, Plane, Point3D, Vec3, Vec4};

impl Plane {
    /// 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 new(normal: Option<&Vec3>, constant: f32) -> Self {
        assert_initialized_main_thread!();
        unsafe {
            let mut plane = Self::uninitialized();
            ffi::graphene_plane_init(
                plane.to_glib_none_mut().0,
                normal.to_glib_none().0,
                constant,
            );
            plane
        }
    }

    /// 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")]
    #[doc(alias = "init_from_point")]
    pub fn from_point(normal: &Vec3, point: &Point3D) -> Self {
        assert_initialized_main_thread!();
        unsafe {
            let mut plane = Self::uninitialized();
            ffi::graphene_plane_init_from_point(
                plane.to_glib_none_mut().0,
                normal.to_glib_none().0,
                point.to_glib_none().0,
            );
            plane
        }
    }

    /// 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")]
    #[doc(alias = "init_from_points")]
    pub fn from_points(a: &Point3D, b: &Point3D, c: &Point3D) -> Self {
        assert_initialized_main_thread!();
        unsafe {
            let mut plane = Self::uninitialized();
            ffi::graphene_plane_init_from_points(
                plane.to_glib_none_mut().0,
                a.to_glib_none().0,
                b.to_glib_none().0,
                c.to_glib_none().0,
            );
            plane
        }
    }

    /// 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")]
    #[doc(alias = "init_from_vec4")]
    pub fn from_vec4(src: &Vec4) -> Self {
        assert_initialized_main_thread!();
        unsafe {
            let mut plane = Self::uninitialized();
            ffi::graphene_plane_init_from_vec4(plane.to_glib_none_mut().0, src.to_glib_none().0);
            plane
        }
    }
}

impl fmt::Debug for Plane {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Plane")
            .field("constant", &self.constant())
            .field("normal", &self.normal())
            .finish()
    }
}