Enum ClipShape

Source
pub enum ClipShape {
    Rect(Rect),
    RoundRect {
        rect: Rect,
        radius: f32,
    },
}
Expand description

Axis-aligned or rounded clip region in local coordinates.

Possible values are ClipShape::Rect and ClipShape::RoundRect.

§Examples

use ailloli_ui_core::{ClipShape, Rect};
assert!(ClipShape::rect(Rect::new(0.0, 0.0, 10.0, 10.0)).contains_point(5.0, 5.0));

Variants§

§

Rect(Rect)

Axis-aligned rectangle.

§

RoundRect

Rounded rectangle with uniform corner radius.

Fields

§rect: Rect

Axis-aligned outer bounds in local logical pixels.

§radius: f32

Requested uniform radius in logical pixels.

Hit-testing clamps this to a non-negative half-extent, but the stored value itself is not normalized.

Implementations§

Source§

impl ClipShape

Source

pub fn rect(r: Rect) -> Self

Creates a rectangular clip.

§Examples
use ailloli_ui_core::{ClipShape, Rect};
let rect = Rect::new(0.0, 0.0, 10.0, 10.0);
assert_eq!(ClipShape::rect(rect).bounding_rect(), rect);
Source

pub fn round_rect(rect: Rect, radius: f32) -> Self

Creates a rounded-rect clip without normalizing its radius or bounds.

§Examples
use ailloli_ui_core::{ClipShape, Rect};
assert!(matches!(ClipShape::round_rect(Rect::new(0.0, 0.0, 10.0, 10.0), 2.0), ClipShape::RoundRect { .. }));
Source

pub fn bounding_rect(&self) -> Rect

Tight axis-aligned bounds of this clip (ignores corner cut-outs for RoundRect).

§Examples
use ailloli_ui_core::{ClipShape, Rect};
let rect = Rect::new(1.0, 2.0, 3.0, 4.0);
assert_eq!(ClipShape::round_rect(rect, 2.0).bounding_rect(), rect);
Source

pub fn contains_point(&self, px: f32, py: f32) -> bool

Hit-test in local clip space (same coordinate system as rect).

§Examples
use ailloli_ui_core::{ClipShape, Rect};
assert!(!ClipShape::round_rect(Rect::new(0.0, 0.0, 10.0, 10.0), 5.0).contains_point(0.0, 0.0));
Source

pub fn intersect(&self, other: &Self) -> Option<Self>

Returns a conservative rectangular intersection of two clips.

A rounded result keeps the rounded operand’s radius, or the minimum radius when both operands are rounded. This is not an exact geometric intersection of corner arcs; it is a compact clip approximation. Zero- area edge contact returns None through Rect::intersection.

§Examples
use ailloli_ui_core::{ClipShape, Rect};
let a = ClipShape::rect(Rect::new(0.0, 0.0, 10.0, 10.0));
let b = ClipShape::rect(Rect::new(5.0, 5.0, 10.0, 10.0));
assert_eq!(a.intersect(&b).unwrap().bounding_rect(), Rect::new(5.0, 5.0, 5.0, 5.0));

Trait Implementations§

Source§

impl Clone for ClipShape

Source§

fn clone(&self) -> ClipShape

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 Debug for ClipShape

Source§

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

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

impl PartialEq for ClipShape

Source§

fn eq(&self, other: &ClipShape) -> 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 Copy for ClipShape

Source§

impl StructuralPartialEq for ClipShape

Auto Trait Implementations§

Blanket Implementations§

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> 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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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, 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.