Struct embedded_graphics::primitives::polyline::Polyline

source ·
pub struct Polyline<'a> {
    pub translate: Point,
    pub vertices: &'a [Point],
}
Expand description

Polyline primitive

Creates an unfilled chained line shape.

§Examples

§Draw a “heartbeat” shaped polyline

This example draws a stylized cardiogram in a 5px green stroke.

use embedded_graphics::{
    pixelcolor::Rgb565, prelude::*, primitives::{Polyline, PrimitiveStyle},
};

// A "heartbeat" shaped polyline
let points: [Point; 10] = [
    Point::new(10, 64),
    Point::new(50, 64),
    Point::new(60, 44),
    Point::new(70, 64),
    Point::new(80, 64),
    Point::new(90, 74),
    Point::new(100, 10),
    Point::new(110, 84),
    Point::new(120, 64),
    Point::new(300, 64),
];

let line_style = PrimitiveStyle::with_stroke(Rgb565::GREEN, 5);

Polyline::new(&points)
    .into_styled(line_style)
    .draw(&mut display)?;

Fields§

§translate: Point

An offset to apply to the polyline as a whole

§vertices: &'a [Point]

All vertices in the line

Implementations§

source§

impl<'a> Polyline<'a>

source

pub const fn new(vertices: &'a [Point]) -> Self

Create a new polyline from a list of vertices

If fewer than two vertices are provided, the line will not render anything when drawn.

Trait Implementations§

source§

impl<'a> Clone for Polyline<'a>

source§

fn clone(&self) -> Polyline<'a>

Returns a copy of the value. Read more
1.0.0§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'a> Debug for Polyline<'a>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'a> Default for Polyline<'a>

source§

fn default() -> Polyline<'a>

Returns the “default value” for a type. Read more
source§

impl<'a> Dimensions for Polyline<'a>

source§

fn bounding_box(&self) -> Rectangle

Returns the bounding box.
source§

impl<'a> Hash for Polyline<'a>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher]. Read more
1.3.0§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given [Hasher]. Read more
source§

impl<'a> Ord for Polyline<'a>

source§

fn cmp(&self, other: &Polyline<'a>) -> Ordering

This method returns an [Ordering] between self and other. Read more
1.21.0§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl<'a> PartialEq for Polyline<'a>

source§

fn eq(&self, other: &Polyline<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'a> PartialOrd for Polyline<'a>

source§

fn partial_cmp(&self, other: &Polyline<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl<'a> PointsIter for Polyline<'a>

§

type Iter = Points<'a>

Iterator over all points inside the primitive.
source§

fn points(&self) -> Self::Iter

Returns an iterator over all points inside the primitive.
source§

impl<'a> Primitive for Polyline<'a>

source§

fn into_styled<S>(self, style: S) -> Styled<Self, S>
where Self: Sized,

Converts this primitive into a Styled.
source§

impl<C: PixelColor> StyledDimensions<PrimitiveStyle<C>> for Polyline<'_>

source§

fn styled_bounding_box(&self, style: &PrimitiveStyle<C>) -> Rectangle

Returns the bounding box using the given style.
source§

impl<C: PixelColor> StyledDrawable<PrimitiveStyle<C>> for Polyline<'_>

§

type Color = C

Color type.
§

type Output = ()

Output type.
source§

fn draw_styled<D>( &self, style: &PrimitiveStyle<C>, target: &mut D, ) -> Result<Self::Output, D::Error>
where D: DrawTarget<Color = C>,

Draws the primitive using the given style.
source§

impl<'a> Transform for Polyline<'a>

source§

fn translate(&self, by: Point) -> Self

Translate the polyline from its current position to a new position by (x, y) pixels, returning a new Polyline. For a mutating transform, see translate_mut.

let points = [
    Point::new(5, 10),
    Point::new(7, 7),
    Point::new(5, 8),
    Point::new(10, 10),
];

let polyline = Polyline::new(&points);
let moved = polyline.translate(Point::new(10, 12));

assert_eq!(polyline.bounding_box().top_left, Point::new(5, 7));
assert_eq!(moved.bounding_box().top_left, Point::new(15, 19));
source§

fn translate_mut(&mut self, by: Point) -> &mut Self

Translate the polyline from its current position to a new position by (x, y) pixels.

let points = [
    Point::new(5, 10),
    Point::new(7, 7),
    Point::new(5, 8),
    Point::new(10, 10),
];

let mut polyline = Polyline::new(&points);

polyline.translate_mut(Point::new(10, 12));

assert_eq!(polyline.bounding_box().top_left, Point::new(15, 19));
source§

impl<'a> Copy for Polyline<'a>

source§

impl<'a> Eq for Polyline<'a>

source§

impl<'a> StructuralPartialEq for Polyline<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for Polyline<'a>

§

impl<'a> RefUnwindSafe for Polyline<'a>

§

impl<'a> Send for Polyline<'a>

§

impl<'a> Sync for Polyline<'a>

§

impl<'a> Unpin for Polyline<'a>

§

impl<'a> UnwindSafe for Polyline<'a>

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Az for T

source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

source§

fn cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> CheckedAs for T

source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

source§

impl<T> OverflowingAs for T

source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
source§

impl<T> SaturatingAs for T

source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> UnwrappedAs for T

source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> WrappingAs for T

source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.