Skip to main content

PointerButton

Struct PointerButton 

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

Source

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.

Source

pub const fn button(&self) -> MouseButton

Returns the configured physical mouse button, independent of action names.

Source

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.

Source

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.

Source

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§

Source§

impl<T: Debug + Copy + Eq> Debug for PointerButton<T>

Source§

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

Formats the value using the given formatter. Read more

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> 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

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

Source§

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

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<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

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> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

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

Source§

impl<T> WasmNotSendSync for T

Source§

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

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