Struct OverlayPlacement 

pub struct OverlayPlacement {
    pub side: OverlaySide,
    pub align: OverlayAlign,
    pub offset: f64,
    pub flip: bool,
    pub clamp: bool,
    pub padding: f64,
}

The overlay-portal authoring surface: the slot a widget that floats its own surface holds, what that surface is anchored to, and the placement geometry every anchored pattern needs.

Promoted here rather than left to each design system because all three of them had derived the same geometry independently: a design system’s popover, menu, tooltip and context menu place a surface through place and host it through OverlaySlot, reaching both through frust::authoring alone. The overlay-portal authoring surface: the slot a widget that floats its own surface holds, what that surface is anchored to, and the placement geometry every anchored pattern needs.

Promoted here rather than left to each design system because all three of them had derived the same geometry independently: a design system’s popover, menu, tooltip and context menu place a surface through place and host it through OverlaySlot, reaching both through frust::authoring alone. The overlay-portal authoring surface: the slot a widget that floats its own surface holds, what that surface is anchored to, and the placement geometry every anchored pattern needs.

Promoted here rather than left to each design system because all three of them had derived the same geometry independently: a design system’s popover, menu, tooltip and context menu place a surface through place and host it through OverlaySlot, reaching both through frust::authoring alone. A resolved placement request: which side, how it lines up, how far off the anchor it sits, and how it may move to stay inside the area.

Fields

side: OverlaySide

The preferred side.

align: OverlayAlign

Cross-axis alignment.

offset: f64

Gap between the anchor and the surface, in logical px.

flip: bool

Flip to OverlaySide::opposite when the preferred side does not fit and the opposite one does.

clamp: bool

Shift the placed rect back inside the padded area when it overflows.

padding: f64

The margin the surface keeps from every edge of the area, in logical px. Both the fit test and the clamp read the area inset by it.

Implementations

impl OverlayPlacement

pub fn on(side: OverlaySide) -> Self

A placement on side, everything else defaulted.

pub const fn align(self, align: OverlayAlign) -> Self

Set the cross-axis alignment.

pub const fn offset(self, offset: f64) -> Self

Set the anchor gap, in logical px.

pub const fn flip(self, flip: bool) -> Self

Enable or disable the collision flip.

pub const fn clamp(self, clamp: bool) -> Self

Enable or disable the shift-back-inside clamp.

pub const fn padding(self, padding: f64) -> Self

Set the margin kept from the area’s edges, in logical px.

Trait Implementations

impl Clone for OverlayPlacement

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OverlayPlacement

impl Debug for OverlayPlacement

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

Formats the value using the given formatter.

impl Default for OverlayPlacement

fn default() -> Self

Below the anchor, centred, at DEFAULT_OFFSET, flipping and clamping inside DEFAULT_PADDING of the area’s edges.

impl PartialEq for OverlayPlacement

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OverlayPlacement