Struct ApplicationSelectionState 

pub struct ApplicationSelectionState { /* private fields */ }

Selection and hover state.

Both hover and selection are double buffered: Changes from one frame are only visible in the next frame.

Implementations

impl ApplicationSelectionState

pub fn on_frame_start( &mut self, resolve_item: impl Fn(&Item) -> Option<Item>, fallback_selection: Option<Item>, ) -> SelectionChange<'_>

Called at the start of each frame.

resolve_item decides the fate of each currently selected item: returning None drops it, while returning Some(item) keeps it — possibly replacing it with a different item (e.g. downgrading a no-longer-valid data result to a plain entity selection).

pub fn on_frame_end(&mut self)

pub fn set_selection(&mut self, items: impl Into<SetSelection>)

Sets several objects to be selected, updating history as needed.

Clears the selected item context if none was specified.

pub fn selected_items(&self) -> &ItemCollection

Returns the current selection.

pub fn hovered_items(&self) -> &ItemCollection

Returns the currently hovered objects.

pub fn set_hovered(&self, hovered: impl Into<ItemCollection>)

Set the hovered objects. Will be in Self::hovered_items on the next frame.

pub fn selection_item_contexts(&self) -> impl Iterator<Item = &ItemContext>

pub fn hovered_item_context(&self) -> Option<&ItemContext>

pub fn selection_changed(&self) -> Option<SelectionSource>

Returns Some if the selection changed this frame.

pub fn highlight_for_ui_element(&self, test: &Item) -> HoverHighlight

Trait Implementations

impl Default for ApplicationSelectionState

fn default() -> ApplicationSelectionState

Returns the “default value” for a type.