concinnity-engine 0.18.66

// src/ui/dropdown.rs
//
// Reference-space layout for a settings dropdown's floating option list, shared
// by the input hit-test and the overlay renderer so the two agree on where
// each option sits. A dropdown row's control button is the anchor; the list is
// a stack of equal-height option rows placed directly below it, or flipped
// above when it would spill past the bottom of the reference canvas. A list
// with more options than `MAX_VISIBLE` shows a scrolling window: the layout
// places only the visible rows, and the caller maps a row index to an option
// index by adding its scroll position (the `first` shown option). Purely
// geometric: no colors, fonts, or draw state.

use concinnity_core::gfx::overlay::UI_REFERENCE_SIZE;

// The most option rows a dropdown list shows at once; a longer list scrolls
// (the wheel moves the window while it is open).
pub(crate) const MAX_VISIBLE: usize = 8;

// How many rows a `count`-option list actually shows.
pub(crate) fn visible_count(count: usize) -> usize {
    count.min(MAX_VISIBLE)
}

// The largest valid `first` (top shown option) for a `count`-option list, so
// the window never runs past the last option.
pub(crate) fn max_first(count: usize) -> usize {
    count.saturating_sub(MAX_VISIBLE)
}

// The `first` that shows `selected` near the middle of the window when the
// list opens, clamped to the scrollable range.
pub(crate) fn first_for_selected(selected: usize, count: usize) -> usize {
    selected
        .saturating_sub(MAX_VISIBLE / 2)
        .min(max_first(count))
}

// The placed list rectangle and the per-row rectangles inside it, all in
// reference-space `[x, y, width, height]`. `items` has one entry per SHOWN row
// (at most `MAX_VISIBLE`), top to bottom; row `i` displays option `first + i`.
#[derive(Debug, Clone, PartialEq)]
pub(crate) struct DropdownLayout {
    pub list: [f32; 4],
    pub items: Vec<[f32; 4]>,
}

// Lay out a `count`-option list anchored to a control button `anchor`
// (`[x, y, width, height]`, reference space). Each option row is the anchor's
// height; the list matches the anchor's x + width and shows at most
// `MAX_VISIBLE` rows (a longer list scrolls). It opens downward from just
// below the anchor, flipping to open upward when opening down would overflow the
// reference canvas bottom, and clamps onto the canvas if it is taller than the
// space either way. A zero `count` yields an empty list.
pub(crate) fn layout(anchor: [f32; 4], count: usize) -> DropdownLayout {
    let [ax, ay, aw, ah] = anchor;
    let count = visible_count(count);
    let item_h = ah;
    let list_h = item_h * count as f32;
    let ref_h = UI_REFERENCE_SIZE[1];

    // Prefer opening downward; flip up if that overflows the bottom.
    let below_top = ay + ah;
    let above_top = ay - list_h;
    let mut top = if below_top + list_h <= ref_h || above_top < 0.0 {
        below_top
    } else {
        above_top
    };
    // Keep the list on the canvas even in the degenerate "taller than the
    // screen" case (top pinned to 0, the excess simply runs off the bottom).
    let max_top = (ref_h - list_h).max(0.0);
    top = top.clamp(0.0, max_top);

    let items = (0..count)
        .map(|i| [ax, top + i as f32 * item_h, aw, item_h])
        .collect();
    DropdownLayout {
        list: [ax, top, aw, list_h],
        items,
    }
}

// The index of the option row containing reference-space point `(px, py)`, or
// `None` if the point is outside every row.
pub(crate) fn item_at(layout: &DropdownLayout, px: f32, py: f32) -> Option<usize> {
    layout
        .items
        .iter()
        .position(|&[x, y, w, h]| px >= x && px < x + w && py >= y && py < y + h)
}

// Scrollbar-thumb styling: a chunky near-square handle inside the list's right
// edge. The height leans on the shown fraction but clamps to a narrow range so
// the handle stays grabbable and square-ish instead of a long sliver.
const THUMB_W: f32 = 14.0;
const THUMB_PAD: f32 = 2.0;
const THUMB_MIN_H: f32 = 16.0;
const THUMB_MAX_H: f32 = 28.0;

fn thumb_height(list_h: f32, count: usize) -> f32 {
    let frac = visible_count(count) as f32 / count.max(1) as f32;
    (list_h * frac).clamp(THUMB_MIN_H, THUMB_MAX_H)
}

// The scrollbar-thumb rectangle for a scrolled list (drawn inside the list's
// right edge), or `None` when every option fits and no scrollbar is needed.
// The thumb's position mirrors the shown window's scroll position, like the
// settings ScrollPanel's thumb; a drag maps back through
// `first_for_thumb_top`.
pub(crate) fn thumb_rect(layout: &DropdownLayout, first: usize, count: usize) -> Option<[f32; 4]> {
    let visible = visible_count(count);
    if count <= visible || visible == 0 {
        return None;
    }
    let [lx, ly, lw, lh] = layout.list;
    let thumb_h = thumb_height(lh, count);
    let travel = lh - thumb_h;
    let pos = first as f32 / max_first(count) as f32;
    Some([
        lx + lw - THUMB_W - THUMB_PAD,
        ly + travel * pos.clamp(0.0, 1.0),
        THUMB_W,
        thumb_h,
    ])
}

// The full-height scrollbar strip (the thumb's travel column, pads included)
// for a scrolled list, or `None` when every option fits. A press inside it is
// scrollbar input (a thumb grab, or a jump to the pressed spot), never an
// option pick.
pub(crate) fn track_rect(layout: &DropdownLayout, count: usize) -> Option<[f32; 4]> {
    if count <= visible_count(count) {
        return None;
    }
    let [lx, ly, lw, lh] = layout.list;
    let w = THUMB_W + 2.0 * THUMB_PAD;
    Some([lx + lw - w, ly, w, lh])
}

// Map a dragged thumb-top y back to the window's first shown option, as the
// fractional row offset the caller accumulates (its scroll position). Clamps
// to the scrollable range, so any cursor y is safe.
pub(crate) fn first_for_thumb_top(layout: &DropdownLayout, count: usize, top: f32) -> f32 {
    let [_, ly, _, lh] = layout.list;
    let travel = lh - thumb_height(lh, count);
    if travel <= 0.0 {
        return 0.0;
    }
    ((top - ly) / travel).clamp(0.0, 1.0) * max_first(count) as f32
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn opens_downward_with_room_below() {
        // A row near the top: the 3-item list sits directly below it.
        let anchor = [400.0, 100.0, 200.0, 40.0];
        let l = layout(anchor, 3);
        assert_eq!(l.list, [400.0, 140.0, 200.0, 120.0]);
        assert_eq!(l.items.len(), 3);
        assert_eq!(l.items[0], [400.0, 140.0, 200.0, 40.0]);
        assert_eq!(l.items[1], [400.0, 180.0, 200.0, 40.0]);
        assert_eq!(l.items[2], [400.0, 220.0, 200.0, 40.0]);
    }

    #[test]
    fn flips_upward_when_it_would_overflow_the_bottom() {
        // A row low on the canvas (720 tall): opening down would spill past the
        // bottom, so the list opens upward, ending at the anchor's top.
        let anchor = [400.0, 680.0, 200.0, 40.0];
        let l = layout(anchor, 4); // list_h = 160
        // above_top = 680 - 160 = 520; below_top + 160 = 720+160 overflow.
        assert_eq!(l.list, [400.0, 520.0, 200.0, 160.0]);
        assert_eq!(l.items[0], [400.0, 520.0, 200.0, 40.0]);
        assert_eq!(l.items[3], [400.0, 640.0, 200.0, 40.0]);
    }

    #[test]
    fn long_lists_window_to_max_visible() {
        // A 40-option list shows only MAX_VISIBLE rows; the window (not the
        // whole list) is what must fit on the canvas.
        let anchor = [0.0, 300.0, 100.0, 40.0];
        let l = layout(anchor, 40);
        assert_eq!(l.items.len(), MAX_VISIBLE);
        assert_eq!(l.list[3], 40.0 * MAX_VISIBLE as f32);
        // The window opens below the anchor (340 + 320 <= 720).
        assert_eq!(l.list[1], 340.0);
        // A shorter list is not windowed.
        assert_eq!(layout(anchor, 3).items.len(), 3);
    }

    #[test]
    fn scroll_window_helpers_clamp() {
        assert_eq!(visible_count(3), 3);
        assert_eq!(visible_count(40), MAX_VISIBLE);
        // A fitting list never scrolls; a long one stops at the last window.
        assert_eq!(max_first(MAX_VISIBLE), 0);
        assert_eq!(max_first(40), 40 - MAX_VISIBLE);
        // Opening centers the selection, clamped at both ends.
        assert_eq!(first_for_selected(0, 40), 0);
        assert_eq!(first_for_selected(20, 40), 20 - MAX_VISIBLE / 2);
        assert_eq!(first_for_selected(39, 40), 40 - MAX_VISIBLE);
        assert_eq!(first_for_selected(2, 3), 0);
    }

    #[test]
    fn thumb_tracks_the_scroll_position() {
        let l = layout([0.0, 100.0, 100.0, 40.0], 16); // window 8 of 16
        // Top of the range: thumb at the list top.
        let top = thumb_rect(&l, 0, 16).unwrap();
        assert_eq!(top[1], l.list[1]);
        // Bottom of the range: thumb ends at the list bottom.
        let bottom = thumb_rect(&l, 8, 16).unwrap();
        assert_eq!(bottom[1] + bottom[3], l.list[1] + l.list[3]);
        // A fitting list has no thumb.
        assert!(thumb_rect(&layout([0.0, 100.0, 100.0, 40.0], 4), 0, 4).is_none());
    }

    #[test]
    fn thumb_height_clamps_to_a_grabbable_handle() {
        // 8 of 1000 shown: the proportional height would be a sliver; it
        // clamps up to the minimum handle size.
        let l = layout([0.0, 100.0, 100.0, 40.0], 1000);
        assert_eq!(thumb_rect(&l, 0, 1000).unwrap()[3], THUMB_MIN_H);
        // 8 of 9 shown: proportional would nearly fill the track; it clamps
        // down so the handle still reads as a handle.
        let l = layout([0.0, 100.0, 100.0, 40.0], 9);
        assert_eq!(thumb_rect(&l, 0, 9).unwrap()[3], THUMB_MAX_H);
    }

    #[test]
    fn track_strip_spans_the_list_and_contains_the_thumb() {
        let l = layout([0.0, 100.0, 200.0, 40.0], 16);
        let track = track_rect(&l, 16).unwrap();
        // Full list height, flush with the list's right edge.
        assert_eq!(track[1], l.list[1]);
        assert_eq!(track[3], l.list[3]);
        assert_eq!(track[0] + track[2], l.list[0] + l.list[2]);
        // The thumb travels inside the strip.
        let thumb = thumb_rect(&l, 4, 16).unwrap();
        assert!(thumb[0] >= track[0]);
        assert!(thumb[0] + thumb[2] <= track[0] + track[2]);
        // A fitting list has no track.
        assert!(track_rect(&layout([0.0, 100.0, 200.0, 40.0], 4), 4).is_none());
    }

    #[test]
    fn thumb_top_maps_back_to_the_scroll_range() {
        let l = layout([0.0, 100.0, 100.0, 40.0], 16); // window 8 of 16
        let [_, ly, _, lh] = l.list;
        let th = thumb_rect(&l, 0, 16).unwrap()[3];
        // The travel endpoints map to the ends of the scroll range, the middle
        // to its middle, and out-of-range tops clamp.
        assert_eq!(first_for_thumb_top(&l, 16, ly), 0.0);
        assert_eq!(first_for_thumb_top(&l, 16, ly + lh - th), 8.0);
        assert_eq!(first_for_thumb_top(&l, 16, ly + (lh - th) / 2.0), 4.0);
        assert_eq!(first_for_thumb_top(&l, 16, ly - 100.0), 0.0);
        assert_eq!(first_for_thumb_top(&l, 16, ly + lh), 8.0);
    }

    #[test]
    fn item_at_finds_the_row_under_a_point() {
        let l = layout([400.0, 100.0, 200.0, 40.0], 3);
        assert_eq!(item_at(&l, 500.0, 150.0), Some(0));
        assert_eq!(item_at(&l, 500.0, 190.0), Some(1));
        assert_eq!(item_at(&l, 500.0, 230.0), Some(2));
        // Outside the list horizontally / below it: no hit.
        assert_eq!(item_at(&l, 700.0, 150.0), None);
        assert_eq!(item_at(&l, 500.0, 300.0), None);
    }

    #[test]
    fn zero_options_is_empty() {
        let l = layout([0.0, 0.0, 100.0, 40.0], 0);
        assert!(l.items.is_empty());
        assert_eq!(l.list[3], 0.0);
    }
}