Struct RoundedRect

pub struct RoundedRect { /* private fields */ }

A rectangle with equally rounded corners.

By construction the rounded rectangle will have non-negative dimensions and radii clamped to half size of the rect.

The easiest way to create a RoundedRect is often to create a Rect, and then call to_rounded_rect.

use kurbo::{RoundedRect, RoundedRectRadii};

// Create a rounded rectangle with a single radius for all corners:
RoundedRect::new(0.0, 0.0, 10.0, 10.0, 5.0);

// Or, specify different radii for each corner, clockwise from the top-left:
RoundedRect::new(0.0, 0.0, 10.0, 10.0, (1.0, 2.0, 3.0, 4.0));

Implementations

impl RoundedRect

pub fn new( x0: f64, y0: f64, x1: f64, y1: f64, radii: impl Into<RoundedRectRadii>, ) -> RoundedRect

A new rectangle from minimum and maximum coordinates.

The result will have non-negative width, height and radii.

pub fn from_rect(rect: Rect, radii: impl Into<RoundedRectRadii>) -> RoundedRect

A new rounded rectangle from a rectangle and corner radii.

The result will have non-negative width, height and radii.

See also Rect::to_rounded_rect, which offers the same utility.

pub fn from_points( p0: impl Into<Point>, p1: impl Into<Point>, radii: impl Into<RoundedRectRadii>, ) -> RoundedRect

A new rectangle from two Points.

The result will have non-negative width, height and radius.

pub fn from_origin_size( origin: impl Into<Point>, size: impl Into<Size>, radii: impl Into<RoundedRectRadii>, ) -> RoundedRect

A new rectangle from origin and size.

The result will have non-negative width, height and radius.

pub fn width(&self) -> f64

The width of the rectangle.

pub fn height(&self) -> f64

The height of the rectangle.

pub fn radii(&self) -> RoundedRectRadii

Radii of the rounded corners.

pub fn rect(&self) -> Rect

The (non-rounded) rectangle.

pub fn origin(&self) -> Point

The origin of the rectangle.

This is the top left corner in a y-down space.

pub fn center(&self) -> Point

The center point of the rectangle.

pub fn is_finite(&self) -> bool

Is this rounded rectangle finite?

pub fn is_nan(&self) -> bool

Is this rounded rectangle NaN?

Trait Implementations

impl Add<Vec2> for RoundedRect

type Output = RoundedRect

The resulting type after applying the + operator.

fn add(self, v: Vec2) -> RoundedRect

Performs the + operation.

impl Clone for RoundedRect

fn clone(&self) -> RoundedRect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoundedRect

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

Formats the value using the given formatter.

impl Default for RoundedRect

fn default() -> RoundedRect

Returns the “default value” for a type.

impl Mul<RoundedRect> for TranslateScale

type Output = RoundedRect

The resulting type after applying the * operator.

fn mul(self, other: RoundedRect) -> RoundedRect

Performs the * operation.

impl PartialEq for RoundedRect

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Shape for RoundedRect

type PathElementsIter<'iter> = RoundedRectPathIter

The iterator returned by the path_elements method.

fn path_elements(&self, tolerance: f64) -> RoundedRectPathIter

Returns an iterator over this shape expressed as PathEls; that is, as Bézier path elements.

fn area(&self) -> f64

Signed area.

fn perimeter(&self, _accuracy: f64) -> f64

Total length of perimeter.

fn winding(&self, pt: Point) -> i32

The winding number of a point.

fn bounding_box(&self) -> Rect

The smallest rectangle that encloses the shape.

fn as_rounded_rect(&self) -> Option<RoundedRect>

If the shape is a rounded rectangle, make it available.

fn to_path(&self, tolerance: f64) -> BezPath

Convert to a Bézier path.

fn into_path(self, tolerance: f64) -> BezPath

where Self: Sized,

Convert into a Bézier path.

fn path_segments(&self, tolerance: f64) -> Segments<Self::PathElementsIter<'_>>

Returns an iterator over this shape expressed as Bézier path segments (PathSegs).

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

Returns true if the Point is inside this shape.

fn as_line(&self) -> Option<Line>

If the shape is a line, make it available.

fn as_rect(&self) -> Option<Rect>

If the shape is a rectangle, make it available.

fn as_circle(&self) -> Option<Circle>

If the shape is a circle, make it available.

fn as_path_slice(&self) -> Option<&[PathEl]>

If the shape is stored as a slice of path elements, make that available.

impl Sub<Vec2> for RoundedRect

type Output = RoundedRect

The resulting type after applying the - operator.

fn sub(self, v: Vec2) -> RoundedRect

Performs the - operation.

impl Copy for RoundedRect

impl StructuralPartialEq for RoundedRect