Skip to main content

HitTester

Struct HitTester 

Source
pub struct HitTester<Id> { /* private fields */ }
Expand description

A per-frame registry of (Rect, Id) pairs, queried by pointer position to find the topmost widget under a point.

Standalone and headless: no Backend dependency, so it’s usable (and unit-testable) without a Terminal or any drawing at all, e.g. for hand-rolled hit-testing outside of Interaction.

Registrations are draw-ordered: a later push means drawn (and therefore visually on top) later, so topmost_at scans back-to-front and returns the last match. This mirrors the painter’s algorithm every widget in this crate already draws with.

Implementations§

Source§

impl<Id> HitTester<Id>

Source

pub const fn new() -> Self

An empty registry.

Source

pub fn push(&mut self, rect: Rect, id: Id)

Register id as occupying rect, on top of everything registered so far this pass.

Source

pub fn clear(&mut self)

Discard all registrations, e.g. at the start of a new frame’s draw pass.

Source

pub const fn len(&self) -> usize

Number of rects currently registered.

Source

pub const fn is_empty(&self) -> bool

true if nothing has been registered.

Source§

impl<Id: Copy> HitTester<Id>

Source

pub fn topmost_at(&self, pos: Pos) -> Option<Id>

The id of the topmost (most recently pushed) registration whose rect contains pos, if any.

Trait Implementations§

Source§

impl<Id: Clone> Clone for HitTester<Id>

Source§

fn clone(&self) -> HitTester<Id>

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<Id: Debug> Debug for HitTester<Id>

Source§

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

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

impl<Id> Default for HitTester<Id>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<Id> Freeze for HitTester<Id>

§

impl<Id> RefUnwindSafe for HitTester<Id>
where Id: RefUnwindSafe,

§

impl<Id> Send for HitTester<Id>
where Id: Send,

§

impl<Id> Sync for HitTester<Id>
where Id: Sync,

§

impl<Id> Unpin for HitTester<Id>
where Id: Unpin,

§

impl<Id> UnsafeUnpin for HitTester<Id>

§

impl<Id> UnwindSafe for HitTester<Id>
where Id: UnwindSafe,

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.