Struct FlapState 

pub struct FlapState { /* private fields */ }

The reveal shared by every flap. See the module docs.

Implementations

impl FlapState

pub fn open_when_docked() -> FlapState

A flap that is open when docked (the common navigation sidebar).

pub fn closed_by_default() -> FlapState

A flap that is closed even when docked — summoned on demand.

pub fn from_input(&mut self, source: MotionSource)

Say what input the next choice comes from: a shortcut lands at once.

pub fn is_open(&self, layout: SplitLayout) -> bool

Whether the flap is currently open in layout, resolving the person’s choice against the layout default.

pub fn toggle(&mut self, layout: SplitLayout)

Flip the flap relative to its resolved openness in layout.

pub fn open(&mut self)

Open the flap in the current layout.

pub fn close(&mut self)

Close the flap in the current layout (scrim, Esc, a choice made in a drawer).

pub fn snap(&mut self, open: bool)

Set the open state with no animation, for deterministic shots.

pub fn settle(&mut self, layout: SplitLayout)

Jump the reveal to the resolved openness without recording a choice.

pub fn advance( &mut self, layout: SplitLayout, now: Instant, motion: EffectiveMotion, ) -> bool

Follow the resolved state to now (the frame’s time) on the panel slide motion allows. Returns whether it is still moving.

pub fn reconcile(&mut self, layout: SplitLayout)

Note the layout the flap is laid out in. The first call settles the reveal (the constructor guessed before any width was known); a later change drops a transient overlay choice and settles to the new layout’s resolved state, so a resize is a structural jump, never a slide.

pub fn reveal(&self) -> f64

The reveal in 0..=1 as of the last frame: the docked width share, the overlay slide and the scrim strength.

pub fn is_animating(&self, layout: SplitLayout) -> bool

Whether the reveal is still moving toward the resolved state.

Trait Implementations

impl Clone for FlapState

fn clone(&self) -> FlapState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FlapState

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

Formats the value using the given formatter.