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
//! The polyline primitive
use crate::{
geometry::{Dimensions, Point, Size},
primitives::{PointsIter, Primitive, Rectangle},
transform::Transform,
};
mod points;
pub(in crate::primitives) mod scanline_intersections;
mod scanline_iterator;
mod styled;
pub use points::Points;
pub use styled::StyledPixelsIterator;
/// Polyline primitive
///
/// Creates an unfilled chained line shape.
///
/// # Examples
///
/// ## Draw a "heartbeat" shaped polyline
///
/// This example draws a stylized cardiogram in a 5px green stroke.
///
/// ```rust
/// use embedded_graphics::{
/// pixelcolor::Rgb565, prelude::*, primitives::{Polyline, PrimitiveStyle},
/// };
/// # use embedded_graphics::mock_display::MockDisplay;
/// # let mut display = MockDisplay::default();
/// # display.set_allow_out_of_bounds_drawing(true);
///
/// // A "heartbeat" shaped polyline
/// let points: [Point; 10] = [
/// Point::new(10, 64),
/// Point::new(50, 64),
/// Point::new(60, 44),
/// Point::new(70, 64),
/// Point::new(80, 64),
/// Point::new(90, 74),
/// Point::new(100, 10),
/// Point::new(110, 84),
/// Point::new(120, 64),
/// Point::new(300, 64),
/// ];
///
/// let line_style = PrimitiveStyle::with_stroke(Rgb565::GREEN, 5);
///
/// Polyline::new(&points)
/// .into_styled(line_style)
/// .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 Polyline<'a> {
/// An offset to apply to the polyline as a whole
pub translate: Point,
/// All vertices in the line
pub vertices: &'a [Point],
}
impl<'a> Polyline<'a> {
/// Create a new polyline from a list of vertices
///
/// If fewer than two vertices are provided, the line will not render anything when drawn.
pub const fn new(vertices: &'a [Point]) -> Self {
Self {
vertices,
translate: Point::zero(),
}
}
}
impl<'a> Primitive for Polyline<'a> {}
impl<'a> PointsIter for Polyline<'a> {
type Iter = Points<'a>;
fn points(&self) -> Self::Iter {
Points::new(self)
}
}
impl<'a> Dimensions for Polyline<'a> {
fn bounding_box(&self) -> Rectangle {
match self.vertices {
[] => Rectangle::zero(),
[v] => Rectangle::new(*v, Size::zero()),
vertices => {
let top_left = vertices
.iter()
.map(|v| *v + self.translate)
.fold(Point::new(core::i32::MAX, core::i32::MAX), |accum, v| {
Point::new(accum.x.min(v.x), accum.y.min(v.y))
});
let bottom_right = vertices
.iter()
.map(|v| *v + self.translate)
.fold(Point::new(core::i32::MIN, core::i32::MIN), |accum, v| {
Point::new(accum.x.max(v.x), accum.y.max(v.y))
});
Rectangle::with_corners(top_left, bottom_right)
}
}
}
}
impl<'a> Transform for Polyline<'a> {
/// Translate the polyline from its current position to a new position by (x, y) pixels, returning
/// a new `Polyline`. For a mutating transform, see `translate_mut`.
///
/// ```
/// # use embedded_graphics::primitives::Polyline;
/// # use embedded_graphics::prelude::*;
/// let points = [
/// Point::new(5, 10),
/// Point::new(7, 7),
/// Point::new(5, 8),
/// Point::new(10, 10),
/// ];
///
/// let polyline = Polyline::new(&points);
/// let moved = polyline.translate(Point::new(10, 12));
///
/// assert_eq!(polyline.bounding_box().top_left, Point::new(5, 7));
/// assert_eq!(moved.bounding_box().top_left, Point::new(15, 19));
/// ```
fn translate(&self, by: Point) -> Self {
Self {
translate: self.translate + by,
..*self
}
}
/// Translate the polyline from its current position to a new position by (x, y) pixels.
///
/// ```
/// # use embedded_graphics::primitives::Polyline;
/// # use embedded_graphics::prelude::*;
/// let points = [
/// Point::new(5, 10),
/// Point::new(7, 7),
/// Point::new(5, 8),
/// Point::new(10, 10),
/// ];
///
/// let mut polyline = Polyline::new(&points);
///
/// polyline.translate_mut(Point::new(10, 12));
///
/// assert_eq!(polyline.bounding_box().top_left, Point::new(15, 19));
/// ```
fn translate_mut(&mut self, by: Point) -> &mut Self {
self.translate += by;
self
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::geometry::{Point, Size};
// A "heartbeat" shaped polyline
pub(in crate::primitives::polyline) const HEARTBEAT: [Point; 10] = [
Point::new(10, 64),
Point::new(50, 64),
Point::new(60, 44),
Point::new(70, 64),
Point::new(80, 64),
Point::new(90, 74),
Point::new(100, 10),
Point::new(110, 84),
Point::new(120, 64),
Point::new(300, 64),
];
// Smaller test pattern for mock display
pub(in crate::primitives::polyline) const SMALL: [Point; 4] = [
Point::new(2, 5),
Point::new(5, 2),
Point::new(10, 5),
Point::new(15, 2),
];
#[test]
fn special_case_dimensions() {
assert_eq!(Polyline::new(&[]).bounding_box(), Rectangle::zero(),);
assert_eq!(
Polyline::new(&[Point::new(15, 17)]).bounding_box(),
Rectangle::new(Point::new(15, 17), Size::zero())
);
}
#[test]
fn positive_dimensions() {
let polyline = Polyline::new(&HEARTBEAT);
let bb = polyline.bounding_box();
assert_eq!(
bb,
Rectangle::with_corners(Point::new(10, 10), Point::new(300, 84))
);
}
#[test]
fn negative_dimensions() {
let mut negative: [Point; 10] = [Point::zero(); 10];
for (i, v) in HEARTBEAT.iter().enumerate() {
negative[i] = *v - Point::new(100, 100);
}
let polyline = Polyline::new(&negative);
let bb = polyline.bounding_box();
assert_eq!(
bb,
Rectangle::with_corners(Point::new(-90, -90), Point::new(200, -16))
);
}
#[test]
fn transformed_dimensions() {
let polyline = Polyline::new(&HEARTBEAT).translate(Point::new(-100, -100));
let bb = polyline.bounding_box();
assert_eq!(
bb,
Rectangle::with_corners(Point::new(-90, -90), Point::new(200, -16))
);
}
#[test]
fn translate_does_not_modify_size() {
let points = [
Point::new(5, 10),
Point::new(7, 7),
Point::new(5, 8),
Point::new(10, 10),
];
let polyline = Polyline::new(&points);
let moved = polyline.translate(Point::new(10, 12));
assert_eq!(moved.bounding_box().size, polyline.bounding_box().size);
}
#[test]
fn translate_translated() {
let points = [
Point::new(5, 10),
Point::new(7, 7),
Point::new(5, 8),
Point::new(10, 10),
];
let polyline = Polyline::new(&points);
let moved = polyline.translate(Point::new(10, 12));
let moved2 = moved.translate(Point::new(10, 12));
assert_eq!(
moved.bounding_box(),
polyline.bounding_box().translate(Point::new(10, 12))
);
assert_eq!(
moved2.bounding_box(),
polyline.bounding_box().translate(Point::new(20, 24))
);
}
}