Struct piet_common::kurbo::Size

pub struct Size {
    pub width: f64,
    pub height: f64,
}

A 2D size.

Fields

width: f64

The width.

height: f64

The height.

Implementations

impl Size

pub const ZERO: Size

A size with zero width or height.

pub const fn new(width: f64, height: f64) -> Size

Create a new Size with the provided width and height.

pub fn max_side(self) -> f64

Returns the max of width and height.

Examples

use kurbo::Size;
let size = Size::new(-10.5, 42.0);
assert_eq!(size.max_side(), 42.0);

pub fn min_side(self) -> f64

Returns the min of width and height.

Examples

use kurbo::Size;
let size = Size::new(-10.5, 42.0);
assert_eq!(size.min_side(), -10.5);

pub fn area(self) -> f64

The area covered by this size.

pub fn is_empty(self) -> bool

Whether this size has zero area.

Note: a size with negative area is not considered empty.

pub fn clamp(self, min: Size, max: Size) -> Size

Returns a new size bounded by min and max.

Examples

use kurbo::Size;

let this = Size::new(0., 100.);
let min = Size::new(10., 10.,);
let max = Size::new(50., 50.);
assert_eq!(this.clamp(min, max), Size::new(10., 50.))

pub const fn to_vec2(self) -> Vec2

Convert this size into a Vec2, with width mapped to x and height mapped to y.

pub fn round(self) -> Size

Returns a new Size, with width and height rounded to the nearest integer.

Examples

use kurbo::Size;
let size_pos = Size::new(3.3, 3.6).round();
assert_eq!(size_pos.width, 3.0);
assert_eq!(size_pos.height, 4.0);
let size_neg = Size::new(-3.3, -3.6).round();
assert_eq!(size_neg.width, -3.0);
assert_eq!(size_neg.height, -4.0);

pub fn ceil(self) -> Size

Returns a new Size, with width and height rounded up to the nearest integer, unless they are already an integer.

Examples

use kurbo::Size;
let size_pos = Size::new(3.3, 3.6).ceil();
assert_eq!(size_pos.width, 4.0);
assert_eq!(size_pos.height, 4.0);
let size_neg = Size::new(-3.3, -3.6).ceil();
assert_eq!(size_neg.width, -3.0);
assert_eq!(size_neg.height, -3.0);

pub fn floor(self) -> Size

Returns a new Size, with width and height rounded down to the nearest integer, unless they are already an integer.

Examples

use kurbo::Size;
let size_pos = Size::new(3.3, 3.6).floor();
assert_eq!(size_pos.width, 3.0);
assert_eq!(size_pos.height, 3.0);
let size_neg = Size::new(-3.3, -3.6).floor();
assert_eq!(size_neg.width, -4.0);
assert_eq!(size_neg.height, -4.0);

pub fn expand(self) -> Size

Returns a new Size, with width and height rounded away from zero to the nearest integer, unless they are already an integer.

Examples

use kurbo::Size;
let size_pos = Size::new(3.3, 3.6).expand();
assert_eq!(size_pos.width, 4.0);
assert_eq!(size_pos.height, 4.0);
let size_neg = Size::new(-3.3, -3.6).expand();
assert_eq!(size_neg.width, -4.0);
assert_eq!(size_neg.height, -4.0);

pub fn trunc(self) -> Size

Returns a new Size, with width and height rounded down towards zero the nearest integer, unless they are already an integer.

Examples

use kurbo::Size;
let size_pos = Size::new(3.3, 3.6).trunc();
assert_eq!(size_pos.width, 3.0);
assert_eq!(size_pos.height, 3.0);
let size_neg = Size::new(-3.3, -3.6).trunc();
assert_eq!(size_neg.width, -3.0);
assert_eq!(size_neg.height, -3.0);

pub fn aspect_ratio(self) -> f64

Returns the aspect ratio of a rectangle with the given size.

If the width is 0, the output will be sign(self.height) * infinity. If The width and height are 0, then the output will be NaN.

pub const fn to_rect(self) -> Rect

Convert this Size into a Rect with origin (0.0, 0.0).

pub fn to_rounded_rect(self, radius: f64) -> RoundedRect

Convert this Size into a RoundedRect with origin (0.0, 0.0) and the provided corner radius.

Trait Implementations

impl Add<Size> for Size

type Output = Size

The resulting type after applying the + operator.

pub fn add(self, other: Size) -> Size

Performs the + operation.

impl AddAssign<Size> for Size

pub fn add_assign(&mut self, other: Size)

Performs the += operation.

impl Clone for Size

pub fn clone(&self) -> Size

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Size

impl Debug for Size

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

Formats the value using the given formatter.

impl Default for Size

pub fn default() -> Size

Returns the "default value" for a type.

impl Display for Size

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

Formats the value using the given formatter.

impl Div<f64> for Size

type Output = Size

The resulting type after applying the / operator.

pub fn div(self, other: f64) -> Size

Performs the / operation.

impl DivAssign<f64> for Size

pub fn div_assign(&mut self, other: f64)

Performs the /= operation.

impl From<(f64, f64)> for Size

pub fn from(v: (f64, f64)) -> Size

Performs the conversion.

impl Into<Size> for Vec2

pub fn into(self) -> Size

Performs the conversion.

impl Mul<f64> for Size

type Output = Size

The resulting type after applying the * operator.

pub fn mul(self, other: f64) -> Size

Performs the * operation.

impl MulAssign<f64> for Size

pub fn mul_assign(&mut self, other: f64)

Performs the *= operation.

impl PartialEq<Size> for Size

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

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

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

This method tests for !=.

impl StructuralPartialEq for Size

impl Sub<Size> for Size

type Output = Size

The resulting type after applying the - operator.

pub fn sub(self, other: Size) -> Size

Performs the - operation.

impl SubAssign<Size> for Size

pub fn sub_assign(&mut self, other: Size)

Performs the -= operation.