Unity: UGUI Text扩展: 下划线,颜色渐变等

UGUI默认的文本没有显示下划线,颜色渐变等功能的,可以:

  1. 使用Image来模拟下划线,但对于多行文本的支持有问题.
  2. 使用TextMeshPro来做,但需要制作字体纹理集,如果要使用多种字体,则会更麻烦.
    如果能让UGUI默认Text就支持,则是比较方便的.

代码如下:

using UnityEngine;
using UnityEngine.UI;
using System.Collections.Generic;
using XLua;

    ///<summary>对文本组建的扩展</summary>
    [RequireComponent(typeof(Text)), DisallowMultipleComponent, LuaCallCSharp]
        public class TextExpand : BaseMeshEffect
    {
        [Header("是否使用渐变色")]
        public bool useGradientColor = false;
        [Header("左上颜色,右上颜色,左下颜色,右下颜色")]
        public Color32 gradientColor1 = Color.white;
        public Color32 gradientColor2 = Color.white;
        public Color32 gradientColor3 = Color.white;
        public Color32 gradientColor4 = Color.white;

        [Header("是否开启对齐")]
        public bool useAlign = false;
        [Header("字间距")]
        public float wordSpace = 0;
        [Header("行间距")]
        public float lineSpace = 0;

        [Header("是否显示下划线")]
        public bool useUnderline = false;
        [Header("下划线是否忽略换行符")]
        public bool ignoreBreakSign = true;
        [Header("下划线宽度"), Range(0f, 100f), SerializeField]
        private float _lineHeight = 1.5f;
        private float _lineHeightHalf = 0.75f;
        public float lineHeight
        {
            get { return this._lineHeight; }
            set
            {
                this._lineHeight = value;
                this._lineHeightHalf = value * .5f;
            }
        }
        [Header("行高是否两端扩展,否则向下扩展")]
        public bool lineHeightJustify = true;
        public float lineOffset = 0;
        public Color32 lineColor = Color.white;
        [Header("横线对齐到行的上下中间")]
        public bool lineAlignToMiddle = false;

        [Header("是否使用customLineIndexArray来作为显示线的起止依据,否则是全文字段显示")]
        public bool useCustomLineIndexArray = false;
        public Vector2Int[] customLineIndexArray = new Vector2Int[] { };

        private Text text;
        private UICharInfo[] characters;
        private UILineInfo[] lines;

        private Color[] gradientColors;
        private char[] textChars;

        private List<UIVertex> stream = null;

        // 可视的字符个数
        private int characterCountVisible = 0;

        override protected void Awake()
        {
            this.text = this.GetComponent<Text>();
            if (this.text == null) return;

            text.RegisterDirtyMaterialCallback(OnFontMaterialChanged);
        }
#if UNITY_EDITOR
        override protected void OnEnable()
        {
            this.text = this.GetComponent<Text>();
            text.RegisterDirtyMaterialCallback(OnFontMaterialChanged);
        }
#endif

        private void OnFontMaterialChanged()
        {
            // font纹理发生变化时,在font中注册一个字符
            text.font.RequestCharactersInTexture("*", text.fontSize, text.fontStyle);
        }

        protected override void OnDestroy()
        {
            text.UnregisterDirtyMaterialCallback(OnFontMaterialChanged);
            base.OnDestroy();
        }

        /// 从font纹理中获取指定字符的uv
        private Vector2 GetUnderlineCharUV()
        {
            CharacterInfo info;
            if (text.font.GetCharacterInfo('*', out info, text.fontSize, text.fontStyle))
            {
                return (info.uvBottomLeft + info.uvBottomRight + info.uvTopLeft + info.uvTopRight) * 0.25f;
            }
            Debug.LogWarning("GetCharacterInfo failed");
            return Vector2.zero;
        }

        override public void ModifyMesh(VertexHelper vh)
        {
            if (!IsActive() || (!this.useUnderline && !this.useAlign && !this.useGradientColor))
            {
                return;
            }

            // 当宽或高足够小则不处理
            if (text.rectTransform.rect.size.x <= 0 || text.rectTransform.rect.size.y <= 0) return;

#if UNITY_EDITOR
            _lineHeightHalf = this.lineHeight * .5f;
#endif

            // cachedTextGenerator是当前实际显示出来的相关信息,cachedTextGeneratorForLayout是所有布局信息(包括看不到的)
            this.characters = text.cachedTextGenerator.GetCharactersArray();
            this.lines = text.cachedTextGenerator.GetLinesArray();
            if (this.useUnderline && this.ignoreBreakSign)
            {
                this.textChars = this.text.text.ToCharArray();
            }

            // 使用characterCountVisible来得到真正显示的字符数量.characterCount会额外包含(在宽度不足)时候裁剪掉的(边缘)字符,会导致显示的下划线多一个空白的宽度
            this.characterCountVisible = text.cachedTextGenerator.characterCountVisible;

            /* stream是6个一组(对应三角形索引信息,左上角开始,顺时针)对应1个字(含空白)
                0-1
                 \|
                  2
                0
                |\
                3-2
                数组索引:
                [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, ...]
                对应三角形索引:
                [0, 1, 2, 2, 3, 0, 4, 5, 6, 6,  7,  4,...]
            */
            this.stream = new List<UIVertex>();

            vh.GetUIVertexStream(stream);
            vh.Clear();

            if (this.useAlign || this.useGradientColor)
            {

                var _offi = 0;
                for (int i = 0; i < stream.Count; i += 6) // 单个字符
                {

                    int charIdx = i / 6;

                    var offx = 0f;
                    var offy = 0f;
                    if (this.useAlign)
                    {

                        // 不能直接使用(wordSpace * charIdx)来计算每个字符在间距下的x偏移,
                        // 要判断该字符是否处于换行的第1个字符序列,如果是第1个应该重置为0,
                        // GetCharCursorPos()中在获取每个字符的起始位置时,也会将该偏移减掉.
                        var lineIndex = this.GetCharInLineIndex(charIdx);
                        if (this.lines[lineIndex].startCharIdx == charIdx)
                        {
                            _offi = 0;
                        }

                        offx = this.wordSpace * _offi;
                        offy = this.lineSpace * lineIndex;

                        _offi++;
                    }

                    for (int j = 0; j < 6; j++)
                    {
                        // 渐变色
                        if (this.useGradientColor)
                        {
                            this.SetGradientColors(i, j);
                        }

                        // 间距
                        if (this.useAlign)
                        {
                            this.DoAlign(i, j, offx, offy);
                        }
                    }
                }
            }

            // 添加下划线
            if (useUnderline)
            {
                if (!this.useCustomLineIndexArray)
                {
                    this.DrawAllLinesLine(vh);
                }
                else
                {
                    this.DrawCustomLine(vh);
                }
            }

            vh.AddUIVertexTriangleStream(stream);
        }

        private void SetGradientColors(int i, int j)
        {
            if (gradientColors == null) gradientColors = new Color[6];

            gradientColors[0] = gradientColor1;
            gradientColors[1] = gradientColor2;
            gradientColors[2] = gradientColor4;
            gradientColors[3] = gradientColor4;
            gradientColors[4] = gradientColor3;
            gradientColors[5] = gradientColor1;

            UIVertex uiv = stream[i + j];
            uiv.color = gradientColors[j];
            stream[i + j] = uiv;
        }

        private void DoAlign(int i, int j, float offx, float offy)
        {
            UIVertex uiv = stream[i + j];
            var pos = uiv.position;
            // pos.x += this.wordSpace * _offi;
            // pos.y += this.lineSpace * lineIndex;
            pos.x += offx;
            pos.y += offy;

            uiv.position = pos;
            stream[i + j] = uiv;
        }

        /// 获取一个字符索引所在的行
        private int GetCharInLineIndex(int charIndex)
        {
            var ei = this.lines.Length - 1;
            for (int i = 0; i < ei; i++)
            {
                var line = lines[i];
                if (charIndex >= line.startCharIdx && charIndex < lines[i + 1].startCharIdx) return i;
            }

            // 是否在最后一行
            if (charIndex >= lines[ei].startCharIdx && charIndex < this.characters.Length) return ei;

            return -1;
        }
        // 显示所有下划线
        private void DrawAllLinesLine(VertexHelper vh)
        {
            var uv0 = this.GetUnderlineCharUV();
            for (int i = 0; i < this.lines.Length; i++)
            {
                var line = this.lines[i];
                var endIndex = 0;
                if (i + 1 < this.lines.Length)
                {
                    // 通过下一行的起始索引减1得到这一行最后一个字符索引位置
                    var nextLineStartCharIdx = this.lines[i + 1].startCharIdx;
                    // 与本行的相同,当文本宽度只够容纳一个字的时候,unity会产生一个空行,要排除改行
                    if (nextLineStartCharIdx == this.lines[i].startCharIdx) continue;

                    endIndex = nextLineStartCharIdx - 1;
                }
                else
                {
                    // 最后一行的最后字符索引位置
                    if (this.characterCountVisible == 0) continue;
                    endIndex = this.characterCountVisible - 1;
                }

                var bottomY = this.GetLineBottomY(i);

                var firstCharOff = line.startCharIdx * this.wordSpace;
                this.AddUnderlineVertTriangle(vh, line.startCharIdx, endIndex, firstCharOff, bottomY, uv0);
            }
        }
        // 显示自定义起止点下划线
        private void DrawCustomLine(VertexHelper vh)
        {
            var uv0 = this.GetUnderlineCharUV();
            var charsMaxIndex = this.characterCountVisible - 1;

            var chars = text.text.ToCharArray();

            for (int i = 0; i < this.customLineIndexArray.Length; i++)
            {
                var v2 = this.customLineIndexArray[i];
                var startIndex = v2[0];
                var endIndex = v2[1];

                if (endIndex < startIndex)
                {
                    startIndex = v2[1];
                    endIndex = v2[0];
                }

                if (startIndex < 0) startIndex = 0;
                if (endIndex > charsMaxIndex) endIndex = charsMaxIndex;

                if (startIndex >= this.characterCountVisible) continue;

                var lineIndex0 = this.GetCharInLineIndex(startIndex);
                var lineIndex1 = this.GetCharInLineIndex(endIndex);
                if (lineIndex0 != lineIndex1)
                {
                    // 跨行
                    for (int j = lineIndex0; j <= lineIndex1; j++)
                    {
                        var bottomY = this.GetLineBottomY(j);
                        var lineStartCharIndex = startIndex;
                        var lineEndCharIndex = endIndex;
                        if (j == lineIndex0)
                        {
                            // 第一行,从指定起始字索引到改行末尾字索引(改行末尾索引是下一行的起始索引-1得到)
                            lineEndCharIndex = lines[j + 1].startCharIdx - 1;
                        }
                        else if (j == lineIndex1)
                        {
                            // 最后一行,从改行起始字索引到指定字索引
                            lineStartCharIndex = lines[j].startCharIdx;
                        }
                        else
                        {
                            // 中间行,从改行起始字所以到该行末尾字索引
                            lineStartCharIndex = lines[j].startCharIdx;
                            lineEndCharIndex = lines[j + 1].startCharIdx - 1;
                        }

                        var firstCharOff = lines[j].startCharIdx * this.wordSpace;
                        this.AddUnderlineVertTriangle(vh, lineStartCharIndex, lineEndCharIndex, firstCharOff, bottomY, uv0);
                    }
                }
                else
                {
                    // 在同一行
                    var bottomY = this.GetLineBottomY(lineIndex0);
                    var firstCharOff = lines[lineIndex0].startCharIdx * this.wordSpace;
                    this.AddUnderlineVertTriangle(vh, startIndex, endIndex, firstCharOff, bottomY, uv0);
                }
            }
        }

        private float GetLineBottomY(int lineIndex)
        {
            UILineInfo line = this.lines[lineIndex];
            var bottomY = line.topY - (lineAlignToMiddle ? line.height * .5f : line.height) - lineOffset;
            
            // bottomY是原始大小下的信息,但文本在不同分辨率下会被进一步缩放处理,所以要将比例带入计算
            bottomY /= this.text.pixelsPerUnit;
            
            if (this.useAlign)
            {
                bottomY += lineIndex * this.lineSpace;
            }
            return bottomY;
        }

        private Vector2 GetCharCursorPos(int charIdx, float firstCharOff)
        {
            var charInfo = this.characters[charIdx];
            var cursorPos = charInfo.cursorPos;
            // cursorPos是原始大小下的信息,但文本在不同分辨率下会被进一步缩放处理,所以要将比例带入计算
            cursorPos /= this.text.pixelsPerUnit;

            var rtf = (this.transform as RectTransform);
            if (this.useAlign)
            {
                // 行的第1个字符在DoAlign()中是修正过偏移的,所有后面的所有字符都要相应使用此偏移
                cursorPos.x += this.wordSpace * charIdx - firstCharOff;
            }
            return cursorPos;
        }
        private UIVertex[] underlineUIVertexs = new UIVertex[6];
        private void AddUnderlineVertTriangle(VertexHelper vh, int startIndex, int endIndex, float firstCharOff, float bottomY, Vector2 uv0)
        {
            if (this.ignoreBreakSign && this.textChars[endIndex] == '\n')
            {
                // 跳过换行符
                endIndex--;
            }
            if (endIndex < startIndex) return;

            // 左上
            var pos0 = new Vector3(this.GetCharCursorPos(startIndex, firstCharOff).x, bottomY + (this.lineHeightJustify ? this._lineHeightHalf : 0), 0);

            // 左下, 向下扩展
            var pos1 = new Vector3(pos0.x, pos0.y - this.lineHeight, 0);

            // 右下. charWidth是原始大小下的信息,但文本在不同分辨率下会被进一步缩放处理,所以要将比例带入计算
            var pos2 = new Vector3(this.GetCharCursorPos(endIndex, firstCharOff).x + characters[endIndex].charWidth / this.text.pixelsPerUnit, pos1.y, 0);

            // 右上
            var pos3 = new Vector3(pos2.x, pos0.y, 0);

            // 按照stream存储的规范,构建6个顶点: 左上和右下是2个三角形的重叠, 
            UIVertex vert = UIVertex.simpleVert;
            vert.color = this.lineColor;
            vert.uv0 = uv0;

            vert.position = pos0;
            underlineUIVertexs[0] = vert;
            underlineUIVertexs[3] = vert;

            vert.position = pos1;
            underlineUIVertexs[5] = vert;

            vert.position = pos2;
            underlineUIVertexs[2] = vert;
            underlineUIVertexs[4] = vert;

            vert.position = pos3;
            underlineUIVertexs[1] = vert;

            stream.AddRange(underlineUIVertexs);
        }
    }

部分效果图如下:


image.png

image.png

说明:

  1. 支持多行文本.
  2. 将下划线偏移到文字中部时可形成删除线.
  3. 支持对某个区间添加下划线(通过在customLineIndexArray中添加字的起止索引),需要将富文本标签和换行符也算到长度中.
  4. 在当前文字的顶点和三角形数组中添加额外的下划线顶点和三角形(AddUnderlineVertTriangle()方法),没有增加新的mesh和material等,没有过多额外性能开销.
  5. 但顶点需要一个uv信息,如果直接使用(0,0),(0,1)来做下划线uv的映射,会发现显示出来的是整张font纹理,只能通过font纹理中的某个有效区域(有字符的区域)的uv来给到顶点,这样顶点就能显示出来. 通过RequestCharactersInTexture()在font注册一个自定义字符,而且该字符是不会显示到文本的内容中的,该字符的uv就可以作为下划线顶点的映射(参考https://gist.github.com/QXSoftware/dee6b88041e8c10056e860b98388b2f9)
  6. char和line包含的信息是原始信息,需要将text的pixelsPerUnit(作为除数)带入到这些坐标和宽度的计算中,才能使得在不同分辨率下显示正确(代码第356行,370行,397行).
  7. 理论上可以自行解析富文本,对其增加自定义标签(比如"<u></u>")来达到显示下划线或其它操作(比如间距)等的处理,需要在ModifyMesh()中对每个字的顶点信息做手动处理,进行手动排列等(此处没有进一步制作); 也可以对每个字的三角形做其它处理达到更多效果表现.

转载请注明出处: https://www.jianshu.com/p/1ec514e62606

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