embedded_layout/align/vertical/
mod.rs

1//! Vertical alignment options
2//!
3//! Vertical alignment types must implement [`VerticalAlignment`].
4use crate::align::{Alignment, VerticalAlignment};
5use embedded_graphics::{geometry::AnchorPoint, primitives::Rectangle};
6
7/// Keep the objects' vertical alignment unchanged
8#[derive(Copy, Clone, Default)]
9pub struct NoAlignment;
10impl VerticalAlignment for NoAlignment {}
11
12impl Alignment for NoAlignment {
13    #[inline]
14    fn align_with_offset(&self, _object: Rectangle, _reference: Rectangle, _offset: i32) -> i32 {
15        0
16    }
17}
18
19/// Center the objects vertically
20///
21/// *Note:* in certain cases it's not possible to center objects perfectly because of
22///         the integer cordinates used.
23#[derive(Copy, Clone, Default)]
24pub struct Center;
25impl VerticalAlignment for Center {}
26
27impl Alignment for Center {
28    #[inline]
29    fn align_with_offset(&self, object: Rectangle, reference: Rectangle, offset: i32) -> i32 {
30        reference.anchor_point(AnchorPoint::Center).y - object.anchor_point(AnchorPoint::Center).y
31            + offset
32    }
33}
34
35/// Align the top edge of the object to the top edge of the reference
36#[derive(Copy, Clone, Default)]
37pub struct Top;
38impl VerticalAlignment for Top {}
39
40impl Alignment for Top {
41    #[inline]
42    fn align_with_offset(&self, object: Rectangle, reference: Rectangle, offset: i32) -> i32 {
43        reference.top_left.y - object.top_left.y + offset
44    }
45}
46
47/// Align the bottom edge of the object to the bottom edge of the reference
48#[derive(Copy, Clone, Default)]
49pub struct Bottom;
50impl VerticalAlignment for Bottom {}
51
52impl Alignment for Bottom {
53    #[inline]
54    fn align_with_offset(&self, object: Rectangle, reference: Rectangle, offset: i32) -> i32 {
55        reference.anchor_point(AnchorPoint::BottomRight).y
56            - object.anchor_point(AnchorPoint::BottomRight).y
57            + offset
58    }
59}
60
61/// Align the top edge of the object to the bottom edge of the reference, non-overlapping
62#[derive(Copy, Clone, Default)]
63pub struct TopToBottom;
64impl VerticalAlignment for TopToBottom {}
65
66impl Alignment for TopToBottom {
67    #[inline]
68    fn align_with_offset(&self, object: Rectangle, reference: Rectangle, offset: i32) -> i32 {
69        let offset = if object.size.height == 0 {
70            offset
71        } else {
72            offset + 1
73        };
74        reference.anchor_point(AnchorPoint::BottomRight).y - object.top_left.y + offset
75    }
76}
77
78/// Align the bottom edge of the object to the top edge of the reference, non-overlapping
79#[derive(Copy, Clone, Default)]
80pub struct BottomToTop;
81impl VerticalAlignment for BottomToTop {}
82
83impl Alignment for BottomToTop {
84    #[inline]
85    fn align_with_offset(&self, object: Rectangle, reference: Rectangle, offset: i32) -> i32 {
86        let offset = if object.size.height == 0 {
87            offset
88        } else {
89            offset - 1
90        };
91        reference.top_left.y - object.anchor_point(AnchorPoint::BottomRight).y + offset
92    }
93}
94
95#[cfg(test)]
96mod test {
97    use crate::prelude::*;
98    use embedded_graphics::{
99        geometry::{AnchorPoint, Point},
100        prelude::Size,
101        primitives::Rectangle,
102    };
103
104    #[test]
105    fn test_center() {
106        fn check_center_alignment(source: Rectangle, reference: Rectangle, result: Rectangle) {
107            let center_of_reference = reference.top_left + reference.size() / 2;
108            let center_of_result = result.top_left + result.size() / 2;
109
110            // The size hasn't changed
111            assert_eq!(result.size(), source.size());
112
113            // Vertical coordinate matches reference
114            assert_eq!(center_of_result.y, center_of_reference.y);
115
116            // Horizontal coordinate is unchanged
117            assert_eq!(result.top_left.x, source.top_left.x);
118        }
119
120        let rect1 = Rectangle::with_corners(Point::new(0, 0), Point::new(10, 10));
121        let rect2 = Rectangle::with_corners(Point::new(30, 20), Point::new(40, 50));
122
123        let result = rect1.align_to(&rect2, horizontal::NoAlignment, vertical::Center);
124        check_center_alignment(rect1, rect2, result);
125
126        // Test the other direction
127
128        let result = rect2.align_to(&rect1, horizontal::NoAlignment, vertical::Center);
129        check_center_alignment(rect2, rect1, result);
130    }
131
132    #[test]
133    fn test_top() {
134        fn check_top_alignment(source: Rectangle, reference: Rectangle, result: Rectangle) {
135            // The size hasn't changed
136            assert_eq!(result.size(), source.size());
137
138            // Vertical coordinate matches reference
139            assert_eq!(result.top_left.y, reference.top_left.y);
140
141            // Horizontal coordinate is unchanged
142            assert_eq!(result.top_left.x, source.top_left.x);
143        }
144
145        let rect1 = Rectangle::with_corners(Point::new(0, 0), Point::new(10, 10));
146        let rect2 = Rectangle::with_corners(Point::new(30, 20), Point::new(40, 50));
147
148        let result = rect1.align_to(&rect2, horizontal::NoAlignment, vertical::Top);
149        check_top_alignment(rect1, rect2, result);
150
151        // Test the other direction
152        let result = rect2.align_to(&rect1, horizontal::NoAlignment, vertical::Top);
153        check_top_alignment(rect2, rect1, result);
154    }
155
156    #[test]
157    fn test_bottom() {
158        fn check_bottom_alignment(source: Rectangle, reference: Rectangle, result: Rectangle) {
159            // The size hasn't changed
160            assert_eq!(result.size(), source.size());
161
162            // Vertical coordinate matches reference
163            assert_eq!(
164                result.anchor_point(AnchorPoint::BottomRight).y,
165                reference.anchor_point(AnchorPoint::BottomRight).y
166            );
167
168            // Horizontal coordinate is unchanged
169            assert_eq!(
170                result.anchor_point(AnchorPoint::BottomRight).x,
171                source.anchor_point(AnchorPoint::BottomRight).x
172            );
173        }
174
175        let rect1 = Rectangle::with_corners(Point::new(0, 0), Point::new(10, 10));
176        let rect2 = Rectangle::with_corners(Point::new(30, 20), Point::new(40, 50));
177
178        let result = rect1.align_to(&rect2, horizontal::NoAlignment, vertical::Bottom);
179        check_bottom_alignment(rect1, rect2, result);
180
181        // Test the other direction
182        let result = rect2.align_to(&rect1, horizontal::NoAlignment, vertical::Bottom);
183        check_bottom_alignment(rect2, rect1, result);
184    }
185
186    #[test]
187    fn test_top_to_bottom() {
188        let rect1 = Rectangle::with_corners(Point::new(0, 0), Point::new(10, 10));
189        let rect2 = Rectangle::with_corners(Point::new(30, 20), Point::new(40, 50));
190
191        let result = rect1.align_to(&rect2, horizontal::NoAlignment, vertical::TopToBottom);
192        // The size hasn't changed
193        assert_eq!(result.size(), rect1.size());
194
195        // Top is at bottom + 1
196        assert_eq!(
197            result.top_left.y,
198            rect2.anchor_point(AnchorPoint::BottomRight).y + 1
199        );
200
201        // Horizontal coordinate is unchanged
202        assert_eq!(
203            result.anchor_point(AnchorPoint::BottomRight).x,
204            rect1.anchor_point(AnchorPoint::BottomRight).x
205        );
206
207        // Test the other direction
208        let result = rect2.align_to(&rect1, horizontal::NoAlignment, vertical::TopToBottom);
209        // The size hasn't changed
210        assert_eq!(result.size(), rect2.size());
211
212        // Top is at bottom + 1
213        assert_eq!(
214            result.top_left.y,
215            rect1.anchor_point(AnchorPoint::BottomRight).y + 1
216        );
217
218        // Horizontal coordinate is unchanged
219        assert_eq!(
220            result.anchor_point(AnchorPoint::BottomRight).x,
221            rect2.anchor_point(AnchorPoint::BottomRight).x
222        );
223    }
224
225    #[test]
226    fn test_top_to_bottom_empty() {
227        let rect1 = Rectangle::new(Point::new(0, 0), Size::zero());
228        let rect2 = Rectangle::with_corners(Point::new(30, 20), Point::new(40, 50));
229
230        let result = rect1.align_to(&rect2, horizontal::NoAlignment, vertical::TopToBottom);
231        // The size hasn't changed
232        assert_eq!(result.size(), rect1.size());
233
234        // Top is at bottom
235        assert_eq!(
236            result.top_left.y,
237            rect2.anchor_point(AnchorPoint::BottomRight).y
238        );
239
240        // Horizontal coordinate is unchanged
241        assert_eq!(
242            result.anchor_point(AnchorPoint::BottomRight).x,
243            rect1.anchor_point(AnchorPoint::BottomRight).x
244        );
245
246        // Test the other direction
247        let result = rect2.align_to(&rect1, horizontal::NoAlignment, vertical::TopToBottom);
248        // The size hasn't changed
249        assert_eq!(result.size(), rect2.size());
250
251        // Top is at bottom + 1
252        assert_eq!(
253            result.top_left.y,
254            rect1.anchor_point(AnchorPoint::BottomRight).y + 1
255        );
256
257        // Horizontal coordinate is unchanged
258        assert_eq!(
259            result.anchor_point(AnchorPoint::BottomRight).x,
260            rect2.anchor_point(AnchorPoint::BottomRight).x
261        );
262    }
263
264    #[test]
265    fn test_bottom_to_top() {
266        let rect1 = Rectangle::with_corners(Point::new(0, 0), Point::new(10, 10));
267        let rect2 = Rectangle::with_corners(Point::new(30, 20), Point::new(40, 50));
268
269        let result = rect1.align_to(&rect2, horizontal::NoAlignment, vertical::BottomToTop);
270        // The size hasn't changed
271        assert_eq!(result.size(), rect1.size());
272
273        // Bottom is at top - 1
274        assert_eq!(
275            result.anchor_point(AnchorPoint::BottomRight).y,
276            rect2.top_left.y - 1
277        );
278
279        // Horizontal coordinate is unchanged
280        assert_eq!(
281            result.anchor_point(AnchorPoint::BottomRight).x,
282            rect1.anchor_point(AnchorPoint::BottomRight).x
283        );
284
285        // Test the other direction
286        let result = rect2.align_to(&rect1, horizontal::NoAlignment, vertical::BottomToTop);
287        // The size hasn't changed
288        assert_eq!(result.size(), rect2.size());
289
290        // Bottom is at top - 1
291        assert_eq!(
292            result.anchor_point(AnchorPoint::BottomRight).y,
293            rect1.top_left.y - 1
294        );
295
296        // Horizontal coordinate is unchanged
297        assert_eq!(
298            result.anchor_point(AnchorPoint::BottomRight).x,
299            rect2.anchor_point(AnchorPoint::BottomRight).x
300        );
301    }
302
303    #[test]
304    fn test_bottom_to_top_empty() {
305        let rect1 = Rectangle::new(Point::new(0, 0), Size::zero());
306        let rect2 = Rectangle::with_corners(Point::new(30, 20), Point::new(40, 50));
307
308        let result = rect1.align_to(&rect2, horizontal::NoAlignment, vertical::BottomToTop);
309        // The size hasn't changed
310        assert_eq!(result.size(), rect1.size());
311
312        // Bottom is at top
313        assert_eq!(
314            result.anchor_point(AnchorPoint::BottomRight).y,
315            rect2.top_left.y
316        );
317
318        // Horizontal coordinate is unchanged
319        assert_eq!(
320            result.anchor_point(AnchorPoint::BottomRight).x,
321            rect1.anchor_point(AnchorPoint::BottomRight).x
322        );
323
324        // Test the other direction
325        let result = rect2.align_to(&rect1, horizontal::NoAlignment, vertical::BottomToTop);
326        // The size hasn't changed
327        assert_eq!(result.size(), rect2.size());
328
329        // Bottom is at top - 1
330        assert_eq!(
331            result.anchor_point(AnchorPoint::BottomRight).y,
332            rect1.top_left.y - 1
333        );
334
335        // Horizontal coordinate is unchanged
336        assert_eq!(
337            result.anchor_point(AnchorPoint::BottomRight).x,
338            rect2.anchor_point(AnchorPoint::BottomRight).x
339        );
340    }
341}
embedded_layout/align/vertical/mod.rs

embedded_layout/align/vertical/
mod.rs
