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
//! The rectangle primitive. Also good for drawing squares.
use super::super::drawable::*;
use super::super::transform::*;
use crate::coord::{Coord, ToUnsigned};
use crate::pixelcolor::PixelColor;
use crate::primitives::Primitive;
use crate::style::Style;
use crate::style::WithStyle;
use crate::unsignedcoord::UnsignedCoord;
/// Rectangle primitive
///
/// # Examples
///
/// The [macro examples](../../macro.egrectangle.html) make for more concise code.
///
/// ## Create some rectangles with different styles
///
/// ```rust
/// use embedded_graphics::prelude::*;
/// use embedded_graphics::primitives::Rectangle;
/// # use embedded_graphics::mock_display::Display;
/// # let mut display = Display::default();
///
/// // Default rect from (10, 20) to (30, 40)
/// let r1 = Rectangle::new(Coord::new(10, 20), Coord::new(30, 40));
///
/// // Rectangle with styled stroke and fill from (50, 20) to (60, 35)
/// let r2 = Rectangle::new(Coord::new(50, 20), Coord::new(60, 35))
/// .stroke(Some(5u8))
/// .stroke_width(3)
/// .fill(Some(10u8));
///
/// // Rectangle with translation applied
/// let r3 = Rectangle::new(Coord::new(50, 20), Coord::new(60, 35))
/// .translate(Coord::new(65, 35));
///
/// display.draw(r1);
/// display.draw(r2);
/// display.draw(r3);
/// ```
#[derive(Debug, Clone, Copy)]
pub struct Rectangle<C: PixelColor> {
/// Top left point of the rect
pub top_left: Coord,
/// Bottom right point of the rect
pub bottom_right: Coord,
/// Object style
pub style: Style<C>,
}
impl<C> Primitive for Rectangle<C> where C: PixelColor {}
impl<C> Dimensions for Rectangle<C>
where
C: PixelColor,
{
fn top_left(&self) -> Coord {
self.top_left
}
fn bottom_right(&self) -> Coord {
self.bottom_right
}
fn size(&self) -> UnsignedCoord {
(self.bottom_right - self.top_left).abs().to_unsigned()
}
}
impl<C> Rectangle<C>
where
C: PixelColor,
{
/// Create a new rectangle from the top left point to the bottom right point with a given style
pub fn new(top_left: Coord, bottom_right: Coord) -> Self {
Rectangle {
top_left,
bottom_right,
style: Style::default(),
}
}
}
impl<C> WithStyle<C> for Rectangle<C>
where
C: PixelColor,
{
fn style(mut self, style: Style<C>) -> Self {
self.style = style;
self
}
fn stroke(mut self, color: Option<C>) -> Self {
self.style.stroke_color = color;
self
}
fn stroke_width(mut self, width: u8) -> Self {
self.style.stroke_width = width;
self
}
fn fill(mut self, color: Option<C>) -> Self {
self.style.fill_color = color;
self
}
}
impl<C> IntoIterator for Rectangle<C>
where
C: PixelColor,
{
type Item = Pixel<C>;
type IntoIter = RectangleIterator<C>;
fn into_iter(self) -> Self::IntoIter {
(&self).into_iter()
}
}
impl<'a, C> IntoIterator for &'a Rectangle<C>
where
C: PixelColor,
{
type Item = Pixel<C>;
type IntoIter = RectangleIterator<C>;
fn into_iter(self) -> Self::IntoIter {
RectangleIterator {
top_left: self.top_left,
bottom_right: self.bottom_right,
style: self.style,
x: self.top_left[0],
y: self.top_left[1],
}
}
}
/// Pixel iterator for each pixel in the rect border
#[derive(Debug, Clone, Copy)]
pub struct RectangleIterator<C: PixelColor>
where
C: PixelColor,
{
top_left: Coord,
bottom_right: Coord,
style: Style<C>,
x: i32,
y: i32,
}
impl<C> Iterator for RectangleIterator<C>
where
C: PixelColor,
{
type Item = Pixel<C>;
fn next(&mut self) -> Option<Self::Item> {
// If entire object is off the top left of the screen or has no border or fill colour,
// don't render anything
if (self.top_left[0] < 0 || self.top_left[1] < 0)
&& (self.bottom_right[0] < 0 || self.bottom_right[1] < 0)
|| (self.style.stroke_color.is_none() && self.style.fill_color.is_none())
{
return None;
}
let pixel = loop {
let mut out = None;
// Finished, i.e. we're below the rect
if self.y > self.bottom_right[1] {
break None;
}
let border_width = self.style.stroke_width as i32;
let tl = self.top_left;
let br = self.bottom_right;
if self.x >= 0 && self.y >= 0 {
// Border
if (
// Top border
(self.y >= tl[1] && self.y < tl[1] + border_width)
// Bottom border
|| (self.y <= br[1] && self.y > br[1] - border_width)
// Left border
|| (self.x >= tl[0] && self.x < tl[0] + border_width)
// Right border
|| (self.x <= br[0] && self.x > br[0] - border_width)
) && self.style.stroke_color.is_some()
{
out = Some((
self.x,
self.y,
self.style.stroke_color.expect("Expected stroke"),
));
}
// Fill
else if let Some(fill) = self.style.fill_color {
out = Some((self.x, self.y, fill));
}
}
self.x += 1;
// Reached end of row? Jump down one line
if self.x > self.bottom_right[0] {
self.x = self.top_left[0];
self.y += 1;
}
if out.is_some() {
break out;
}
};
pixel.map(|(x, y, c)| Pixel(Coord::new(x, y).to_unsigned(), c))
}
}
impl<C> Drawable for Rectangle<C> where C: PixelColor {}
impl<C> Transform for Rectangle<C>
where
C: PixelColor,
{
/// Translate the rect from its current position to a new position by (x, y) pixels, returning
/// a new `Rectangle`. For a mutating transform, see `translate_mut`.
///
/// ```
/// # use embedded_graphics::primitives::Rectangle;
/// # use embedded_graphics::prelude::*;
/// #
/// # let style = Style::stroke(1u8);
/// #
/// let rect = Rectangle::new(Coord::new(5, 10), Coord::new(15, 20))
/// # .style(style);
/// let moved = rect.translate(Coord::new(10, 10));
///
/// assert_eq!(moved.top_left, Coord::new(15, 20));
/// assert_eq!(moved.bottom_right, Coord::new(25, 30));
/// ```
fn translate(&self, by: Coord) -> Self {
Self {
top_left: self.top_left + by,
bottom_right: self.bottom_right + by,
..self.clone()
}
}
/// Translate the rect from its current position to a new position by (x, y) pixels.
///
/// ```
/// # use embedded_graphics::primitives::Rectangle;
/// # use embedded_graphics::prelude::*;
/// #
/// # let style = Style::stroke(1u8);
/// #
/// let mut rect = Rectangle::new(Coord::new(5, 10), Coord::new(15, 20))
/// # .style(style);
/// rect.translate_mut(Coord::new(10, 10));
///
/// assert_eq!(rect.top_left, Coord::new(15, 20));
/// assert_eq!(rect.bottom_right, Coord::new(25, 30));
/// ```
fn translate_mut(&mut self, by: Coord) -> &mut Self {
self.top_left += by;
self.bottom_right += by;
self
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::unsignedcoord::UnsignedCoord;
#[test]
fn dimensions() {
let rect: Rectangle<u8> = Rectangle::new(Coord::new(5, 10), Coord::new(15, 20));
let moved = rect.translate(Coord::new(-10, -10));
assert_eq!(rect.top_left(), Coord::new(5, 10));
assert_eq!(rect.bottom_right(), Coord::new(15, 20));
assert_eq!(rect.size(), UnsignedCoord::new(10, 10));
assert_eq!(moved.top_left(), Coord::new(-5, 0));
assert_eq!(moved.bottom_right(), Coord::new(5, 10));
assert_eq!(moved.size(), UnsignedCoord::new(10, 10));
}
#[test]
fn it_can_be_translated() {
let rect: Rectangle<u8> = Rectangle::new(Coord::new(5, 10), Coord::new(15, 20));
let moved = rect.translate(Coord::new(10, 10));
assert_eq!(moved.top_left, Coord::new(15, 20));
assert_eq!(moved.bottom_right, Coord::new(25, 30));
}
#[test]
fn it_draws_unfilled_rect() {
let mut rect: RectangleIterator<u8> = Rectangle::new(Coord::new(2, 2), Coord::new(4, 4))
.style(Style::stroke(1))
.into_iter();
assert_eq!(rect.next(), Some(Pixel(UnsignedCoord::new(2, 2), 1.into())));
assert_eq!(rect.next(), Some(Pixel(UnsignedCoord::new(3, 2), 1.into())));
assert_eq!(rect.next(), Some(Pixel(UnsignedCoord::new(4, 2), 1.into())));
assert_eq!(rect.next(), Some(Pixel(UnsignedCoord::new(2, 3), 1.into())));
assert_eq!(rect.next(), Some(Pixel(UnsignedCoord::new(4, 3), 1.into())));
assert_eq!(rect.next(), Some(Pixel(UnsignedCoord::new(2, 4), 1.into())));
assert_eq!(rect.next(), Some(Pixel(UnsignedCoord::new(3, 4), 1.into())));
assert_eq!(rect.next(), Some(Pixel(UnsignedCoord::new(4, 4), 1.into())));
}
#[test]
fn it_can_be_negative() {
let mut rect: RectangleIterator<u8> = Rectangle::new(Coord::new(-2, -2), Coord::new(2, 2))
.style(Style::stroke(1))
.into_iter();
// TODO: Macro
// Only the bottom right corner of the rect should be visible
assert_eq!(rect.next(), Some(Pixel(UnsignedCoord::new(2, 0), 1.into())));
assert_eq!(rect.next(), Some(Pixel(UnsignedCoord::new(2, 1), 1.into())));
assert_eq!(rect.next(), Some(Pixel(UnsignedCoord::new(0, 2), 1.into())));
assert_eq!(rect.next(), Some(Pixel(UnsignedCoord::new(1, 2), 1.into())));
assert_eq!(rect.next(), Some(Pixel(UnsignedCoord::new(2, 2), 1.into())));
}
}