Struct embedded_graphics::primitives::rounded_rectangle::RoundedRectangle [−][src]
pub struct RoundedRectangle { pub rectangle: Rectangle, pub corners: CornerRadii, }
Expand description
Rounded rectangle primitive.
Creates a rectangle with rounded corners. Corners can be circular or elliptical in shape, and
each corner may have a separate radius applied to it. To create a rounded rectangle with the same
radius for each corner, use the with_equal_corners
method.
Rounded rectangles with different radii for each corner can be created by passing a
CornerRadii
configuration struct to the new
method.
Overlapping corners
It is possible to create a RoundedRectangle
with corner radii too large to be contained within
its edges. When this happens, the corner radii will be confined to fit within the rounded
rectangle before use by other parts of embedded-graphics.
This is similar but not identical to how the CSS specification works as it relies on floating point calculations.
Examples
Create a uniform rounded rectangle
This example creates a rounded rectangle 50px wide by 60px tall. Using
with_equal_corners
, all corners are given the same 10px circular
radius. The rectangle is drawn using a solid green fill with a 5px red stroke.
use embedded_graphics::{ pixelcolor::Rgb565, prelude::*, primitives::{Rectangle, RoundedRectangle, PrimitiveStyle, PrimitiveStyleBuilder}, }; let style = PrimitiveStyleBuilder::new() .stroke_width(5) .stroke_color(Rgb565::RED) .fill_color(Rgb565::GREEN) .build(); RoundedRectangle::with_equal_corners( Rectangle::new(Point::new(5, 5), Size::new(40, 50)), Size::new(10, 10), ) .into_styled(style) .draw(&mut display)?;
Different corner radii
This example creates a rounded rectangle 50px wide by 60px tall. Each corner is given a distinct
radius in the x and y direction by creating a CornerRadii
object and passing that to RoundedRectangle::new
.
use embedded_graphics::{ pixelcolor::Rgb565, prelude::*, primitives::{CornerRadiiBuilder, Rectangle, RoundedRectangle, PrimitiveStyle, PrimitiveStyleBuilder}, }; let style = PrimitiveStyleBuilder::new() .stroke_width(5) .stroke_color(Rgb565::RED) .fill_color(Rgb565::GREEN) .build(); let radii = CornerRadiiBuilder::new() .top_left(Size::new(5, 6)) .top_right(Size::new(7, 8)) .bottom_right(Size::new(9, 10)) .bottom_left(Size::new(11, 12)) .build(); RoundedRectangle::new(Rectangle::new(Point::new(5, 5), Size::new(40, 50)), radii) .into_styled(style) .draw(&mut display)?;
Using CornerRadiiBuilder
This example creates a rounded rectangle 50px wide by 60px tall. Corner radii are set using the
CornerRadiiBuilder
builder.
use embedded_graphics::{ pixelcolor::Rgb565, prelude::*, primitives::{CornerRadii, CornerRadiiBuilder, Rectangle, RoundedRectangle, PrimitiveStyle, PrimitiveStyleBuilder}, }; let style = PrimitiveStyleBuilder::new() .stroke_width(5) .stroke_color(Rgb565::RED) .fill_color(Rgb565::GREEN) .build(); let radii = CornerRadiiBuilder::new() // Set the top left and top right corner radii to 10 x 20px .top(Size::new(10, 20)) // Set the bottom right corner radius to 5 x 8px .bottom_right(Size::new(5, 8)) .build(); RoundedRectangle::new(Rectangle::new(Point::new(5, 5), Size::new(40, 50)), radii) .into_styled(style) .draw(&mut display)?;
Fields
rectangle: Rectangle
The base rectangle
corners: CornerRadii
The radius of each corner
Implementations
impl RoundedRectangle
[src]
impl RoundedRectangle
[src]pub const fn new(rectangle: Rectangle, corners: CornerRadii) -> Self
[src]
pub const fn new(rectangle: Rectangle, corners: CornerRadii) -> Self
[src]Creates a new rounded rectangle with the given corner radii.
The size and position of the rounded rectangle is determined by the given base rectangle.
pub const fn with_equal_corners(
rectangle: Rectangle,
corner_radius: Size
) -> Self
[src]
pub const fn with_equal_corners(
rectangle: Rectangle,
corner_radius: Size
) -> Self
[src]Creates a new rounded rectangle with equal corner radius for all corners.
The size and position of the rounded rectangle is determined by the given base rectangle.
pub fn confine_radii(&self) -> Self
[src]
pub fn confine_radii(&self) -> Self
[src]Return the rounded rectangle with confined corner radii.
This method will return a rounded rectangle of the same width and height, but with all corner radii confined to fit within its base rectangle.
Calling this method is not necessary when using operations provided by embedded-graphics
(.into_styled()
, .contains()
, etc) as these confine the corner radii internally.
Examples
Confine corner radii that are too large
This example creates a rounded rectangle 50px x 60px in size. Each corner is set to an equal
radius of 40px x 40px. Each edge of the rectangle would thus need to be at least 80px long
to contain all corner radii completely. By using confine_radii
, the corner radii are
reduced to 25px x 25px so that they fit within the 50px x 60px base rectangle.
use embedded_graphics::{ geometry::{Point, Size}, primitives::{CornerRadii, CornerRadiiBuilder, Rectangle, RoundedRectangle}, }; let radii = CornerRadiiBuilder::new().all(Size::new(40, 40)).build(); let base_rectangle = Rectangle::new(Point::zero(), Size::new(50, 60)); let rounded_rectangle = RoundedRectangle::new(base_rectangle, radii); let confined = rounded_rectangle.confine_radii(); assert_eq!( confined.corners, CornerRadii { top_left: Size::new(25, 25), top_right: Size::new(25, 25), bottom_right: Size::new(25, 25), bottom_left: Size::new(25, 25), } );
Trait Implementations
impl Clone for RoundedRectangle
[src]
impl Clone for RoundedRectangle
[src]fn clone(&self) -> RoundedRectangle
[src]
fn clone(&self) -> RoundedRectangle
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl ContainsPoint for RoundedRectangle
[src]
impl ContainsPoint for RoundedRectangle
[src]impl Debug for RoundedRectangle
[src]
impl Debug for RoundedRectangle
[src]impl Dimensions for RoundedRectangle
[src]
impl Dimensions for RoundedRectangle
[src]fn bounding_box(&self) -> Rectangle
[src]
fn bounding_box(&self) -> Rectangle
[src]Returns the bounding box.
impl Hash for RoundedRectangle
[src]
impl Hash for RoundedRectangle
[src]impl OffsetOutline for RoundedRectangle
[src]
impl OffsetOutline for RoundedRectangle
[src]impl Ord for RoundedRectangle
[src]
impl Ord for RoundedRectangle
[src]impl PartialEq<RoundedRectangle> for RoundedRectangle
[src]
impl PartialEq<RoundedRectangle> for RoundedRectangle
[src]fn eq(&self, other: &RoundedRectangle) -> bool
[src]
fn eq(&self, other: &RoundedRectangle) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &RoundedRectangle) -> bool
[src]
fn ne(&self, other: &RoundedRectangle) -> bool
[src]This method tests for !=
.
impl PartialOrd<RoundedRectangle> for RoundedRectangle
[src]
impl PartialOrd<RoundedRectangle> for RoundedRectangle
[src]fn partial_cmp(&self, other: &RoundedRectangle) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &RoundedRectangle) -> Option<Ordering>
[src]This method returns an ordering between self
and other
values if one exists. Read more
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than (for self
and other
) and is used by the <
operator. Read more
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl PointsIter for RoundedRectangle
[src]
impl PointsIter for RoundedRectangle
[src]impl Primitive for RoundedRectangle
[src]
impl Primitive for RoundedRectangle
[src]fn into_styled<S>(self, style: S) -> Styled<Self, S> where
Self: Sized,
[src]
fn into_styled<S>(self, style: S) -> Styled<Self, S> where
Self: Sized,
[src]Converts this primitive into a Styled
.
impl<C: PixelColor> StyledDimensions<PrimitiveStyle<C>> for RoundedRectangle
[src]
impl<C: PixelColor> StyledDimensions<PrimitiveStyle<C>> for RoundedRectangle
[src]fn styled_bounding_box(&self, style: &PrimitiveStyle<C>) -> Rectangle
[src]
fn styled_bounding_box(&self, style: &PrimitiveStyle<C>) -> Rectangle
[src]Returns the bounding box using the given style.
impl<C: PixelColor> StyledDrawable<PrimitiveStyle<C>> for RoundedRectangle
[src]
impl<C: PixelColor> StyledDrawable<PrimitiveStyle<C>> for RoundedRectangle
[src]type Color = C
type Color = C
Color type.
fn draw_styled<D>(
&self,
style: &PrimitiveStyle<C>,
target: &mut D
) -> Result<Self::Output, D::Error> where
D: DrawTarget<Color = C>,
[src]
fn draw_styled<D>(
&self,
style: &PrimitiveStyle<C>,
target: &mut D
) -> Result<Self::Output, D::Error> where
D: DrawTarget<Color = C>,
[src]Draws the primitive using the given style.
impl Transform for RoundedRectangle
[src]
impl Transform for RoundedRectangle
[src]fn translate(&self, by: Point) -> Self
[src]
fn translate(&self, by: Point) -> Self
[src]Translate the rounded rectangle from its current position to a new position by (x, y)
pixels, returning a new RoundedRectangle
. For a mutating transform, see translate_mut
.
use embedded_graphics::primitives::{Rectangle, RoundedRectangle}; let original = RoundedRectangle::with_equal_corners( Rectangle::new(Point::new(5, 10), Size::new(20, 30)), Size::new(10, 15), ); let moved = original.translate(Point::new(10, 12)); assert_eq!(original.bounding_box().top_left, Point::new(5, 10)); assert_eq!(moved.bounding_box().top_left, Point::new(15, 22));
fn translate_mut(&mut self, by: Point) -> &mut Self
[src]
fn translate_mut(&mut self, by: Point) -> &mut Self
[src]Translate the rounded rectangle from its current position to a new position by (x, y) pixels.
use embedded_graphics::primitives::{Rectangle, RoundedRectangle}; let mut shape = RoundedRectangle::with_equal_corners( Rectangle::new(Point::new(5, 10), Size::new(20, 30)), Size::new(10, 15), ); shape.translate_mut(Point::new(10, 12)); assert_eq!(shape.bounding_box().top_left, Point::new(15, 22));
impl Copy for RoundedRectangle
[src]
impl Eq for RoundedRectangle
[src]
impl StructuralEq for RoundedRectangle
[src]
impl StructuralPartialEq for RoundedRectangle
[src]
Auto Trait Implementations
impl RefUnwindSafe for RoundedRectangle
impl Send for RoundedRectangle
impl Sync for RoundedRectangle
impl Unpin for RoundedRectangle
impl UnwindSafe for RoundedRectangle
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<Src, Dst> LosslessTryInto<Dst> for Src where
Dst: LosslessTryFrom<Src>,
[src]
impl<Src, Dst> LosslessTryInto<Dst> for Src where
Dst: LosslessTryFrom<Src>,
[src]pub fn lossless_try_into(self) -> Option<Dst>
[src]
pub fn lossless_try_into(self) -> Option<Dst>
[src]Performs the conversion.
impl<Src, Dst> LossyInto<Dst> for Src where
Dst: LossyFrom<Src>,
[src]
impl<Src, Dst> LossyInto<Dst> for Src where
Dst: LossyFrom<Src>,
[src]pub fn lossy_into(self) -> Dst
[src]
pub fn lossy_into(self) -> Dst
[src]Performs the conversion.
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
pub fn to_subset(&self) -> Option<SS>
pub fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,