Unity TextMeshPro 一鍵生成工具

本文參考了這片博客文章，在此基礎上進行優化和改進：

https://blog.csdn.net/akof1314/article/details/80868869

先截張效果圖：

 

TextMeshPro在之前的博客中有介紹：

https://www.cnblogs.com/koshio0219/p/11643268.html

思來想去，這東西還是有些使用不方便的地方，問題的根本還是在於中文字庫太多，雖然縮減為7000簡體字庫或3500簡體字庫可以解決問題。

但無論怎么說，游戲中大量的字其實是沒有用到的，這勢必會造成資源浪費。

於是，接下來的想法也就應運而生——為什不能找到游戲中所有用到的字，只將這些字渲染進紋理圖呢，有新增的字就更新下字庫和紋理圖就好了。

這也就是上面這個工具誕生的最主要原因，它主要為了實現：

 

1.批量查找游戲中Canvas或其他GameObject上的文字內容

2.掃描查找指定路徑下的配置文件中文本內容

3.將這些文本去除重復字符后保存到一個固定的輸出路徑

4.根據輸出的游戲文本內容按照想要生成的TMP字體類型批量一鍵生產和更新

5.隨時批量修改Canvas上的字體資源

 

下面是一些相對具體的思路：

查找Canvas中的文字資源很簡單，只需要遍歷所有的對應組件上的內容就行了：

string newText = "";
foreach (var targetCanvas in targetCanvasList)
{
    TextMeshProUGUI[] textMeshProUGUIs = targetCanvas.GetComponentsInChildren<TextMeshProUGUI>(true);
    foreach (var item in textMeshProUGUIs)
    {
        newText += item.text;
    }
}

對於配置文件，需要在指定的文件夾路徑中查找：

private void FindTextAssets(string textAssetPath)
{
    textAssetList.Clear();
    if (Directory.Exists(textAssetPath))
    {
        DirectoryInfo info = new DirectoryInfo(textAssetPath);
        FileInfo[] files = info.GetFiles("*", SearchOption.AllDirectories);

        for (int i = 0; i < files.Length; i++)
        {
            //去除meat文件
            if (!files[i].Name.EndsWith(".csv.meat"))
            {
                var str = File.ReadAllText(files[i].ToString());
                Debug.Log(str);
                textAssetList.Add(str);
            }
        }
    }
}

對於得到的文字，每次更新時進行字符去重，去空格，去換行：

private string StrCutRepeat(string oriStr)
{
    return string.Join("", oriStr.ToArray().Distinct().ToArray()).Replace("\n", "").Replace(" ", "");
}

上面的需要用到以下命名空間：

using System.IO;
using System.Linq;

每次更新完文本內容需要刷新資源：

AssetDatabase.Refresh();

清理文本資源：

private void ClearTextAsset(string path)
{
    if (File.Exists(path))
    {
        File.WriteAllText(path, "X");
        AssetDatabase.Refresh();
    }
}

 

單個TMP字體紋理的生成功能在插件中已經有了，這里只需要實現選擇控制和按順序批量生產就可以了。

在Updata()中檢測上一個字體資源的生成進度，按百分比顯示，當生成完成時循環生成下一個即可：

private void MyUpdate()
{
    if (m_IsRepaintNeeded)
    {
        m_IsRepaintNeeded = false;
        Repaint();
    }

    // 第一步創建字體渲染數組
    if (m_IsProcessing)
    {
        m_AtlasGenerationProgress = FontEngine.generationProgress;
        m_FontAssetInfos[m_CurGenerateIndex].genPercent = m_AtlasGenerationProgress * 100;

        m_IsRepaintNeeded = true;
    }

    // 是否生成完
    if (m_IsRenderingDone)
    {
        m_IsProcessing = false;
        m_IsRenderingDone = false;

        if (m_IsGenerationCancelled == false)
        {
            // 第二步輸出渲染結果
            UpdateRenderFeedbackWindow();
            // 第三步將渲染數組填充到紋理貼圖（注意，貼圖共享不刪除）
            CreateFontTexture();
            foreach (var asset in m_FontAssetInfos[m_CurGenerateIndex].assets)
            {
                //保存信息到字體資產
                Save_SDF_FontAsset(asset);
            }
            // 最后置空
            m_FontAtlasTexture = null;
        }
        Repaint();
        //開始循環生成下一個資源
        GenerateNext();
    }
    else if (m_LoadFontFaceInMainThread == 1)
    {
        FontEngineError errorCode = FontEngine.LoadFontFace(m_LoadFontFaceInMainThreadFontPath);
        m_LoadFontFaceInMainThread = errorCode == FontEngineError.Success ? 2 : 3;
    }
}

private void GenerateNext()
{
    m_CurGenerateIndex++;
    //判斷是否所有資源序列已經執行完
    if (m_CurGenerateIndex >= m_FontAssetInfos.Count)
    {
        EditorUtility.DisplayDialog("提示", "生成字庫資產成功!", "OK");
        return;
    }

    //判斷資源信息的生成開關是否已經開啟
    var info = m_FontAssetInfos[m_CurGenerateIndex];
    if (!info.toggle)
    {
        GenerateNext();
        return;
    }

    //得到資源路徑下的文件
    m_SourceFontFile = AssetDatabase.LoadAssetAtPath<Font>(info.fontPath);
    //具體生成流程
    GenerateFontAtlasButton();
}

 

批量賦值字體資源：

private void AttachFontAsset()
{
    foreach (var targetCanvas in attachCanvasList)
    {
        TextMeshProUGUI[] textMeshProUGUIs = targetCanvas.GetComponentsInChildren<TextMeshProUGUI>(true);
        foreach (var item in textMeshProUGUIs)
        {
            item.font = tmpFontAsset;
        }
    }
}

 

Editor窗口顯示部分：

 大部分的Editor顯示功能都是非常基礎的，這里記錄下幾個不太常用的功能的實現：

1.顯示需要序列化的屬性，例如要序列化List：

先定義兩個屬性，一個是需要序列化的屬性，另一個是該序列化屬性對應的對象，如下：

[SerializeField]
List<GameObject> targetCanvasList = new List<GameObject>();

SerializedProperty _canvasPropertyt;

在OnEnable()中進行序列化對象的初始化和對應屬性查找賦值：

public void OnEnable()
{
    _serializedObject = new SerializedObject(this);
    _canvasPropertyt = _serializedObject.FindProperty("targetCanvasList");
}

在繪制函數中對序列化對象進行修改更新的檢測，並隨時提交修改，例如：

public void OnGUI()
{
    _serializedObject.Update();

    EditorGUI.BeginChangeCheck();

    EditorGUILayout.PropertyField(_canvasPropertyt, true);

    if (EditorGUI.EndChangeCheck())
        _serializedObject.ApplyModifiedProperties();
}

注意在函數EditorGUILayout.PropertyField中第二個參數一定要賦值為true，不然序列化屬性的子對象無法顯示。

 

2.點擊控制標題——折疊式開關的開啟與關閉：

public void OnGUI()
{
    bShowFontWorld = EditorGUILayout.Foldout(bShowFontWorld, "Font Word", true, EditorStyles.foldoutPreDrop);

    if (bShowFontWorld)
    {
        //折疊開關開啟時需要顯示的內容   
    }
}

函數EditorGUILayout.Foldout會自動在顯示內容左側創建小三角Icon，四個參數意義分別是：

1.控制點擊時是否顯示折疊的內容，為true時顯示折疊內容

2.具體的顯示內容標題

3.控制開關的檢測區域是否包含標題內容區域本身，還是只包含開關Icon部分，為true時全部包含

4.風格設置，這里的風格最好選擇帶有foldout類型的，不然無法自動創建小三角Icon

函數返回當前用戶的操作——是否開啟折疊內容。

 

3.Object拾取器：

tmpFontAsset = (TMP_FontAsset)EditorGUILayout.ObjectField("Font Asset", tmpFontAsset, typeof(TMP_FontAsset),false);

最后一個參數為是否允許拾取場景中的物體，返回的是一個Object對象，需要進行強制類型轉換。