Struct embedded_graphics::primitives::triangle::Triangle

pub struct Triangle {
    pub vertices: [Point; 3],
}

Triangle primitive

Examples

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(40, 20), Point::new(50, 25), Point::new(60, 60))
    .into_styled(PrimitiveStyle::with_stroke(Rgb565::RED, 1))
    .draw(&mut display)?;

// Triangle with translation applied
Triangle::new(Point::new(40, 20), Point::new(50, 25), Point::new(60, 60))
    .translate(Point::new(-10, -20))
    .into_styled(PrimitiveStyle::with_stroke(Rgb565::GREEN, 1))
    .draw(&mut display)?;

Create a triangle from a slice

A triangle can be created from a &[Point] slice. If the slice is not exactly 3 elements long, the from_slice method will panic.

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

let tri = Triangle::from_slice(&[p1, p2, p3]);

Fields

vertices: [Point; 3]

The vertices of the triangle.

Implementations

impl Triangle

pub const fn new(vertex1: Point, vertex2: Point, vertex3: Point) -> Self

Create a new triangle with the given vertices.

pub fn from_slice(vertices: &[Point]) -> Self

Creates a new triangle from a Point slice.

Panics

This method will panic if the given slice is not exactly 3 items long.

Trait Implementations

impl Clone for Triangle

pub fn clone(&self) -> Triangle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ContainsPoint for Triangle

pub fn contains(&self, point: Point) -> bool

Returns true if the given point is inside the shape.

impl Copy for Triangle

impl Debug for Triangle

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

Formats the value using the given formatter.

impl Default for Triangle

pub fn default() -> Triangle

Returns the "default value" for a type.

impl Dimensions for Triangle

pub fn bounding_box(&self) -> Rectangle

Returns the bounding box.

impl Eq for Triangle

impl Hash for Triangle

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

Feeds this value into the given Hasher.

pub 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

pub fn cmp(&self, other: &Triangle) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Triangle> for Triangle

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

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

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

This method tests for !=.

impl PartialOrd<Triangle> for Triangle

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

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

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

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

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

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

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

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

pub 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 PointsIter for Triangle

type Iter = Points

Iterator over all points inside the primitive.

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

Returns an iterator over all points inside the primitive.

impl Primitive for Triangle

pub 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

pub 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,
    Triangle::new(Point::new(15, 20), Point::new(25, 30), Point::new(18, 25))
);

pub 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,
    Triangle::new(Point::new(15, 20), Point::new(25, 30), Point::new(20, 25))
)