Struct embedded_graphics::primitives::sector::Sector

pub struct Sector {
    pub top_left: Point,
    pub diameter: u32,
    pub angle_start: Angle,
    pub angle_sweep: Angle,
}

Sector primitive

Examples

Create some sectors with different styles

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

// Sector with 1 pixel wide white stroke with top-left point at (10, 20) with a diameter of 30
Sector::new(Point::new(10, 20), 30, 0.0.deg(), 90.0.deg())
    .into_styled(PrimitiveStyle::with_stroke(Rgb565::WHITE, 1))
    .draw(&mut display)?;

// Sector with styled stroke and fill with top-left point at (10, 20) with a diameter of 30
let style = PrimitiveStyleBuilder::new()
    .stroke_color(Rgb565::RED)
    .stroke_width(3)
    .fill_color(Rgb565::GREEN)
    .build();

Sector::new(Point::new(10, 20), 30, 180.0.deg(), -90.0.deg())
    .into_styled(style)
    .draw(&mut display)?;

// Sector with blue fill and no stroke with a translation applied
Sector::new(Point::new(10, 20), 30, 0.0.deg(), 90.0.deg())
    .translate(Point::new(15, 5))
    .into_styled(PrimitiveStyle::with_fill(Rgb565::BLUE))
    .draw(&mut display)?;

Fields

top_left: Point

Top-left point of the bounding-box of the circle supporting the sector

diameter: u32

Diameter of the circle supporting the sector

angle_start: Angle

Angle at which the sector starts

angle_sweep: Angle

Angle defining the sector sweep starting at angle_start

Implementations

impl Sector

pub const fn new(
    top_left: Point,
    diameter: u32,
    angle_start: Angle,
    angle_sweep: Angle
) -> Self

Create a new sector delimited with a top-left point with a specific diameter and start and sweep angles

pub fn with_center(
    center: Point,
    diameter: u32,
    angle_start: Angle,
    angle_sweep: Angle
) -> Self

Create a new sector centered around a given point with a specific diameter and start and sweep angles

pub fn from_circle(
    circle: Circle,
    angle_start: Angle,
    angle_sweep: Angle
) -> Self

Creates an arc based on a circle.

The resulting sector will match the top_left and diameter of the base circle.

pub fn to_circle(&self) -> Circle

Returns a circle with the same top_left and diameter as this sector.

pub fn center(&self) -> Point

Return the center point of the sector

Trait Implementations

impl Clone for Sector

fn clone(&self) -> Sector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ContainsPoint for Sector

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

Returns true if the given point is inside the shape.

impl Copy for Sector

impl Debug for Sector

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

Formats the value using the given formatter.

impl Dimensions for Sector

fn bounding_box(&self) -> Rectangle

Returns the bounding box.

impl OffsetOutline for Sector

fn offset(&self, offset: i32) -> Self

Offsets the outline of the shape.

impl PartialEq<Sector> for Sector

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

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

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

This method tests for !=.

impl PartialOrd<Sector> for Sector

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

impl PointsIter for Sector

type Iter = Points

Iterator over all points inside the primitive.

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

Returns an iterator over all points inside the primitive.

impl Primitive for Sector

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

Converts this primitive into a Styled.

impl StructuralPartialEq for Sector

impl<C: PixelColor> StyledDimensions<PrimitiveStyle<C>> for Sector

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

Returns the bounding box using the given style.

impl<C: PixelColor> StyledDrawable<PrimitiveStyle<C>> for Sector

type Color = C

Color type.

type Output = ()

Output type.

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.

impl Transform for Sector

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

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

let sector = Sector::new(Point::new(5, 10), 10, 0.0.deg(), 90.0.deg());
let moved = sector.translate(Point::new(10, 10));

assert_eq!(moved.top_left, Point::new(15, 20));

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

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

let mut sector = Sector::new(Point::new(5, 10), 10, 0.0.deg(), 90.0.deg());
sector.translate_mut(Point::new(10, 10));

assert_eq!(sector.top_left, Point::new(15, 20));