Expand description
The picking prelude.
This includes the most common types in this crate, re-exported for your convenience.
Structs§
- Cancel
- Fires when a pointer is canceled, and its current interaction state is dropped.
- Click
- Fires when a pointer sends a pointer pressed event followed by a pointer released event, with the same target entity for both events.
- Default
Picking Plugins - One plugin that contains the
PointerInputPlugin
,PickingPlugin
and theInteractionPlugin
, this is probably the plugin that will be most used. - Drag
- Fires while the target entity is being dragged.
- Drag
Drop - Fires when a pointer drops the
dropped
entity onto the target entity. - DragEnd
- Fires when a pointer is dragging the target entity and a pointer released event is received.
- Drag
Enter - Fires when a pointer dragging the
dragged
entity enters the target entity. - Drag
Entry - Dragging state.
- Drag
Leave - Fires when a pointer dragging the
dragged
entity leaves the target entity. - Drag
Over - Fires while the
dragged
entity is being dragged over the target entity. - Drag
Start - Fires when the target entity receives a pointer pressed event followed by a pointer move event.
- Interaction
Plugin - Generates
Pointer
events and handles event bubbling. - Move
- Fires while a pointer is moving over the target entity.
- Out
- Fires when a pointer crosses out of the bounds of the target entity.
- Over
- Fires when a pointer crosses into the bounds of the target entity.
- Pickable
- An optional component that marks an entity as usable by a backend, and overrides default picking behavior for an entity.
- Picking
Message Writers - A helper system param for accessing the picking event writers.
- Picking
Plugin - This plugin sets up the core picking infrastructure. It receives input events, and provides the shared types used by other picking plugins.
- Pointer
- Stores the common data needed for all pointer events.
- Pointer
Button State - An entry in the cache that drives the
pointer_events
system, storing additional data about pointer button presses. - Pointer
Input Plugin - Adds mouse and touch inputs for picking pointers to your app. This is a default input plugin, that you can replace with your own plugin as needed.
- Pointer
State - State for all pointers.
- Pointer
Traversal - A traversal query (i.e. it implements
Traversal
) intended for use withPointer
events. - Pointer
Traversal Item - Automatically generated
WorldQuery
item type forPointerTraversal
, returned when iterating over query results. - Press
- Fires when a pointer button is pressed over the target entity.
- Release
- Fires when a pointer button is released over the target entity.
- Scroll
- Fires while a pointer is scrolling over the target entity.
Enums§
- Pointer
Button - The button that was just pressed or released
Functions§
- pointer_
events - Dispatches interaction events to the target entities.