Struct egui::WidgetRects

source ·
pub struct WidgetRects {
    by_layer: HashMap<LayerId, Vec<WidgetRect>>,
    by_id: IdMap<(usize, WidgetRect)>,
    infos: IdMap<WidgetInfo>,
}
Expand description

Stores the WidgetRects of all widgets generated during a single egui update/frame.

All Uis have a WidgetRects, but whether or not their rects are correct depends on if Ui::interact_bg was ever called.

Fields§

§by_layer: HashMap<LayerId, Vec<WidgetRect>>

All widgets, in painting order.

§by_id: IdMap<(usize, WidgetRect)>

All widgets, by id, and their order in their respective layer

§infos: IdMap<WidgetInfo>

Info about some widgets.

Only filled in if the widget is interacted with, or if this is a debug build.

Implementations§

source§

impl WidgetRects

source

pub fn layer_ids(&self) -> impl ExactSizeIterator<Item = LayerId> + '_

All known layers with widgets.

source

pub fn layers(&self) -> impl Iterator<Item = (&LayerId, &[WidgetRect])> + '_

source

pub fn get(&self, id: Id) -> Option<&WidgetRect>

source

pub fn order(&self, id: Id) -> Option<(LayerId, usize)>

In which layer, and in which order in that layer?

source

pub fn contains(&self, id: Id) -> bool

source

pub fn get_layer( &self, layer_id: LayerId, ) -> impl Iterator<Item = &WidgetRect> + '_

All widgets in this layer, sorted back-to-front.

source

pub fn clear(&mut self)

Clear the contents while retaining allocated memory.

source

pub fn insert(&mut self, layer_id: LayerId, widget_rect: WidgetRect)

Insert the given widget rect in the given layer.

source

pub fn set_info(&mut self, id: Id, info: WidgetInfo)

source

pub fn info(&self, id: Id) -> Option<&WidgetInfo>

Trait Implementations§

source§

impl Clone for WidgetRects

source§

fn clone(&self) -> WidgetRects

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Default for WidgetRects

source§

fn default() -> WidgetRects

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

impl PartialEq for WidgetRects

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,