Class ScyllaScrollRect

A scroll rect that keeps the elastic bounce for dragging, clamps wheel and trackpad scrolling to the ends of the content, and scrolls horizontally in the direction the gesture asks for.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

UIBehaviour

ScrollRect

ScyllaScrollRect

Implements

IInitializePotentialDragHandler

IBeginDragHandler

IEndDragHandler

IDragHandler

IScrollHandler

IEventSystemHandler

ICanvasElement

ILayoutElement

ILayoutGroup

ILayoutController

Inherited Members

ScrollRect.m_ContentStartPosition

ScrollRect.m_ContentBounds

ScrollRect.Rebuild(CanvasUpdate)

ScrollRect.LayoutComplete()

ScrollRect.GraphicUpdateComplete()

ScrollRect.OnEnable()

ScrollRect.OnDisable()

ScrollRect.IsActive()

ScrollRect.StopMovement()

ScrollRect.OnInitializePotentialDrag(PointerEventData)

ScrollRect.OnBeginDrag(PointerEventData)

ScrollRect.OnEndDrag(PointerEventData)

ScrollRect.OnDrag(PointerEventData)

ScrollRect.SetContentAnchoredPosition(Vector2)

ScrollRect.LateUpdate()

ScrollRect.UpdatePrevData()

ScrollRect.SetNormalizedPosition(float, int)

ScrollRect.OnRectTransformDimensionsChange()

ScrollRect.CalculateLayoutInputHorizontal()

ScrollRect.CalculateLayoutInputVertical()

ScrollRect.SetLayoutHorizontal()

ScrollRect.SetLayoutVertical()

ScrollRect.UpdateBounds()

ScrollRect.SetDirty()

ScrollRect.SetDirtyCaching()

ScrollRect.OnValidate()

ScrollRect.content

ScrollRect.horizontal

ScrollRect.vertical

ScrollRect.movementType

ScrollRect.elasticity

ScrollRect.inertia

ScrollRect.decelerationRate

ScrollRect.scrollSensitivity

ScrollRect.viewport

ScrollRect.horizontalScrollbar

ScrollRect.verticalScrollbar

ScrollRect.horizontalScrollbarVisibility

ScrollRect.verticalScrollbarVisibility

ScrollRect.horizontalScrollbarSpacing

ScrollRect.verticalScrollbarSpacing

ScrollRect.onValueChanged

ScrollRect.viewRect

ScrollRect.velocity

ScrollRect.normalizedPosition

ScrollRect.horizontalNormalizedPosition

ScrollRect.verticalNormalizedPosition

ScrollRect.minWidth

ScrollRect.preferredWidth

ScrollRect.flexibleWidth

ScrollRect.minHeight

ScrollRect.preferredHeight

ScrollRect.flexibleHeight

ScrollRect.layoutPriority

UIBehaviour.Awake()

UIBehaviour.Start()

UIBehaviour.OnDestroy()

UIBehaviour.Reset()

UIBehaviour.OnBeforeTransformParentChanged()

UIBehaviour.OnTransformParentChanged()

UIBehaviour.OnDidApplyAnimationProperties()

UIBehaviour.OnCanvasGroupChanged()

UIBehaviour.OnCanvasHierarchyChanged()

UIBehaviour.IsDestroyed()

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.didStart

MonoBehaviour.didAwake

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.GetComponentIndex()

Component.CompareTag(string)

Component.CompareTag(TagHandle)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.transformHandle

Component.gameObject

Component.tag

Object.GetEntityId()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsByType(Type)

Object.FindObjectsByType(Type, FindObjectsInactive)

Object.DontDestroyOnLoad(Object)

Object.FindAnyObjectByType<T>()

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsByType<T>()

Object.FindObjectsByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType(Type)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Scylla.Core.Util.UI

Assembly: ScyllaCore.dll

Syntax

[AddComponentMenu("")]
public class ScyllaScrollRect : ScrollRect, IInitializePotentialDragHandler, IBeginDragHandler, IEndDragHandler, IDragHandler, IScrollHandler, IEventSystemHandler, ICanvasElement, ILayoutElement, ILayoutGroup, ILayoutController

Remarks

Two corrections, both on the scroll path only. The horizontal direction fix is described on OnScroll(PointerEventData); the clamping is the reason the class was written and is described below.

Unity's own scroll rect applies a scroll event straight to the content position and only clamps it when the movement type is Clamped. In Elastic mode the delta goes on unchecked, so the content can be pushed as far past the end as the input asks for and the spring then has that whole distance to travel back.

A mouse wheel sends a fixed step and never gets far enough for that to show. A macOS trackpad sends a continuous, momentum-carried stream that keeps arriving after the fingers lift, which is enough to throw the whole content off screen and leave it out there for about a second before it springs back.

Clamping only the scroll path is what keeps both behaviours: a drag past the end still resists and bounces, because that overshoot is the user pulling on it directly and is bounded by how far they dragged.

Use it exactly as ScrollRect, on either axis or both. Configure the elasticity, inertia and sensitivity as usual; only the scroll-wheel path behaves differently.

Methods

OnScroll(PointerEventData)

Applies a wheel or trackpad scroll with the horizontal axis corrected, then pins the content back inside its ends.

Declaration

public override void OnScroll(PointerEventData eventData)

Parameters

Type	Name	Description
PointerEventData	eventData	Pointer event carrying the scroll delta.

Overrides

UnityEngine.UI.ScrollRect.OnScroll(UnityEngine.EventSystems.PointerEventData)

Remarks

Unity's scroll rect flips the vertical delta, with the comment that down is positive for a scroll event while up is positive in the UI system, and then does not do the same for the horizontal one. The result is that a two-finger swipe left scrolls the content right and a swipe right scrolls it left, while the vertical axis behaves correctly. Flipping the horizontal delta the same way puts both axes back on the platform's convention.

Only when UnityEngine.UI.ScrollRect.horizontal is on. With it off, Unity repurposes a horizontal delta as a vertical one so a sideways wheel still drives a vertical list, and flipping it there would invert that instead of fixing anything.

An axis whose content already fits has its delta dropped. In Elastic mode Unity still moves content that is shorter than the viewport and then springs it back, so a trackpad swipe across a table with nothing to scroll made the whole table drift and bounce. There is nowhere to go on such an axis, so the honest response to the gesture is to do nothing.

The event's delta is restored before returning. It is a pooled object that the event system may pass on to another handler, and leaving a modified delta on it would make this component change how an unrelated one behaves.