Struct me3_framework::overlay::containers::Area
source · [−]pub struct Area { /* private fields */ }
Expand description
An area on the screen that can be moved by dragging.
This forms the base of the Window
container.
egui::Area::new("my_area")
.fixed_pos(egui::pos2(32.0, 32.0))
.show(ctx, |ui| {
ui.label("Floating text!");
});
Implementations
sourceimpl Area
impl Area
pub fn new(id_source: impl Hash) -> Area
pub fn id(self, id: Id) -> Area
pub fn layer(&self) -> LayerId
sourcepub fn enabled(self, enabled: bool) -> Area
pub fn enabled(self, enabled: bool) -> Area
If false, no content responds to click
and widgets will be shown grayed out.
You won’t be able to move the window.
Default: true
.
pub fn is_enabled(&self) -> bool
pub fn is_movable(&self) -> bool
sourcepub fn interactable(self, interactable: bool) -> Area
pub fn interactable(self, interactable: bool) -> Area
If false, clicks goes straight through to what is behind us. Good for tooltips etc.
sourcepub fn order(self, order: Order) -> Area
pub fn order(self, order: Order) -> Area
order(Order::Foreground)
for an Area that should always be on top
pub fn default_pos(self, default_pos: impl Into<Pos2>) -> Area
sourcepub fn fixed_pos(self, fixed_pos: impl Into<Pos2>) -> Area
pub fn fixed_pos(self, fixed_pos: impl Into<Pos2>) -> Area
Positions the window and prevents it from being moved
sourcepub fn current_pos(self, current_pos: impl Into<Pos2>) -> Area
pub fn current_pos(self, current_pos: impl Into<Pos2>) -> Area
Positions the window but you can still move it.
sourcepub fn anchor(self, align: Align2, offset: impl Into<Vec2>) -> Area
pub fn anchor(self, align: Align2, offset: impl Into<Vec2>) -> Area
Set anchor and distance.
An anchor of Align2::RIGHT_TOP
means “put the right-top corner of the window
in the right-top corner of the screen”.
The offset is added to the position, so e.g. an offset of [-5.0, 5.0]
would move the window left and down from the given anchor.
Anchoring also makes the window immovable.
It is an error to set both an anchor and a position.
sourcepub fn drag_bounds(self, bounds: Rect) -> Area
pub fn drag_bounds(self, bounds: Rect) -> Area
Constrain the area up to which the window can be dragged.