Struct iced_core::Rectangle

source ·
pub struct Rectangle<T = f32> {
    pub x: T,
    pub y: T,
    pub width: T,
    pub height: T,
}
Expand description

An axis-aligned rectangle.

Fields§

§x: T

X coordinate of the top-left corner.

§y: T

Y coordinate of the top-left corner.

§width: T

Width of the rectangle.

§height: T

Height of the rectangle.

Implementations§

source§

impl<T> Rectangle<T>
where T: Default,

source

pub fn with_size(size: Size<T>) -> Self

Creates a new Rectangle with its top-left corner at the origin and with the provided Size.

source§

impl Rectangle<f32>

source

pub const INFINITE: Self = _

A rectangle starting at Point::ORIGIN with infinite width and height.

source

pub const fn new(top_left: Point, size: Size) -> Self

Creates a new Rectangle with its top-left corner in the given Point and with the provided Size.

source

pub fn with_radius(radius: f32) -> Self

Creates a new square Rectangle with the center at the origin and with the given radius.

source

pub fn with_vertices( top_left: Point, top_right: Point, bottom_left: Point, ) -> (Rectangle, Radians)

Creates a new axis-aligned Rectangle from the given vertices; returning the rotation in Radians that must be applied to the axis-aligned Rectangle to obtain the desired result.

source

pub fn center(&self) -> Point

Returns the Point at the center of the Rectangle.

source

pub fn center_x(&self) -> f32

Returns the X coordinate of the Point at the center of the Rectangle.

source

pub fn center_y(&self) -> f32

Returns the Y coordinate of the Point at the center of the Rectangle.

source

pub fn position(&self) -> Point

Returns the position of the top left corner of the Rectangle.

source

pub fn size(&self) -> Size

Returns the Size of the Rectangle.

source

pub fn area(&self) -> f32

Returns the area of the Rectangle.

source

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

Returns true if the given Point is contained in the Rectangle.

source

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

Returns true if the given Point is contained in the Rectangle. The Point must be strictly contained, i.e. it must not be on the border.

source

pub fn is_within(&self, container: &Rectangle) -> bool

Returns true if the current Rectangle is completely within the given container.

source

pub fn is_within_strict(&self, container: &Rectangle) -> bool

Returns true if the current Rectangle is completely within the given container. The Rectangle must be strictly contained, i.e. it must not be on the border.

source

pub fn intersection(&self, other: &Rectangle<f32>) -> Option<Rectangle<f32>>

Computes the intersection with the given Rectangle.

source

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

Returns whether the Rectangle intersects with the given one.

source

pub fn union(&self, other: &Self) -> Self

Computes the union with the given Rectangle.

source

pub fn snap(self) -> Option<Rectangle<u32>>

Snaps the Rectangle to unsigned integer coordinates.

source

pub fn expand(self, padding: impl Into<Padding>) -> Self

Expands the Rectangle a given amount.

source

pub fn shrink(self, padding: impl Into<Padding>) -> Self

Shrinks the Rectangle a given amount.

source

pub fn rotate(self, rotation: Radians) -> Self

Rotates the Rectangle and returns the smallest Rectangle containing it.

Trait Implementations§

source§

impl<T> Add<Vector<T>> for Rectangle<T>
where T: Add<Output = T>,

source§

type Output = Rectangle<T>

The resulting type after applying the + operator.
source§

fn add(self, translation: Vector<T>) -> Self

Performs the + operation. Read more
source§

impl<T: Clone> Clone for Rectangle<T>

source§

fn clone(&self) -> Rectangle<T>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T: Debug> Debug for Rectangle<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T: Default> Default for Rectangle<T>

source§

fn default() -> Rectangle<T>

Returns the “default value” for a type. Read more
source§

impl From<Rectangle<u32>> for Rectangle<f32>

source§

fn from(rectangle: Rectangle<u32>) -> Rectangle<f32>

Converts to this type from the input type.
source§

impl Mul<Transformation> for Rectangle

source§

type Output = Rectangle

The resulting type after applying the * operator.
source§

fn mul(self, transformation: Transformation) -> Self

Performs the * operation. Read more
source§

impl<T> Mul<Vector<T>> for Rectangle<T>
where T: Mul<Output = T> + Copy,

source§

type Output = Rectangle<T>

The resulting type after applying the * operator.
source§

fn mul(self, scale: Vector<T>) -> Self

Performs the * operation. Read more
source§

impl Mul<f32> for Rectangle<f32>

source§

type Output = Rectangle

The resulting type after applying the * operator.
source§

fn mul(self, scale: f32) -> Self

Performs the * operation. Read more
source§

impl<T: PartialEq> PartialEq for Rectangle<T>

source§

fn eq(&self, other: &Rectangle<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

impl<T> Sub<Vector<T>> for Rectangle<T>
where T: Sub<Output = T>,

source§

type Output = Rectangle<T>

The resulting type after applying the - operator.
source§

fn sub(self, translation: Vector<T>) -> Self

Performs the - operation. Read more
source§

impl<T: Copy> Copy for Rectangle<T>

source§

impl<T: Eq> Eq for Rectangle<T>

source§

impl<T> StructuralPartialEq for Rectangle<T>

Auto Trait Implementations§

§

impl<T> Freeze for Rectangle<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Rectangle<T>
where T: RefUnwindSafe,

§

impl<T> Send for Rectangle<T>
where T: Send,

§

impl<T> Sync for Rectangle<T>
where T: Sync,

§

impl<T> Unpin for Rectangle<T>
where T: Unpin,

§

impl<T> UnwindSafe for Rectangle<T>
where T: UnwindSafe,

Blanket Implementations§

source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

source§

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.
source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.
source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

source§

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.
source§

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

source§

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

source§

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
source§

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

source§

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.
source§

impl<T> Downcast for T
where T: Any,

source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromAngle<T> for T

source§

fn from_angle(angle: T) -> T

Performs a conversion from angle.
source§

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

source§

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> IntoAngle<U> for T
where U: FromAngle<T>,

source§

fn into_angle(self) -> U

Performs a conversion into T.
source§

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

source§

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
source§

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
source§

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
source§

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
source§

impl<T> IntoStimulus<T> for T

source§

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.
source§

impl<T> NoneValue for T
where T: Default,

source§

type NoneType = T

source§

fn null_value() -> T

The none-equivalent value.
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

source§

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.
source§

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more
source§

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

source§

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.
source§

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

source§

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more