/// Credit setchi (https://github.com/setchi) /// Sourced from - https://github.com/setchi/FancyScrollView using System; using UnityEngine.Events; using UnityEngine.EventSystems; namespace UnityEngine.UI.Extensions { public class ScrollPositionController : UIBehaviour, IBeginDragHandler, IEndDragHandler, IDragHandler { [SerializeField] RectTransform viewport; [SerializeField] ScrollDirection directionOfRecognize = ScrollDirection.Vertical; [SerializeField] MovementType movementType = MovementType.Elastic; [SerializeField] float elasticity = 0.1f; [SerializeField] float scrollSensitivity = 1f; [SerializeField] bool inertia = true; [SerializeField, Tooltip("Only used when inertia is enabled")] float decelerationRate = 0.03f; [SerializeField, Tooltip("Only used when inertia is enabled")] Snap snap = new Snap { Enable = true, VelocityThreshold = 0.5f, Duration = 0.3f }; [SerializeField] int dataCount; readonly AutoScrollState autoScrollState = new AutoScrollState(); Action onUpdatePosition; Action onItemSelected; Vector2 pointerStartLocalPosition; float dragStartScrollPosition; float prevScrollPosition; float currentScrollPosition; bool dragging; float velocity; enum ScrollDirection { Vertical, Horizontal, } enum MovementType { Unrestricted = ScrollRect.MovementType.Unrestricted, Elastic = ScrollRect.MovementType.Elastic, Clamped = ScrollRect.MovementType.Clamped } [Serializable] struct Snap { public bool Enable; public float VelocityThreshold; public float Duration; } class AutoScrollState { public bool Enable; public bool Elastic; public float Duration; public float StartTime; public float EndScrollPosition; public void Reset() { Enable = false; Elastic = false; Duration = 0f; StartTime = 0f; EndScrollPosition = 0f; } } public void OnUpdatePosition(Action onUpdatePosition) { this.onUpdatePosition = onUpdatePosition; } public void OnItemSelected(Action onItemSelected) { this.onItemSelected = onItemSelected; } public void SetDataCount(int dataCount) { this.dataCount = dataCount; } public void ScrollTo(int index, float duration) { autoScrollState.Reset(); autoScrollState.Enable = true; autoScrollState.Duration = duration; autoScrollState.StartTime = Time.unscaledTime; autoScrollState.EndScrollPosition = CalculateDestinationIndex(index); velocity = 0f; dragStartScrollPosition = currentScrollPosition; ItemSelected(Mathf.RoundToInt(GetCircularPosition(autoScrollState.EndScrollPosition, dataCount))); } public void JumpTo(int index) { autoScrollState.Reset(); velocity = 0f; dragging = false; index = CalculateDestinationIndex(index); ItemSelected(index); UpdatePosition(index); } void IBeginDragHandler.OnBeginDrag(PointerEventData eventData) { if (eventData.button != PointerEventData.InputButton.Left) { return; } pointerStartLocalPosition = Vector2.zero; RectTransformUtility.ScreenPointToLocalPointInRectangle( viewport, eventData.position, eventData.pressEventCamera, out pointerStartLocalPosition); dragStartScrollPosition = currentScrollPosition; dragging = true; autoScrollState.Reset(); } void IDragHandler.OnDrag(PointerEventData eventData) { if (eventData.button != PointerEventData.InputButton.Left) { return; } if (!dragging) { return; } Vector2 localCursor; if (!RectTransformUtility.ScreenPointToLocalPointInRectangle( viewport, eventData.position, eventData.pressEventCamera, out localCursor)) { return; } var pointerDelta = localCursor - pointerStartLocalPosition; var position = (directionOfRecognize == ScrollDirection.Horizontal ? -pointerDelta.x : pointerDelta.y) / GetViewportSize() * scrollSensitivity + dragStartScrollPosition; var offset = CalculateOffset(position); position += offset; if (movementType == MovementType.Elastic) { if (offset != 0f) { position -= RubberDelta(offset, scrollSensitivity); } } UpdatePosition(position); } void IEndDragHandler.OnEndDrag(PointerEventData eventData) { if (eventData.button != PointerEventData.InputButton.Left) { return; } dragging = false; } float GetViewportSize() { return directionOfRecognize == ScrollDirection.Horizontal ? viewport.rect.size.x : viewport.rect.size.y; } float CalculateOffset(float position) { if (movementType == MovementType.Unrestricted) { return 0f; } if (position < 0f) { return -position; } if (position > dataCount - 1) { return dataCount - 1 - position; } return 0f; } void UpdatePosition(float position) { currentScrollPosition = position; if (onUpdatePosition != null) { onUpdatePosition(currentScrollPosition); } } void ItemSelected(int index) { if (onItemSelected != null) { onItemSelected(index); } } float RubberDelta(float overStretching, float viewSize) { return (1 - (1 / ((Mathf.Abs(overStretching) * 0.55f / viewSize) + 1))) * viewSize * Mathf.Sign(overStretching); } void Update() { var deltaTime = Time.unscaledDeltaTime; var offset = CalculateOffset(currentScrollPosition); if (autoScrollState.Enable) { var position = 0f; if (autoScrollState.Elastic) { var speed = velocity; position = Mathf.SmoothDamp(currentScrollPosition, currentScrollPosition + offset, ref speed, elasticity, Mathf.Infinity, deltaTime); velocity = speed; if (Mathf.Abs(velocity) < 0.01f) { position = Mathf.Clamp(Mathf.RoundToInt(position), 0, dataCount - 1); velocity = 0f; autoScrollState.Reset(); } } else { var alpha = Mathf.Clamp01((Time.unscaledTime - autoScrollState.StartTime) / Mathf.Max(autoScrollState.Duration, float.Epsilon)); position = Mathf.Lerp(dragStartScrollPosition, autoScrollState.EndScrollPosition, EaseInOutCubic(0, 1, alpha)); if (Mathf.Approximately(alpha, 1f)) { autoScrollState.Reset(); } } UpdatePosition(position); } else if (!dragging && (!Mathf.Approximately(offset, 0f) || !Mathf.Approximately(velocity, 0f))) { var position = currentScrollPosition; if (movementType == MovementType.Elastic && !Mathf.Approximately(offset, 0f)) { autoScrollState.Reset(); autoScrollState.Enable = true; autoScrollState.Elastic = true; ItemSelected(Mathf.Clamp(Mathf.RoundToInt(position), 0, dataCount - 1)); } else if (inertia) { velocity *= Mathf.Pow(decelerationRate, deltaTime); if (Mathf.Abs(velocity) < 0.001f) { velocity = 0f; } position += velocity * deltaTime; if (snap.Enable && Mathf.Abs(velocity) < snap.VelocityThreshold) { ScrollTo(Mathf.RoundToInt(currentScrollPosition), snap.Duration); } } else { velocity = 0f; } if (!Mathf.Approximately(velocity, 0f)) { if (movementType == MovementType.Clamped) { offset = CalculateOffset(position); position += offset; if (Mathf.Approximately(position, 0f) || Mathf.Approximately(position, dataCount - 1f)) { velocity = 0f; ItemSelected(Mathf.RoundToInt(position)); } } UpdatePosition(position); } } if (!autoScrollState.Enable && dragging && inertia) { var newVelocity = (currentScrollPosition - prevScrollPosition) / deltaTime; velocity = Mathf.Lerp(velocity, newVelocity, deltaTime * 10f); } if (currentScrollPosition != prevScrollPosition) { prevScrollPosition = currentScrollPosition; } } int CalculateDestinationIndex(int index) { return movementType == MovementType.Unrestricted ? CalculateClosestIndex(index) : Mathf.Clamp(index, 0, dataCount - 1); } int CalculateClosestIndex(int index) { var diff = GetCircularPosition(index, dataCount) - GetCircularPosition(currentScrollPosition, dataCount); if (Mathf.Abs(diff) > dataCount * 0.5f) { diff = Mathf.Sign(-diff) * (dataCount - Mathf.Abs(diff)); } return Mathf.RoundToInt(diff + currentScrollPosition); } float GetCircularPosition(float position, int length) { return position < 0 ? length - 1 + (position + 1) % length : position % length; } float EaseInOutCubic(float start, float end, float value) { value /= 0.5f; end -= start; if (value < 1f) { return end * 0.5f * value * value * value + start; } value -= 2f; return end * 0.5f * (value * value * value + 2f) + start; } } }