pub struct PointerButton<T: Copy + Eq> { /* private fields */ }Expand description
Tracks press-to-release ownership for one physical mouse button.
The caller selects an eligible target at each edge’s pointer position, then
feeds the complete ordered crate::input::FrameInput::edges sequence once.
Never also feed its retained FixedInput copies: replaying a completed pair
can confirm a second click. Keyboard aliases and other mouse buttons cannot
disturb this controller. A press outside all eligible targets cannot become
a click merely by releasing over a button later.
This is a headless state machine, not a widget renderer, drag-motion stream,
OS pointer grab, keyboard-focus tree, or global input-consumption service.
Processing allocates no internal storage and registers no callbacks. Target
equality uses the caller’s Eq implementation, whose costs remain its own.
Target liveness and overlap priority belong to the caller. Invalidate capture
with Self::cancel when the target is removed, disabled or made ineligible.
Use generation-qualified IDs such as crate::identity::LogicEntity for ECS
targets. Prefer a World-local Resource recreated on replacement; a persistent
controller must be cancelled at world changes and continue receiving release
boundaries. Keeping a controller in an inactive world can miss its release.
Implementations§
Source§impl<T: Copy + Eq> PointerButton<T>
impl<T: Copy + Eq> PointerButton<T>
Sourcepub const fn new(button: MouseButton) -> Self
pub const fn new(button: MouseButton) -> Self
Creates an idle controller without allocating or requiring a renderer. Only action edges from this physical mouse button are interpreted.
Returns the configured physical mouse button, independent of action names.
Sourcepub const fn captured(&self) -> Option<T>
pub const fn captured(&self) -> Option<T>
Returns the original pressed target while it still owns the gesture. Use this for held styling, not as proof that the pointer is still inside.
Sourcepub fn cancel(&mut self) -> Option<T>
pub fn cancel(&mut self) -> Option<T>
Invalidates a captured target and returns it for caller-owned cleanup.
Its remaining matching mouse edges stay claimed until release. A removed or disabled button therefore cannot transfer an in-progress UI gesture to the gameplay beneath it, even if the same target value reappears. Without capture this does nothing. It neither invents an input token nor emits an event; the caller knows why it explicitly invalidated the target.
Sourcepub fn process<A: Action>(
&mut self,
edge: ActionEdge<A>,
hit: Option<T>,
) -> PointerButtonOutcome<T>
pub fn process<A: Action>( &mut self, edge: ActionEdge<A>, hit: Option<T>, ) -> PointerButtonOutcome<T>
Interprets one ordered edge using its caller-selected eligible hit target.
Compute hit from this edge’s sample, not the frame’s latest pointer.
Unknown or out-of-viewport samples cannot capture or confirm even if
hit is Some. Normal release over the captured target clicks; release
elsewhere or runtime cancellation ends capture without confirmation.
Multiple pairs in one frame are processed in their supplied order.
No snapshot is consumed. Inspect PointerButtonOutcome::claimed before
forwarding this edge to gameplay. FixedUpdate precedes FrameUpdate;
routing here cannot undo a game action already applied in FixedUpdate.
Route competing actions together, or queue accepted gameplay intents for
a later fixed tick. This helper does not change the runtime schedule.
Trait Implementations§
Auto Trait Implementations§
impl<T> Freeze for PointerButton<T>where
Capture<T>: Freeze,
impl<T> RefUnwindSafe for PointerButton<T>where
Capture<T>: RefUnwindSafe,
impl<T> Send for PointerButton<T>where
Capture<T>: Send,
impl<T> Sync for PointerButton<T>where
Capture<T>: Sync,
impl<T> Unpin for PointerButton<T>where
Capture<T>: Unpin,
impl<T> UnsafeUnpin for PointerButton<T>where
Capture<T>: UnsafeUnpin,
impl<T> UnwindSafe for PointerButton<T>where
Capture<T>: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
impl<T> ConditionalSend for Twhere
T: Send,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.