pengtaihao
/
com.unity.uiextensions
mirror of https://github.com/Unity-UI-Extensions/com.unity.uiextensions
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated Fancy ScrollView and added Example 8

pull/413/head
Simon (darkside) Jackson 2019-12-04 17:25:31 +00:00
parent c41ad9a163
commit 0a5444b22b
17 changed files with 759 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Examples

@ -1 +1 @@
Subproject commit a5914a92198efb1422bd66f84e8cde6cb0842b87
Subproject commit 4878f8d7d74c72a334b6204dffc9cb117a9463f2

92
Scripts/Layout/FancyScrollView/Core/FancyScrollView.cs
View File

@ -5,26 +5,84 @@ using System.Collections.Generic;
namespace UnityEngine.UI.Extensions
{
/// <summary>
/// スクロールビューを実装するための抽象基底クラス.
/// 無限スクロールおよびスナップに対応しています.
/// <see cref="FancyScrollView{TItemData, TContext}.Context"/> が不要な場合は
/// 代わりに <see cref="FancyScrollView{TItemData}"/> を使用します.
/// </summary>
/// <typeparam name="TItemData">アイテムのデータ型.</typeparam>
/// <typeparam name="TContext"><see cref="Context"/> の型.</typeparam>
public abstract class FancyScrollView<TItemData, TContext> : MonoBehaviour where TContext : class, new()
{
/// <summary>
/// セル同士の間隔.
/// </summary>
[SerializeField, Range(1e-2f, 1f)] protected float cellInterval = 0.2f;
/// <summary>
/// スクロール位置の基準.
/// </summary>
/// <remarks>
/// たとえば、 <c>0.5</c> を指定してスクロール位置が <c>0</c> の場合, 中央に最初のセルが配置されます.
/// </remarks>
[SerializeField, Range(0f, 1f)] protected float scrollOffset = 0.5f;
/// <summary>
/// セルを循環して配置させるどうか.
/// </summary>
/// <remarks>
/// <c>true</c> にすると最後のセルの後に最初のセル, 最初のセルの前に最後のセルが並ぶようになります.
/// 無限スクロールを実装する場合は <c>true</c> を指定します.
/// </remarks>
[SerializeField] protected bool loop = false;
/// <summary>
/// セルの親要素となる <c>Transform</c>.
/// </summary>
[SerializeField] protected Transform cellContainer = default;
readonly IList<FancyScrollViewCell<TItemData, TContext>> pool =
new List<FancyScrollViewCell<TItemData, TContext>>();
/// <summary>
/// 初期化済みかどうか.
/// </summary>
protected bool initialized;
/// <summary>
/// 現在のスクロール位置.
/// </summary>
protected float currentPosition;
/// <summary>
/// セルの Prefab.
/// </summary>
protected abstract GameObject CellPrefab { get; }
/// <summary>
/// アイテム一覧のデータ.
/// </summary>
protected IList<TItemData> ItemsSource { get; set; } = new List<TItemData>();
/// <summary>
/// <typeparamref name="TContext"/> のインスタンス.
/// セルとスクロールビュー間で同じインスタンスが共有されます. 情報の受け渡しや状態の保持に使用します.
/// </summary>
protected TContext Context { get; } = new TContext();
/// <summary>
/// Updates the contents.
/// 初期化を行います.
/// </summary>
/// <param name="itemsSource">Items source.</param>
/// <remarks>
/// 最初にセルが生成される直前に呼び出されます.
/// </remarks>
protected virtual void Initialize() { }
/// <summary>
/// 渡されたアイテム一覧に基づいて表示内容を更新します.
/// </summary>
/// <param name="itemsSource">アイテム一覧.</param>
protected virtual void UpdateContents(IList<TItemData> itemsSource)
{
ItemsSource = itemsSource;
@ -32,18 +90,24 @@ namespace UnityEngine.UI.Extensions
}
/// <summary>
/// Refreshes the cells.
/// セルの表示内容を更新します.
/// </summary>
protected virtual void Refresh() => UpdatePosition(currentPosition, true);
/// <summary>
/// Updates the scroll position.
/// スクロール位置を更新します.
/// </summary>
/// <param name="position">Position.</param>
/// <param name="position">スクロール位置.</param>
protected virtual void UpdatePosition(float position) => UpdatePosition(position, false);
protected void UpdatePosition(float position, bool forceRefresh)
void UpdatePosition(float position, bool forceRefresh)
{
if (!initialized)
{
Initialize();
initialized = true;
}
currentPosition = position;
var p = position - scrollOffset / cellInterval;
@ -66,7 +130,8 @@ namespace UnityEngine.UI.Extensions
var addCount = Mathf.CeilToInt((1f - firstPosition) / cellInterval) - pool.Count;
for (var i = 0; i < addCount; i++)
{
var cell = Instantiate(CellPrefab, cellContainer).GetComponent<FancyScrollViewCell<TItemData, TContext>>();
var cell = Instantiate(CellPrefab, cellContainer)
.GetComponent<FancyScrollViewCell<TItemData, TContext>>();
if (cell == null)
{
throw new MissingComponentException(
@ -118,7 +183,9 @@ namespace UnityEngine.UI.Extensions
void LateUpdate()
{
if (cachedLoop != loop || cachedCellInterval != cellInterval || cachedScrollOffset != scrollOffset)
if (cachedLoop != loop ||
cachedCellInterval != cellInterval ||
cachedScrollOffset != scrollOffset)
{
cachedLoop = loop;
cachedCellInterval = cellInterval;
@ -130,7 +197,16 @@ namespace UnityEngine.UI.Extensions
#endif
}
/// <summary>
/// <see cref="FancyScrollView{TItemData}"/> のコンテキストクラス.
/// </summary>
public sealed class FancyScrollViewNullContext { }
/// <summary>
/// スクロールビューを実装するための抽象基底クラス.
/// 無限スクロールおよびスナップに対応しています.
/// </summary>
/// <typeparam name="TItemData"></typeparam>
/// <seealso cref="FancyScrollView{TItemData, TContext}"/>
public abstract class FancyScrollView<TItemData> : FancyScrollView<TItemData, FancyScrollViewNullContext> { }
}

39
Scripts/Layout/FancyScrollView/Core/FancyScrollViewCell.cs
View File

@ -3,53 +3,64 @@
namespace UnityEngine.UI.Extensions
{
/// <summary>
/// <see cref="FancyScrollView{TItemData, TContext}"/> のセルを実装するための抽象基底クラス.
/// <see cref="FancyScrollViewCell{TItemData, TContext}.Context"/> が不要な場合は
/// 代わりに <see cref="FancyScrollViewCell{TItemData}"/> を使用します.
/// </summary>
/// <typeparam name="TItemData">アイテムのデータ型.</typeparam>
/// <typeparam name="TContext"><see cref="Context"/> の型.</typeparam>
public abstract class FancyScrollViewCell<TItemData, TContext> : MonoBehaviour where TContext : class, new()
{
/// <summary>
/// Gets or sets the index of the data.
/// このセルで表示しているデータのインデックス.
/// </summary>
/// <value>The index of the data.</value>
public int Index { get; set; } = -1;
/// <summary>
/// Gets a value indicating whether this <see cref="T:FancyScrollView.FancyScrollViewCell`2"/> is visible.
/// このセルの可視状態.
/// </summary>
/// <value><c>true</c> if is visible; otherwise, <c>false</c>.</value>
public virtual bool IsVisible => gameObject.activeSelf;
/// <summary>
/// Gets the context.
/// <see cref="FancyScrollView{TItemData, TContext}.Context"/> の参照.
/// セルとスクロールビュー間で同じインスタンスが共有されます. 情報の受け渡しや状態の保持に使用します.
/// </summary>
/// <value>The context.</value>
protected TContext Context { get; private set; }
/// <summary>
/// Setup the context.
/// <see cref="Context"/> のセットアップを行います.
/// </summary>
/// <param name="context">Context.</param>
/// <param name="context">コンテキスト.</param>
public virtual void SetupContext(TContext context) => Context = context;
/// <summary>
/// Sets the visible.
/// このセルの可視状態を設定します.
/// </summary>
/// <param name="visible">If set to <c>true</c> visible.</param>
/// <param name="visible">可視状態なら <c>true</c>, 非可視状態なら <c>false</c>.</param>
public virtual void SetVisible(bool visible) => gameObject.SetActive(visible);
/// <summary>
/// Updates the content.
/// アイテムデータに基づいてこのセルの表示内容を更新します.
/// </summary>
/// <param name="itemData">Item data.</param>
/// <param name="itemData">アイテムデータ.</param>
public abstract void UpdateContent(TItemData itemData);
/// <summary>
/// Updates the position.
/// <c>0.0f</c> ~ <c>1.0f</c> の値に基づいてこのセルのスクロール位置を更新します.
/// </summary>
/// <param name="position">Position.</param>
/// <param name="position">ビューポート範囲の正規化されたスクロール位置.</param>
public abstract void UpdatePosition(float position);
}
/// <summary>
/// <see cref="FancyScrollView{TItemData}"/> のセルを実装するための抽象基底クラス.
/// </summary>
/// <typeparam name="TItemData">アイテムのデータ型.</typeparam>
/// <seealso cref="FancyScrollViewCell{TItemData, TContext}"/>
public abstract class FancyScrollViewCell<TItemData> : FancyScrollViewCell<TItemData, FancyScrollViewNullContext>
{
/// <inheritdoc/>
public sealed override void SetupContext(FancyScrollViewNullContext context) => base.SetupContext(context);
}
}

8
Scripts/Layout/FancyScrollView/GridView.meta Normal file
View File

@ -0,0 +1,8 @@
fileFormatVersion: 2
guid: c7768f2982b0142ab876d2bb4b597646
folderAsset: yes
DefaultImporter:
externalObjects: {}
userData:
assetBundleName:
assetBundleVariant:

144
Scripts/Layout/FancyScrollView/GridView/FancyGridView.cs Normal file
View File

@ -0,0 +1,144 @@
/// Credit setchi (https://github.com/setchi)
/// Sourced from - https://github.com/setchi/FancyScrollView
using System;
using System.Collections.Generic;
using System.Linq;
using UnityEngine.UI.Extensions.EasingCore;
namespace UnityEngine.UI.Extensions
{
/// <summary>
/// グリッドレイアウトのスクロールビューを実装するための抽象基底クラス.
/// 無限スクロールおよびスナップには対応していません.
/// </summary>
/// <typeparam name="TItemData">アイテムのデータ型.</typeparam>
/// <typeparam name="TContext"><see cref="FancyScrollView{TItemData, TContext}.Context"/> の型.</typeparam>
public abstract class FancyGridView<TItemData, TContext> : FancyScrollRect<TItemData[], TContext>
where TContext : class, IFancyScrollRectContext, IFancyGridViewContext, new()
{
/// <summary>
/// カラム同士の余白.
/// </summary>
[SerializeField] protected float columnSpacing = 0f;
GameObject cachedRowPrefab;
/// <summary>
/// 行の Prefab.
/// </summary>
/// <remarks>
/// <see cref="FancyGridView{TItemData, TContext}"/> では,
/// <see cref="FancyScrollView{TItemData, TContext}.CellPrefab"/> を行オブジェクトとして使用します.
/// </remarks>
protected sealed override GameObject CellPrefab => cachedRowPrefab ?? (cachedRowPrefab = SetupRowTemplate());
/// <summary>
/// 一行あたりの要素数.
/// </summary>
protected abstract int ColumnCount { get; }
/// <summary>
/// セルのテンプレート.
/// </summary>
protected abstract FancyScrollViewCell<TItemData, TContext> CellTemplate { get; }
/// <summary>
/// 行オブジェクトのテンプレート.
/// </summary>
protected abstract FancyGridViewRow<TItemData, TContext> RowTemplate { get; }
/// <summary>
/// アイテムの総数.
/// </summary>
public int DataCount { get; private set; }
/// <inheritdoc/>
protected override void Initialize()
{
base.Initialize();
Debug.Assert(RowTemplate != null);
Debug.Assert(CellTemplate != null);
Debug.Assert(ColumnCount > 0);
Context.CellTemplate = CellTemplate.gameObject;
Context.ScrollDirection = Scroller.ScrollDirection;
Context.GetColumnCount = () => ColumnCount;
Context.GetColumnSpacing = () => columnSpacing;
}
/// <summary>
/// 行オブジェクトのセットアップを行います.
/// </summary>
/// <returns>行を構成する <c>GameObject</c>.</returns>
protected virtual GameObject SetupRowTemplate()
{
var cell = CellTemplate.GetComponent<RectTransform>();
var row = RowTemplate.GetComponent<RectTransform>();
row.sizeDelta = Scroller.ScrollDirection == ScrollDirection.Horizontal
? new Vector2(cell.rect.width, row.sizeDelta.y)
: new Vector2(row.sizeDelta.x, cell.rect.height);
return row.gameObject;
}
/// <summary>
/// 渡されたアイテム一覧に基づいて表示内容を更新します.
/// </summary>
/// <param name="items">アイテム一覧.</param>
public virtual void UpdateContents(IList<TItemData> items)
{
DataCount = items.Count;
var rows = items
.Select((item, index) => (item, index))
.GroupBy(
x => x.index / ColumnCount,
x => x.item)
.Select(group => group.ToArray())
.ToArray();
UpdateContents(rows);
}
/// <summary>
/// 指定したアイテムの位置まで移動します.
/// </summary>
/// <param name="itemIndex">アイテムのインデックス.</param>
/// <param name="duration">移動にかける秒数.</param>
/// <param name="alignment"><see cref="Alignment"/>.</param>
/// <param name="onComplete">移動が完了した際に呼び出されるコールバック.</param>
public override void ScrollTo(int itemIndex, float duration, Alignment alignment = Alignment.Center, Action onComplete = null)
{
var rowIndex = itemIndex / Context.GetColumnCount();
base.ScrollTo(rowIndex, duration, alignment, onComplete);
}
/// <summary>
/// 指定したアイテムの位置まで移動します.
/// </summary>
/// <param name="itemIndex">アイテムのインデックス.</param>
/// <param name="duration">移動にかける秒数.</param>
/// <param name="easing">移動に使用するイージング.</param>
/// <param name="alignment"><see cref="Alignment"/>.</param>
/// <param name="onComplete">移動が完了した際に呼び出されるコールバック.</param>
public override void ScrollTo(int itemIndex, float duration, Ease easing, Alignment alignment = Alignment.Center, Action onComplete = null)
{
var rowIndex = itemIndex / Context.GetColumnCount();
base.ScrollTo(rowIndex, duration, easing, alignment, onComplete);
}
/// <summary>
/// 指定したアイテムの位置までジャンプします.
/// </summary>
/// <param name="itemIndex">アイテムのインデックス.</param>
/// <param name="alignment"><see cref="Alignment"/>.</param>
public virtual void JumpTo(int itemIndex, Alignment alignment = Alignment.Center)
{
var rowIndex = itemIndex / Context.GetColumnCount();
UpdatePosition(rowIndex, alignment);
}
}
}

11
Scripts/Layout/FancyScrollView/GridView/FancyGridView.cs.meta Normal file
View File

@ -0,0 +1,11 @@
fileFormatVersion: 2
guid: e806c8d18b1ff45bb87e9a5b87ec85e3
MonoImporter:
externalObjects: {}
serializedVersion: 2
defaultReferences: []
executionOrder: 0
icon: {instanceID: 0}
userData:
assetBundleName:
assetBundleVariant:

23
Scripts/Layout/FancyScrollView/GridView/FancyGridViewContext.cs Normal file
View File

@ -0,0 +1,23 @@
/// Credit setchi (https://github.com/setchi)
/// Sourced from - https://github.com/setchi/FancyScrollView
using System;
namespace UnityEngine.UI.Extensions
{
/// <summary>
/// <see cref="FancyGridView{TItemData, TContext}"/> のコンテキスト基底クラス.
/// </summary>
public class FancyGridViewContext : IFancyGridViewContext, IFancyScrollRectContext
{
Func<(float ScrollSize, float ReuseMargin)> IFancyScrollRectContext.CalculateScrollSize { get; set; }
GameObject IFancyGridViewContext.CellTemplate { get; set; }
ScrollDirection IFancyGridViewContext.ScrollDirection { get; set; }
public Func<int> GetColumnCount { get; set; }
public Func<float> GetColumnSpacing { get; set; }
}
}

11
Scripts/Layout/FancyScrollView/GridView/FancyGridViewContext.cs.meta Normal file
View File

@ -0,0 +1,11 @@
fileFormatVersion: 2
guid: 954a17398bfb54ee7baac3d7ab7e822c
MonoImporter:
externalObjects: {}
serializedVersion: 2
defaultReferences: []
executionOrder: 0
icon: {instanceID: 0}
userData:
assetBundleName:
assetBundleVariant:

81
Scripts/Layout/FancyScrollView/GridView/FancyGridViewRow.cs Normal file
View File

@ -0,0 +1,81 @@
/// Credit setchi (https://github.com/setchi)
/// Sourced from - https://github.com/setchi/FancyScrollView
using System.Linq;
namespace UnityEngine.UI.Extensions
{
/// <summary>
/// <see cref="FancyGridView{TItemData, TContext}"/> の行を実装するための抽象基底クラス.
/// </summary>
/// <typeparam name="TItemData">アイテムのデータ型.</typeparam>
/// <typeparam name="TContext"><see cref="FancyScrollViewCell{TItemData, TContext}.Context"/> の型.</typeparam>
public abstract class FancyGridViewRow<TItemData, TContext> : FancyScrollRectCell<TItemData[], TContext>
where TContext : class, IFancyScrollRectContext, IFancyGridViewContext, new()
{
/// <summary>
/// この行で表示するセルの配列.
/// </summary>
protected virtual FancyScrollViewCell<TItemData, TContext>[] Cells { get; private set; }
/// <summary>
/// この行で表示するセルの配列をインスタンス化します.
/// </summary>
/// <returns>この行で表示するセルの配列.</returns>
protected virtual FancyScrollViewCell<TItemData, TContext>[] InstantiateCells()
{
return Enumerable.Range(0, Context.GetColumnCount())
.Select(_ => Instantiate(Context.CellTemplate, transform))
.Select(x => x.GetComponent<FancyScrollViewCell<TItemData, TContext>>())
.ToArray();
}
/// <inheritdoc/>
public override void SetupContext(TContext context)
{
base.SetupContext(context);
Cells = InstantiateCells();
Debug.Assert(Cells.Length == Context.GetColumnCount());
for (var i = 0; i < Cells.Length; i++)
{
Cells[i].SetupContext(context);
}
}
/// <inheritdoc/>
public override void UpdateContent(TItemData[] rowContents)
{
for (var i = 0; i < Cells.Length; i++)
{
Cells[i].Index = i + Index * Context.GetColumnCount();
Cells[i].SetVisible(i < rowContents.Length);
if (Cells[i].IsVisible)
{
Cells[i].UpdateContent(rowContents[i]);
}
}
}
/// <inheritdoc/>
public override void UpdatePosition(float position)
{
base.UpdatePosition(position);
for (var i = 0; i < Cells.Length; i++)
{
Cells[i].UpdatePosition(position);
}
}
/// <inheritdoc/>
protected override void UpdatePosition(float position, float viewportPosition)
{
transform.localPosition = Context.ScrollDirection == ScrollDirection.Horizontal
? new Vector2(viewportPosition, transform.localPosition.y)
: new Vector2(transform.localPosition.x, viewportPosition);
}
}
}

11
Scripts/Layout/FancyScrollView/GridView/FancyGridViewRow.cs.meta Normal file
View File

@ -0,0 +1,11 @@
fileFormatVersion: 2
guid: 84300901ad8704c11b39587ed6d87468
MonoImporter:
externalObjects: {}
serializedVersion: 2
defaultReferences: []
executionOrder: 0
icon: {instanceID: 0}
userData:
assetBundleName:
assetBundleVariant:

18
Scripts/Layout/FancyScrollView/GridView/IFancyGridViewContext.cs Normal file
View File

@ -0,0 +1,18 @@
/// Credit setchi (https://github.com/setchi)
/// Sourced from - https://github.com/setchi/FancyScrollView
using System;
namespace UnityEngine.UI.Extensions
{
/// <summary>
/// <see cref="FancyGridView{TItemData, TContext}"/> のコンテキストインターフェース.
/// </summary>
public interface IFancyGridViewContext
{
GameObject CellTemplate { get; set; }
ScrollDirection ScrollDirection { get; set; }
Func<int> GetColumnCount { get; set; }
Func<float> GetColumnSpacing { get; set; }
}
}

11
Scripts/Layout/FancyScrollView/GridView/IFancyGridViewContext.cs.meta Normal file
View File

@ -0,0 +1,11 @@
fileFormatVersion: 2
guid: 3cf2d53d9c81945c28f7c558a7c40ba3
MonoImporter:
externalObjects: {}
serializedVersion: 2
defaultReferences: []
executionOrder: 0
icon: {instanceID: 0}
userData:
assetBundleName:
assetBundleVariant:

203
Scripts/Layout/FancyScrollView/ScrollRect/FancyScrollRect.cs
View File

@ -7,38 +7,86 @@ using UnityEngine.UI.Extensions.EasingCore;
namespace UnityEngine.UI.Extensions
{
/// <summary>
/// ScrollRect スタイルのスクロールビューを実装するための抽象基底クラス.
/// 無限スクロールおよびスナップには対応していません.
/// <see cref="FancyScrollView{TItemData, TContext}.Context"/> が不要な場合は
/// 代わりに <see cref="FancyScrollRect{TItemData}"/> を使用します.
/// </summary>
/// <typeparam name="TItemData">アイテムのデータ型.</typeparam>
/// <typeparam name="TContext"><see cref="FancyScrollView{TItemData, TContext}.Context"/> の型.</typeparam>
[RequireComponent(typeof(Scroller))]
public abstract class FancyScrollRect<TItemData, TContext> : FancyScrollView<TItemData, TContext>
where TContext : class, IFancyScrollRectContext, new()
{
/// <summary>
/// スクロール中にセルが再利用されるまでの余白のセル数.
/// </summary>
/// <remarks>
/// <c>0</c> を指定するとセルが完全に隠れた直後に再利用されます.
/// <c>1</c> 以上を指定すると, そのセル数だけ余分にスクロールしてから再利用されます.
/// </remarks>
[SerializeField] protected float reuseCellMarginCount = 0f;
/// <summary>
/// コンテンツ先頭の余白.
/// </summary>
[SerializeField] protected float paddingHead = 0f;
/// <summary>
/// コンテンツ末尾の余白.
/// </summary>
[SerializeField] protected float paddingTail = 0f;
/// <summary>
/// セル同士の余白.
/// </summary>
[SerializeField] protected float spacing = 0f;
protected virtual float ScrollLength => 1f / Mathf.Max(cellInterval, 1e-2f) - 1f;
protected virtual float ViewportLength => ScrollLength - reuseCellMarginCount * 2f;
protected virtual float MaxScrollPosition => ItemsSource.Count
- ScrollLength
+ reuseCellMarginCount * 2f
+ (paddingHead + (paddingTail - spacing)) / (CellSize + spacing);
protected virtual bool ScrollEnabled => MaxScrollPosition > 0f;
/// <summary>
/// スクロール可能かどうか.
/// </summary>
/// <remarks>
/// アイテム数が十分少なくビューポート内に全てのセルが収まっている場合は <c>false</c>, それ以外は <c>true</c> になります.
/// </remarks>
protected virtual bool Scrollable => MaxScrollPosition > 0f;
/// <summary>
/// セルのサイズ.
/// </summary>
protected virtual float CellSize => Scroller.ScrollDirection == ScrollDirection.Horizontal
? CellRectTransform.rect.width
: CellRectTransform.rect.height;
Scroller cachedScroller;
/// <summary>
/// スクロール位置を制御する <see cref="FancyScrollView.Scroller"/> のインスタンス.
/// </summary>
/// <remarks>
/// <see cref="Scroller"/> のスクロール位置を変更する際は必ず <see cref="ToScrollerPosition(float)"/> を使用して変換した位置を使用してください.
/// </remarks>
protected Scroller Scroller => cachedScroller ?? (cachedScroller = GetComponent<Scroller>());
RectTransform cachedCellRect;
RectTransform CellRectTransform => cachedCellRect ?? (cachedCellRect = CellPrefab.transform as RectTransform);
protected virtual void Awake()
float ScrollLength => 1f / Mathf.Max(cellInterval, 1e-2f) - 1f;
float ViewportLength => ScrollLength - reuseCellMarginCount * 2f;
float PaddingHeadLength => (paddingHead - spacing * 0.5f) / (CellSize + spacing);
float MaxScrollPosition => ItemsSource.Count
- ScrollLength
+ reuseCellMarginCount * 2f
+ (paddingHead + paddingTail - spacing) / (CellSize + spacing);
/// <inheritdoc/>
protected override void Initialize()
{
base.Initialize();
Context.CalculateScrollSize = () =>
{
var interval = CellSize + spacing;
@ -46,17 +94,18 @@ namespace UnityEngine.UI.Extensions
var scrollSize = Scroller.ViewportSize + interval + reuseMargin * 2f;
return (scrollSize, reuseMargin);
};
}
protected virtual void Start()
{
AdjustCellIntervalAndScrollOffset();
Scroller.OnValueChanged(OnScrollerValueChanged);
}
/// <summary>
/// <see cref="Scroller"/> のスクロール位置が変更された際の処理.
/// </summary>
/// <param name="p"><see cref="Scroller"/> のスクロール位置.</param>
void OnScrollerValueChanged(float p)
{
base.UpdatePosition(ScrollEnabled ? ToFancyScrollViewPosition(p) : 0f);
base.UpdatePosition(Scrollable ? ToFancyScrollViewPosition(p) : 0f);
if (Scroller.Scrollbar)
{
@ -71,12 +120,41 @@ namespace UnityEngine.UI.Extensions
}
}
/// <summary>
/// スクロール範囲を超えてスクロールされた量に基づいて, スクロールバーのサイズを縮小します.
/// </summary>
/// <param name="offset">スクロール範囲を超えてスクロールされた量.</param>
void ShrinkScrollbar(float offset)
{
var scale = 1f - ToFancyScrollViewPosition(offset) / ViewportLength;
UpdateScrollbarSize(ViewportLength * scale / Mathf.Max(ItemsSource.Count, 1));
var scale = 1f - ToFancyScrollViewPosition(offset) / (ViewportLength - PaddingHeadLength);
UpdateScrollbarSize((ViewportLength - PaddingHeadLength) * scale);
}
/// <inheritdoc/>
protected override void Refresh()
{
AdjustCellIntervalAndScrollOffset();
RefreshScroller();
base.Refresh();
}
/// <summary>
/// <see cref="Scroller"/> の各種状態を更新します.
/// </summary>
protected void RefreshScroller()
{
Scroller.Draggable = Scrollable;
Scroller.ScrollSensitivity = ToScrollerPosition(ViewportLength - PaddingHeadLength);
Scroller.Position = ToScrollerPosition(currentPosition);
if (Scroller.Scrollbar)
{
Scroller.Scrollbar.gameObject.SetActive(Scrollable);
UpdateScrollbarSize(ViewportLength);
}
}
/// <inheritdoc/>
protected override void UpdateContents(IList<TItemData> items)
{
Debug.Assert(Context.CalculateScrollSize != null);
@ -85,64 +163,96 @@ namespace UnityEngine.UI.Extensions
base.UpdateContents(items);
Scroller.SetTotalCount(items.Count);
Scroller.Draggable = ScrollEnabled;
Scroller.ScrollSensitivity = ToScrollerPosition(ViewportLength);
Scroller.Position = ToScrollerPosition(currentPosition);
if (Scroller.Scrollbar)
{
Scroller.Scrollbar.gameObject.SetActive(ScrollEnabled);
UpdateScrollbarSize(ViewportLength / Mathf.Max(ItemsSource.Count, 1));
}
RefreshScroller();
}
/// <summary>
/// スクロール位置を更新します.
/// </summary>
/// <param name="position">スクロール位置.</param>
protected new void UpdatePosition(float position)
{
UpdatePosition(position, Alignment.Center);
}
/// <summary>
/// スクロール位置を更新します.
/// </summary>
/// <param name="position">スクロール位置.</param>
/// <param name="alignment"><see cref="Alignment"/>.</param>
protected virtual void UpdatePosition(float position, Alignment alignment)
{
Scroller.Position = ToScrollerPosition(position, alignment);
}
/// <summary>
/// 指定したアイテムの位置まで移動します.
/// </summary>
/// <param name="index">アイテムのインデックス.</param>
/// <param name="duration">移動にかける秒数.</param>
/// <param name="alignment"><see cref="Alignment"/>.</param>
/// <param name="onComplete">移動が完了した際に呼び出されるコールバック.</param>
public virtual void ScrollTo(int index, float duration, Alignment alignment = Alignment.Center, Action onComplete = null)
{
Scroller.ScrollTo(ToScrollerPosition(index, alignment), duration, onComplete);
}
/// <summary>
/// 指定したアイテムの位置まで移動します.
/// </summary>
/// <param name="index">アイテムのインデックス.</param>
/// <param name="duration">移動にかける秒数.</param>
/// <param name="easing">移動に使用するイージング.</param>
/// <param name="alignment"><see cref="Alignment"/>.</param>
/// <param name="onComplete">移動が完了した際に呼び出されるコールバック.</param>
public virtual void ScrollTo(int index, float duration, Ease easing, Alignment alignment = Alignment.Center, Action onComplete = null)
{
Scroller.ScrollTo(ToScrollerPosition(index, alignment), duration, easing, onComplete);
}
protected void UpdateScrollbarSize(float size)
/// <summary>
/// ビューポートとコンテンツの長さに基づいてスクロールバーのサイズを更新します.
/// </summary>
/// <param name="viewportLength">ビューポートのサイズ.</param>
protected void UpdateScrollbarSize(float viewportLength)
{
Scroller.Scrollbar.size = ScrollEnabled ? Mathf.Clamp01(size) : 1f;
var contentLength = Mathf.Max(ItemsSource.Count + (paddingHead + paddingTail - spacing) / (CellSize + spacing), 1);
Scroller.Scrollbar.size = Scrollable ? Mathf.Clamp01(viewportLength / contentLength) : 1f;
}
protected virtual float ToFancyScrollViewPosition(float position)
/// <summary>
/// <see cref="Scroller"/> が扱うスクロール位置を <see cref="FancyScrollRect{TItemData, TContext}"/> が扱うスクロール位置に変換します.
/// </summary>
/// <param name="position"><see cref="Scroller"/> が扱うスクロール位置.</param>
/// <returns><see cref="FancyScrollRect{TItemData, TContext}"/> が扱うスクロール位置.</returns>
protected float ToFancyScrollViewPosition(float position)
{
return position
/ Mathf.Max(ItemsSource.Count - 1, 1)
* MaxScrollPosition
- (paddingHead - spacing * 0.5f) / (CellSize + spacing);
return position / Mathf.Max(ItemsSource.Count - 1, 1) * MaxScrollPosition - PaddingHeadLength;
}
protected virtual float ToScrollerPosition(float position)
/// <summary>
/// <see cref="FancyScrollRect{TItemData, TContext}"/> が扱うスクロール位置を <see cref="Scroller"/> が扱うスクロール位置に変換します.
/// </summary>
/// <param name="position"><see cref="FancyScrollRect{TItemData, TContext}"/> が扱うスクロール位置.</param>
/// <returns><see cref="Scroller"/> が扱うスクロール位置.</returns>
protected float ToScrollerPosition(float position)
{
return (position + (paddingHead - spacing * 0.5f) / (CellSize + spacing))
/ MaxScrollPosition
* Mathf.Max(ItemsSource.Count - 1, 1);
return (position + PaddingHeadLength) / MaxScrollPosition * Mathf.Max(ItemsSource.Count - 1, 1);
}
protected virtual float ToScrollerPosition(float position, Alignment alignment = Alignment.Center)
/// <summary>
/// <see cref="FancyScrollRect{TItemData, TContext}"/> が扱うスクロール位置を <see cref="Scroller"/> が扱うスクロール位置に変換します.
/// </summary>
/// <param name="position"><see cref="FancyScrollRect{TItemData, TContext}"/> が扱うスクロール位置.</param>
/// <param name="alignment"><see cref="Alignment"/>.</param>
/// <returns><see cref="Scroller"/> が扱うスクロール位置.</returns>
protected float ToScrollerPosition(float position, Alignment alignment = Alignment.Center)
{
var offset = (ScrollLength - (1f + reuseCellMarginCount * 2f)) * GetAnchore(alignment);
return ToScrollerPosition(Mathf.Clamp(position - offset, 0f, MaxScrollPosition));
}
protected virtual float GetAnchore(Alignment alignment)
float GetAnchore(Alignment alignment)
{
switch (alignment)
{
@ -153,7 +263,12 @@ namespace UnityEngine.UI.Extensions
}
}
void AdjustCellIntervalAndScrollOffset()
/// <summary>
/// 指定された設定を実現するための
/// <see cref="FancyScrollView{TItemData,TContext}.cellInterval"/> と
/// <see cref="FancyScrollView{TItemData,TContext}.scrollOffset"/> を計算して適用します.
/// </summary>
protected void AdjustCellIntervalAndScrollOffset()
{
var totalSize = Scroller.ViewportSize + (CellSize + spacing) * (1f + reuseCellMarginCount * 2f);
cellInterval = (CellSize + spacing) / totalSize;
@ -187,5 +302,11 @@ namespace UnityEngine.UI.Extensions
}
}
/// <summary>
/// ScrollRect スタイルのスクロールビューを実装するための抽象基底クラス.
/// 無限スクロールおよびスナップには対応していません.
/// </summary>
/// <typeparam name="TItemData">アイテムのデータ型.</typeparam>
/// <seealso cref="FancyScrollRect{TItemData, TContext}"/>
public abstract class FancyScrollRect<TItemData> : FancyScrollRect<TItemData, FancyScrollRectContext> { }
}
}

25
Scripts/Layout/FancyScrollView/ScrollRect/FancyScrollRectCell.cs
View File

@ -3,9 +3,17 @@
namespace UnityEngine.UI.Extensions
{
/// <summary>
/// <see cref="FancyScrollRect{TItemData, TContext}"/> のセルを実装するための抽象基底クラス.
/// <see cref="FancyScrollViewCell{TItemData, TContext}.Context"/> が不要な場合は
/// 代わりに <see cref="FancyScrollRectCell{TItemData}"/> を使用します.
/// </summary>
/// <typeparam name="TItemData">アイテムのデータ型.</typeparam>
/// <typeparam name="TContext"><see cref="FancyScrollViewCell{TItemData, TContext}.Context"/> の型.</typeparam>
public abstract class FancyScrollRectCell<TItemData, TContext> : FancyScrollViewCell<TItemData, TContext>
where TContext : class, IFancyScrollRectContext, new()
{
/// <inheritdoc/>
public override void UpdatePosition(float position)
{
var (scrollSize, reuseMargin) = Context.CalculateScrollSize();
@ -18,11 +26,26 @@ namespace UnityEngine.UI.Extensions
UpdatePosition(unclampedPosition, Mathf.Lerp(start, end, position));
}
/// <summary>
/// このセルの位置を更新します.
/// </summary>
/// <param name="position">
/// ビューポートの範囲で正規化されたスクロール位置.
/// <see cref="FancyScrollRect{TItemData, TContext}.reuseCellMarginCount"/> の値に基づいて
/// <c>0.0</c> ~ <c>1.0</c> の範囲を超えた値が渡されることがあります.
/// </param>
/// <param name="viewportPosition">ローカル位置.</param>
protected virtual void UpdatePosition(float position, float viewportPosition) { }
}
/// <summary>
/// <see cref="FancyScrollRect{TItemData}"/> のセルを実装するための抽象基底クラス.
/// </summary>
/// <typeparam name="TItemData">アイテムのデータ型.</typeparam>
/// <seealso cref="FancyScrollRectCell{TItemData, TContext}"/>
public abstract class FancyScrollRectCell<TItemData> : FancyScrollRectCell<TItemData, FancyScrollRectContext>
{
/// <inheritdoc/>
public sealed override void SetupContext(FancyScrollRectContext context) => base.SetupContext(context);
}
}
}

3
Scripts/Layout/FancyScrollView/ScrollRect/FancyScrollRectContext.cs
View File

@ -5,6 +5,9 @@ using System;
namespace UnityEngine.UI.Extensions
{
/// <summary>
/// <see cref="FancyScrollRect{TItemData, TContext}"/> のコンテキスト基底クラス.
/// </summary>
public class FancyScrollRectContext : IFancyScrollRectContext
{
Func<(float ScrollSize, float ReuseMargin)> IFancyScrollRectContext.CalculateScrollSize { get; set; }

4
Scripts/Layout/FancyScrollView/ScrollRect/IFancyScrollRectContext.cs
View File

@ -5,7 +5,9 @@ using System;
namespace UnityEngine.UI.Extensions
{
/// <summary>
/// <see cref="FancyScrollRect{TItemData, TContext}"/> のコンテキストインターフェース.
/// </summary>
public interface IFancyScrollRectContext
{
Func<(float ScrollSize, float ReuseMargin)> CalculateScrollSize { get; set; }

162
Scripts/Layout/FancyScrollView/Scroller/Scroller.cs
View File

@ -7,15 +7,82 @@ using UnityEngine.UI.Extensions.EasingCore;
namespace UnityEngine.UI.Extensions
{
/// <summary>
/// スクロール位置の制御を行うコンポーネント.
/// </summary>
public class Scroller : UIBehaviour, IBeginDragHandler, IEndDragHandler, IDragHandler
{
[SerializeField] RectTransform viewport = default;
/// <summary>
/// ビューポートのサイズ.
/// </summary>
public float ViewportSize => scrollDirection == ScrollDirection.Horizontal
? viewport.rect.size.x
: viewport.rect.size.y;
[SerializeField] ScrollDirection scrollDirection = ScrollDirection.Vertical;
/// <summary>
/// スクロール方向.
/// </summary>
public ScrollDirection ScrollDirection => scrollDirection;
[SerializeField] MovementType movementType = MovementType.Elastic;
/// <summary>
/// コンテンツがスクロール範囲を越えて移動するときに使用する挙動.
/// </summary>
public MovementType MovementType
{
get => movementType;
set => movementType = value;
}
[SerializeField] float elasticity = 0.1f;
/// <summary>
/// コンテンツがスクロール範囲を越えて移動するときに使用する弾力性の量.
/// </summary>
public float Elasticity
{
get => elasticity;
set => elasticity = value;
}
[SerializeField] float scrollSensitivity = 1f;
/// <summary>
/// <see cref="ViewportSize"/> の端から端まで Drag したときのスクロール位置の変化量.
/// </summary>
public float ScrollSensitivity
{
get => scrollSensitivity;
set => scrollSensitivity = value;
}
[SerializeField] bool inertia = true;
/// <summary>
/// 慣性を使用するかどうか. <c>true</c> を指定すると慣性が有効に, <c>false</c> を指定すると慣性が無効になります.
/// </summary>
public bool Inertia
{
get => inertia;
set => inertia = value;
}
[SerializeField] float decelerationRate = 0.03f;
/// <summary>
/// スクロールの減速率. <see cref="Inertia"/> が <c>true</c> の場合のみ有効です.
/// </summary>
public float DecelerationRate
{
get => decelerationRate;
set => decelerationRate = value;
}
[SerializeField]
Snap snap = new Snap
{
@ -24,41 +91,41 @@ namespace UnityEngine.UI.Extensions
Duration = 0.3f,
Easing = Ease.InOutCubic
};
[SerializeField] bool draggable = true;
[SerializeField] Scrollbar scrollbar = default;
public ScrollDirection ScrollDirection => scrollDirection;
public MovementType MovementType
{
get => movementType;
set => movementType = value;
}
public float ViewportSize => scrollDirection == ScrollDirection.Horizontal
? viewport.rect.size.x
: viewport.rect.size.y;
/// <summary>
/// <c>true</c> ならスナップし, <c>false</c>ならスナップしません.
/// </summary>
/// <remarks>
/// スナップを有効にすると, 慣性でスクロールが止まる直前に最寄りのセルへ移動します.
/// </remarks>
public bool SnapEnabled
{
get => snap.Enable;
set => snap.Enable = value;
}
public float ScrollSensitivity
{
get => scrollSensitivity;
set => scrollSensitivity = value;
}
[SerializeField] bool draggable = true;
/// <summary>
/// Drag 入力を受付けるかどうか.
/// </summary>
public bool Draggable
{
get => draggable;
set => draggable = value;
}
[SerializeField] Scrollbar scrollbar = default;
/// <summary>
/// スクロールバーのオブジェクト.
/// </summary>
public Scrollbar Scrollbar => scrollbar;
/// <summary>
/// 現在のスクロール位置.
/// </summary>
/// <value></value>
public float Position
{
get => currentPosition;
@ -137,16 +204,51 @@ namespace UnityEngine.UI.Extensions
}
}
/// <summary>
/// スクロール位置が変化したときのコールバックを設定します.
/// </summary>
/// <param name="callback">スクロール位置が変化したときのコールバック.</param>
public void OnValueChanged(Action<float> callback) => onValueChanged = callback;
/// <summary>
/// 選択位置が変化したときのコールバックを設定します.
/// </summary>
/// <param name="callback">選択位置が変化したときのコールバック.</param>
public void OnSelectionChanged(Action<int> callback) => onSelectionChanged = callback;
/// <summary>
/// アイテムの総数を設定します.
/// </summary>
/// <remarks>
/// <paramref name="totalCount"/> を元に最大スクロール位置を計算します.
/// </remarks>
/// <param name="totalCount">アイテムの総数.</param>
public void SetTotalCount(int totalCount) => this.totalCount = totalCount;
/// <summary>
/// 指定した位置まで移動します.
/// </summary>
/// <param name="position">スクロール位置. <c>0f</c> ~ <c>totalCount - 1f</c> の範囲.</param>
/// <param name="duration">移動にかける秒数.</param>
/// <param name="onComplete">移動が完了した際に呼び出されるコールバック.</param>
public void ScrollTo(float position, float duration, Action onComplete = null) => ScrollTo(position, duration, Ease.OutCubic, onComplete);
/// <summary>
/// 指定した位置まで移動します.
/// </summary>
/// <param name="position">スクロール位置. <c>0f</c> ~ <c>totalCount - 1f</c> の範囲.</param>
/// <param name="duration">移動にかける秒数.</param>
/// <param name="easing">移動に使用するイージング.</param>
/// <param name="onComplete">移動が完了した際に呼び出されるコールバック.</param>
public void ScrollTo(float position, float duration, Ease easing, Action onComplete = null) => ScrollTo(position, duration, EasingFunction.Get(easing), onComplete);
/// <summary>
/// 指定した位置まで移動します.
/// </summary>
/// <param name="position">スクロール位置. <c>0f</c> ~ <c>totalCount - 1f</c> の範囲.</param>
/// <param name="duration">移動にかける秒数.</param>
/// <param name="easingFunction">移動に使用するイージング関数.</param>
/// <param name="onComplete">移動が完了した際に呼び出されるコールバック.</param>
public void ScrollTo(float position, float duration, Func<float, float> easingFunction, Action onComplete = null)
{
if (duration <= 0f)
@ -170,6 +272,10 @@ namespace UnityEngine.UI.Extensions
UpdateSelection(Mathf.RoundToInt(CircularPosition(autoScrollState.EndPosition, totalCount)));
}
/// <summary>
/// 指定したインデックスの位置までジャンプします.
/// </summary>
/// <param name="index">アイテムのインデックス.</param>
public void JumpTo(int index)
{
if (index < 0 || index > totalCount - 1)
@ -186,6 +292,13 @@ namespace UnityEngine.UI.Extensions
UpdatePosition(index);
}
/// <summary>
/// <paramref name="sourceIndex"/> から <paramref name="destIndex"/> に移動する際の移動方向を返します.
/// スクロール範囲が無制限に設定されている場合は, 最短距離の移動方向を返します.
/// </summary>
/// <param name="sourceIndex">移動元のインデックス.</param>
/// <param name="destIndex">移動先のインデックス.</param>
/// <returns></returns>
public MovementDirection GetMovementDirection(int sourceIndex, int destIndex)
{
var movementAmount = CalculateMovementAmount(sourceIndex, destIndex);
@ -198,6 +311,7 @@ namespace UnityEngine.UI.Extensions
: MovementDirection.Down;
}
/// <inheritdoc/>
void IBeginDragHandler.OnBeginDrag(PointerEventData eventData)
{
if (!draggable || eventData.button != PointerEventData.InputButton.Left)
@ -216,6 +330,7 @@ namespace UnityEngine.UI.Extensions
autoScrollState.Reset();
}
/// <inheritdoc/>
void IDragHandler.OnDrag(PointerEventData eventData)
{
if (!draggable || eventData.button != PointerEventData.InputButton.Left || !dragging)
@ -252,6 +367,7 @@ namespace UnityEngine.UI.Extensions
UpdatePosition(position);
}
/// <inheritdoc/>
void IEndDragHandler.OnEndDrag(PointerEventData eventData)
{
if (!draggable || eventData.button != PointerEventData.InputButton.Left)
@ -400,14 +516,14 @@ namespace UnityEngine.UI.Extensions
return Mathf.Clamp(destPosition, 0, totalCount - 1) - sourcePosition;
}
var movementAmount = CircularPosition(destPosition, totalCount) - CircularPosition(sourcePosition, totalCount);
var amount = CircularPosition(destPosition, totalCount) - CircularPosition(sourcePosition, totalCount);
if (Mathf.Abs(movementAmount) > totalCount * 0.5f)
if (Mathf.Abs(amount) > totalCount * 0.5f)
{
movementAmount = Mathf.Sign(-movementAmount) * (totalCount - Mathf.Abs(movementAmount));
amount = Mathf.Sign(-amount) * (totalCount - Mathf.Abs(amount));
}
return movementAmount;
return amount;
}
float CircularPosition(float p, int size) => size < 1 ? 0 : p < 0 ? size - 1 + (p + 1) % size : p % size;