Unity UI 自动生成控件引用

对于做UI的同学来说,日常获取界面下各种控件一定是一件很繁琐的事情吧,这个工具可以根据开发者在Editor里的设置,自动生成对应控件引用的代码段。
先从实际案例说起:

图1

Canvas下有一个简单界面(图1),包含了一个标题,一个副标题,一个文本输入框以及一个登陆按钮两个交互控件,现在要做一个登陆功能,用户输入用户名后,点击Login按钮进行登陆。
首先要获得输入框和登录按钮的引用。
整个界面在Hierarchy中层级结构如图2

图2

在Unity里面,最传统的做法当然是通过transform.find 去获得引用。

this.txt_userName = this.transform.find("Center/Login/Background/TxtUsername/InputField/Text");

现在应该很少人会这么干:1、路径容易写错;2、层级结构调整后,路径也要跟着调整。
当然对于那些不屑用Editor的程序员们来说,会更加容易维护。
其实主流的做法应该是通过在Editor拖曳获得引用
在Monobehavior里定义两个私有成员加上[SerializeField]标记:

[SerializeField]
private Text txt_userName;
[SerializeField]
private Button btn_login;

对于[SerializeField]标记成员,Unity会自动序列化,并在Editor里显示,如图:

图3

需要做的就是,将Hierarchy里对应对象拖曳到正确的位置。
但这样还是不够方便,我希望获得控件引用可以完全在Editor下完成,无需经常切换Editor和VS。至此,引入一个UIProperties类,代码如下:

using System.Collections.Generic;
using UnityEngine;

public class UIProperties : MonoBehaviour
{
    public List<string> propNames;

    public List<Object> propValues;

    public T GetComponent<T>(string propName) where T : Component
    {
        GameObject gameObject = this.GetObject(propName) as GameObject;
        if (gameObject != null)
        {
            return gameObject.GetComponent<T>();
        }
        return (T)((object)null);
    }

    public GameObject[] GetGameObjects(params string[] propNames)
    {
        GameObject[] array = new GameObject[propNames.Length];
        for (int i = 0; i < propNames.Length; i++)
        {
            array[i] = this.GetGameObject(propNames[i]);
        }
        return array;
    }

    public T[] GetAllComponent<T>(params string[] propNames) where T : Component
    {
        T[] array = new T[propNames.Length];
        for (int i = 0; i < propNames.Length; i++)
        {
            array[i] = this.GetComponent<T>(propNames[i]);
        }
        return array;
    }

    public Object GetObject(string propName)
    {
        if (this.propNames != null && this.propNames.Contains(propName))
        {
            int index = this.propNames.IndexOf(propName);
            return this.propValues[index];
        }
        UnityEngine.Debug.LogError("找不到属性:" + propName);
        return null;
    }

    public GameObject GetGameObject(string propName)
    {
        return this.GetObject(propName) as GameObject;
    }
}

对应的Editor代码

using UnityEngine;
using System.Collections;
using UnityEditor;
using System.IO;
using System.Text;
using System;
using System.Collections.Generic;
using UnityEngine.UI;

/// <summary>
/// Author:jin
/// </summary>
[CustomEditor(typeof(UIProperties))]
public class UIPropertiesEditor1 : Editor
{
    public override void OnInspectorGUI()
    {
        base.OnInspectorGUI();

        if( GUILayout.Button("Create Templet") )
        {
            UIProperties uiProp = target as UIProperties;
            DialogWindow dWin = ( DialogWindow )EditorWindow.GetWindow(typeof(DialogWindow), true, "复制板");
            StringBuilder templetStr = new StringBuilder();
            StringBuilder declareStr = new StringBuilder();
            StringBuilder contentStr = new StringBuilder();
            declareStr.Append("private UIProperties uiProperties;\n");
            contentStr.Append(" private void InitUIPropertiesWidget()\n{\n");
            contentStr.Append("this.uiProperties = base.gameObject.GetComponent<UIProperties>();\n");
            for( int i = 0; i < uiProp.propNames.Count; i++ )
            {
                string propName = uiProp.propNames[i];
                string typeStr = Utils.ToStringArray(propName, "_")[0];
                string propStr = Utils.ToStringArray(propName, "_")[1];
                if( typeStr.Length > 0 )
                {
                    declareStr.AppendFormat("private {0} {1};\n", typeStr, propStr);
                    contentStr.AppendFormat("this.{0} = uiProperties.GetComponent<{1}>(\"{2}\");\n", propStr, typeStr,propName);
                }
            }
            contentStr.Append("}\n");
            templetStr.Append("//----Init UIPropertiesWidget Start\n");
            templetStr.Append(declareStr).Append(contentStr);
            templetStr.Append("//----Init UIPropertiesWidget End\n");
            dWin.templetStr = templetStr.ToString();
        }
    }
}

把它挂到LoginView的GameObject下,如图

图4

在PromNames 的Element里填写:Text_txtUserName,Button_btnLogin
然后将对应的GameObject拖曳到PropValues。点击Create Templet,生成如图所示

图5

复制里面的代码到你的界面Component里

//----Init UIPropertiesWidget Start
private UIProperties uiProperties;
private Text txtUserName;
private Button btnLogin;
private void InitUIPropertiesWidget()
{
    this.uiProperties = base.gameObject.GetComponent<UIProperties>();
    this.txtUserName = uiProperties.GetComponent<Text>("Text_txtUserName");
    this.btnLogin = uiProperties.GetComponent<Button>("Button_btnLogin");
}
//----Init UIPropertiesWidget End

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容