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
//! The sector primitive
use crate::{
geometry::{Angle, Dimensions, Point, Size},
primitives::{
common::PlaneSector, Circle, ContainsPoint, OffsetOutline, PointsIter, Primitive, Rectangle,
},
transform::Transform,
};
mod points;
mod styled;
pub use points::Points;
pub use styled::StyledPixelsIterator;
/// Sector primitive
///
/// # Examples
///
/// ## Create some sectors with different styles
///
/// ```rust
/// use embedded_graphics::{
/// pixelcolor::Rgb565,
/// prelude::*,
/// primitives::{Sector, PrimitiveStyle, PrimitiveStyleBuilder},
/// };
/// # use embedded_graphics::mock_display::MockDisplay;
/// # let mut display = MockDisplay::default();
/// # display.set_allow_overdraw(true);
///
/// // Sector with 1 pixel wide white stroke with top-left point at (10, 20) with a diameter of 30
/// Sector::new(Point::new(10, 20), 30, 0.0.deg(), 90.0.deg())
/// .into_styled(PrimitiveStyle::with_stroke(Rgb565::WHITE, 1))
/// .draw(&mut display)?;
///
/// // Sector with styled stroke and fill with top-left point at (10, 20) with a diameter of 30
/// let style = PrimitiveStyleBuilder::new()
/// .stroke_color(Rgb565::RED)
/// .stroke_width(3)
/// .fill_color(Rgb565::GREEN)
/// .build();
///
/// Sector::new(Point::new(10, 20), 30, 180.0.deg(), -90.0.deg())
/// .into_styled(style)
/// .draw(&mut display)?;
///
/// // Sector with blue fill and no stroke with a translation applied
/// Sector::new(Point::new(10, 20), 30, 0.0.deg(), 90.0.deg())
/// .translate(Point::new(15, 5))
/// .into_styled(PrimitiveStyle::with_fill(Rgb565::BLUE))
/// .draw(&mut display)?;
/// # Ok::<(), core::convert::Infallible>(())
/// ```
#[derive(Copy, Clone, PartialEq, PartialOrd, Debug)]
#[cfg_attr(feature = "defmt", derive(::defmt::Format))]
pub struct Sector {
/// Top-left point of the bounding-box of the circle supporting the sector
pub top_left: Point,
/// Diameter of the circle supporting the sector
pub diameter: u32,
/// Angle at which the sector starts
pub angle_start: Angle,
/// Angle defining the sector sweep starting at angle_start
pub angle_sweep: Angle,
}
impl Sector {
/// Create a new sector delimited with a top-left point with a specific diameter and start and sweep angles
pub const fn new(
top_left: Point,
diameter: u32,
angle_start: Angle,
angle_sweep: Angle,
) -> Self {
Sector {
top_left,
diameter,
angle_start,
angle_sweep,
}
}
/// Create a new sector centered around a given point with a specific diameter and start and sweep angles
pub const fn with_center(
center: Point,
diameter: u32,
angle_start: Angle,
angle_sweep: Angle,
) -> Self {
let top_left = Rectangle::with_center(center, Size::new_equal(diameter)).top_left;
Sector {
top_left,
diameter,
angle_start,
angle_sweep,
}
}
/// Creates an arc based on a circle.
///
/// The resulting sector will match the `top_left` and `diameter` of the base circle.
pub const fn from_circle(circle: Circle, angle_start: Angle, angle_sweep: Angle) -> Self {
Sector {
top_left: circle.top_left,
diameter: circle.diameter,
angle_start,
angle_sweep,
}
}
/// Returns a circle with the same `top_left` and `diameter` as this sector.
pub const fn to_circle(&self) -> Circle {
Circle::new(self.top_left, self.diameter)
}
/// Return the center point of the sector
pub fn center(&self) -> Point {
self.bounding_box().center()
}
/// Returns the center point of the sector scaled by a factor of 2.
///
/// This method is used to accurately calculate the outside edge of the sector.
/// The result is not equivalent to `self.center() * 2` because of rounding.
fn center_2x(&self) -> Point {
// The radius scaled up by a factor of 2 is equal to the diameter
let radius = self.diameter.saturating_sub(1);
self.top_left * 2 + Size::new(radius, radius)
}
}
impl OffsetOutline for Sector {
fn offset(&self, offset: i32) -> Self {
let circle = self.to_circle().offset(offset);
Self::from_circle(circle, self.angle_start, self.angle_sweep)
}
}
impl Primitive for Sector {}
impl PointsIter for Sector {
type Iter = Points;
fn points(&self) -> Self::Iter {
Points::new(self)
}
}
impl ContainsPoint for Sector {
fn contains(&self, point: Point) -> bool {
if self.to_circle().contains(point) {
let delta = point * 2 - self.center_2x();
PlaneSector::new(self.angle_start, self.angle_sweep).contains(delta)
} else {
false
}
}
}
impl Dimensions for Sector {
fn bounding_box(&self) -> Rectangle {
Rectangle::new(self.top_left, Size::new_equal(self.diameter))
}
}
impl Transform for Sector {
/// Translate the sector from its current position to a new position by (x, y) pixels,
/// returning a new `Sector`. For a mutating transform, see `translate_mut`.
///
/// ```
/// # use embedded_graphics::primitives::Sector;
/// # use embedded_graphics::prelude::*;
/// let sector = Sector::new(Point::new(5, 10), 10, 0.0.deg(), 90.0.deg());
/// let moved = sector.translate(Point::new(10, 10));
///
/// assert_eq!(moved.top_left, Point::new(15, 20));
/// ```
fn translate(&self, by: Point) -> Self {
Self {
top_left: self.top_left + by,
..*self
}
}
/// Translate the sector from its current position to a new position by (x, y) pixels.
///
/// ```
/// # use embedded_graphics::primitives::Sector;
/// # use embedded_graphics::prelude::*;
/// let mut sector = Sector::new(Point::new(5, 10), 10, 0.0.deg(), 90.0.deg());
/// sector.translate_mut(Point::new(10, 10));
///
/// assert_eq!(sector.top_left, Point::new(15, 20));
/// ```
fn translate_mut(&mut self, by: Point) -> &mut Self {
self.top_left += by;
self
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::geometry::AngleUnit;
#[test]
fn negative_dimensions() {
let sector = Sector::new(Point::new(-15, -15), 10, 0.0.deg(), 90.0.deg());
assert_eq!(
sector.bounding_box(),
Rectangle::new(Point::new(-15, -15), Size::new(10, 10))
);
}
#[test]
fn dimensions() {
let sector = Sector::new(Point::new(5, 15), 10, 0.0.deg(), 90.0.deg());
assert_eq!(
sector.bounding_box(),
Rectangle::new(Point::new(5, 15), Size::new(10, 10))
);
}
#[test]
fn it_handles_negative_coordinates() {
let positive = Sector::new(Point::new(10, 10), 5, 0.0.deg(), 90.0.deg()).points();
let negative = Sector::new(Point::new(-10, -10), 5, 0.0.deg(), 90.0.deg()).points();
assert!(negative.eq(positive.map(|p| p - Point::new(20, 20))));
}
#[test]
fn center_is_correct() {
// odd diameter
let sector = Sector::new(Point::new(10, 10), 5, 0.0.deg(), 90.0.deg());
assert_eq!(sector.center(), Point::new(12, 12));
// even diameter
let sector = Sector::new(Point::new(10, 10), 6, 0.0.deg(), 90.0.deg());
assert_eq!(sector.center(), Point::new(12, 12));
// odd diameter
let sector = Sector::with_center(Point::new(10, 10), 5, 0.0.deg(), 90.0.deg());
assert_eq!(sector.center(), Point::new(10, 10));
// even diameter
let sector = Sector::with_center(Point::new(10, 10), 6, 0.0.deg(), 90.0.deg());
assert_eq!(sector.center(), Point::new(10, 10));
}
#[test]
fn contains() {
let sector = Sector::new(Point::zero(), 10, 0.0.deg(), 90.0.deg());
let contained_points = Rectangle::new(Point::new(-10, -10), Size::new(30, 30))
.points()
.filter(|p| sector.contains(*p));
assert!(contained_points.eq(sector.points()));
}
#[test]
fn offset() {
let center = Point::new(5, 7);
let sector = Sector::with_center(center, 3, 0.0.deg(), 90.0.deg());
assert_eq!(sector.offset(0), sector);
assert_eq!(
sector.offset(1),
Sector::with_center(center, 5, 0.0.deg(), 90.0.deg())
);
assert_eq!(
sector.offset(2),
Sector::with_center(center, 7, 0.0.deg(), 90.0.deg())
);
assert_eq!(
sector.offset(-1),
Sector::with_center(center, 1, 0.0.deg(), 90.0.deg())
);
assert_eq!(
sector.offset(-2),
Sector::with_center(center, 0, 0.0.deg(), 90.0.deg())
);
assert_eq!(
sector.offset(-3),
Sector::with_center(center, 0, 0.0.deg(), 90.0.deg())
);
}
}