fix: when modifying TextMeshPro vertices, element disapear

close #305
This commit is contained in:
mob-sakai
2025-02-06 18:40:23 +09:00
parent c51b5f34bb
commit 7529a7c4cd
7 changed files with 365 additions and 334 deletions
+1 -152
View File
@@ -1,4 +1,3 @@
using System.Collections.Generic;
using System.Runtime.CompilerServices;
using Coffee.UIEffectInternal;
using UnityEngine;
@@ -6,9 +5,6 @@ using UnityEngine.EventSystems;
using UnityEngine.Profiling;
using UnityEngine.UI;
using UnityEditor;
#if TMP_ENABLE
using TMPro;
#endif
[assembly: InternalsVisibleTo("UIEffect")]
[assembly: InternalsVisibleTo("Coffee.UIEffect.Editor")]
@@ -19,9 +15,6 @@ namespace Coffee.UIEffects
[DisallowMultipleComponent]
public abstract class UIEffectBase : UIBehaviour, IMeshModifier, IMaterialModifier, ICanvasRaycastFilter
{
private static readonly VertexHelper s_VertexHelper = new VertexHelper();
private static Mesh s_Mesh;
private static readonly InternalObjectPool<UIEffectContext> s_ContextPool =
new InternalObjectPool<UIEffectContext>(() => new UIEffectContext(), x => true, x => x.Reset());
@@ -52,15 +45,6 @@ namespace Coffee.UIEffects
protected override void OnEnable()
{
#if TMP_ENABLE
if (graphic is TextMeshProUGUI)
{
_prevLossyScaleY = transform.lossyScale.y;
Canvas.willRenderCanvases += CheckSDFScaleForTMP;
UIExtraCallbacks.onScreenSizeChanged += SetVerticesDirtyForTMP;
}
#endif
UpdateContext(context);
SetMaterialDirty();
SetVerticesDirty();
@@ -68,11 +52,6 @@ namespace Coffee.UIEffects
protected override void OnDisable()
{
#if TMP_ENABLE
Canvas.willRenderCanvases -= CheckSDFScaleForTMP;
UIExtraCallbacks.onScreenSizeChanged -= SetVerticesDirtyForTMP;
#endif
MaterialRepository.Release(ref _material);
SetMaterialDirty();
SetVerticesDirty();
@@ -159,24 +138,10 @@ namespace Coffee.UIEffects
public virtual void SetVerticesDirty()
{
#if TMP_ENABLE
if (graphic is TextMeshProUGUI textMeshProUGUI && textMeshProUGUI.isActiveAndEnabled)
{
if (isActiveAndEnabled)
{
OnTMPChanged(textMeshProUGUI);
}
else if (0 < textMeshProUGUI.textInfo?.meshInfo?.Length
&& 0 < textMeshProUGUI.textInfo.meshInfo[0].vertexCount)
{
textMeshProUGUI.UpdateVertexData();
}
}
else
#endif
if (graphic)
{
graphic.SetVerticesDirty();
GraphicProxy.Find(graphic).SetVerticesDirty(graphic);
#if UNITY_EDITOR
EditorApplication.QueuePlayerLoopUpdate();
#endif
@@ -211,122 +176,6 @@ namespace Coffee.UIEffects
#endif
}
#if TMP_ENABLE
#if UNITY_EDITOR
[InitializeOnLoadMethod]
#else
[RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)]
#endif
private static void InitializeOnLoad()
{
TMPro_EventManager.TEXT_CHANGED_EVENT.Add(obj =>
{
if (obj is TextMeshProUGUI textMeshProUGUI)
{
OnTMPChanged(textMeshProUGUI);
}
});
}
private static void OnTMPChanged(TextMeshProUGUI textMeshProUGUI)
{
if (!textMeshProUGUI.TryGetComponent<UIEffectBase>(out var effect)) return;
if (!effect || !effect.isActiveAndEnabled) return;
if (!s_Mesh)
{
s_Mesh = new Mesh();
s_Mesh.MarkDynamic();
}
var target = effect is UIEffect uiEffect
? uiEffect
: effect is UIEffectReplica parentReplica
? parentReplica.target
: null;
var subMeshes = InternalListPool<TMP_SubMeshUI>.Rent();
var modifiers = InternalListPool<IMeshModifier>.Rent();
textMeshProUGUI.GetComponentsInChildren(subMeshes, 1);
for (var i = 0; i < textMeshProUGUI.textInfo.meshInfo.Length; i++)
{
var meshInfo = textMeshProUGUI.textInfo.meshInfo[i];
s_VertexHelper.Clear();
meshInfo.mesh.CopyTo(s_VertexHelper, meshInfo.vertexCount, meshInfo.vertexCount * 6 / 4);
if (i == 0)
{
textMeshProUGUI.GetComponents(modifiers);
foreach (var modifier in modifiers)
{
modifier.ModifyMesh(s_VertexHelper);
}
s_VertexHelper.FillMesh(s_Mesh);
textMeshProUGUI.canvasRenderer.SetMesh(s_Mesh);
}
else if (i - 1 < subMeshes.Count)
{
var subMeshUI = GetSubMeshUI(subMeshes, meshInfo.material, i - 1);
if (!target || !subMeshUI) break;
var replica = subMeshUI.GetOrAddComponent<UIEffectReplica>();
replica.target = target;
subMeshUI.GetComponents(modifiers);
foreach (var modifier in modifiers)
{
modifier.ModifyMesh(s_VertexHelper);
}
s_VertexHelper.FillMesh(s_Mesh);
replica.ApplyContextToMaterial();
subMeshUI.canvasRenderer.SetMesh(s_Mesh);
}
else
{
break;
}
}
InternalListPool<IMeshModifier>.Return(ref modifiers);
InternalListPool<TMP_SubMeshUI>.Return(ref subMeshes);
s_Mesh.Clear(false);
}
private static TMP_SubMeshUI GetSubMeshUI(List<TMP_SubMeshUI> subMeshes, Material material, int start)
{
var count = subMeshes.Count;
for (var j = 0; j < count; j++)
{
var s = subMeshes[(j + start + count) % count];
if (s.sharedMaterial == material) return s;
}
return null;
}
private void SetVerticesDirtyForTMP()
{
if (graphic && graphic.isActiveAndEnabled)
{
graphic.SetVerticesDirty();
}
}
private void CheckSDFScaleForTMP()
{
var lossyScaleY = transform.lossyScale.y;
if (Mathf.Approximately(_prevLossyScaleY, lossyScaleY)) return;
_prevLossyScaleY = lossyScaleY;
if (graphic is TextMeshProUGUI textMeshProUGUI && graphic.isActiveAndEnabled)
{
OnTMPChanged(textMeshProUGUI);
}
}
private float _prevLossyScaleY;
#endif
public abstract void SetRate(float rate, UIEffectTweener.CullingMask cullingMask);
public abstract bool IsRaycastLocationValid(Vector2 sp, Camera eventCamera);
}
+3 -3
View File
@@ -434,9 +434,9 @@ namespace Coffee.UIEffects
public void ModifyMesh(Graphic graphic, RectTransform transitionRoot, VertexHelper vh, bool canModifyShape)
{
var processor = ContextProcessor.FindProcessor(graphic);
var isText = processor.IsText(graphic);
processor.OnPreModifyMesh(graphic);
var effectProxy = GraphicProxy.Find(graphic);
var isText = effectProxy.IsText(graphic);
effectProxy.OnPreModifyMesh(graphic);
var verts = s_WorkingVertices;
var expandSize = GetExpandSize(canModifyShape);
@@ -1,178 +0,0 @@
using System;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.UI;
#if TMP_ENABLE
using TMPro;
#endif
namespace Coffee.UIEffects
{
public class ContextProcessor
{
private static readonly List<ContextProcessor> s_Processors = new List<ContextProcessor>()
{
new ContextProcessor(),
#if TMP_ENABLE
new TmpContextProcessor(),
#endif
};
public static void RegisterProcessor(ContextProcessor processor)
{
// Register only once.
foreach (var p in s_Processors)
{
if (p.GetType() == processor.GetType()) return;
}
s_Processors.Add(processor);
}
public static ContextProcessor FindProcessor(Graphic graphic)
{
for (var i = s_Processors.Count - 1; i >= 0; i--)
{
var p = s_Processors[i];
if (p.IsValid(graphic)) return p;
}
return null;
}
/// <summary>
/// Check if the graphic is valid for this processor.
/// </summary>
protected virtual bool IsValid(Graphic graphic)
{
return graphic;
}
/// <summary>
/// Check if the graphic is a text.
/// </summary>
public virtual bool IsText(Graphic graphic)
{
return graphic is Text;
}
/// <summary>
/// Called before modifying the mesh.
/// </summary>
public virtual void OnPreModifyMesh(Graphic graphic)
{
UIVertexUtil.onLerpVertex = s_OnLerpVertex;
ShadowUtil.onMarkAsShadow = s_OnMarkAsShadow;
UIEffectContext.onModifyVertex = s_OnModifyVertex;
var canvas = graphic.canvas;
if (canvas)
{
canvas.additionalShaderChannels |= AdditionalCanvasShaderChannels.TexCoord1;
}
}
private static readonly Func<UIVertex, UIVertex, UIVertex, float, UIVertex> s_OnLerpVertex =
null;
private static readonly Func<UIVertex, UIVertex> s_OnMarkAsShadow =
vt =>
{
vt.uv0.z -= 8;
vt.uv0.w -= 8;
return vt;
};
private static readonly Func<UIVertex, Rect, float, float, UIVertex> s_OnModifyVertex =
(vt, uvMask, normalizedX, normalizedY) =>
{
vt.uv0.z = normalizedX;
vt.uv0.w = normalizedY;
vt.uv1 = new Vector4(uvMask.xMin, uvMask.yMin, uvMask.xMax, uvMask.yMax);
return vt;
};
}
#if TMP_ENABLE
internal class TmpContextProcessor : ContextProcessor
{
protected override bool IsValid(Graphic graphic)
{
if (!graphic) return false;
if (graphic is TextMeshProUGUI) return true;
if (graphic is TMP_SubMeshUI sub)
{
// If TMP_SubMeshUI is used for text
return !sub.spriteAsset
|| sub.sharedMaterial != sub.spriteAsset.material;
}
return false;
}
/// <summary>
/// Check if the graphic is a text.
/// </summary>
public override bool IsText(Graphic graphic)
{
return true;
}
/// <summary>
/// Called before modifying the mesh.
/// </summary>
public override void OnPreModifyMesh(Graphic graphic)
{
UIVertexUtil.onLerpVertex = s_OnLerpVertex;
ShadowUtil.onMarkAsShadow = s_OnMarkAsShadow;
UIEffectContext.onModifyVertex = s_OnModifyVertex;
var canvas = graphic.canvas;
if (canvas)
{
canvas.additionalShaderChannels |= AdditionalCanvasShaderChannels.TexCoord2;
}
}
private static readonly Func<UIVertex, UIVertex, UIVertex, float, UIVertex> s_OnLerpVertex =
#if UNITY_2023_2_OR_NEWER
null;
#else
(vt, a, b, t) =>
{
// TMP 3.x uses packed UV
vt.uv1.x = PackUV(Vector2.Lerp(UnpackUV(a.uv1.x), UnpackUV(b.uv1.x), t));
return vt;
static float PackUV(Vector2 input)
{
return (int)(input.x * 511) * 4096 + (int)(input.y * 511);
}
static Vector2 UnpackUV(float input)
{
return new Vector2(input / 4096 / 511, input % 4096 / 511);
}
};
#endif
private static readonly Func<UIVertex, UIVertex> s_OnMarkAsShadow =
vt =>
{
vt.uv1.z -= 8;
vt.uv1.w -= 8;
return vt;
};
private static readonly Func<UIVertex, Rect, float, float, UIVertex> s_OnModifyVertex =
(vt, uvMask, normalizedX, normalizedY) =>
{
vt.uv1.z = normalizedX;
vt.uv1.w = normalizedY;
vt.uv2 = new Vector4(uvMask.xMin, uvMask.yMin, uvMask.xMax, uvMask.yMax);
return vt;
};
}
#endif
}
@@ -0,0 +1,95 @@
using System;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.UI;
namespace Coffee.UIEffects
{
public class GraphicProxy
{
private static readonly List<GraphicProxy> s_Proxies = new List<GraphicProxy>()
{
new GraphicProxy()
};
public static void Register(GraphicProxy proxy)
{
// Register only once.
foreach (var p in s_Proxies)
{
if (p.GetType() == proxy.GetType()) return;
}
s_Proxies.Add(proxy);
}
public static GraphicProxy Find(Graphic graphic)
{
if (!graphic) return null;
for (var i = s_Proxies.Count - 1; i >= 0; i--)
{
var p = s_Proxies[i];
if (p.IsValid(graphic)) return p;
}
return null;
}
/// <summary>
/// Check if the graphic is valid for this proxy.
/// </summary>
protected virtual bool IsValid(Graphic graphic)
{
return graphic;
}
/// <summary>
/// Check if the graphic is a text.
/// </summary>
public virtual bool IsText(Graphic graphic)
{
return graphic is Text;
}
/// <summary>
/// Called before modifying the mesh.
/// </summary>
public virtual void OnPreModifyMesh(Graphic graphic)
{
UIVertexUtil.onLerpVertex = s_OnLerpVertex;
ShadowUtil.onMarkAsShadow = s_OnMarkAsShadow;
UIEffectContext.onModifyVertex = s_OnModifyVertex;
var canvas = graphic.canvas;
if (canvas)
{
canvas.additionalShaderChannels |= AdditionalCanvasShaderChannels.TexCoord1;
}
}
public virtual void SetVerticesDirty(Graphic graphic)
{
}
private static readonly Func<UIVertex, UIVertex, UIVertex, float, UIVertex> s_OnLerpVertex =
null;
private static readonly Func<UIVertex, UIVertex> s_OnMarkAsShadow =
vt =>
{
vt.uv0.z -= 8;
vt.uv0.w -= 8;
return vt;
};
private static readonly Func<UIVertex, Rect, float, float, UIVertex> s_OnModifyVertex =
(vt, uvMask, normalizedX, normalizedY) =>
{
vt.uv0.z = normalizedX;
vt.uv0.w = normalizedY;
vt.uv1 = new Vector4(uvMask.xMin, uvMask.yMin, uvMask.xMax, uvMask.yMax);
return vt;
};
}
}
@@ -1,5 +1,5 @@
fileFormatVersion: 2
guid: 402a2dd4d098a4d708b9f6e7ce0557cd
guid: c6f31259f929a47bf9cbd8f1b921327e
MonoImporter:
externalObjects: {}
serializedVersion: 2
+254
View File
@@ -0,0 +1,254 @@
#if TMP_ENABLE
using System;
using System.Collections.Generic;
using Coffee.UIEffectInternal;
using UnityEditor;
using UnityEngine;
using UnityEngine.UI;
using TMPro;
namespace Coffee.UIEffects
{
internal class TmpProxy : GraphicProxy
{
/// <summary>
/// Check if the graphic is valid for this proxy.
/// </summary>
protected override bool IsValid(Graphic graphic)
{
if (!graphic) return false;
if (graphic is TextMeshProUGUI) return true;
if (graphic is TMP_SubMeshUI sub)
{
// If TMP_SubMeshUI is used for text
return !sub.spriteAsset
|| sub.sharedMaterial != sub.spriteAsset.material;
}
return false;
}
/// <summary>
/// Check if the graphic is a text.
/// </summary>
public override bool IsText(Graphic graphic)
{
return true;
}
/// <summary>
/// Called before modifying the mesh.
/// </summary>
public override void OnPreModifyMesh(Graphic graphic)
{
UIVertexUtil.onLerpVertex = s_OnLerpVertex;
ShadowUtil.onMarkAsShadow = s_OnMarkAsShadow;
UIEffectContext.onModifyVertex = s_OnModifyVertex;
var canvas = graphic.canvas;
if (canvas)
{
canvas.additionalShaderChannels |= AdditionalCanvasShaderChannels.TexCoord2;
}
}
public override void SetVerticesDirty(Graphic graphic)
{
if (graphic is TextMeshProUGUI textMeshProUGUI)
{
s_ChangedInstances.Add(textMeshProUGUI);
}
}
private static readonly Func<UIVertex, UIVertex, UIVertex, float, UIVertex> s_OnLerpVertex =
#if UNITY_2023_2_OR_NEWER
null;
#else
(vt, a, b, t) =>
{
// TMP 3.x uses packed UV
vt.uv1.x = PackUV(Vector2.Lerp(UnpackUV(a.uv1.x), UnpackUV(b.uv1.x), t));
return vt;
static float PackUV(Vector2 input)
{
return (int)(input.x * 511) * 4096 + (int)(input.y * 511);
}
static Vector2 UnpackUV(float input)
{
return new Vector2(input / 4096 / 511, input % 4096 / 511);
}
};
#endif
private static readonly Func<UIVertex, UIVertex> s_OnMarkAsShadow =
vt =>
{
vt.uv1.z -= 8;
vt.uv1.w -= 8;
return vt;
};
private static readonly Func<UIVertex, Rect, float, float, UIVertex> s_OnModifyVertex =
(vt, uvMask, normalizedX, normalizedY) =>
{
vt.uv1.z = normalizedX;
vt.uv1.w = normalizedY;
vt.uv2 = new Vector4(uvMask.xMin, uvMask.yMin, uvMask.xMax, uvMask.yMax);
return vt;
};
private static Mesh s_Mesh;
private static readonly VertexHelper s_VertexHelper = new VertexHelper();
private static readonly HashSet<TextMeshProUGUI> s_ChangedInstances = new HashSet<TextMeshProUGUI>();
private static readonly HashSet<TextMeshProUGUI> s_RegisteredInstances = new HashSet<TextMeshProUGUI>();
private static readonly Dictionary<int, float> s_SdfScaleCache = new Dictionary<int, float>();
#if UNITY_EDITOR
[InitializeOnLoadMethod]
#else
[RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)]
#endif
private static void InitializeOnLoad()
{
Register(new TmpProxy());
// When the text is changed, add it to the changed list
TMPro_EventManager.TEXT_CHANGED_EVENT.Add(obj =>
{
if (obj is TextMeshProUGUI textMeshProUGUI)
{
s_ChangedInstances.Add(textMeshProUGUI);
}
});
UIExtraCallbacks.onBeforeCanvasRebuild += () =>
{
// Check SDF scale (lossyScale.y) change
var toRemove = InternalListPool<TextMeshProUGUI>.Rent();
foreach (var textMeshProUGUI in s_RegisteredInstances)
{
if (textMeshProUGUI)
{
var id = textMeshProUGUI.GetHashCode();
var lossyScaleY = textMeshProUGUI.transform.lossyScale.y;
// If the scale has changed, add to the changed list
if (s_SdfScaleCache.TryGetValue(id, out var prev)
&& !Mathf.Approximately(prev, lossyScaleY))
{
s_ChangedInstances.Add(textMeshProUGUI);
}
// Update the scale cache
s_SdfScaleCache[id] = textMeshProUGUI.transform.lossyScale.y;
}
// Remove destroyed objects later
else if (!ReferenceEquals(textMeshProUGUI, null))
{
toRemove.Add(textMeshProUGUI);
}
}
// Remove destroyed objects
foreach (var textMeshProUGUI in toRemove)
{
s_SdfScaleCache.Remove(textMeshProUGUI.GetHashCode());
s_RegisteredInstances.Remove(textMeshProUGUI);
}
};
// Modify the changed TMP mesh
UIExtraCallbacks.onAfterCanvasRebuild += () =>
{
foreach (var textMeshProUGUI in s_ChangedInstances)
{
if (!textMeshProUGUI || !textMeshProUGUI.isActiveAndEnabled) continue;
ModifyMesh(textMeshProUGUI);
}
s_ChangedInstances.Clear();
};
}
private static void ModifyMesh(TextMeshProUGUI textMeshProUGUI)
{
if (!textMeshProUGUI.TryGetComponent<UIEffectBase>(out var effect)) return;
if (!effect || !effect.isActiveAndEnabled) return;
s_RegisteredInstances.Add(textMeshProUGUI);
if (!s_Mesh)
{
s_Mesh = new Mesh();
s_Mesh.MarkDynamic();
}
var target = effect is UIEffect uiEffect
? uiEffect
: effect is UIEffectReplica parentReplica
? parentReplica.target
: null;
var subMeshes = InternalListPool<TMP_SubMeshUI>.Rent();
var modifiers = InternalListPool<IMeshModifier>.Rent();
textMeshProUGUI.GetComponentsInChildren(subMeshes, 1);
for (var i = 0; i < textMeshProUGUI.textInfo.meshInfo.Length; i++)
{
var meshInfo = textMeshProUGUI.textInfo.meshInfo[i];
s_VertexHelper.Clear();
meshInfo.mesh.CopyTo(s_VertexHelper, meshInfo.vertexCount, meshInfo.vertexCount * 6 / 4);
if (i == 0)
{
textMeshProUGUI.GetComponents(modifiers);
foreach (var modifier in modifiers)
{
modifier.ModifyMesh(s_VertexHelper);
}
s_VertexHelper.FillMesh(s_Mesh);
textMeshProUGUI.canvasRenderer.SetMesh(s_Mesh);
}
else if (i - 1 < subMeshes.Count)
{
var subMeshUI = GetSubMeshUI(subMeshes, meshInfo.material, i - 1);
if (!target || !subMeshUI) break;
var replica = subMeshUI.GetOrAddComponent<UIEffectReplica>();
replica.target = target;
subMeshUI.GetComponents(modifiers);
foreach (var modifier in modifiers)
{
modifier.ModifyMesh(s_VertexHelper);
}
s_VertexHelper.FillMesh(s_Mesh);
replica.ApplyContextToMaterial();
subMeshUI.canvasRenderer.SetMesh(s_Mesh);
}
else
{
break;
}
}
InternalListPool<IMeshModifier>.Return(ref modifiers);
InternalListPool<TMP_SubMeshUI>.Return(ref subMeshes);
s_Mesh.Clear(false);
}
private static TMP_SubMeshUI GetSubMeshUI(List<TMP_SubMeshUI> subMeshes, Material material, int start)
{
var count = subMeshes.Count;
for (var j = 0; j < count; j++)
{
var s = subMeshes[(j + start + count) % count];
if (s.sharedMaterial == material) return s;
}
return null;
}
}
}
#endif
@@ -0,0 +1,11 @@
fileFormatVersion: 2
guid: b2ffc93dc93f34027ad9bfdbfd61caae
MonoImporter:
externalObjects: {}
serializedVersion: 2
defaultReferences: []
executionOrder: 0
icon: {instanceID: 0}
userData:
assetBundleName:
assetBundleVariant: