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
use crate::pixelcolor::PixelColor;
use core::convert::TryFrom;
/// 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`, use the [`primitive_style!`] macro or
/// [`PrimitiveStyleBuilder`].
///
/// [primitive]: ../primitives/index.html
/// [`PrimitiveStyleBuilder`]: ../style/struct.PrimitiveStyleBuilder.html
/// [`non_exhaustive`]: https://blog.rust-lang.org/2019/12/19/Rust-1.40.0.html#[non_exhaustive]-structs,-enums,-and-variants
/// [`primitive_style!`]: ../macro.primitive_style.html
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
#[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,
}
impl<C> PrimitiveStyle<C>
where
C: PixelColor,
{
/// Creates a primitive style without fill and stroke.
pub fn new() -> Self {
Self::default()
}
/// Creates a stroke primitive style.
///
/// If the `stroke_width` is `0` the resulting style won't draw a stroke.
pub fn with_stroke(stroke_color: C, stroke_width: u32) -> Self {
Self {
stroke_color: Some(stroke_color),
stroke_width,
..PrimitiveStyle::default()
}
}
/// Creates a fill primitive style.
pub fn with_fill(fill_color: C) -> Self {
Self {
fill_color: Some(fill_color),
..PrimitiveStyle::default()
}
}
/// Returns the stroke width as an `i32`.
///
/// If the stroke width is too large to fit into an `i32` the maximum value
/// for an `i32` is returned instead.
pub(crate) fn stroke_width_i32(&self) -> i32 {
i32::try_from(self.stroke_width).unwrap_or(i32::max_value())
}
}
impl<C> Default for PrimitiveStyle<C>
where
C: PixelColor,
{
fn default() -> Self {
Self {
fill_color: None,
stroke_color: None,
stroke_width: 0,
}
}
}
/// 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.
///
/// The [`primitive_style!`] macro can also be used to create [`PrimitiveStyle`]s, but with a
/// shorter syntax. See the [`primitive_style!`] documentation for examples.
///
/// # 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 is centered at (20, 20) with a radius of 10px.
///
/// ```rust
/// use embedded_graphics::{
/// egtext,
/// pixelcolor::Rgb565,
/// prelude::*,
/// primitives::Circle,
/// style::{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(20, 20), 10).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::{
/// egtext,
/// pixelcolor::Rgb565,
/// prelude::*,
/// primitives::Rectangle,
/// style::{PrimitiveStyle, PrimitiveStyleBuilder},
/// };
///
/// let style: PrimitiveStyle<Rgb565> = PrimitiveStyleBuilder::new()
/// .stroke_color(Rgb565::RED)
/// .stroke_width(1)
/// .build();
///
/// let rectangle = Rectangle::new(Point::new(20, 20), Point::new(40, 30)).into_styled(style);
/// ```
///
/// [`PrimitiveStyle`]: ./struct.PrimitiveStyle.html
/// [`primitive_style!`]: ../macro.primitive_style.html
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default)]
pub struct PrimitiveStyleBuilder<C>
where
C: PixelColor,
{
style: PrimitiveStyle<C>,
}
impl<C> PrimitiveStyleBuilder<C>
where
C: PixelColor,
{
/// Creates a new primitive style builder.
pub fn new() -> Self {
Self {
style: PrimitiveStyle::default(),
}
}
/// Sets the fill color.
pub fn fill_color(mut self, fill_color: C) -> Self {
self.style.fill_color = Some(fill_color);
self
}
/// Sets the stroke color.
pub fn stroke_color(mut self, stroke_color: C) -> Self {
self.style.stroke_color = Some(stroke_color);
self
}
/// Sets the stroke width.
pub fn stroke_width(mut self, stroke_width: u32) -> Self {
self.style.stroke_width = stroke_width;
self
}
/// Builds the primitive style.
pub fn build(self) -> PrimitiveStyle<C> {
self.style
}
}
#[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,
}
);
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_width_i32() {
let mut style: PrimitiveStyle<BinaryColor> = PrimitiveStyle::default();
style.stroke_width = 1;
assert_eq!(style.stroke_width_i32(), 1);
style.stroke_width = 0x7FFFFFFF;
assert_eq!(style.stroke_width_i32(), 0x7FFFFFFF);
style.stroke_width = 0x80000000;
assert_eq!(style.stroke_width_i32(), 0x7FFFFFFF);
style.stroke_width = 0xFFFFFFFF;
assert_eq!(style.stroke_width_i32(), 0x7FFFFFFF);
}
#[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_fill() {
assert_eq!(
PrimitiveStyleBuilder::new()
.fill_color(BinaryColor::On)
.build(),
PrimitiveStyle::with_fill(BinaryColor::On)
);
}
}