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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
//! The line primitive

use crate::{
    geometry::{Dimensions, Point},
    primitives::{
        common::StrokeOffset,
        line::thick_points::{ParallelLineType, ParallelsIterator},
        PointsIter, Primitive, Rectangle,
    },
    transform::Transform,
};
use az::SaturatingAs;

mod bresenham;
pub(in crate::primitives) mod intersection_params;
mod points;
mod styled;
mod thick_points;

pub use points::Points;
pub use styled::StyledPixelsIterator;

/// Line primitive
///
/// # Examples
///
/// ## Create some lines with different styles
///
/// ```rust
/// use embedded_graphics::{
///     pixelcolor::Rgb565, prelude::*, primitives::{Line, PrimitiveStyle},
/// };
/// # use embedded_graphics::mock_display::MockDisplay;
/// # let mut display = MockDisplay::default();
///
/// // Red 1 pixel wide line from (50, 20) to (60, 35)
/// Line::new(Point::new(50, 20), Point::new(60, 35))
///     .into_styled(PrimitiveStyle::with_stroke(Rgb565::RED, 1))
///     .draw(&mut display)?;
///
/// // Green 10 pixel wide line with translation applied
/// Line::new(Point::new(50, 20), Point::new(60, 35))
///     .translate(Point::new(-30, 10))
///     .into_styled(PrimitiveStyle::with_stroke(Rgb565::GREEN, 10))
///     .draw(&mut display)?;
/// # Ok::<(), core::convert::Infallible>(())
/// ```
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default)]
#[cfg_attr(feature = "defmt", derive(::defmt::Format))]
pub struct Line {
    /// Start point
    pub start: Point,

    /// End point
    pub end: Point,
}

impl Primitive for Line {}

impl PointsIter for Line {
    type Iter = Points;

    fn points(&self) -> Self::Iter {
        Points::new(self)
    }
}

impl Dimensions for Line {
    fn bounding_box(&self) -> Rectangle {
        Rectangle::with_corners(self.start, self.end)
    }
}

impl Line {
    /// Creates a line between two points.
    pub const fn new(start: Point, end: Point) -> Self {
        Self { start, end }
    }

    /// Creates a line with a start point and a delta vector.
    ///
    /// # Examples
    /// ```
    /// use embedded_graphics::{prelude::*, primitives::Line};
    ///
    /// let line = Line::with_delta(Point::new(10, 20), Point::new(20, -20));
    /// # assert_eq!(line, Line::new(Point::new(10, 20), Point::new(30, 0)));
    /// ```
    pub const fn with_delta(start: Point, delta: Point) -> Self {
        // Add coordinates manually because `start + delta` isn't const.
        let end = Point::new(start.x + delta.x, start.y + delta.y);

        Self { start, end }
    }

    /// Returns a perpendicular line.
    ///
    /// The returned line is rotated 90 degree counter clockwise and shares the start point with the
    /// original line.
    fn perpendicular(&self) -> Self {
        let delta = self.end - self.start;
        let delta = Point::new(delta.y, -delta.x);

        Line::new(self.start, self.start + delta)
    }

    /// Get two lines representing the left and right edges of the thick line.
    ///
    /// If a thickness of `0` is given, the lines returned will lie on the same points as `self`.
    pub(in crate::primitives) fn extents(
        &self,
        thickness: u32,
        stroke_offset: StrokeOffset,
    ) -> (Line, Line) {
        let mut it = ParallelsIterator::new(self, thickness.saturating_as(), stroke_offset);
        let reduce =
            it.parallel_parameters.position_step.major + it.parallel_parameters.position_step.minor;

        let mut left = (self.start, ParallelLineType::Normal);
        let mut right = (self.start, ParallelLineType::Normal);

        match stroke_offset {
            #[allow(clippy::while_let_loop)]
            StrokeOffset::None => loop {
                if let Some((bresenham, reduce)) = it.next() {
                    right = (bresenham.point, reduce);
                } else {
                    break;
                }

                if let Some((bresenham, reduce)) = it.next() {
                    left = (bresenham.point, reduce);
                } else {
                    break;
                }
            },
            StrokeOffset::Left => {
                if let Some((bresenham, reduce)) = it.last() {
                    left = (bresenham.point, reduce);
                }
            }
            StrokeOffset::Right => {
                if let Some((bresenham, reduce)) = it.last() {
                    right = (bresenham.point, reduce);
                }
            }
        };

        let left_start = left.0;
        let right_start = right.0;

        let delta = self.end - self.start;

        let left_line = Line::new(
            left_start,
            left_start + delta
                - match left.1 {
                    ParallelLineType::Normal => Point::zero(),
                    ParallelLineType::Extra => reduce,
                },
        );

        let right_line = Line::new(
            right_start,
            right_start + delta
                - match right.1 {
                    ParallelLineType::Normal => Point::zero(),
                    ParallelLineType::Extra => reduce,
                },
        );
        (left_line, right_line)
    }

    /// Compute the midpoint of the line.
    pub fn midpoint(&self) -> Point {
        self.start + (self.end - self.start) / 2
    }

    /// Compute the delta (`end - start`) of the line.
    pub fn delta(&self) -> Point {
        self.end - self.start
    }
}

impl Transform for Line {
    /// Translate the line from its current position to a new position by (x, y) pixels, returning
    /// a new `Line`. For a mutating transform, see `translate_mut`.
    ///
    /// ```
    /// # use embedded_graphics::primitives::Line;
    /// # use embedded_graphics::prelude::*;
    /// let line = Line::new(Point::new(5, 10), Point::new(15, 20));
    /// let moved = line.translate(Point::new(10, 10));
    ///
    /// assert_eq!(moved.start, Point::new(15, 20));
    /// assert_eq!(moved.end, Point::new(25, 30));
    /// ```
    fn translate(&self, by: Point) -> Self {
        Self {
            start: self.start + by,
            end: self.end + by,
        }
    }

    /// Translate the line from its current position to a new position by (x, y) pixels.
    ///
    /// ```
    /// # use embedded_graphics::primitives::Line;
    /// # use embedded_graphics::prelude::*;
    /// let mut line = Line::new(Point::new(5, 10), Point::new(15, 20));
    /// line.translate_mut(Point::new(10, 10));
    ///
    /// assert_eq!(line.start, Point::new(15, 20));
    /// assert_eq!(line.end, Point::new(25, 30));
    /// ```
    fn translate_mut(&mut self, by: Point) -> &mut Self {
        self.start += by;
        self.end += by;

        self
    }
}

/// Pixel iterator for each pixel in the line
#[cfg(test)]
mod tests {
    use super::*;
    use crate::{
        geometry::Size, mock_display::MockDisplay, pixelcolor::BinaryColor,
        primitives::PrimitiveStyle, Drawable, Pixel,
    };
    use arrayvec::ArrayVec;

    #[test]
    fn bounding_box() {
        let start = Point::new(10, 10);
        let end = Point::new(19, 29);

        let line: Line = Line::new(start, end);
        let backwards_line: Line = Line::new(end, start);

        assert_eq!(
            line.bounding_box(),
            Rectangle::new(start, Size::new(10, 20))
        );
        assert_eq!(
            backwards_line.bounding_box(),
            Rectangle::new(start, Size::new(10, 20))
        );
    }

    #[test]
    fn no_stroke_width_no_line() {
        let start = Point::new(2, 3);
        let end = Point::new(3, 2);

        let line =
            Line::new(start, end).into_styled(PrimitiveStyle::with_stroke(BinaryColor::On, 0));

        assert!(line.pixels().eq(core::iter::empty()));
    }

    #[test]
    fn thick_line_octant_1() {
        let mut display: MockDisplay<BinaryColor> = MockDisplay::new();

        Line::new(Point::new(2, 2), Point::new(20, 8))
            .into_styled(PrimitiveStyle::with_stroke(BinaryColor::On, 5))
            .draw(&mut display)
            .unwrap();

        display.assert_pattern(&[
            "   #                   ",
            "  #####                ",
            "  ########             ",
            "  ###########          ",
            " ###############       ",
            "    ###############    ",
            "       ############### ",
            "          ###########  ",
            "             ########  ",
            "                #####  ",
            "                   #   ",
        ]);
    }

    #[test]
    fn thick_line_2px() {
        let mut display: MockDisplay<BinaryColor> = MockDisplay::new();

        // Horizontal line
        Line::new(Point::new(2, 2), Point::new(10, 2))
            .into_styled(PrimitiveStyle::with_stroke(BinaryColor::On, 2))
            .draw(&mut display)
            .unwrap();

        // Vertical line
        Line::new(Point::new(2, 5), Point::new(2, 10))
            .into_styled(PrimitiveStyle::with_stroke(BinaryColor::Off, 2))
            .draw(&mut display)
            .unwrap();

        display.assert_pattern(&[
            "            ",
            "  ######### ",
            "  ######### ",
            "            ",
            "            ",
            "  ..        ",
            "  ..        ",
            "  ..        ",
            "  ..        ",
            "  ..        ",
            "  ..        ",
        ]);
    }

    // Check that 45 degree lines don't draw their right side 1px too long
    #[test]
    fn diagonal() {
        let mut display: MockDisplay<BinaryColor> = MockDisplay::new();

        Line::new(Point::new(3, 2), Point::new(10, 9))
            .into_styled(PrimitiveStyle::with_stroke(BinaryColor::On, 7))
            .draw(&mut display)
            .unwrap();

        display.assert_pattern(&[
            "     #        ",
            "    ###       ",
            "   #####      ",
            "  #######     ",
            " #########    ",
            "  #########   ",
            "   #########  ",
            "    ######### ",
            "     #######  ",
            "      #####   ",
            "       ###    ",
            "        #     ",
        ]);
    }

    #[test]
    fn thick_line_3px() {
        let mut display: MockDisplay<BinaryColor> = MockDisplay::new();

        // Horizontal line
        Line::new(Point::new(2, 2), Point::new(10, 2))
            .into_styled(PrimitiveStyle::with_stroke(BinaryColor::On, 3))
            .draw(&mut display)
            .unwrap();

        // Vertical line
        Line::new(Point::new(2, 5), Point::new(2, 10))
            .into_styled(PrimitiveStyle::with_stroke(BinaryColor::Off, 3))
            .draw(&mut display)
            .unwrap();

        display.assert_pattern(&[
            "            ",
            "  ######### ",
            "  ######### ",
            "  ######### ",
            "            ",
            " ...        ",
            " ...        ",
            " ...        ",
            " ...        ",
            " ...        ",
            " ...        ",
        ]);
    }

    #[test]
    fn thick_line_0px() {
        let mut display: MockDisplay<BinaryColor> = MockDisplay::new();

        Line::new(Point::new(2, 2), Point::new(2, 2))
            .into_styled(PrimitiveStyle::with_stroke(BinaryColor::On, 3))
            .draw(&mut display)
            .unwrap();

        display.assert_pattern(&[
            "   ", //
            "  #", //
            "  #", //
            "  #", //
        ]);
    }

    #[test]
    fn event_width_offset() {
        let mut display: MockDisplay<BinaryColor> = MockDisplay::new();

        // Horizontal line
        Line::new(Point::new(2, 3), Point::new(10, 3))
            .into_styled(PrimitiveStyle::with_stroke(BinaryColor::On, 4))
            .draw(&mut display)
            .unwrap();

        // Vertical line
        Line::new(Point::new(2, 9), Point::new(10, 8))
            .into_styled(PrimitiveStyle::with_stroke(BinaryColor::On, 4))
            .draw(&mut display)
            .unwrap();

        display.assert_pattern(&[
            "            ",
            "  ######### ",
            "  ######### ",
            "  ######### ",
            "  ######### ",
            "            ",
            "       #### ",
            "  ######### ",
            "  ######### ",
            "  ######### ",
            "  #####     ",
        ]);
    }

    #[test]
    fn points_iter() {
        let line = Line::new(Point::new(10, 10), Point::new(20, 30));

        let styled_points: ArrayVec<_, 32> = line
            .clone()
            .into_styled(PrimitiveStyle::with_stroke(BinaryColor::On, 1))
            .pixels()
            .map(|Pixel(p, _)| p)
            .collect();

        let points: ArrayVec<_, 32> = line.points().collect();

        assert_eq!(points, styled_points);
    }

    #[test]
    fn perpendicular() {
        assert_eq!(
            Line::new(Point::zero(), Point::new(10, 0)).perpendicular(),
            Line::new(Point::zero(), Point::new(0, -10))
        );

        assert_eq!(
            Line::new(Point::new(10, 20), Point::new(20, 10)).perpendicular(),
            Line::new(Point::new(10, 20), Point::new(0, 10))
        );

        assert_eq!(
            Line::new(Point::zero(), Point::new(0, -10)).perpendicular(),
            Line::new(Point::zero(), Point::new(-10, 0))
        );
    }

    #[test]
    fn extents() {
        let line = Line::new(Point::new(10, 50), Point::new(10, 0));
        let (l, r) = line.extents(11, StrokeOffset::None);

        assert_eq!(l, line.translate(Point::new(-5, 0)));
        assert_eq!(r, line.translate(Point::new(5, 0)));
    }

    #[test]
    fn extents_zero_thickness() {
        let line = Line::new(Point::new(10, 20), Point::new(20, 10));

        let (l, r) = line.extents(0, StrokeOffset::None);

        assert_eq!(l, line);
        assert_eq!(r, line);
    }
}