Skip to main content

MousePosition

Struct MousePosition 

Source
pub struct MousePosition {
    pub column: i16,
    pub row: i16,
    pub space: CoordSpace,
}
Expand description

A mouse cursor position with an explicit coordinate space tag.

Always CoordSpace::Screen for dispatched events. The space field exists to prevent accidental mixing of coordinate systems — a compile-time reminder that all positions are in absolute screen coordinates and should never be mutated during dispatch.

Fields§

§column: i16

Column in cells (signed — no u16 underflow on out-of-bounds drag).

§row: i16

Row in cells (signed — no u16 underflow on out-of-bounds drag).

§space: CoordSpace

Coordinate space tag. Always Screen for dispatched events.

Implementations§

Source§

impl MousePosition

Source

pub fn is_inside(&self, area: LayoutRect) -> bool

Returns true if this position lies within area in screen coordinates.

This is the unified replacement for ad-hoc rect_contains() checks scattered across component handle_events methods. Because the hitbox registry already guarantees the component was the hit target, this is used only for sub-widget coordinate gallity checks.

Source

pub fn to_local(&self, area: LayoutRect) -> Option<(u16, u16)>

Convert this screen-space position to local (area-relative) coordinates.

Returns Some((col, row)) if the position is inside area, or None if outside. This replaces the pattern mouse.column - last_area.x with a single checked operation.

Unlike bare subtraction, this does not underflow or produce nonsensical values for out-of-bounds positions.

Trait Implementations§

Source§

impl Clone for MousePosition

Source§

fn clone(&self) -> MousePosition

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for MousePosition

Source§

impl Debug for MousePosition

Source§

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

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

impl Eq for MousePosition

Source§

impl PartialEq for MousePosition

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for MousePosition

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