logo
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

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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

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

Returns the bounding box.

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

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

This method tests for !=.

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

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

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

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

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

Iterator over all points inside the primitive.

Returns an iterator over all points inside the primitive.

Converts this primitive into a Styled.

Returns the bounding box using the given style.

Color type.

Output type.

Draws the primitive using the given style.

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

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

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Casts the value.

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Casts the value.

Casts the value.

Casts the value.

Returns the argument unchanged.

Calls U::from(self).

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

Casts the value.

OverflowingCasts the value.

Casts the value.

Casts the value.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Casts the value.

UnwrappedCasts the value.

Casts the value.

WrappingCasts the value.