mutils 12.7.0

Mathematical-like utilities. Points, Sizes, Colours, maths operating on them. Things like that.
Documentation 
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

use crate::geom::HorizontalPosition;
use crate::geom::VerticalPosition;

#[derive(Copy, Clone, PartialEq, Debug)]
pub struct PointPosition(pub HorizontalPosition, pub VerticalPosition);

impl PointPosition {
    pub fn new(horizontal: HorizontalPosition, vertical: VerticalPosition) -> Self {
        Self(horizontal, vertical)
    }

    #[inline(always)]
    pub fn horizontal(self) -> HorizontalPosition {
        self.0
    }

    #[inline(always)]
    pub fn vertical(self) -> VerticalPosition {
        self.1
    }

    pub fn is_left(self) -> bool {
        self.horizontal() == HorizontalPosition::Left
    }

    pub fn is_right(self) -> bool {
        self.horizontal() == HorizontalPosition::Right
    }

    pub fn is_above(self) -> bool {
        self.vertical() == VerticalPosition::Above
    }

    pub fn is_below(self) -> bool {
        self.vertical() == VerticalPosition::Below
    }

    pub fn is_entirely_inside(self) -> bool {
        self == PointPosition(HorizontalPosition::Inside, VerticalPosition::Inside)
    }

    // It is outside if either the horizontal or the vertical, is not inside.
    pub fn is_outside(self) -> bool {
        self.horizontal() != HorizontalPosition::Inside
            || self.vertical() != VerticalPosition::Inside
    }

    // It is entirely outside if neither the horizontal or the vertical, are inside.
    pub fn is_entirely_outside(self) -> bool {
        self.horizontal() != HorizontalPosition::Inside
            && self.vertical() != VerticalPosition::Inside
    }
}