Module prelude

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 it’s current interaction state is dropped.

Click

Fires when a pointer sends a pointer down event followed by a pointer up event, with the same target entity for both events.

DefaultPickingPlugins

One plugin that contains the PointerInputPlugin, PickingPlugin and the InteractionPlugin, this is probably the plugin that will be most used.

Down

Fires when a pointer button is pressed over the target entity.

Drag

Fires while the target entity is being dragged.

DragDrop

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 up event is received.

DragEnter

Fires when a pointer dragging the dragged entity enters the target entity.

DragEntry

Dragging state.

DragLeave

Fires when a pointer dragging the dragged entity leaves the target entity.

DragOver

Fires while the dragged entity is being dragged over the target entity.

DragStart

Fires when the target entity receives a pointer down event followed by a pointer move event.

InteractionPlugin

Generates Pointer events and handles event bubbling.

Move

Fires while a pointer is moving over the target entity.

Out

Fires when a the pointer crosses out of the bounds of the target entity.

Over

Fires when a the pointer crosses into the bounds of the target entity.

PickingBehavior

An optional component that overrides default picking behavior for an entity, allowing you to make an entity non-hoverable, or allow items below it to be hovered. See the documentation on the fields for more details.

PickingEventWriters

A helper system param for accessing the picking event writers.

PickingPlugin

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.

PointerButtonState

An entry in the cache that drives the pointer_events system, storing additional data about pointer button presses.

PointerInputPlugin

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.

PointerState

State for all pointers.

Up

Fires when a pointer button is released over the target entity.

Enums

PointerButton

The button that was just pressed or released

Functions

pointer_events

Dispatches interaction events to the target entities.