Struct Radius 

pub struct Radius {
    pub x: f64,
    pub y: f64,
}

A radius for either circular or elliptical shapes.

Fields

x: f64

The radius value on the horizontal axis.

y: f64

The radius value on the vertical axis.

Implementations

impl Radius

pub const ZERO: Radius

A radius with x and y values set to zero.

You can use Radius::ZERO with RRect or RSuperellipse to have right-angle corners.

pub const fn circular(radius: f64) -> Radius

Constructs a circular radius. x and y will have the same radius value.

pub const fn elliptical(x: f64, y: f64) -> Radius

Constructs an elliptical radius with the given radii.

pub fn clamp(&self, minimum: Option<Radius>, maximum: Option<Radius>) -> Radius

Returns this Radius, with values clamped to the given min and max Radius values.

The minimum value defaults to Radius::circular(f64::NEG_INFINITY), and the maximum value defaults to Radius::circular(f64::INFINITY).

pub fn clamp_values( &self, minimum_x: Option<f64>, minimum_y: Option<f64>, maximum_x: Option<f64>, maximum_y: Option<f64>, ) -> Radius

Returns this Radius, with values clamped to the given min and max values in each dimension.

The minimum_x and minimum_y values default to f64::NEG_INFINITY, and the maximum_x and maximum_y values default to f64::INFINITY.

pub fn truncating_div(&self, operand: f64) -> Radius

Integer (truncating) division operator.

Returns a radius whose coordinates are the coordinates of this radius divided by the scalar operand, rounded towards zero.

pub fn lerp(a: Option<Radius>, b: Option<Radius>, t: f64) -> Option<Radius>

Linearly interpolate between two radii.

If either is null, this function substitutes Radius::ZERO instead.

The t argument represents position on the timeline, with 0.0 meaning that the interpolation has not started, returning a (or something equivalent to a), 1.0 meaning that the interpolation has finished, returning b (or something equivalent to b), and values in between meaning that the interpolation is at the relevant point on the timeline between a and b. The interpolation can be extrapolated beyond 0.0 and 1.0, so negative values and values greater than 1.0 are valid (and can easily be generated by curves such as Curves.elasticInOut).

Values for t are usually obtained from an Animation<double>, such as an AnimationController.

Trait Implementations

impl Add for Radius

Binary addition operator.

Returns a radius whose x value is the sum of the x values of the two operands, and whose y value is the sum of the y values of the two operands.

type Output = Radius

The resulting type after applying the + operator.

fn add(self, other: Radius) -> Radius

Performs the + operation.

impl Clone for Radius

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Radius

impl Debug for Radius

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

Formats the value using the given formatter.

impl Div<f64> for Radius

Division operator.

Returns a radius whose coordinates are the coordinates of the left-hand-side operand (a radius) divided by the scalar right-hand-side operand (an f64).

type Output = Radius

The resulting type after applying the / operator.

fn div(self, operand: f64) -> Radius

Performs the / operation.

impl Mul<f64> for Radius

Multiplication operator.

Returns a radius whose coordinates are the coordinates of the left-hand-side operand (a radius) multiplied by the scalar right-hand-side operand (an f64).

type Output = Radius

The resulting type after applying the * operator.

fn mul(self, operand: f64) -> Radius

Performs the * operation.

impl Neg for Radius

Unary negation operator.

Returns a Radius with the distances negated.

Radiuses with negative values aren’t geometrically meaningful, but could occur as part of expressions. For example, negating a radius of one pixel and then adding the result to another radius is equivalent to subtracting a radius of one pixel from the other.

type Output = Radius

The resulting type after applying the - operator.

fn neg(self) -> Radius

Performs the unary - operation.

impl PartialEq for Radius

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

Equality operator ==.

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

Inequality operator !=.

impl Rem<f64> for Radius

Modulo (remainder) operator.

Returns a radius whose coordinates are the remainder of dividing the coordinates of the left-hand-side operand (a radius) by the scalar right-hand-side operand (an f64).

type Output = Radius

The resulting type after applying the % operator.

fn rem(self, operand: f64) -> Radius

Performs the % operation.

impl StructuralPartialEq for Radius

impl Sub for Radius

Binary subtraction operator.

Returns a radius whose x value is the left-hand-side operand’s x minus the right-hand-side operand’s x and whose y value is the left-hand-side operand’s y minus the right-hand-side operand’s y.

type Output = Radius

The resulting type after applying the - operator.

fn sub(self, other: Radius) -> Radius

Performs the - operation.