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

DefaultPickingPlugins

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

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 released 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 pressed event followed by a pointer move event.

Enter

Fires when a pointer crosses into the bounds of a target entity. Unlike Over, this event bubbles up through a subset of the target entity’s ancestors (traversed via the ChildOf relationship).

HoveredEntityAncestors

A cache map containing the ancestry of hovered entities

InteractionPlugin

Generates Pointer events and handles event bubbling.

Leave

Fires when a pointer crosses out of the bounds of a target entity. Unlike Out, this event bubbles up through a subset of the target entity’s ancestors (traversed via the ChildOf relationship).

Move

Fires while a pointer is moving over the target entity.

Out

Fires when a pointer crosses out of the bounds of a target entity. Unlike Leave, this event bubbles up to all of the target entity’s ancestors (traversed via the ChildOf relationship) without restriction. Refer to pointer_events for more information on how these events are triggered. Refer to PointerTraversal for how Pointer events are propagated.

Over

Fires when a pointer crosses into the bounds of a target entity. Unlike Enter, this event bubbles up to all of the target entity’s ancestors (traversed via the ChildOf relationship) without restriction. Refer to pointer_events for more information on how these events are triggered. Refer to PointerTraversal for how Pointer events are propagated.

Pickable

An optional component that marks an entity as usable by a backend, and overrides default picking behavior for an entity.

PickingMessageWriters

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.

PointerTraversal

A traversal query (i.e. it implements Traversal) intended for use with Pointer events.

PointerTraversalItem

Automatically generated WorldQuery item type for PointerTraversal, 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

PointerButton

The button that was just pressed or released

Functions

pointer_events

Dispatches interaction events to the target entities.