Struct OverlayState 

pub struct OverlayState { /* private fields */ }

Owns overlay lifecycle, animation progress, and the computed inner area.

State machine

Closed ──open()──▸ Opening ──tick──▸ Open
  ▴                                    │
  └──tick──◂ Closing ◂──close()────────┘

With default duration (zero), open()/close() transition instantly. Set with_duration for animated transitions. Interrupting mid-animation reverses from the current progress.

Implementations

impl OverlayState

pub fn new() -> Self

pub fn with_duration(self, duration: Duration) -> Self

pub fn with_easing(self, easing: Easing) -> Self

pub fn open(&mut self)

pub fn close(&mut self)

pub fn toggle(&mut self)

pub fn tick(&mut self, elapsed: Duration)

Advance animation by elapsed time. No-op when fully open, closed, or duration is zero.

pub fn is_open(&self) -> bool

pub fn is_closed(&self) -> bool

pub fn is_animating(&self) -> bool

pub fn overlay_rect(&self) -> Option<Rect>

Full overlay bounding rect, set during render. None when closed.

Use this for hit-testing (e.g. click-outside-to-dismiss):

if let Some(rect) = state.overlay_rect() {
    if !rect.contains(click_position) {
        state.close();
    }
}

pub fn inner_area(&self) -> Option<Rect>

Region available for body content (inside block chrome), set during render. None when closed.

Trait Implementations

impl Clone for OverlayState

fn clone(&self) -> OverlayState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OverlayState

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

Formats the value using the given formatter.

impl Default for OverlayState

fn default() -> Self

Returns the “default value” for a type.