Skip to main content

Selection

Struct Selection 

Source
pub struct Selection {
    pub entities: HashSet<Entity>,
    pub last_pick: Option<PickPoint>,
}
Expand description

World-global selection state — current entity set plus last hit point.

Insert via World::insert_resource before any system that reads it. The TS helper emits both single-click and marquee events; both flow into apply_pick / apply_pick_rect.

Fields§

§entities: HashSet<Entity>

Currently selected entities.

§last_pick: Option<PickPoint>

World-space point of the most recent successful click pick, if any.

Implementations§

Source§

impl Selection

Source

pub fn new() -> Self

Source

pub fn apply_pick( &mut self, entity: Option<Entity>, point: Option<PickPoint>, modifiers: PickModifiers, )

Apply a single-click pick.

  • No modifier: replace selection with entity (or clear if None).
  • Shift: toggle (add if absent, remove if present). Clicks on empty space are no-ops to avoid accidental clears mid-shift.
  • Ctrl: subtract. Clicks on empty space are no-ops.
  • Other modifier combinations: same as no-modifier on a hit; no-op on a miss.

last_pick is updated whenever point is provided, regardless of modifier — game code may want the cursor position even on a clear.

Source

pub fn apply_pick_rect<I>(&mut self, entities: I, modifiers: PickModifiers)
where I: IntoIterator<Item = Entity>,

Apply a marquee pick.

  • No modifier: replace selection with entities.
  • Shift only: add entities to selection.
  • Ctrl only: remove entities from selection.
  • Alt only: keep only entities present in both the current selection and entities (set intersection).
  • Other modifier combinations (Shift+Ctrl, Shift+Alt, Meta, …): same as no-modifier (replace).

Dispatch is on the full modifier bitmask — mirroring apply_pick — so that a multi-modifier marquee (e.g. a user holding Shift+Ctrl during a drag) falls through to the documented replace branch instead of being absorbed by the first matching single-modifier rule.

Source

pub fn contains(&self, entity: Entity) -> bool

Whether entity is currently selected.

Source

pub fn len(&self) -> usize

Number of selected entities.

Source

pub fn is_empty(&self) -> bool

Whether the selection is empty.

Trait Implementations§

Source§

impl Debug for Selection

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Selection

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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