//----------------------------------------------
// NGUI: Next-Gen UI kit
// Copyright © 2011-2014 Tasharen Entertainment
//----------------------------------------------
using UnityEngine;
using System.Collections.Generic;
/// <summary>
/// All children added to the game object with this script will be repositioned to be on a grid of specified dimensions.
/// If you want the cells to automatically set their scale based on the dimensions of their content, take a look at UITable.
/// </summary>
[AddComponentMenu("NGUI/Interaction/Grid")]
public class UIGrid : UIWidgetContainer
{
public delegate void OnReposition ();
public enum Arrangement
{
Horizontal,
Vertical,
}
public enum Sorting
{
None,
Alphabetic,
Horizontal,
Vertical,
Custom,
}
/// <summary>
/// Type of arrangement -- vertical or horizontal.
/// </summary>
public Arrangement arrangement = Arrangement.Horizontal;
/// <summary>
/// How to sort the grid's elements.
/// </summary>
public Sorting sorting = Sorting.None;
/// <summary>
/// Maximum children per line.
/// If the arrangement is horizontal, this denotes the number of columns.
/// If the arrangement is vertical, this stands for the number of rows.
/// </summary>
public int maxPerLine = 0;
/// <summary>
/// The width of each of the cells.
/// </summary>
public float cellWidth = 200f;
/// <summary>
/// The height of each of the cells.
/// </summary>
public float cellHeight = 200f;
/// <summary>
/// Whether the grid will smoothly animate its children into the correct place.
/// </summary>
public bool animateSmoothly = false;
/// <summary>
/// Whether the children will be sorted alphabetically prior to repositioning.
/// </summary>
[HideInInspector]
[System.Obsolete("Use the 'sorting' property instead")]
public bool sorted = false;
/// <summary>
/// Whether to ignore the disabled children or to treat them as being present.
/// </summary>
public bool hideInactive = true;
/// <summary>
/// Whether the parent container will be notified of the grid's changes.
/// </summary>
public bool keepWithinPanel = false;
/// <summary>
/// Callback triggered when the grid repositions its contents.
/// </summary>
public OnReposition onReposition;
/// <summary>
/// Reposition the children on the next Update().
/// </summary>
public bool repositionNow { set { if (value) { mReposition = true; enabled = true; } } }
protected bool mReposition = false;
protected UIPanel mPanel;
protected bool mInitDone = false;
protected virtual void Init ()
{
mInitDone = true;
mPanel = NGUITools.FindInParents<UIPanel>(gameObject);
}
protected virtual void Start ()
{
if (!mInitDone) Init();
bool smooth = animateSmoothly;
animateSmoothly = false;
Reposition();
animateSmoothly = smooth;
enabled = false;
}
protected virtual void Update ()
{
if (mReposition) Reposition();
enabled = false;
}
static protected int SortByName (Transform a, Transform b) { return string.Compare(a.name, b.name); }
static protected int SortHorizontal (Transform a, Transform b) { return a.localPosition.x.CompareTo(b.localPosition.x); }
static protected int SortVertical (Transform a, Transform b) { return b.localPosition.y.CompareTo(a.localPosition.y); }
/// <summary>
/// Want your own custom sorting logic? Override this function.
/// </summary>
protected virtual void Sort (List<Transform> list) { list.Sort(SortByName); }
/// <summary>
/// Recalculate the position of all elements within the grid, sorting them alphabetically if necessary.
/// </summary>
[ContextMenu("Execute")]
public virtual void Reposition ()
{
if (Application.isPlaying && !mInitDone && NGUITools.GetActive(this))
{
mReposition = true;
return;
}
if (!mInitDone) Init();
mReposition = false;
Transform myTrans = transform;
int x = 0;
int y = 0;
if (sorting != Sorting.None)
{
List
<Transform
> list
= new List
<Transform
>();
for (int i = 0; i < myTrans.childCount; ++i)
{
Transform t = myTrans.GetChild(i);
if (t && (!hideInactive || NGUITools.GetActive(t.gameObject))) list.Add(t);
}
if (sorting == Sorting.Alphabetic) list.Sort(SortByName);
else if (sorting == Sorting.Horizontal) list.Sort(SortHorizontal);
else if (sorting == Sorting.Vertical) list.Sort(SortVertical);
else Sort(list);
for (int i = 0, imax = list.Count; i < imax; ++i)
{
Transform t = list[i];
if (!NGUITools.GetActive(t.gameObject) && hideInactive) continue;
float depth = t.localPosition.z;
Vector3 pos = (arrangement == Arrangement.Horizontal) ?
new Vector3
(cellWidth
* x,
-cellHeight
* y, depth
) : new Vector3
(cellWidth
* y,
-cellHeight
* x, depth
);
if (animateSmoothly && Application.isPlaying)
{
SpringPosition.Begin(t.gameObject, pos, 15f).updateScrollView = true;
}
else t.localPosition = pos;
if (++x >= maxPerLine && maxPerLine > 0)
{
x = 0;
++y;
}
}
}
else
{
for (int i = 0; i < myTrans.childCount; ++i)
{
Transform t = myTrans.GetChild(i);
if (!NGUITools.GetActive(t.gameObject) && hideInactive) continue;
float depth = t.localPosition.z;
Vector3 pos = (arrangement == Arrangement.Horizontal) ?
new Vector3
(cellWidth
* x,
-cellHeight
* y, depth
) : new Vector3
(cellWidth
* y,
-cellHeight
* x, depth
);
if (animateSmoothly && Application.isPlaying)
{
SpringPosition.Begin(t.gameObject, pos, 15f).updateScrollView = true;
}
else t.localPosition = pos;
if (++x >= maxPerLine && maxPerLine > 0)
{
x = 0;
++y;
}
}
}
if (keepWithinPanel && mPanel != null)
mPanel.ConstrainTargetToBounds(myTrans, true);
if (onReposition != null)
onReposition();
}
}
