Struct ItemCollection

pub struct ItemCollection(IndexMap<Item, Option<ItemContext>>);

An ordered collection of Item and optional associated context objects.

Used to store what is currently selected and/or hovered.

Tuple Fields

0: IndexMap<Item, Option<ItemContext>>

Implementations

impl ItemCollection

pub fn into_mono_instance_path_items(self, ctx: &ViewerContext<'_>) -> Self

For each item in this selection, if it refers to the first element of an instance with a single element, resolve it to a unindexed entity path.

pub fn first_item(&self) -> Option<&Item>

The first selected object if any.

pub fn single_item(&self) -> Option<&Item>

Check if the selection contains a single item and returns it if so.

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

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

pub fn context_for_item(&self, item: &Item) -> Option<&ItemContext>

pub fn contains_item(&self, needle: &Item) -> bool

Returns true if the exact selection is part of the current selection.

pub fn are_all_items_same_kind(&self) -> Option<&'static str>

pub fn retain(&mut self, f: impl FnMut(&Item, &mut Option<ItemContext>) -> bool)

Retains elements that fulfill a certain condition.

pub fn len(&self) -> usize

Returns the number of items in the selection.

pub fn is_empty(&self) -> bool

Check if the selection is empty.

pub fn iter(&self) -> impl Iterator<Item = (&Item, &Option<ItemContext>)>

Returns an iterator over the items and their selected context.

pub fn iter_mut( &mut self, ) -> impl Iterator<Item = (&Item, &mut Option<ItemContext>)>

Returns a mutable iterator over the items and their selected context.

pub fn extend( &mut self, other: impl IntoIterator<Item = (Item, Option<ItemContext>)>, )

Extend the selection with more items.

pub fn copy_to_clipboard(&self, egui_ctx: &Context)

Tries to copy a description of the selection to the clipboard.

Only certain elements are copyable right now.

Trait Implementations

impl Clone for ItemCollection

fn clone(&self) -> ItemCollection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ItemCollection

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

Formats the value using the given formatter.

impl Default for ItemCollection

fn default() -> ItemCollection

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ItemCollection

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Item> for ItemCollection

fn from(val: Item) -> Self

Converts to this type from the input type.

impl<T> From<T> for ItemCollection

where T: Iterator<Item = (Item, Option<ItemContext>)>,

fn from(value: T) -> Self

Converts to this type from the input type.

impl IntoIterator for ItemCollection

type Item = (Item, Option<ItemContext>)

The type of the elements being iterated over.

type IntoIter = IntoIter<Item, Option<ItemContext>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for ItemCollection

fn eq(&self, other: &ItemCollection) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ItemCollection

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ItemCollection