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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

use crate::geom::position::HorizontalPosition;
use crate::geom::position::VerticalPosition;
use crate::geom::PointPosition;

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

impl LinePosition {
    pub fn new(start: PointPosition, end: PointPosition) -> Self {
        Self(start, end)
    }

    pub fn start(self) -> PointPosition {
        self.0
    }

    pub fn end(self) -> PointPosition {
        self.1
    }

    pub fn is_entirely_left(self) -> bool {
        self.start().is_left() && self.end().is_left()
    }

    pub fn is_entirely_right(self) -> bool {
        self.start().is_right() && self.end().is_right()
    }

    pub fn is_entirely_above(self) -> bool {
        self.start().is_above() && self.end().is_above()
    }

    pub fn is_entirely_below(self) -> bool {
        self.start().is_below() && self.end().is_below()
    }

    pub fn is_on_same_horizontal(self) -> bool {
        self.start().horizontal() == self.end().horizontal()
    }

    pub fn is_on_same_vertical(self) -> bool {
        self.start().vertical() == self.end().vertical()
    }

    pub fn is_within_same_space(self) -> bool {
        self.start() == self.end()
    }

    pub fn is_entirely_inside(self) -> bool {
        self.start().is_entirely_inside() && self.end().is_entirely_inside()
    }

    /**
     * Returns true, if it's guaranteed this does not clip the inside.
     * `is_entirely_outside` is not the opposite of `is_entirely_inside`.
     */
    pub fn is_entirely_outside(self) -> bool {
        // Is either fully above, or fully below.
        if self.is_on_same_horizontal() && self.start().horizontal() != HorizontalPosition::Inside {
            return true;
        }

        // Is either fully on the left, or fully on the right.
        if self.is_on_same_vertical() && self.start().vertical() != VerticalPosition::Inside {
            return true;
        }

        false
    }
}