Skip to main content

cranpose_ui/
round_scroll_indicator.rs

1//! The curved scroll indicator a round watch puts at 3 o'clock.
2//!
3//! Every round-screen app needs this and none of it is guessable: the track is
4//! described by a height in dp rather than an angle, the thumb is a separate
5//! segment with a gap at each end rather than paint over a continuous rail, and
6//! a segment shorter than its own stroke turns into a shrinking, fading dot
7//! instead of a stubby arc.
8//!
9//! The numbers and the arithmetic here were read out of
10//! `androidx.wear.compose.material3` 1.6.2 with `javap -c` and then checked
11//! against where the shipping Compose build actually puts pixels on 454x454 and
12//! 384x384 displays. The sources are named per item so the next person can
13//! re-derive them rather than trust this comment.
14//!
15//! This module is deliberately pure geometry. It returns the segments to draw
16//! and takes no view of how they are drawn, so it costs nothing to a platform
17//! that never shows it and can be tested without a GPU.
18
19use std::f32::consts::FRAC_PI_2;
20
21use crate::{
22    round_scaling_list::ScalingParams,
23    scrollbar::{ThumbBounds, thumb_geometry},
24};
25
26/// `ScrollIndicatorDefaults.indicatorHeight` — how far the track reaches up and
27/// down from 3 o'clock, as a straight-line height rather than an arc length.
28pub const INDICATOR_HEIGHT_DP: f32 = 50.0;
29/// `ScrollIndicatorDefaults.indicatorWidth`, whose two values are chosen by
30/// screen size.
31pub const INDICATOR_WIDTH_DP: f32 = 6.0;
32pub const INDICATOR_NARROW_WIDTH_DP: f32 = 5.0;
33/// Wear's own breakpoint: a display at least this wide gets the wider stroke.
34pub const INDICATOR_LARGE_SCREEN_DP: f32 = 225.0;
35/// `PaddingDefaults.edgePadding` — how far the track's outer edge stays off the
36/// display edge.
37pub const INDICATOR_EDGE_PADDING_DP: f32 = 2.0;
38/// `ScrollIndicatorDefaults.gapHeight` — the blank left between the thumb and
39/// each end of the track.
40pub const INDICATOR_GAP_DP: f32 = 3.0;
41/// `ScrollIndicatorDefaults.minSizeFraction` / `maxSizeFraction` — the thumb's
42/// share of the track is clamped to this range however long the list is.
43pub const INDICATOR_MIN_THUMB: f32 = 0.3;
44pub const INDICATOR_MAX_THUMB: f32 = 0.7;
45
46/// The stroke width Wear would use on a display this wide.
47pub fn indicator_width_dp(display_dp: f32) -> f32 {
48    if display_dp.is_finite() && display_dp >= INDICATOR_LARGE_SCREEN_DP {
49        INDICATOR_WIDTH_DP
50    } else {
51        INDICATOR_NARROW_WIDTH_DP
52    }
53}
54
55/// Where the track sits on a display of the given radius.
56#[derive(Clone, Copy, Debug, PartialEq)]
57pub struct IndicatorArc {
58    /// Radius of the stroke's centreline, in the same unit as the radius given.
59    centreline: f32,
60    /// Stroke width, same unit.
61    width: f32,
62    /// Half the angle the whole track covers, in radians.
63    half_sweep: f32,
64    /// Angular amount removed from every segment before round caps are drawn.
65    /// Wear derives this from the stroke width plus the visible gap.
66    segment_inset: f32,
67}
68
69impl IndicatorArc {
70    /// Radius of the stroke's centreline.
71    pub fn centreline(self) -> f32 {
72        self.centreline
73    }
74
75    /// Stroke width.
76    pub fn width(self) -> f32 {
77        self.width
78    }
79
80    /// Angular amount removed from each segment before its round caps draw.
81    pub fn segment_inset(self) -> f32 {
82        self.segment_inset
83    }
84
85    /// The angle at which the track starts, measured the way a canvas measures
86    /// it: `0` at 3 o'clock, increasing clockwise.
87    pub fn start_angle(self) -> f32 {
88        -self.half_sweep
89    }
90
91    /// The whole track's sweep in radians.
92    pub fn sweep(self) -> f32 {
93        self.half_sweep * 2.0
94    }
95
96    /// How much angle a round cap adds beyond the nominal arc at each end.
97    ///
98    /// Wear draws each segment inset by half a cap at the start and a whole cap
99    /// shorter, so the round caps put the ink back exactly on the nominal
100    /// bounds. A caller that draws with a butt cap wants this to be zero.
101    pub fn cap_sweep(self) -> f32 {
102        if self.centreline > 0.0 {
103            self.width / self.centreline
104        } else {
105            0.0
106        }
107    }
108}
109
110fn height_to_sweep(height: f32, radius: f32) -> f32 {
111    if radius <= 0.0 || !radius.is_finite() {
112        return 0.0;
113    }
114    (height * 0.5 / radius).clamp(-1.0, 1.0).asin() * 2.0
115}
116
117/// Where the track's centreline sits and how far it sweeps.
118///
119/// Wear describes the track by a height in dp, so the angle it covers depends
120/// on the radius it is drawn at — deriving it here rather than storing an angle
121/// keeps the indicator the same size in millimetres on every watch.
122///
123/// The centreline is `radius - edgePadding - strokeWidth / 2`. Wear converts
124/// both the track height and `(strokeWidth + gapHeight)` to angles using the
125/// padded radius, then adds the latter inset to the total sweep before each
126/// segment removes it again. The round caps restore the stroke-width share,
127/// leaving the requested visible gap.
128pub fn indicator_arc(radius: f32) -> IndicatorArc {
129    let width = indicator_width_dp(radius * 2.0);
130    let usable_radius = radius - INDICATOR_EDGE_PADDING_DP;
131    let centreline = usable_radius - width * 0.5;
132    if centreline <= 0.0 || !centreline.is_finite() {
133        return IndicatorArc {
134            centreline: 0.0,
135            width,
136            half_sweep: 0.0,
137            segment_inset: 0.0,
138        };
139    }
140    let segment_inset = height_to_sweep(width + INDICATOR_GAP_DP, usable_radius);
141    let half_sweep = ((height_to_sweep(INDICATOR_HEIGHT_DP, usable_radius) + segment_inset) * 0.5)
142        .min(FRAC_PI_2);
143    IndicatorArc {
144        centreline,
145        width,
146        half_sweep,
147        segment_inset,
148    }
149}
150
151/// Where the thumb sits inside the track and how long it is, both as fractions
152/// of the whole track.
153#[derive(Clone, Copy, Debug, PartialEq)]
154pub struct IndicatorGeometry {
155    /// Thumb length as a share of the track, clamped to Wear's range.
156    pub thumb: f32,
157    /// The thumb's leading edge: `0.0` at the top, `1.0 - thumb` at the bottom.
158    pub offset: f32,
159}
160
161/// Works out the thumb for a list, or `None` when everything fits on screen and
162/// Wear shows nothing at all.
163///
164/// `content` and `viewport` are lengths in any one unit; `scrolled` is how far
165/// the content has travelled, in the same unit.
166///
167/// This is the generic, flat-list model: the thumb is the share of the content
168/// on screen and it moves with the pixels. A `ScalingLazyColumn` does **not**
169/// work this way — see [`scaling_list_geometry`], which is the rule Wear's own
170/// indicator uses for one. Reach for this one when a caller genuinely scrolls
171/// pixels, and for that one when it is a Wear list.
172pub fn indicator_geometry(content: f32, viewport: f32, scrolled: f32) -> Option<IndicatorGeometry> {
173    thumb_geometry(
174        content,
175        viewport,
176        scrolled,
177        ThumbBounds::new(INDICATOR_MIN_THUMB, INDICATOR_MAX_THUMB),
178    )
179    .map(|geometry| IndicatorGeometry {
180        thumb: geometry.length,
181        offset: geometry.offset,
182    })
183}
184
185/// One row of a `ScalingLazyColumn`, as `ScalingLazyListItemInfo` reports it.
186///
187/// **Device pixels.** Wear's adapter reads a layout that has already been
188/// resolved onto the pixel grid — item heights are whole pixels, the viewport's
189/// centre line is an integer halving — and it divides by those integers. Doing
190/// the same arithmetic in points quietly loses the halves, and the halves are
191/// what decide which item index the thumb's ends land on.
192///
193/// [`scaling_list_items`] builds these from a laid-out list; a caller that
194/// already holds a real `ScalingLazyListLayoutInfo` can fill them in directly.
195#[derive(Clone, Copy, Debug, PartialEq)]
196pub struct IndicatorItem {
197    /// The row's index in the whole list.
198    pub index: usize,
199    /// `ScalingLazyListItemInfo.startOffset(ItemCenter)`: the row's top edge
200    /// measured from the viewport's centre line, after scaling.
201    pub start_offset: f32,
202    /// `ScalingLazyListItemInfo.size`: the row's height after scaling, rounded
203    /// to a whole pixel. Not the height the row is *drawn* at — the graphics
204    /// layer scales by the unrounded scale — but this rounded one is what the
205    /// layout info reports and therefore what the indicator divides by.
206    pub size: f32,
207}
208
209/// A scaling list as `ScalingLazyColumnStateAdapter` sees it. Device pixels.
210#[derive(Clone, Copy, Debug, PartialEq)]
211pub struct ScalingList<'a> {
212    /// The rows on screen, in order. Only the first and last are read, but the
213    /// whole window is taken because that is what the adapter is handed and
214    /// because a caller that trims it to two has to get the window right
215    /// itself.
216    pub visible: &'a [IndicatorItem],
217    /// `totalItemsCount` — every row, on screen or not. This is the
218    /// denominator the thumb's length is a share of.
219    pub total: usize,
220    /// `viewportSize.height`.
221    pub viewport: f32,
222    /// `beforeContentPadding + beforeAutoCenteringPadding`, the blank the list
223    /// keeps above its first row. It counts only while the first row is on
224    /// screen, which is the adapter's own rule and not an optimisation.
225    pub before_padding: f32,
226    /// `afterContentPadding + afterAutoCenteringPadding`, likewise below the
227    /// last row.
228    pub after_padding: f32,
229}
230
231/// Where the first visible row sits, as a fractional item index.
232///
233/// `androidx.wear.compose.material3.ScalingLazyColumnStateAdapter`. The whole
234/// part is the row's index and the fraction is how much of it has gone off the
235/// top, so a list that has scrolled half of item 3 away reads 3.5 — **an
236/// item-space position, not a pixel one**.
237pub fn decimal_first_item_index(list: ScalingList<'_>) -> f32 {
238    let Some(first) = list.visible.first() else {
239        return 0.0;
240    };
241    let offset_from_start = if first.index == 0 {
242        list.before_padding
243    } else {
244        0.0
245    };
246    let start = first.start_offset - offset_from_start;
247    let top = -(list.viewport / 2.0);
248    let fraction = ((top - start) / (first.size + offset_from_start).max(1.0)).max(0.0);
249    finite(first.index as f32 + fraction)
250}
251
252/// Where the last visible row sits, as a fractional item index.
253///
254/// The mirror of [`decimal_first_item_index`]: the fraction is how much of the
255/// row is on screen, so a list showing the top third of item 6 reads 6.33.
256pub fn decimal_last_item_index(list: ScalingList<'_>) -> f32 {
257    let Some(last) = list.visible.last() else {
258        return 0.0;
259    };
260    let span = last.size
261        + if last.index + 1 == list.total {
262            list.after_padding
263        } else {
264            0.0
265        };
266    let end = last.start_offset + span;
267    let bottom = list.viewport / 2.0;
268    let fraction = (1.0 - (end - bottom) / span.max(1.0)).min(1.0);
269    finite(last.index as f32 + fraction)
270}
271
272/// How far down the track the thumb's leading edge sits, before the thumb's own
273/// length is taken out of the travel. `0.0` at the top, `1.0` at the bottom.
274///
275/// The denominator is the number of items that are *not* on screen — how far
276/// the list can still travel, counted in items — which is why this is not the
277/// same number as a pixel scroll's progress on a list whose rows differ in
278/// height.
279pub fn position_fraction(list: ScalingList<'_>) -> f32 {
280    if list.visible.is_empty() {
281        return 0.0;
282    }
283    let first = decimal_first_item_index(list);
284    let remaining = list.total as f32 - decimal_last_item_index(list);
285    if first + remaining == 0.0 {
286        0.0
287    } else {
288        finite(first / (first + remaining))
289    }
290}
291
292/// The thumb's length, and the fact that Wear only measures it once.
293///
294/// `ScalingLazyColumnStateAdapter` holds `currentSizeFraction` and recomputes
295/// it **only when `totalItemsCount` changes**, guarded by `previousItemsCount`.
296/// That is not a cache in the sense of an optimisation, it is the behaviour:
297/// the thumb keeps the length it was given by the list's first layout and does
298/// not breathe as rows of different heights scroll past. Recomputing it every
299/// frame gives a thumb that grows and shrinks while you turn the crown, which
300/// the shipping build does not do.
301///
302/// One of these belongs to one list. Give a screen its own, and drop it (or
303/// call [`ThumbLength::forget`]) when the screen goes away, the way Wear drops
304/// the adapter with the `ScreenScaffold` that made it.
305#[derive(Clone, Copy, Debug, Default, PartialEq)]
306pub struct ThumbLength {
307    fraction: f32,
308    items: usize,
309}
310
311impl ThumbLength {
312    /// `getSizeFraction`: the share of the track the thumb covers.
313    pub fn of(&mut self, list: ScalingList<'_>) -> f32 {
314        if list.visible.is_empty() {
315            return 0.0;
316        }
317        if self.items != list.total {
318            self.items = list.total;
319            let span = decimal_last_item_index(list) - decimal_first_item_index(list);
320            let share = span / list.total.max(1) as f32;
321            self.fraction = if share.is_finite() {
322                share.clamp(INDICATOR_MIN_THUMB, INDICATOR_MAX_THUMB)
323            } else {
324                INDICATOR_MIN_THUMB
325            };
326        }
327        self.fraction
328    }
329
330    /// Forget the measured length, so the next list measures itself again.
331    pub fn forget(&mut self) {
332        *self = Self::default();
333    }
334}
335
336/// The thumb for a `ScalingLazyColumn`, in the item-index space Wear uses.
337///
338/// This is the second of the two models in this module and the one a Wear list
339/// wants. [`indicator_geometry`] answers "what share of the content is on
340/// screen, and how far have the pixels travelled"; Wear asks "what share of the
341/// *items* is on screen, and how many items are left". The two agree only when
342/// every row is the same height and the list is as tall as its content — which
343/// is why a port built on the pixel model can look right on one display size
344/// and put the thumb in the wrong place on another.
345///
346/// Returns `None` when there is nothing on screen to describe. It does not
347/// decide whether the list is scrollable at all: Wear leaves that to
348/// `ScreenScaffold`, and so does this.
349pub fn scaling_list_geometry(
350    thumb: &mut ThumbLength,
351    list: ScalingList<'_>,
352) -> Option<IndicatorGeometry> {
353    if list.visible.is_empty() || list.total == 0 || !list.viewport.is_finite() {
354        return None;
355    }
356    let size = thumb.of(list);
357    let position = position_fraction(list).clamp(0.0, 1.0);
358    Some(IndicatorGeometry {
359        thumb: size,
360        offset: position * (1.0 - size),
361    })
362}
363
364/// The rows of a laid-out scaling list that are on screen, as the adapter reads
365/// them, for a list scaled by Wear's own ramp.
366///
367/// `rows` are `(top, height)` pairs — the walk's cursor and the row's full
368/// height, the same geometry [`crate::round_scaling_list::place_row`] takes —
369/// already moved to where the list sits on screen, and in whatever unit
370/// `viewport` is given in. `density` converts that unit to device pixels;
371/// [`IndicatorItem`] is always in pixels, because that is the space Wear does
372/// this arithmetic in.
373///
374/// The window is the contiguous run of rows whose scaled rectangle still meets
375/// the viewport, which is what Wear's own walk out from the centre item
376/// produces: it stops the first time the running edge leaves the display.
377///
378/// `out` is cleared first, so one buffer can be reused frame to frame.
379pub fn scaling_list_items<I>(viewport: f32, density: f32, rows: I, out: &mut Vec<IndicatorItem>)
380where
381    I: IntoIterator<Item = (f32, f32)>,
382{
383    scaling_list_items_with(ScalingParams::WEAR, viewport, density, rows, out)
384}
385
386/// [`scaling_list_items`] for a list whose ramp is not the default one.
387///
388/// A row's reported size is its full height times the scale the ramp gave it,
389/// so a list built with different [`ScalingParams`] reports different sizes and
390/// its thumb sits somewhere else. Every list Cranpose ships uses
391/// [`ScalingParams::WEAR`] and cannot tell the two apart; a list under
392/// `LocalReduceMotion` uses [`ScalingParams::reduced_motion`], where every row
393/// reports its full height, and can.
394pub fn scaling_list_items_with<I>(
395    params: ScalingParams,
396    viewport: f32,
397    density: f32,
398    rows: I,
399    out: &mut Vec<IndicatorItem>,
400) where
401    I: IntoIterator<Item = (f32, f32)>,
402{
403    out.clear();
404    if !viewport.is_finite() || !density.is_finite() {
405        return;
406    }
407    // A caller working in continuous coordinates gets the same rule with the
408    // integer steps taken out, which is what `place_row` does with the same
409    // argument.
410    let pixels = density > 0.0;
411    let to_px = |value: f32| if pixels { value * density } else { value };
412    let round_px = |value: f32| if pixels { value.round() } else { value };
413    let viewport_px = round_px(to_px(viewport));
414    // `viewportCenterLinePx()`: half the viewport rounded DOWN, so an odd
415    // viewport gives its spare pixel to the half below the line.
416    let centre_line = if pixels {
417        (viewport_px * 0.5).floor()
418    } else {
419        viewport_px * 0.5
420    };
421    for (index, (top, height)) in rows.into_iter().enumerate() {
422        let Some(placed) =
423            crate::round_scaling_list::place_row_with(params, viewport, top, height, density)
424        else {
425            continue;
426        };
427        let height_px = round_px(to_px(height));
428        let size = round_px(height_px * placed.scale);
429        // `place_row` answers where the row is DRAWN, and Compose's drawn
430        // position carries half a pixel that the reported offset does not: the
431        // graphics layer's `translationY` is
432        // `startOffset - unadjustedStartOffset`, and each of those halves an
433        // integer height twice — once with integer division inside
434        // `convertToCenterOffset`, once in floating point inside `startOffset`
435        // — so the unadjusted row's half survives into the drawing and cancels
436        // out of the report. Undoing it here is what keeps the two coordinate
437        // systems from sitting half a pixel apart per row.
438        let drawn_top = to_px(placed.top);
439        let carried = if pixels { odd_pixel(height_px) } else { 0.0 };
440        let stacked_top = drawn_top - carried + if pixels { odd_pixel(size) } else { 0.0 };
441        if stacked_top > viewport_px || stacked_top + size < 0.0 {
442            if out.is_empty() {
443                continue;
444            }
445            break;
446        }
447        out.push(IndicatorItem {
448            index,
449            start_offset: drawn_top - carried - centre_line,
450            size,
451        });
452    }
453}
454
455/// Half a pixel when a pixel height is odd, nothing when it is even.
456fn odd_pixel(pixels: f32) -> f32 {
457    let half = pixels * 0.5;
458    half - half.floor()
459}
460
461fn finite(value: f32) -> f32 {
462    if value.is_finite() { value } else { 0.0 }
463}
464
465/// One piece of the indicator, ready to draw.
466///
467/// A segment shorter than its own stroke cannot be drawn as an arc without
468/// looking like a blob, so Wear swaps it for a circle that shrinks and fades
469/// out together. Callers draw whichever variant they are handed.
470#[derive(Clone, Copy, Debug, PartialEq)]
471pub enum IndicatorSegment {
472    /// A stroked arc with a round cap, already inset so the caps land on the
473    /// nominal bounds. `start` and `sweep` are radians, `0` at 3 o'clock.
474    Arc { start: f32, sweep: f32, alpha: f32 },
475    /// A filled circle standing in for an arc too short to draw.
476    Dot {
477        /// Angle of the dot's centre, radians.
478        angle: f32,
479        /// Radius, in the same unit as the arc's stroke width.
480        radius: f32,
481        alpha: f32,
482    },
483}
484
485/// Which part of the indicator a segment belongs to, so a caller can colour the
486/// thumb and the track differently without re-deriving the order.
487#[derive(Clone, Copy, Debug, PartialEq, Eq)]
488pub enum IndicatorPart {
489    Track,
490    Thumb,
491}
492
493/// The whole indicator as a list of drawable pieces: track, thumb, track.
494///
495/// It is three separate segments with a gap at each end of the thumb, not a
496/// thumb painted over a continuous rail — drawing a full-length track under a
497/// thumb gives a visibly different picture where the gaps should be.
498///
499/// `alpha` scales every piece, which is how the indicator fades out after the
500/// list has been still.
501pub fn indicator_segments(
502    arc: IndicatorArc,
503    geometry: IndicatorGeometry,
504    alpha: f32,
505) -> [(IndicatorPart, IndicatorSegment); 3] {
506    let alpha = if alpha.is_finite() {
507        alpha.clamp(0.0, 1.0)
508    } else {
509        0.0
510    };
511    let thumb = if geometry.thumb.is_finite() {
512        geometry.thumb.clamp(0.0, 1.0)
513    } else {
514        0.0
515    };
516    let offset = if geometry.offset.is_finite() {
517        geometry.offset.clamp(0.0, 1.0 - thumb)
518    } else {
519        0.0
520    };
521    let sweep = arc.sweep();
522    let top = arc.start_angle();
523    let thumb_start = top + sweep * offset;
524    let thumb_sweep = sweep * thumb;
525    let below_start = thumb_start + thumb_sweep;
526    [
527        (
528            IndicatorPart::Track,
529            segment(top, thumb_start - top, arc.width, arc.segment_inset, alpha),
530        ),
531        (
532            IndicatorPart::Thumb,
533            segment(
534                thumb_start,
535                thumb_sweep,
536                arc.width,
537                arc.segment_inset,
538                alpha,
539            ),
540        ),
541        (
542            IndicatorPart::Track,
543            segment(
544                below_start,
545                top + sweep - below_start,
546                arc.width,
547                arc.segment_inset,
548                alpha,
549            ),
550        ),
551    ]
552}
553
554/// One segment, with Wear's cap inset applied and its too-short case handled.
555fn segment(start: f32, sweep: f32, width: f32, inset: f32, alpha: f32) -> IndicatorSegment {
556    if sweep <= 0.0 || inset <= 0.0 {
557        return IndicatorSegment::Arc {
558            start,
559            sweep: 0.0,
560            alpha: 0.0,
561        };
562    }
563    if sweep < inset {
564        // Below one stroke width Wear stops drawing an arc and draws a circle
565        // that shrinks and fades on the same fraction, so a segment leaves the
566        // screen smoothly instead of collapsing into a dash.
567        let fill = sweep / inset;
568        return IndicatorSegment::Dot {
569            angle: start + sweep * 0.5,
570            radius: width * 0.5 * fill,
571            alpha: alpha * fill,
572        };
573    }
574    // `drawCurvedIndicatorSegment` starts half an inset in and runs a whole
575    // inset shorter; round caps restore the stroke share and leave the gap.
576    IndicatorSegment::Arc {
577        start: start + inset * 0.5,
578        sweep: sweep - inset,
579        alpha,
580    }
581}
582
583#[cfg(test)]
584mod tests {
585    use super::*;
586
587    /// The two displays Google Play requires a Wear app to support, in dp.
588    const LARGE_RADIUS_DP: f32 = 113.5; // 454px at density 2
589    const SMALL_RADIUS_DP: f32 = 96.0; // 384px at density 2
590
591    #[test]
592    fn stroke_width_switches_at_the_wear_large_screen_breakpoint() {
593        assert_eq!(indicator_width_dp(224.99), INDICATOR_NARROW_WIDTH_DP);
594        assert_eq!(indicator_width_dp(225.0), INDICATOR_WIDTH_DP);
595        assert_eq!(indicator_width_dp(f32::NAN), INDICATOR_NARROW_WIDTH_DP);
596    }
597
598    #[test]
599    fn the_track_lands_where_the_shipping_compose_build_draws_it() {
600        // Measured off the Compose build itself: the stroke's centreline sits
601        // at 108.5dp on a 454px display and 91.5dp on a 384px one, and the
602        // stroke is 6dp on the first and 5dp on the second.
603        let large = indicator_arc(LARGE_RADIUS_DP);
604        assert!((large.centreline() - 108.5).abs() < 0.01, "{large:?}");
605        assert!((large.width() - 6.0).abs() < 0.01, "{large:?}");
606
607        let small = indicator_arc(SMALL_RADIUS_DP);
608        assert!((small.centreline() - 91.5).abs() < 0.01, "{small:?}");
609        assert!((small.width() - 5.0).abs() < 0.01, "{small:?}");
610    }
611
612    #[test]
613    fn the_sweep_is_a_height_in_dp_not_a_fixed_angle() {
614        // The same 50dp track covers a wider angle on a smaller watch, which is
615        // the whole point of storing a height rather than an angle.
616        let large = indicator_arc(LARGE_RADIUS_DP).sweep().to_degrees();
617        let small = indicator_arc(SMALL_RADIUS_DP).sweep().to_degrees();
618        assert!((large - 30.54).abs() < 0.05, "{large}");
619        assert!((small - 35.73).abs() < 0.05, "{small}");
620        assert!(small > large);
621    }
622
623    #[test]
624    fn a_list_that_fits_on_screen_shows_no_indicator_at_all() {
625        assert_eq!(indicator_geometry(100.0, 100.0, 0.0), None);
626        assert_eq!(indicator_geometry(80.0, 100.0, 0.0), None);
627        assert_eq!(indicator_geometry(f32::NAN, 100.0, 0.0), None);
628        assert_eq!(indicator_geometry(200.0, 0.0, 0.0), None);
629    }
630
631    #[test]
632    fn the_thumb_is_the_viewport_share_clamped_at_both_ends() {
633        // Half the content visible is half the track...
634        let half = indicator_geometry(200.0, 100.0, 0.0).unwrap();
635        assert!((half.thumb - 0.5).abs() < 1e-6, "{half:?}");
636        // ...but a very long list never shrinks it past the floor, and a barely
637        // scrolling one never grows it past the ceiling.
638        let long = indicator_geometry(10_000.0, 100.0, 0.0).unwrap();
639        assert!((long.thumb - INDICATOR_MIN_THUMB).abs() < 1e-6, "{long:?}");
640        let short = indicator_geometry(105.0, 100.0, 0.0).unwrap();
641        assert!(
642            (short.thumb - INDICATOR_MAX_THUMB).abs() < 1e-6,
643            "{short:?}"
644        );
645    }
646
647    #[test]
648    fn the_thumb_reaches_the_bottom_of_the_track_and_no_further() {
649        let bottom = indicator_geometry(200.0, 100.0, 100.0).unwrap();
650        assert!(
651            (bottom.offset + bottom.thumb - 1.0).abs() < 1e-6,
652            "{bottom:?}"
653        );
654        // Overscrolling past the end must not push it off the track.
655        let past = indicator_geometry(200.0, 100.0, 500.0).unwrap();
656        assert_eq!(past, bottom);
657    }
658
659    #[test]
660    fn the_indicator_is_three_segments_with_a_gap_either_side_of_the_thumb() {
661        let arc = indicator_arc(LARGE_RADIUS_DP);
662        let geometry = IndicatorGeometry {
663            thumb: 0.4,
664            offset: 0.3,
665        };
666        let parts = indicator_segments(arc, geometry, 1.0);
667        assert_eq!(parts[0].0, IndicatorPart::Track);
668        assert_eq!(parts[1].0, IndicatorPart::Thumb);
669        assert_eq!(parts[2].0, IndicatorPart::Track);
670
671        // Every piece is an arc at this size, and the ink they cover — the
672        // nominal bounds, once the round caps undo the inset — must stay inside
673        // the track with the gaps left blank.
674        let ink_bounds = |segment: IndicatorSegment| match segment {
675            IndicatorSegment::Arc { start, sweep, .. } => {
676                (start - arc.cap_sweep() * 0.5, sweep + arc.cap_sweep())
677            }
678            other => panic!("expected an arc, got {other:?}"),
679        };
680        let (above_start, above_sweep) = ink_bounds(parts[0].1);
681        let (thumb_start, thumb_sweep) = ink_bounds(parts[1].1);
682        let (below_start, below_sweep) = ink_bounds(parts[2].1);
683        let gap = arc.segment_inset() - arc.cap_sweep();
684
685        assert!((above_start - arc.start_angle() - gap * 0.5).abs() < 1e-4);
686        assert!((thumb_start - (above_start + above_sweep) - gap).abs() < 1e-4);
687        assert!((below_start - (thumb_start + thumb_sweep) - gap).abs() < 1e-4);
688        assert!(
689            (below_start + below_sweep + gap * 0.5 - (arc.start_angle() + arc.sweep())).abs()
690                < 1e-4,
691            "the track has to end where it should"
692        );
693    }
694
695    #[test]
696    fn a_segment_shorter_than_its_stroke_becomes_a_shrinking_dot() {
697        let arc = indicator_arc(LARGE_RADIUS_DP);
698        // Thumb hard against the top: the track above it has almost no room.
699        let parts = indicator_segments(
700            arc,
701            IndicatorGeometry {
702                thumb: 0.7,
703                offset: 0.0,
704            },
705            1.0,
706        );
707        match parts[0].1 {
708            IndicatorSegment::Dot { radius, alpha, .. } => {
709                assert!(
710                    radius <= arc.width() * 0.5,
711                    "a dot never exceeds the stroke"
712                );
713                assert!(alpha < 1.0, "it fades on the same fraction as it shrinks");
714            }
715            IndicatorSegment::Arc { sweep, .. } => {
716                assert!(sweep <= 0.0, "an arc this short should have been a dot");
717            }
718        }
719    }
720
721    #[test]
722    fn fading_the_indicator_fades_every_piece_of_it() {
723        let arc = indicator_arc(LARGE_RADIUS_DP);
724        let geometry = IndicatorGeometry {
725            thumb: 0.4,
726            offset: 0.3,
727        };
728        for (_, segment) in indicator_segments(arc, geometry, 0.25) {
729            let alpha = match segment {
730                IndicatorSegment::Arc { alpha, .. } => alpha,
731                IndicatorSegment::Dot { alpha, .. } => alpha,
732            };
733            assert!(alpha <= 0.25 + 1e-6, "{segment:?}");
734        }
735    }
736
737    #[test]
738    fn a_display_too_small_to_hold_the_track_degrades_instead_of_panicking() {
739        let tiny = indicator_arc(1.0);
740        assert_eq!(tiny.centreline(), 0.0);
741        assert_eq!(tiny.sweep(), 0.0);
742        assert_eq!(tiny.cap_sweep(), 0.0);
743        // And asking for its segments must not divide by that zero.
744        let parts = indicator_segments(
745            tiny,
746            IndicatorGeometry {
747                thumb: 0.4,
748                offset: 0.3,
749            },
750            1.0,
751        );
752        for (_, segment) in parts {
753            assert!(matches!(segment, IndicatorSegment::Arc { sweep: 0.0, .. }));
754        }
755    }
756
757    /// A synthetic list to hang the adapter's arithmetic on: a 400px viewport,
758    /// so the centre line is 200 and `startOffset` is a row's top edge measured
759    /// from there, and ten rows of 100px.
760    const VIEWPORT: f32 = 400.0;
761
762    fn list<'a>(visible: &'a [IndicatorItem]) -> ScalingList<'a> {
763        ScalingList {
764            visible,
765            total: 10,
766            viewport: VIEWPORT,
767            before_padding: 0.0,
768            after_padding: 0.0,
769        }
770    }
771
772    fn row(index: usize, start_offset: f32) -> IndicatorItem {
773        IndicatorItem {
774            index,
775            start_offset,
776            size: 100.0,
777        }
778    }
779
780    #[test]
781    fn a_row_flush_with_the_top_of_the_screen_is_a_whole_index() {
782        // Its top edge is 200px above the centre line, which is the top of the
783        // display, so none of it has scrolled away.
784        let rows = [row(3, -200.0), row(6, 100.0)];
785        assert_eq!(decimal_first_item_index(list(&rows)), 3.0);
786    }
787
788    #[test]
789    fn a_row_half_off_the_top_reads_half_an_index() {
790        // 250 above the centre line is 50 above the display, half of a 100px
791        // row -- and the answer is in ITEM units, which is the whole point of
792        // this model: 3.5 means "three and a half items have gone past".
793        let rows = [row(3, -250.0), row(6, 100.0)];
794        assert_eq!(decimal_first_item_index(list(&rows)), 3.5);
795    }
796
797    #[test]
798    fn the_last_index_counts_how_much_of_the_row_is_on_screen() {
799        // Bottom half of the display is 0..200 below the centre line; a row
800        // starting at 150 has 50 of its 100 showing.
801        let rows = [row(3, -200.0), row(6, 150.0)];
802        assert_eq!(decimal_last_item_index(list(&rows)), 6.5);
803    }
804
805    #[test]
806    fn the_padding_outside_the_list_counts_only_at_the_end_it_belongs_to() {
807        let rows = [row(0, -250.0), row(9, 150.0)];
808        let padded = ScalingList {
809            before_padding: 80.0,
810            after_padding: 60.0,
811            ..list(&rows)
812        };
813        // The first row's own span grows by the blank above it, and so does the
814        // distance it has travelled: (200 - 250 + 80) / (100 + 80).
815        assert!((decimal_first_item_index(padded) - 130.0 / 180.0).abs() < 1e-6);
816        // The last row's span grows by the blank below it: 1 - (310 - 200)/160.
817        assert!((decimal_last_item_index(padded) - (9.0 + 0.3125)).abs() < 1e-6);
818
819        // The same geometry in the middle of the list ignores both.
820        let inner = [row(3, -250.0), row(6, 150.0)];
821        let inner = ScalingList {
822            before_padding: 80.0,
823            after_padding: 60.0,
824            ..list(&inner)
825        };
826        assert_eq!(decimal_first_item_index(inner), 3.5);
827        assert_eq!(decimal_last_item_index(inner), 6.5);
828    }
829
830    #[test]
831    fn the_thumb_is_the_share_of_the_items_on_screen_not_of_the_pixels() {
832        // Five of ten items on screen is half the track, whatever those items
833        // are worth in pixels.
834        let rows = [row(3, -250.0), row(8, 150.0)];
835        let mut thumb = ThumbLength::default();
836        assert!((thumb.of(list(&rows)) - 0.5).abs() < 1e-6);
837    }
838
839    #[test]
840    fn the_thumb_is_clamped_at_both_ends_however_long_the_list_is() {
841        let rows = [row(3, -250.0), row(4, 150.0)];
842        let mut short = ThumbLength::default();
843        assert_eq!(short.of(list(&rows)), INDICATOR_MIN_THUMB);
844
845        let rows = [row(0, -250.0), row(9, 150.0)];
846        let mut long = ThumbLength::default();
847        assert_eq!(long.of(list(&rows)), INDICATOR_MAX_THUMB);
848    }
849
850    #[test]
851    fn the_thumb_is_measured_once_and_then_only_when_the_list_changes_length() {
852        // `previousItemsCount` in the adapter. Not an optimisation: a thumb
853        // remeasured every frame breathes as rows of different heights scroll
854        // past, and the shipping build's does not move at all.
855        let mut thumb = ThumbLength::default();
856        let five = [row(3, -250.0), row(8, 150.0)];
857        assert!((thumb.of(list(&five)) - 0.5).abs() < 1e-6);
858
859        let three = [row(3, -250.0), row(6, 150.0)];
860        assert!(
861            (thumb.of(list(&three)) - 0.5).abs() < 1e-6,
862            "the window shrank but the list did not, so the thumb holds"
863        );
864
865        let longer = ScalingList {
866            total: 20,
867            ..list(&three)
868        };
869        assert_eq!(thumb.of(longer), INDICATOR_MIN_THUMB);
870
871        thumb.forget();
872        assert!((thumb.of(list(&five)) - 0.5).abs() < 1e-6);
873    }
874
875    #[test]
876    fn the_position_is_how_many_items_are_left_not_how_far_the_pixels_went() {
877        // Three and a half items above the window, three and a half below it.
878        let rows = [row(3, -250.0), row(6, 150.0)];
879        assert!((position_fraction(list(&rows)) - 0.5).abs() < 1e-6);
880    }
881
882    #[test]
883    fn a_list_at_the_top_puts_the_thumb_at_the_top_and_one_at_the_end_at_the_end() {
884        let mut thumb = ThumbLength::default();
885        let top = [row(0, -200.0), row(3, 150.0)];
886        let geometry = scaling_list_geometry(&mut thumb, list(&top)).unwrap();
887        assert_eq!(geometry.offset, 0.0);
888
889        // The last row measured fully in leaves nothing after it, so the thumb
890        // is flush with the end of the track.
891        let mut thumb = ThumbLength::default();
892        let end = [row(6, -250.0), row(9, 100.0)];
893        let geometry = scaling_list_geometry(&mut thumb, list(&end)).unwrap();
894        assert_eq!(decimal_last_item_index(list(&end)), 10.0);
895        assert!((geometry.offset + geometry.thumb - 1.0).abs() < 1e-6);
896    }
897
898    #[test]
899    fn a_list_with_nothing_on_screen_has_no_indicator() {
900        let mut thumb = ThumbLength::default();
901        assert_eq!(scaling_list_geometry(&mut thumb, list(&[])), None);
902        let rows = [row(3, -250.0)];
903        let empty = ScalingList {
904            total: 0,
905            ..list(&rows)
906        };
907        assert_eq!(scaling_list_geometry(&mut thumb, empty), None);
908    }
909
910    #[test]
911    fn the_two_models_disagree_the_moment_the_rows_are_not_all_the_same_height() {
912        // This is the whole reason the second entry point exists. One tall row
913        // and nine short ones: the pixel model says the thumb is the share of
914        // the CONTENT on screen, the adapter says it is the share of the ITEMS,
915        // and the tall row counts for one item and for six rows' worth of
916        // pixels. A caller that reaches for the flat model on a Wear list gets
917        // an answer that happens to look right on a list of uniform rows.
918        let heights: Vec<f32> = std::iter::once(600.0).chain([100.0; 9]).collect();
919        let content: f32 = heights.iter().sum();
920        let pixel = indicator_geometry(content, VIEWPORT, 0.0).unwrap();
921
922        let rows = [row(0, -200.0), row(3, 100.0)];
923        let mut thumb = ThumbLength::default();
924        let wear = scaling_list_geometry(&mut thumb, list(&rows)).unwrap();
925
926        assert!((pixel.thumb - INDICATOR_MIN_THUMB).abs() < 1e-6);
927        assert!((wear.thumb - 0.4).abs() < 1e-6, "{wear:?}");
928    }
929
930    #[test]
931    fn a_reported_row_is_not_the_row_as_it_is_drawn() {
932        // `place_row` answers where a row is DRAWN and the adapter reads what
933        // the layout REPORTS, and Compose's two halvings of an odd pixel height
934        // put half a pixel between them. 103px is odd; 104px is not.
935        let mut out = Vec::new();
936        let density = 2.0;
937        let viewport = 227.0;
938        for (height, carried) in [(51.5, 0.5), (52.0, 0.0)] {
939            scaling_list_items(viewport, density, [(20.0, height)], &mut out);
940            let drawn = crate::round_scaling_list::place_row(viewport, 20.0, height, density)
941                .expect("placed");
942            let item = out.first().expect("on screen");
943            assert!(
944                (item.start_offset - (drawn.top * density - carried - 227.0)).abs() < 1e-4,
945                "{height}dp: reported {} against drawn {}",
946                item.start_offset,
947                drawn.top * density
948            );
949            // And the size it reports is the drawn height rounded to a pixel,
950            // which is not the height the graphics layer scales to.
951            assert_eq!(item.size, (drawn.height * density).round());
952        }
953    }
954
955    #[test]
956    fn a_list_that_does_not_scale_its_rows_reports_them_at_full_height() {
957        // `scaling_list_items` baked in `ScalingParams::WEAR`, so a list under
958        // `LocalReduceMotion` — where the ramp is off and every row keeps its
959        // size — was described to the indicator as though its edge rows had
960        // shrunk. Identical for every list Cranpose ships and wrong for that
961        // one, which is the shape of defect a `_with` variant exists to stop.
962        let mut wear = Vec::new();
963        let mut still = Vec::new();
964        let rows = [(4.0, 52.0), (60.0, 52.0), (116.0, 52.0)];
965        scaling_list_items(227.0, 2.0, rows, &mut wear);
966        scaling_list_items_with(
967            ScalingParams::WEAR.reduced_motion(),
968            227.0,
969            2.0,
970            rows,
971            &mut still,
972        );
973        assert_eq!(wear.len(), still.len());
974        assert!(
975            wear[0].size < still[0].size,
976            "the top row shrinks under the Wear ramp and not under a stilled \
977             one: {} vs {}",
978            wear[0].size,
979            still[0].size
980        );
981        assert_eq!(still[0].size, 104.0, "52dp at density 2, unscaled");
982        // And the default entry point is still the Wear ramp.
983        let mut default = Vec::new();
984        scaling_list_items_with(ScalingParams::WEAR, 227.0, 2.0, rows, &mut default);
985        assert_eq!(default, wear);
986    }
987
988    #[test]
989    fn the_window_is_the_rows_that_still_meet_the_display() {
990        // Ten 40dp rows down a 227dp screen, the list scrolled so row 0 starts
991        // 100dp above the top. Wear walks out from the centre item and stops at
992        // the first row whose edge has left the viewport, which is the same
993        // contiguous run.
994        let mut out = Vec::new();
995        let rows: Vec<(f32, f32)> = (0..10)
996            .map(|index| (index as f32 * 40.0 - 100.0, 40.0))
997            .collect();
998        scaling_list_items(227.0, 2.0, rows.iter().copied(), &mut out);
999        let indices: Vec<usize> = out.iter().map(|item| item.index).collect();
1000        assert_eq!(indices, vec![2, 3, 4, 5, 6, 7, 8]);
1001    }
1002
1003    #[test]
1004    fn invalid_scaling_list_input_never_produces_a_non_finite_thumb() {
1005        let mut out = Vec::new();
1006        scaling_list_items(f32::NAN, 2.0, [(0.0, 40.0)], &mut out);
1007        assert!(out.is_empty());
1008        scaling_list_items(227.0, f32::NAN, [(0.0, 40.0)], &mut out);
1009        assert!(out.is_empty());
1010
1011        let rows = [
1012            IndicatorItem {
1013                index: 0,
1014                start_offset: f32::NAN,
1015                size: 0.0,
1016            },
1017            IndicatorItem {
1018                index: 3,
1019                start_offset: f32::INFINITY,
1020                size: -1.0,
1021            },
1022        ];
1023        let mut thumb = ThumbLength::default();
1024        let geometry = scaling_list_geometry(&mut thumb, list(&rows)).expect("a geometry");
1025        assert!(
1026            geometry.thumb.is_finite() && geometry.offset.is_finite(),
1027            "{geometry:?}"
1028        );
1029        assert!(geometry.thumb >= INDICATOR_MIN_THUMB && geometry.thumb <= INDICATOR_MAX_THUMB);
1030        assert!(geometry.offset >= 0.0 && geometry.offset <= 1.0);
1031    }
1032
1033    #[test]
1034    fn invalid_public_inputs_never_emit_non_finite_draw_values() {
1035        for radius in [f32::NAN, f32::INFINITY, f32::NEG_INFINITY, -1.0] {
1036            let arc = indicator_arc(radius);
1037            assert_eq!(arc.sweep(), 0.0);
1038            assert_eq!(arc.segment_inset(), 0.0);
1039        }
1040
1041        let parts = indicator_segments(
1042            indicator_arc(LARGE_RADIUS_DP),
1043            IndicatorGeometry {
1044                thumb: f32::NAN,
1045                offset: f32::INFINITY,
1046            },
1047            f32::NAN,
1048        );
1049        for (_, part) in parts {
1050            match part {
1051                IndicatorSegment::Arc {
1052                    start,
1053                    sweep,
1054                    alpha,
1055                } => assert!(start.is_finite() && sweep.is_finite() && alpha == 0.0),
1056                IndicatorSegment::Dot {
1057                    angle,
1058                    radius,
1059                    alpha,
1060                } => assert!(angle.is_finite() && radius.is_finite() && alpha == 0.0),
1061            }
1062        }
1063    }
1064}