181 lines
7.8 KiB
C#
181 lines
7.8 KiB
C#
/// 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>
|
|
/// グリッドレイアウトのスクロールビューを実装するための抽象基底クラス.
|
|
/// 無限スクロールおよびスナップには対応していません.
|
|
/// <see cref="FancyScrollView{TItemData, TContext}.Context"/> が不要な場合は
|
|
/// 代わりに <see cref="FancyGridView{TItemData}"/> を使用します.
|
|
/// </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, IFancyGridViewContext, new()
|
|
{
|
|
/// <summary>
|
|
/// デフォルトのセルグループクラス.
|
|
/// </summary>
|
|
protected abstract class DefaultCellGroup : FancyCellGroup<TItemData, TContext> { }
|
|
|
|
/// <summary>
|
|
/// 最初にセルを配置する軸方向のセル同士の余白.
|
|
/// </summary>
|
|
[SerializeField] protected float startAxisSpacing = 0f;
|
|
|
|
/// <summary>
|
|
/// 最初にセルを配置する軸方向のセル数.
|
|
/// </summary>
|
|
[SerializeField] protected int startAxisCellCount = 4;
|
|
|
|
/// <summary>
|
|
/// セルのサイズ.
|
|
/// </summary>
|
|
[SerializeField] protected Vector2 cellSize = new Vector2(100f, 100f);
|
|
|
|
/// <summary>
|
|
/// セルのグループ Prefab.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <see cref="FancyGridView{TItemData, TContext}"/> では,
|
|
/// <see cref="FancyScrollView{TItemData, TContext}.CellPrefab"/> を最初にセルを配置する軸方向のセルコンテナとして使用します.
|
|
/// </remarks>
|
|
protected sealed override GameObject CellPrefab => cellGroupTemplate;
|
|
|
|
/// <inheritdoc/>
|
|
protected override float CellSize => Scroller.ScrollDirection == ScrollDirection.Horizontal
|
|
? cellSize.x
|
|
: cellSize.y;
|
|
|
|
/// <summary>
|
|
/// アイテムの総数.
|
|
/// </summary>
|
|
public int DataCount { get; private set; }
|
|
|
|
GameObject cellGroupTemplate;
|
|
|
|
/// <inheritdoc/>
|
|
protected override void Initialize()
|
|
{
|
|
base.Initialize();
|
|
|
|
Debug.Assert(startAxisCellCount > 0);
|
|
|
|
Context.ScrollDirection = Scroller.ScrollDirection;
|
|
Context.GetGroupCount = () => startAxisCellCount;
|
|
Context.GetStartAxisSpacing = () => startAxisSpacing;
|
|
Context.GetCellSize = () => Scroller.ScrollDirection == ScrollDirection.Horizontal
|
|
? cellSize.y
|
|
: cellSize.x;
|
|
|
|
SetupCellTemplate();
|
|
}
|
|
|
|
/// <summary>
|
|
/// 最初にセルが生成される直前に呼び出されます.
|
|
/// <see cref="Setup{TGroup}(FancyCell{TItemData, TContext})"/> メソッドを使用してセルテンプレートのセットアップを行ってください.
|
|
/// </summary>
|
|
/// <example>
|
|
/// <code><![CDATA[
|
|
/// using UnityEngine;
|
|
/// using FancyScrollView;
|
|
///
|
|
/// public class MyGridView : FancyGridView<ItemData, Context>
|
|
/// {
|
|
/// class CellGroup : DefaultCellGroup { }
|
|
///
|
|
/// [SerializeField] Cell cellPrefab = default;
|
|
///
|
|
/// protected override void SetupCellTemplate() => Setup<CellGroup>(cellPrefab);
|
|
/// }
|
|
/// ]]></code>
|
|
/// </example>
|
|
protected abstract void SetupCellTemplate();
|
|
|
|
/// <summary>
|
|
/// セルテンプレートのセットアップを行います.
|
|
/// </summary>
|
|
/// <param name="cellTemplate">セルのテンプレート.</param>
|
|
/// <typeparam name="TGroup">セルグループの型.</typeparam>
|
|
protected virtual void Setup<TGroup>(FancyCell<TItemData, TContext> cellTemplate)
|
|
where TGroup : FancyCell<TItemData[], TContext>
|
|
{
|
|
Context.CellTemplate = cellTemplate.gameObject;
|
|
|
|
cellGroupTemplate = new GameObject("Group").AddComponent<TGroup>().gameObject;
|
|
cellGroupTemplate.transform.SetParent(cellContainer, false);
|
|
cellGroupTemplate.SetActive(false);
|
|
}
|
|
|
|
/// <summary>
|
|
/// 渡されたアイテム一覧に基づいて表示内容を更新します.
|
|
/// </summary>
|
|
/// <param name="items">アイテム一覧.</param>
|
|
public virtual void UpdateContents(IList<TItemData> items)
|
|
{
|
|
DataCount = items.Count;
|
|
|
|
var itemGroups = items
|
|
.Select((item, index) => (item, index))
|
|
.GroupBy(
|
|
x => x.index / startAxisCellCount,
|
|
x => x.item)
|
|
.Select(group => group.ToArray())
|
|
.ToArray();
|
|
|
|
UpdateContents(itemGroups);
|
|
}
|
|
|
|
/// <summary>
|
|
/// 指定したアイテムの位置までジャンプします.
|
|
/// </summary>
|
|
/// <param name="itemIndex">アイテムのインデックス.</param>
|
|
/// <param name="alignment">ビューポート内におけるセル位置の基準. 0f(先頭) ~ 1f(末尾).</param>
|
|
protected override void JumpTo(int itemIndex, float alignment = 0.5f)
|
|
{
|
|
var groupIndex = itemIndex / startAxisCellCount;
|
|
base.JumpTo(groupIndex, alignment);
|
|
}
|
|
|
|
/// <summary>
|
|
/// 指定したアイテムの位置まで移動します.
|
|
/// </summary>
|
|
/// <param name="itemIndex">アイテムのインデックス.</param>
|
|
/// <param name="duration">移動にかける秒数.</param>
|
|
/// <param name="alignment">ビューポート内におけるセル位置の基準. 0f(先頭) ~ 1f(末尾).</param>
|
|
/// <param name="onComplete">移動が完了した際に呼び出されるコールバック.</param>
|
|
protected override void ScrollTo(int itemIndex, float duration, float alignment = 0.5f, Action onComplete = null)
|
|
{
|
|
var groupIndex = itemIndex / startAxisCellCount;
|
|
base.ScrollTo(groupIndex, duration, alignment, onComplete);
|
|
}
|
|
|
|
/// <summary>
|
|
/// 指定したアイテムの位置まで移動します.
|
|
/// </summary>
|
|
/// <param name="itemIndex">アイテムのインデックス.</param>
|
|
/// <param name="duration">移動にかける秒数.</param>
|
|
/// <param name="easing">移動に使用するイージング.</param>
|
|
/// <param name="alignment">ビューポート内におけるセル位置の基準. 0f(先頭) ~ 1f(末尾).</param>
|
|
/// <param name="onComplete">移動が完了した際に呼び出されるコールバック.</param>
|
|
protected override void ScrollTo(int itemIndex, float duration, Ease easing, float alignment = 0.5f, Action onComplete = null)
|
|
{
|
|
var groupIndex = itemIndex / startAxisCellCount;
|
|
base.ScrollTo(groupIndex, duration, easing, alignment, onComplete);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// グリッドレイアウトのスクロールビューを実装するための抽象基底クラス.
|
|
/// 無限スクロールおよびスナップには対応していません.
|
|
/// </summary>
|
|
/// <typeparam name="TItemData">アイテムのデータ型.</typeparam>
|
|
/// <seealso cref="FancyGridView{TItemData, TContext}"/>
|
|
public abstract class FancyGridView<TItemData> : FancyGridView<TItemData, FancyGridViewContext> { }
|
|
} |