Struct embedded_graphics::primitives::triangle::Triangle

pub struct Triangle {
    pub p1: Point,
    pub p2: Point,
    pub p3: Point,
}

Triangle primitive

Examples

The macro examples make for more concise code.

Create some triangles with different styles

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

// Triangle with red 1 px wide stroke
Triangle::new(Point::new(50, 20), Point::new(60, 35), Point::new(70, 80))
    .into_styled(PrimitiveStyle::with_stroke(Rgb565::RED, 1))
    .draw(&mut display)?;

// Triangle with translation applied
Triangle::new(Point::new(50, 20), Point::new(60, 35), Point::new(70, 80))
    .translate(Point::new(65, 35))
    .into_styled(PrimitiveStyle::with_stroke(Rgb565::GREEN, 1))
    .draw(&mut display)?;

Create a triangle from an array of points

use embedded_graphics::{geometry::Point, primitives::Triangle};

let p1 = Point::new(5, 10);
let p2 = Point::new(15, 25);
let p3 = Point::new(5, 25);

// Owned
let tri = Triangle::from_points([p1, p2, p3]);

// Or borrowed
let tri_ref = Triangle::from_points(&[p1, p2, p3]);

Fields

p1: Point

First point of the triangle

p2: Point

Second point of the triangle

p3: Point

Third point of the triangle

Methods

impl Triangle

pub const fn new(p1: Point, p2: Point, p3: Point) -> Self

Create a new triangle with a given style

pub fn from_points<P, I>(points: P) -> Self where
    I: Into<Point> + Copy,
    P: Borrow<[I; 3]>, 

Creates a new triangle from an array of points.

This supports both Points, as well as anything that implements Into<Point> like (i32, i32).

Trait Implementations

impl Clone for Triangle

fn clone(&self) -> Triangle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Triangle

impl Debug for Triangle

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

Formats the value using the given formatter.

impl Default for Triangle

fn default() -> Triangle

Returns the "default value" for a type.

impl Dimensions for Triangle

fn top_left(&self) -> Point

Get the top left corner of the bounding box for an object

fn bottom_right(&self) -> Point

Get the bottom right corner of the bounding box for an object

fn size(&self) -> Size

Get the width and height for an object

impl Eq for Triangle

impl Hash for Triangle

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 Ord for Triangle

fn cmp(&self, other: &Triangle) -> 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 PartialEq<Triangle> for Triangle

fn eq(&self, other: &Triangle) -> bool

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

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

This method tests for !=.

impl PartialOrd<Triangle> for Triangle

fn partial_cmp(&self, other: &Triangle) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl Primitive for Triangle

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

Converts this primitive into a Styled.

impl StructuralEq for Triangle

impl StructuralPartialEq for Triangle

impl Transform for Triangle

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

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

let tri = Triangle::new(Point::new(5, 10), Point::new(15, 20), Point::new(8, 15));
let moved = tri.translate(Point::new(10, 10));

assert_eq!(moved.p1, Point::new(15, 20));
assert_eq!(moved.p2, Point::new(25, 30));
assert_eq!(moved.p3, Point::new(18, 25));

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

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

let mut tri = Triangle::new(Point::new(5, 10), Point::new(15, 20), Point::new(10, 15));
tri.translate_mut(Point::new(10, 10));

assert_eq!(tri.p1, Point::new(15, 20));
assert_eq!(tri.p2, Point::new(25, 30));
assert_eq!(tri.p3, Point::new(20, 25));