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
//! The arc primitive
use crate::{
geometry::{Angle, Dimensions, Point, Size},
primitives::{Circle, PointsIter, Primitive, Rectangle},
transform::Transform,
};
mod points;
mod styled;
pub use points::Points;
pub use styled::StyledPixelsIterator;
/// Arc primitive
///
/// # Examples
///
/// ## Create some arcs with different styles
///
/// ```rust
/// use embedded_graphics::{
/// pixelcolor::Rgb565,
/// prelude::*,
/// primitives::{Arc, PrimitiveStyle, PrimitiveStyleBuilder},
/// };
/// # use embedded_graphics::mock_display::MockDisplay;
/// # let mut display = MockDisplay::default();
///
/// // Arc with 1 pixel wide white stroke with top-left point at (10, 20) with a diameter of 30
/// Arc::new(Point::new(10, 20), 30, 0.0.deg(), 90.0.deg())
/// .into_styled(PrimitiveStyle::with_stroke(Rgb565::WHITE, 1))
/// .draw(&mut display)?;
///
/// // Arc with styled stroke with top-left point at (15, 25) with a diameter of 20
/// let style = PrimitiveStyleBuilder::new()
/// .stroke_color(Rgb565::RED)
/// .stroke_width(3)
/// .build();
///
/// Arc::new(Point::new(15, 25), 20, 180.0.deg(), -90.0.deg())
/// .into_styled(style)
/// .draw(&mut display)?;
/// # Ok::<(), core::convert::Infallible>(())
/// ```
#[derive(Copy, Clone, PartialEq, PartialOrd, Debug)]
pub struct Arc {
/// Top-left point of the bounding-box of the circle supporting the arc
pub top_left: Point,
/// Diameter of the circle supporting the arc
pub diameter: u32,
/// Angle at which the arc starts
pub angle_start: Angle,
/// Angle defining the arc sweep starting at angle_start
pub angle_sweep: Angle,
}
impl Arc {
/// Create a new arc 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 {
Arc {
top_left,
diameter,
angle_start,
angle_sweep,
}
}
/// Create a new arc centered around a given point with a specific diameter and start and sweep angles
pub fn with_center(
center: Point,
diameter: u32,
angle_start: Angle,
angle_sweep: Angle,
) -> Self {
Self::from_circle(
Circle::with_center(center, diameter),
angle_start,
angle_sweep,
)
}
/// Creates an arc based on a circle.
///
/// The resulting arc will match the `top_left` and `diameter` of the base circle.
pub fn from_circle(circle: Circle, angle_start: Angle, angle_sweep: Angle) -> Self {
Self {
top_left: circle.top_left,
diameter: circle.diameter,
angle_start,
angle_sweep,
}
}
/// Returns a circle with the same `top_left` and `diameter` as this arc.
pub fn to_circle(&self) -> Circle {
Circle::new(self.top_left, self.diameter)
}
/// Return the center point of the arc.
pub fn center(&self) -> Point {
self.bounding_box().center()
}
}
impl Primitive for Arc {}
impl PointsIter for Arc {
type Iter = Points;
fn points(&self) -> Self::Iter {
Points::new(self)
}
}
impl Dimensions for Arc {
fn bounding_box(&self) -> Rectangle {
Rectangle::new(self.top_left, Size::new(self.diameter, self.diameter))
}
}
impl Transform for Arc {
/// Translate the arc from its current position to a new position by (x, y) pixels,
/// returning a new `Arc`. For a mutating transform, see `translate_mut`.
///
/// ```
/// # use embedded_graphics::primitives::Arc;
/// # use embedded_graphics::prelude::*;
/// let arc = Arc::new(Point::new(5, 10), 10, 0.0.deg(), 90.0.deg());
/// let moved = arc.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 arc from its current position to a new position by (x, y) pixels.
///
/// ```
/// # use embedded_graphics::primitives::Arc;
/// # use embedded_graphics::prelude::*;
/// let mut arc = Arc::new(Point::new(5, 10), 10, 0.0.deg(), 90.0.deg());
/// arc.translate_mut(Point::new(10, 10));
///
/// assert_eq!(arc.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 arc = Arc::new(Point::new(-15, -15), 10, 0.0.deg(), 90.0.deg());
assert_eq!(
arc.bounding_box(),
Rectangle::new(Point::new(-15, -15), Size::new(10, 10))
);
}
#[test]
fn dimensions() {
let arc = Arc::new(Point::new(5, 15), 10, 0.0.deg(), 90.0.deg());
assert_eq!(
arc.bounding_box(),
Rectangle::new(Point::new(5, 15), Size::new(10, 10))
);
}
#[test]
fn it_handles_negative_coordinates() {
let positive = Arc::new(Point::new(10, 10), 5, 0.0.deg(), 90.0.deg()).points();
let negative = Arc::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 arc = Arc::new(Point::new(10, 10), 5, 0.0.deg(), 90.0.deg());
assert_eq!(arc.center(), Point::new(12, 12));
// even diameter
let arc = Arc::new(Point::new(10, 10), 6, 0.0.deg(), 90.0.deg());
assert_eq!(arc.center(), Point::new(12, 12));
// odd diameter
let arc = Arc::with_center(Point::new(10, 10), 5, 0.0.deg(), 90.0.deg());
assert_eq!(arc.center(), Point::new(10, 10));
// even diameter
let arc = Arc::with_center(Point::new(10, 10), 6, 0.0.deg(), 90.0.deg());
assert_eq!(arc.center(), Point::new(10, 10));
}
}