Struct embedded_graphics::primitives::polyline::Polyline

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

Polyline primitive

Creates an unfilled chained line shape. Styles with a stroke width greater than 1px are not currently supported and will always render as a 1px wide line.

Examples

Draw a "heartbeat" shaped polyline

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

use embedded_graphics::{
    pixelcolor::Rgb565, prelude::*, primitives::Polyline, style::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, 1);

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

impl<'a> Polyline<'a>

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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

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

fn default() -> Polyline<'a>

Returns the "default value" for a type.

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

fn bounding_box(&self) -> Rectangle

Returns the bounding box.

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

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

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

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

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

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

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

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

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

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

This method tests for !=.

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

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

This method returns an ordering between self and other values if one exists.

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

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

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

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

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

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

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

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

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

type PointsIter = Points<'a>

Iterator over all points inside the primitive.

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

Returns an iterator over all points inside the primitive.

fn into_styled<C>(
    self,
    style: PrimitiveStyle<C>
) -> Styled<Self, PrimitiveStyle<C>> where
    C: PixelColor,
    Self: Sized, 

Converts this primitive into a Styled.

impl<'a> StructuralEq for Polyline<'a>

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

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

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));

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));