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
//! The circle primitive
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::{ToSigned, UnsignedCoord};
/// Circle primitive
///
/// # Examples
///
/// The [macro examples](../../macro.egcircle.html) make for more concise code.
///
/// ## Create some circles with different styles
///
/// ```rust
/// use embedded_graphics::prelude::*;
/// use embedded_graphics::primitives::Circle;
/// # use embedded_graphics::mock_display::Display;
/// # let mut display = Display::default();
///
/// // Default circle with only a stroke centered around (10, 20) with a radius of 30
/// let c1 = Circle::new(Coord::new(10, 20), 30);
///
/// // Circle with styled stroke and fill centered around (50, 20) with a radius of 30
/// let c2 = Circle::new(Coord::new(50, 20), 30)
/// .stroke(Some(5u8))
/// .stroke_width(3)
/// .fill(Some(10u8));
///
/// // Circle with no stroke and a translation applied
/// let c3 = Circle::new(Coord::new(10, 20), 30)
/// .stroke(None)
/// .fill(Some(10u8))
/// .translate(Coord::new(65, 35));
///
/// display.draw(c1);
/// display.draw(c2);
/// display.draw(c3);
/// ```
#[derive(Debug, Copy, Clone)]
pub struct Circle<C: PixelColor> {
/// Center point of circle
pub center: Coord,
/// Radius of the circle
pub radius: u32,
/// Style of the circle
pub style: Style<C>,
}
impl<C> Circle<C>
where
C: PixelColor,
{
/// Create a new circle centered around a given point with a specific radius
pub fn new(center: Coord, radius: u32) -> Self {
Circle {
center,
radius,
style: Style::default(),
}
}
}
impl<C> Primitive for Circle<C> where C: PixelColor {}
impl<C> Dimensions for Circle<C>
where
C: PixelColor,
{
fn top_left(&self) -> Coord {
let radius_coord = Coord::new(self.radius as i32, self.radius as i32);
self.center - radius_coord
}
fn bottom_right(&self) -> Coord {
self.top_left() + self.size().to_signed()
}
fn size(&self) -> UnsignedCoord {
UnsignedCoord::new(self.radius * 2, self.radius * 2)
}
}
impl<C> WithStyle<C> for Circle<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 Circle<C>
where
C: PixelColor,
{
type Item = Pixel<C>;
type IntoIter = CircleIterator<C>;
fn into_iter(self) -> Self::IntoIter {
(&self).into_iter()
}
}
impl<'a, C> IntoIterator for &'a Circle<C>
where
C: PixelColor,
{
type Item = Pixel<C>;
type IntoIter = CircleIterator<C>;
fn into_iter(self) -> Self::IntoIter {
CircleIterator {
center: self.center,
radius: self.radius,
style: self.style,
x: -(self.radius as i32),
y: -(self.radius as i32),
}
}
}
/// Pixel iterator for each pixel in the circle border
#[derive(Debug, Copy, Clone)]
pub struct CircleIterator<C: PixelColor> {
center: Coord,
radius: u32,
style: Style<C>,
x: i32,
y: i32,
}
impl<C> Iterator for CircleIterator<C>
where
C: PixelColor,
{
type Item = Pixel<C>;
// https://stackoverflow.com/questions/1201200/fast-algorithm-for-drawing-filled-circles
fn next(&mut self) -> Option<Self::Item> {
// If border or stroke colour is `None`, treat entire object as transparent and exit early
if self.style.stroke_color.is_none() && self.style.fill_color.is_none() {
return None;
}
let cx = self.center[0];
let cy = self.center[1];
let radius = self.radius as i32 - self.style.stroke_width as i32 + 1;
let outer_radius = self.radius as i32;
let radius_sq = radius * radius;
let outer_radius_sq = outer_radius * outer_radius;
let item = loop {
let tx = self.x;
let ty = self.y;
let len = tx * tx + ty * ty;
let is_border = len > radius_sq - radius && len < outer_radius_sq + radius;
// TODO: Should this be a <= or a <?
let is_fill = len <= outer_radius_sq;
let item = if is_border && self.style.stroke_color.is_some() {
Some((
cx + tx,
cy + ty,
self.style.stroke_color.expect("Border color not defined"),
))
} else if is_fill && self.style.fill_color.is_some() {
Some((
cx + tx,
cy + ty,
self.style.fill_color.expect("Fill color not defined"),
))
} else {
None
};
self.x += 1;
if self.x > self.radius as i32 {
self.x = -(self.radius as i32);
self.y += 1;
}
if self.y > self.radius as i32 {
break None;
}
if let Some(i) = item {
if i.0 >= 0 && i.1 >= 0 {
break item;
}
}
};
item.map(|(x, y, c)| Pixel(Coord::new(x, y).to_unsigned(), c))
}
}
impl<C> Drawable for Circle<C> where C: PixelColor {}
impl<C> Transform for Circle<C>
where
C: PixelColor,
{
/// Translate the circle center from its current position to a new position by (x, y) pixels,
/// returning a new `Circle`. For a mutating transform, see `translate_mut`.
///
/// ```
/// # use embedded_graphics::primitives::Circle;
/// # use embedded_graphics::prelude::*;
/// #
/// # let style = Style::stroke(1u8);
/// #
/// let circle = Circle::new(Coord::new(5, 10), 10)
/// # .style(style);
/// let moved = circle.translate(Coord::new(10, 10));
///
/// assert_eq!(moved.center, Coord::new(15, 20));
/// ```
fn translate(&self, by: Coord) -> Self {
Self {
center: self.center + by,
..self.clone()
}
}
/// Translate the circle center from its current position to a new position by (x, y) pixels.
///
/// ```
/// # use embedded_graphics::primitives::Circle;
/// # use embedded_graphics::prelude::*;
/// #
/// # let style = Style::stroke(1u8);
/// #
/// let mut circle = Circle::new(Coord::new(5, 10), 10)
/// # .style(style);
/// circle.translate_mut(Coord::new(10, 10));
///
/// assert_eq!(circle.center, Coord::new(15, 20));
/// ```
fn translate_mut(&mut self, by: Coord) -> &mut Self {
self.center += by;
self
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::drawable::Dimensions;
#[test]
fn negative_dimensions() {
let circ: Circle<u8> = Circle::new(Coord::new(-10, -10), 5);
assert_eq!(circ.top_left(), Coord::new(-15, -15));
assert_eq!(circ.bottom_right(), Coord::new(-5, -5));
assert_eq!(circ.size(), UnsignedCoord::new(10, 10));
}
#[test]
fn dimensions() {
let circ: Circle<u8> = Circle::new(Coord::new(10, 20), 5);
assert_eq!(circ.top_left(), Coord::new(5, 15));
assert_eq!(circ.bottom_right(), Coord::new(15, 25));
assert_eq!(circ.size(), UnsignedCoord::new(10, 10));
}
#[test]
fn large_radius() {
let circ: Circle<u8> = Circle::new(Coord::new(5, 5), 10);
assert_eq!(circ.top_left(), Coord::new(-5, -5));
assert_eq!(circ.bottom_right(), Coord::new(15, 15));
assert_eq!(circ.size(), UnsignedCoord::new(20, 20));
}
#[test]
fn transparent_border() {
let circ: Circle<u8> = Circle::new(Coord::new(5, 5), 10).stroke(None).fill(Some(1));
assert!(circ.into_iter().count() > 0);
}
#[test]
fn it_handles_offscreen_coords() {
let mut circ: CircleIterator<u8> = Circle::new(Coord::new(-10, -10), 5)
.style(Style::stroke(1))
.into_iter();
assert_eq!(circ.next(), None);
}
#[test]
fn it_handles_partially_on_screen_coords() {
let mut circ: CircleIterator<u8> = Circle::new(Coord::new(-5, -5), 30)
.style(Style::stroke(1))
.into_iter();
assert!(circ.next().is_some());
}
}