Reworked Table and related components.

Author: Hermanest

src/reactive-bs-sdk/Reactive.BeatSaber/Components/Table/Scrollbar.cs

@@ -154,7 +154,7 @@ protected override GameObject Construct() {
                 sEnabled = RememberDerived(
                     x => !x.Item2.Value || (x.Item1.Value?.CanScroll ?? true),
                     (
-                        _scrollContextState.Where(x => x!.UpdateType is ScrollCompleted or Measurements),
+                        _scrollContextState.Where(x => x!.UpdateType is ScrollFinished or Measurements),
                         _hideIfNothingToScroll
                     )
                 ),

src/reactive-bs-sdk/Reactive.BeatSaber/Components/Table/Table.cs

@@ -22,7 +22,8 @@ public ScrollContext ScrollContext {
                 _scrollContext?.ValueChangedEvent -= HandleContextUpdated;
                 _scrollContext = value;
 
-                if (_contentTransform != null) {
+                var didInitialUpdate = DoInitialUpdate();
+                if (!didInitialUpdate && _scrollContent != null) {
                     RefreshMeasurements();
                 }
 
@@ -41,7 +42,7 @@ public IReactiveComponent ScrollContent {
                 _scrollContent.Use(_viewport);
                 _contentTransform = _scrollContent.ContentTransform;
 
-                ReloadContent();
+                DoInitialUpdate();
             }
         }
 
@@ -53,12 +54,22 @@ public ScrollOrientation ScrollOrientation {
             }
         } = ScrollOrientation.Vertical;
 
-        public float JoystickScrollSize { get; set; } = 10f;
-        public Action? OnScrollWithJoystickFinished { get; set; }
+        public float LineSize { get; set; }
+        public Func<ScrollContext, float>? FinalizeScroll { get; set; }
 
         private IReactiveComponent? _scrollContent;
         private RectTransform? _contentTransform;
         private ScrollContext? _scrollContext;
+        private bool _needsInitialUpdate = true;
+
+        private bool DoInitialUpdate() {
+            if (_needsInitialUpdate && _scrollContext != null && _scrollContent != null) {
+                ReloadContent();
+                _needsInitialUpdate = false;
+            }
+
+            return !_needsInitialUpdate;
+        }
 
         #endregion
 
@@ -70,12 +81,12 @@ public ScrollOrientation ScrollOrientation {
         protected override void OnUpdate() {
             // ReSharper disable CompareOfFloatsByEqualityOperator
             if (_lastScrollDeltaTime != -1f && _lastScrollDeltaTime != Time.deltaTime) {
-                OnScrollWithJoystickFinished?.Invoke();
+                FinalizeScrollPos();
                 _lastScrollDeltaTime = -1f;
             }
 
-            if (_contentTransform != null) {
-                var contentSize = Translate(_contentTransform.rect);
+            if (_scrollContent != null) {
+                var contentSize = Translate(_contentTransform!.rect);
 
                 if (_prevContentSize != contentSize) {
                     RefreshMeasurements();
@@ -86,6 +97,12 @@ protected override void OnUpdate() {
             UpdateContentPos(false);
         }
 
+        private void FinalizeScrollPos() {
+            if (FinalizeScroll != null) {
+                _destinationPos = FinalizeScroll.Invoke(ScrollContext);
+            }
+        }
+
         #endregion
 
         #region Content
@@ -120,7 +137,10 @@ private void SetDestinationPos(float pos, bool immediately) {
             _posSet = false;
 
             if (immediately) {
+                FinalizeScrollPos();
                 UpdateContentPos(true);
+                
+                _lastScrollDeltaTime = -1f;
             }
         }
 
@@ -159,7 +179,7 @@ private void RefreshMeasurements() {
             var contentSize = Translate(_contentTransform!.rect);
             var viewSize = Translate(_viewport.rect);
 
-            ScrollContext.ControllerSetMeasurements(contentSize, viewSize, 0f);
+            ScrollContext.ControllerSetMeasurements(contentSize, viewSize, LineSize);
         }
 
         private void RefreshContentSizeIfNeeded() {
@@ -222,10 +242,8 @@ protected override void OnRectDimensionsChanged() {
         #region Callbacks
 
         private void HandlePointerScroll(PointerEventsHandler handler, PointerEventData eventData) {
-            var mul = JoystickScrollSize * -0.1f;
-
             var neg = ScrollOrientation is ScrollOrientation.Vertical ? -1 : 1;
-            var destinationPos = _destinationPos + eventData.scrollDelta.y * mul * neg;
+            var destinationPos = _destinationPos + eventData.scrollDelta.y * LineSize * neg;
 
             _lastScrollDeltaTime = Time.deltaTime;
 

src/reactive-sdk/Reactive.Components/Components/ListView/ListCell.cs

@@ -7,15 +7,15 @@ namespace Reactive.Components;
 public enum ScrollUpdateType {
     None,
     /// User intent to scroll (e.g. ScrollPos, ScrollItem).
-    Intent,       
+    Intent,
     /// Controller measurements (e.g. ContentSize, ViewSize).
-    Measurements,  
+    Measurements,
     /// Controller scroll (ActualScrollPos).
     Scroll,
     /// <summary>
     /// Controller scroll has just finished.
     /// </summary>
-    ScrollCompleted
+    ScrollFinished
 }
 
 [PublicAPI]
@@ -25,13 +25,6 @@ public class ScrollContext : IState<ScrollContext> {
     /// </summary>
     public float ScrollPos { get; private set; }
 
-    /// <summary>
-    /// Determines the item that the controller should scroll to.
-    /// Has higher priority than <see cref="ScrollPos"/>, so if both are specified the first one is ignored.
-    /// Defaults to <see cref="ScrollPos"/> if the specified object isn't presented in the view.
-    /// </summary>
-    public object? ScrollItem { get; private set; }
-
     /// Whether the scroll animation should finish immediately. Set by the user.
     public bool Immediately { get; private set; }
 
@@ -46,7 +39,7 @@ public class ScrollContext : IState<ScrollContext> {
     /// Set by a component controlling the view.
     /// </summary>
     public float LineSize { get; private set; }
-    
+
     /// <summary>
     /// The size of the scroll content. Set by a component controlling the view.
     /// </summary>
@@ -56,7 +49,7 @@ public class ScrollContext : IState<ScrollContext> {
     /// The size of the viewport. Set by a component controlling the view.
     /// </summary>
     public float ViewSize { get; private set; }
-    
+
     /// <summary>
     /// Determines a kind of the last update. Returns None if called outside the ValueChanged cycle.
     /// </summary>
@@ -68,7 +61,7 @@ public class ScrollContext : IState<ScrollContext> {
     public float NormalizedScrollPos {
         get => Mathf.Clamp01(ActualScrollPos / MaxScrollPos);
     }
-    
+
     public float NormalizedPageHeight {
         get => Mathf.Clamp01(ViewSize / ContentSize);
     }
@@ -90,7 +83,7 @@ public bool CanScroll {
         // in the future, so moved into a separate property
         get => ContentSize > ViewSize;
     }
-    
+
     /// <summary>
     /// Scrolls to the specified point.
     /// </summary>
@@ -99,30 +92,17 @@ public bool CanScroll {
     /// <returns>An updated context.</returns>
     public void ScrollTo(float pos, bool immediately = false) {
         var newPos = Mathf.Clamp(pos, 0f, MaxScrollPos);
-        
+
         if (Mathf.Approximately(newPos, ScrollPos)) {
             return;
         }
 
         ScrollPos = newPos;
-        ScrollItem = null;
         Immediately = immediately;
-        
-        NotifyValueChanged(ScrollUpdateType.Intent);
-    }
 
-    /// <summary>
-    /// Scrolls to the specified item. Defaults 
-    /// </summary>
-    /// <param name="pos">The position to scroll to.</param>
-    /// <param name="immediately">Whether to apply the scroll immediately.</param>
-    /// <returns>An updated context.</returns>
-    public void ScrollTo(object item, bool immediately = false) {
-        ScrollItem = item;
-        Immediately = immediately;
         NotifyValueChanged(ScrollUpdateType.Intent);
     }
-    
+
     public void ScrollRelative(float offset, bool immediately = false) {
         ScrollTo(ScrollPos + offset, immediately);
     }
@@ -148,7 +128,7 @@ public void LineDown(bool immediately = false) {
     }
 
     public void LineUp(bool immediately = false) {
-        ScrollRelative(LineSize, immediately);
+        ScrollRelative(LineSize * -1, immediately);
     }
 
     /// <summary>
@@ -171,13 +151,13 @@ public void ControllerSetScrollPos(float pos) {
         if (Mathf.Approximately(ActualScrollPos, pos)) {
             return;
         }
-        
+
         ActualScrollPos = pos;
         NotifyValueChanged(ScrollUpdateType.Scroll);
     }
 
     public void ControllerNotifyScrollCompleted() {
-        NotifyValueChanged(ScrollUpdateType.ScrollCompleted);
+        NotifyValueChanged(ScrollUpdateType.ScrollFinished);
     }
 
     #region State Impl
@@ -189,10 +169,10 @@ public void ControllerNotifyScrollCompleted() {
 
     private void NotifyValueChanged(ScrollUpdateType type) {
         UpdateType = type;
-        
+
         ValueChangedEvent?.Invoke(this);
         StateUpdatedEvent?.Invoke();
-        
+
         UpdateType = ScrollUpdateType.None;
     }