Files
peng-zhihui 06ec2e469e Released.
2022-03-13 06:31:07 +08:00

222 lines
5.0 KiB
C#

namespace UIWidgets
{
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.Events;
using UnityEngine.EventSystems;
using UnityEngine.UI;
/// <summary>
/// Modal helper for UI widgets.
/// <example>modalKey = ModalHelper.Open(this, modalSprite, modalColor);
/// //...
/// ModalHelper.Close(modalKey);</example>
/// </summary>
[RequireComponent(typeof(RectTransform))]
public class ModalHelper : MonoBehaviour, ITemplatable, IPointerClickHandler
{
static readonly Dictionary<int, ModalHelper> Used = new Dictionary<int, ModalHelper>();
static Templates<ModalHelper> Templates = new Templates<ModalHelper>();
static string key = "ModalTemplate";
#if UNITY_2019_3_OR_NEWER
[RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.SubsystemRegistration)]
static void StaticInit()
{
Templates = new Templates<ModalHelper>();
Used.Clear();
key = "ModalTemplate";
}
#endif
bool isTemplate = true;
/// <summary>
/// Gets a value indicating whether this instance is template.
/// </summary>
/// <value><c>true</c> if this instance is template; otherwise, <c>false</c>.</value>
public bool IsTemplate
{
get
{
return isTemplate;
}
set
{
isTemplate = value;
}
}
/// <summary>
/// Gets the name of the template.
/// </summary>
/// <value>The name of the template.</value>
public string TemplateName
{
get;
set;
}
readonly UnityEvent OnClick = new UnityEvent();
/// <summary>
/// Create modal helper with the specified parent, sprite and color.
/// </summary>
/// <param name="parentGameObject">Parent game object.</param>
/// <param name="sprite">Sprite.</param>
/// <param name="color">Color.</param>
/// <param name="onClick">onClick callback</param>
/// <param name="parent">Parent.</param>
/// <returns>Modal helper index</returns>
public static int Open(Component parentGameObject, Sprite sprite = null, Color? color = null, UnityAction onClick = null, RectTransform parent = null)
{
// check if in cache
if (!Templates.Exists(key))
{
Templates.FindTemplates();
CreateTemplate();
}
var modal = Templates.Instance(key);
if (parent == null)
{
parent = UtilitiesUI.FindTopmostCanvas(parentGameObject.transform);
}
modal.gameObject.SetActive(true);
var rt = modal.transform as RectTransform;
rt.SetParent(parent, false);
rt.SetAsLastSibling();
rt.localPosition = Vector3.zero;
rt.sizeDelta = new Vector2(0, 0);
rt.anchorMin = new Vector2(0, 0);
rt.anchorMax = new Vector2(1, 1);
rt.anchoredPosition = new Vector2(0, 0);
var img = modal.GetComponent<Image>();
if (sprite != null)
{
img.sprite = sprite;
}
if (color != null)
{
img.color = (Color)color;
}
modal.OnClick.RemoveAllListeners();
if (onClick != null)
{
modal.OnClick.AddListener(onClick);
}
Used.Add(modal.GetInstanceID(), modal);
return modal.GetInstanceID();
}
/// <summary>
/// Creates the template.
/// </summary>
static void CreateTemplate()
{
var template = new GameObject(key);
var modal = template.AddComponent<ModalHelper>();
template.AddComponent<Image>();
var le = template.AddComponent<LayoutElement>();
le.ignoreLayout = true;
Templates.Add(key, modal);
template.gameObject.SetActive(false);
}
/// <summary>
/// Gets the modal instance.
/// </summary>
/// <returns>The instance.</returns>
/// <param name="index">Index.</param>
public static GameObject GetInstance(int index)
{
return ((Used != null) && Used.ContainsKey(index))
? Used[index].gameObject
: null;
}
/// <summary>
/// Set instance as last sibling.
/// </summary>
/// <param name="index">Instance index.</param>
/// <returns>true if instance exists; otherwise false.</returns>
public static bool SetAsLastSibling(int? index)
{
if (index.HasValue)
{
return SetAsLastSibling(index.Value);
}
return false;
}
/// <summary>
/// Set instance as last sibling.
/// </summary>
/// <param name="index">Instance index.</param>
/// <returns>true if instance exists; otherwise false.</returns>
public static bool SetAsLastSibling(int index)
{
var instance = GetInstance(index);
if (instance != null)
{
instance.transform.SetAsLastSibling();
return true;
}
return false;
}
/// <summary>
/// Close modal helper with the specified index.
/// </summary>
/// <param name="index">Index.</param>
public static void Close(int index)
{
if ((Used != null) && Used.ContainsKey(index))
{
Used[index].OnClick.RemoveAllListeners();
Templates.ToCache(Used[index]);
Used.Remove(index);
}
}
/// <summary>
/// Remove template.
/// </summary>
protected virtual void OnDestroy()
{
Templates.Delete(key);
}
/// <summary>
/// Process the pointer click event.
/// </summary>
/// <param name="eventData">Event data.</param>
public void OnPointerClick(PointerEventData eventData)
{
if (eventData.button != PointerEventData.InputButton.Left)
{
return;
}
OnClick.Invoke();
}
}
}