woodpecker_ui 0.1.1

A UI library for the Bevy game engine.
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
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

use bevy::reflect::Reflect;

use super::Units;

/// A struct for defining properties related to the edges of widgets
///
/// This is useful for things like borders, padding, etc.
#[derive(Debug, Default, Reflect, Copy, Clone, PartialEq)]
pub struct Edge {
    /// The value of the top edge
    pub top: Units,
    /// The value of the right edge
    pub right: Units,
    /// The value of the bottom edge
    pub bottom: Units,
    /// The value of the left edge
    pub left: Units,
}

impl Edge {
    /// Creates a new `Edge` with values individually specified for each edge
    ///
    /// # Arguments
    ///
    /// * `top`: The top edge value
    /// * `right`: The right edge value
    /// * `bottom`: The bottom edge value
    /// * `left`: The left edge value
    ///
    pub fn new(
        top: impl Into<Units>,
        right: impl Into<Units>,
        bottom: impl Into<Units>,
        left: impl Into<Units>,
    ) -> Self {
        Self {
            top: top.into(),
            right: right.into(),
            bottom: bottom.into(),
            left: left.into(),
        }
    }

    /// Creates a new `Edge` with matching vertical edges and matching horizontal edges
    ///
    /// # Arguments
    ///
    /// * `vertical`: The value of the vertical edges
    /// * `horizontal`: The value of the horizontal edges
    ///
    pub fn axis(vertical: Units, horizontal: Units) -> Self {
        Self {
            top: vertical,
            right: horizontal,
            bottom: vertical,
            left: horizontal,
        }
    }

    /// Creates a new `Edge` with all edges having the same value
    ///
    /// # Arguments
    ///
    /// * `value`: The value of all edges
    ///
    pub fn all(value: impl Into<Units> + Copy) -> Self {
        Self {
            top: value.into(),
            right: value.into(),
            bottom: value.into(),
            left: value.into(),
        }
    }

    /// Converts this `Edge` into a tuple matching `(Top, Right, Bottom, Left)`
    pub fn into_tuple(self) -> (Units, Units, Units, Units) {
        (self.top, self.right, self.bottom, self.left)
    }

    /// Modifies the bottom edge value.
    pub fn bottom(mut self, value: impl Into<Units>) -> Self {
        self.bottom = value.into();
        self
    }

    /// Modifies the top edge value.
    pub fn top(mut self, value: impl Into<Units>) -> Self {
        self.top = value.into();
        self
    }

    /// Modifies the left edge value.
    pub fn left(mut self, value: impl Into<Units>) -> Self {
        self.left = value.into();
        self
    }

    /// Modifies the right edge value.
    pub fn right(mut self, value: impl Into<Units>) -> Self {
        self.right = value.into();
        self
    }
}

impl From<Edge> for (Units, Units, Units, Units) {
    fn from(edge: Edge) -> Self {
        edge.into_tuple()
    }
}

impl From<(Units, Units)> for Edge {
    fn from(value: (Units, Units)) -> Self {
        Edge::axis(value.0, value.1)
    }
}

impl From<(Units, Units, Units, Units)> for Edge {
    fn from(value: (Units, Units, Units, Units)) -> Self {
        Edge::new(value.0, value.1, value.2, value.3)
    }
}