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 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
use crate::{pixelcolor::PixelColor, primitives::OffsetOutline};
use az::SaturatingAs;
/// Style properties for primitives.
///
/// `PrimitiveStyle` can be applied to a [primitive] to define how the primitive
/// is drawn.
///
/// Because `PrimitiveStyle` has the [`non_exhaustive`] attribute, it cannot be created using a
/// struct literal. To create a `PrimitiveStyle`, the [`with_stroke`](PrimitiveStyle::with_stroke()) and
/// [`with_fill`](PrimitiveStyle::with_fill()) methods can be used for styles that only require a stroke or
/// fill respectively. For more complex styles, use the [`PrimitiveStyleBuilder`].
///
/// [primitive]: crate::primitives
/// [`non_exhaustive`]: https://blog.rust-lang.org/2019/12/19/Rust-1.40.0.html#[non_exhaustive]-structs,-enums,-and-variants
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
#[cfg_attr(feature = "defmt", derive(::defmt::Format))]
#[non_exhaustive]
pub struct PrimitiveStyle<C>
where
C: PixelColor,
{
/// Fill color of the primitive.
///
/// If `fill_color` is set to `None` no fill will be drawn.
pub fill_color: Option<C>,
/// Stroke color of the primitive.
///
/// If `stroke_color` is set to `None` or the `stroke_width` is set to `0` no stroke will be
/// drawn.
pub stroke_color: Option<C>,
/// Stroke width in pixels.
pub stroke_width: u32,
/// Stroke alignment.
///
/// The stroke alignment sets if the stroke is drawn inside, outside or centered
/// on the outline of a shape.
///
/// This property only applies to closed shapes (rectangle, circle, ...) and is
/// ignored for open shapes (line, ...).
pub stroke_alignment: StrokeAlignment,
}
impl<C> PrimitiveStyle<C>
where
C: PixelColor,
{
/// Creates a primitive style without fill and stroke.
pub const fn new() -> Self {
Self::const_default()
}
/// Creates a stroke primitive style.
///
/// If the `stroke_width` is `0` the resulting style won't draw a stroke.
pub const fn with_stroke(stroke_color: C, stroke_width: u32) -> Self {
Self {
stroke_color: Some(stroke_color),
stroke_width,
..PrimitiveStyle::const_default()
}
}
/// Creates a fill primitive style.
pub const fn with_fill(fill_color: C) -> Self {
Self {
fill_color: Some(fill_color),
..PrimitiveStyle::const_default()
}
}
/// Returns the stroke width on the outside of the shape.
///
/// The outside stroke width is determined by `stroke_width` and `stroke_alignment`.
pub(crate) const fn outside_stroke_width(&self) -> u32 {
match self.stroke_alignment {
StrokeAlignment::Inside => 0,
StrokeAlignment::Center => self.stroke_width / 2,
StrokeAlignment::Outside => self.stroke_width,
}
}
/// Returns the stroke width on the inside of the shape.
///
/// The inside stroke width is determined by `stroke_width` and `stroke_alignment`.
pub(crate) const fn inside_stroke_width(&self) -> u32 {
match self.stroke_alignment {
StrokeAlignment::Inside => self.stroke_width,
StrokeAlignment::Center => self.stroke_width.saturating_add(1) / 2,
StrokeAlignment::Outside => 0,
}
}
/// Returns if a primitive drawn with this style is completely transparent.
pub const fn is_transparent(&self) -> bool {
(self.stroke_color.is_none() || self.stroke_width == 0) && self.fill_color.is_none()
}
/// Returns the effective stroke color of the style.
///
/// If the stroke width is 0, this method will return `None` regardless of the value in
/// `stroke_color`.
pub(crate) fn effective_stroke_color(&self) -> Option<C> {
self.stroke_color.filter(|_| self.stroke_width > 0)
}
/// Returns the stroke area.
pub(in crate::primitives) fn stroke_area<P: OffsetOutline>(&self, primitive: &P) -> P {
// saturate offset at i32::max_value() if stroke width is to large
let offset = self.outside_stroke_width().saturating_as();
primitive.offset(offset)
}
/// Returns the fill area.
pub(in crate::primitives) fn fill_area<P: OffsetOutline>(&self, primitive: &P) -> P {
// saturate offset at i32::min_value() if stroke width is to large
let offset = -self.inside_stroke_width().saturating_as::<i32>();
primitive.offset(offset)
}
/// A helper function to allow `const` default.
// MSRV: Move into `Default` impl when we have consts in traits
const fn const_default() -> Self {
Self {
fill_color: None,
stroke_color: None,
stroke_width: 0,
stroke_alignment: StrokeAlignment::Center,
}
}
}
impl<C> Default for PrimitiveStyle<C>
where
C: PixelColor,
{
fn default() -> Self {
Self::const_default()
}
}
/// Primitive style builder.
///
/// Use this builder to create [`PrimitiveStyle`]s. If any properties on the builder are omitted,
/// the value will remain at its default value.
///
/// # Examples
///
/// ## Build a style with configured stroke and fill
///
/// This example builds a style for a circle with a 3px red stroke and a solid green fill. The
/// circle has its top-left at (10, 10) with a diameter of 20px.
///
/// ```rust
/// use embedded_graphics::{
/// pixelcolor::Rgb565,
/// prelude::*,
/// primitives::{Circle, PrimitiveStyle, PrimitiveStyleBuilder},
/// };
///
/// let style: PrimitiveStyle<Rgb565> = PrimitiveStyleBuilder::new()
/// .stroke_color(Rgb565::RED)
/// .stroke_width(3)
/// .fill_color(Rgb565::GREEN)
/// .build();
///
/// let circle = Circle::new(Point::new(10, 10), 20).into_styled(style);
/// ```
///
/// ## Build a style with stroke and no fill
///
/// This example builds a style for a rectangle with a 1px red stroke. Because `.fill_color()` is
/// not called, the fill color remains the default value of `None` (i.e. transparent).
///
/// ```rust
/// use embedded_graphics::{
/// pixelcolor::Rgb565,
/// prelude::*,
/// primitives::{Rectangle, PrimitiveStyle, PrimitiveStyleBuilder},
/// };
///
/// let style: PrimitiveStyle<Rgb565> = PrimitiveStyleBuilder::new()
/// .stroke_color(Rgb565::RED)
/// .stroke_width(1)
/// .build();
///
/// let rectangle = Rectangle::new(Point::new(20, 20), Size::new(20, 10)).into_styled(style);
/// ```
///
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default)]
#[cfg_attr(feature = "defmt", derive(::defmt::Format))]
pub struct PrimitiveStyleBuilder<C>
where
C: PixelColor,
{
style: PrimitiveStyle<C>,
}
impl<C> PrimitiveStyleBuilder<C>
where
C: PixelColor,
{
/// Creates a new primitive style builder.
pub const fn new() -> Self {
Self {
style: PrimitiveStyle::const_default(),
}
}
/// Sets the fill color.
pub const fn fill_color(mut self, fill_color: C) -> Self {
self.style.fill_color = Some(fill_color);
self
}
/// Resets the fill color to transparent.
pub const fn reset_fill_color(mut self) -> Self {
self.style.fill_color = None;
self
}
/// Sets the stroke color.
pub const fn stroke_color(mut self, stroke_color: C) -> Self {
self.style.stroke_color = Some(stroke_color);
self
}
/// Resets the stroke color to transparent.
pub const fn reset_stroke_color(mut self) -> Self {
self.style.stroke_color = None;
self
}
/// Sets the stroke width.
pub const fn stroke_width(mut self, stroke_width: u32) -> Self {
self.style.stroke_width = stroke_width;
self
}
/// Sets the stroke alignment.
pub const fn stroke_alignment(mut self, stroke_alignment: StrokeAlignment) -> Self {
self.style.stroke_alignment = stroke_alignment;
self
}
/// Builds the primitive style.
pub const fn build(self) -> PrimitiveStyle<C> {
self.style
}
}
impl<C> From<&PrimitiveStyle<C>> for PrimitiveStyleBuilder<C>
where
C: PixelColor,
{
fn from(style: &PrimitiveStyle<C>) -> Self {
Self { style: *style }
}
}
/// Stroke alignment.
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
#[cfg_attr(feature = "defmt", derive(::defmt::Format))]
pub enum StrokeAlignment {
/// Inside.
Inside,
/// Center.
Center,
/// Outside.
Outside,
}
impl Default for StrokeAlignment {
fn default() -> Self {
Self::Center
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::pixelcolor::{BinaryColor, Rgb888, RgbColor};
#[test]
fn default_style() {
assert_eq!(
PrimitiveStyle::<BinaryColor>::default(),
PrimitiveStyle {
fill_color: None,
stroke_color: None,
stroke_width: 0,
stroke_alignment: StrokeAlignment::Center,
}
);
assert_eq!(
PrimitiveStyle::<BinaryColor>::default(),
PrimitiveStyle::new()
);
}
#[test]
fn constructors() {
let style = PrimitiveStyle::with_fill(Rgb888::RED);
assert_eq!(style.fill_color, Some(Rgb888::RED));
assert_eq!(style.stroke_color, None);
let style = PrimitiveStyle::with_stroke(Rgb888::GREEN, 123);
assert_eq!(style.fill_color, None);
assert_eq!(style.stroke_color, Some(Rgb888::GREEN));
assert_eq!(style.stroke_width, 123);
}
#[test]
fn stroke_alignment_1px() {
let mut style = PrimitiveStyle::with_stroke(BinaryColor::On, 1);
style.stroke_alignment = StrokeAlignment::Inside;
assert_eq!(style.inside_stroke_width(), 1);
assert_eq!(style.outside_stroke_width(), 0);
style.stroke_alignment = StrokeAlignment::Center;
assert_eq!(style.inside_stroke_width(), 1);
assert_eq!(style.outside_stroke_width(), 0);
style.stroke_alignment = StrokeAlignment::Outside;
assert_eq!(style.inside_stroke_width(), 0);
assert_eq!(style.outside_stroke_width(), 1);
}
#[test]
fn stroke_alignment_2px() {
let mut style = PrimitiveStyle::with_stroke(BinaryColor::On, 2);
style.stroke_alignment = StrokeAlignment::Inside;
assert_eq!(style.inside_stroke_width(), 2);
assert_eq!(style.outside_stroke_width(), 0);
style.stroke_alignment = StrokeAlignment::Center;
assert_eq!(style.inside_stroke_width(), 1);
assert_eq!(style.outside_stroke_width(), 1);
style.stroke_alignment = StrokeAlignment::Outside;
assert_eq!(style.inside_stroke_width(), 0);
assert_eq!(style.outside_stroke_width(), 2);
}
#[test]
fn builder_default() {
assert_eq!(
PrimitiveStyleBuilder::<BinaryColor>::new().build(),
PrimitiveStyle::<BinaryColor>::default()
);
}
#[test]
fn builder_stroke() {
assert_eq!(
PrimitiveStyleBuilder::new()
.stroke_color(BinaryColor::On)
.stroke_width(10)
.build(),
PrimitiveStyle::with_stroke(BinaryColor::On, 10)
);
}
#[test]
fn builder_reset_stroke_color() {
assert_eq!(
PrimitiveStyleBuilder::new()
.stroke_color(BinaryColor::On)
.stroke_width(10)
.fill_color(BinaryColor::Off)
.reset_stroke_color()
.build(),
PrimitiveStyleBuilder::new()
.stroke_width(10)
.fill_color(BinaryColor::Off)
.build()
);
}
#[test]
fn builder_fill() {
assert_eq!(
PrimitiveStyleBuilder::new()
.fill_color(BinaryColor::On)
.build(),
PrimitiveStyle::with_fill(BinaryColor::On)
);
}
#[test]
fn builder_reset_fill_color() {
assert_eq!(
PrimitiveStyleBuilder::new()
.fill_color(BinaryColor::On)
.stroke_color(BinaryColor::Off)
.reset_fill_color()
.build(),
PrimitiveStyleBuilder::new()
.stroke_color(BinaryColor::Off)
.build(),
);
}
#[test]
fn effective_stroke_color() {
assert_eq!(
PrimitiveStyle::with_stroke(BinaryColor::On, 1).effective_stroke_color(),
Some(BinaryColor::On)
);
assert_eq!(
PrimitiveStyle::with_stroke(BinaryColor::On, 0).effective_stroke_color(),
None
);
}
#[test]
fn stroke_width_max_value() {
assert_eq!(
PrimitiveStyleBuilder::from(&PrimitiveStyle::with_stroke(
BinaryColor::On,
core::u32::MAX
))
.stroke_alignment(StrokeAlignment::Center)
.build()
.inside_stroke_width(),
core::u32::MAX / 2
);
}
}