Struct bevy_mod_picking::backend::PointerHits

pub struct PointerHits {
    pub pointer: PointerId,
    pub picks: Vec<(Entity, HitData)>,
    pub order: f32,
}

An event produced by a picking backend after it has run its hit tests, describing the entities under a pointer.

Some backends may only support providing the topmost entity; this is a valid limitation of some backends. For example, a picking shader might only have data on the topmost rendered output from its buffer.

Fields

pointer: PointerId

The pointer associated with this hit test.

picks: Vec<(Entity, HitData)>

An unordered collection of entities and their distance (depth) from the cursor.

order: f32

Set the order of this group of picks. Normally, this is the bevy_render::camera::Camera::order.

Used to allow multiple PointerHits submitted for the same pointer to be ordered. PointerHits with a higher order will be checked before those with a lower order, regardless of the depth of each entity pick.

In other words, when pick data is coalesced across all backends, the data is grouped by pointer, then sorted by order, and checked sequentially, sorting each PointerHits by entity depth. Events with a higher order are effectively on top of events with a lower order.

Why is this an f32???

Bevy UI is special in that it can share a camera with other things being rendered. in order to properly sort them, we need a way to make bevy_ui’s order a tiny bit higher, like adding 0.5 to the order. We can’t use integers, and we want users to be using camera.order by default, so this is the best solution at the moment.

Implementations

impl PointerHits

pub fn new( pointer: PointerId, picks: Vec<(Entity, HitData)>, order: f32 ) -> PointerHits

Trait Implementations

impl Clone for PointerHits

fn clone(&self) -> PointerHits

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PointerHits

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

Formats the value using the given formatter.

impl Event for PointerHits

where PointerHits: Send + Sync + 'static,