Editor上での表示不具合修正。開始時の異常値に対応。

Author: coposuke

Scripts/Runtime/TextMeshProGeometryAnimator.cs

@@ -4,7 +4,7 @@
 // https://github.com/coposuke/TextMeshProAnimator
 //
 // ===================================
-
+//#define TMPA_OUTPUT_LOG
 
 using UnityEngine;
 using TMPro;
@@ -38,15 +38,13 @@ public class TextMeshProGeometryAnimator : MonoBehaviour
 	/// ループするかどうか
 	/// </summary>
 	[SerializeField]
-	private bool isLoop = false;
-
+	private bool isLoop = false;
+
 	/// <summary>
 	/// アニメーション中かどうか
 	/// </summary>
-	public bool isAnimating { get { return isPlaying && time < maxTime; } }
-	/// <summary>再生フラグ</summary>
-	private bool isPlaying = false;
-
+	public bool isAnimating { get; private set; } = false;
+
 	/// <summary>
 	/// 文字送りアニメーションデータ
 	/// </summary>
@@ -61,8 +59,8 @@ public class TextMeshProGeometryAnimator : MonoBehaviour
 	/// <summary>アニメーション時間</summary>
 	private float time = 0f;
 	/// <summary>アニメーション最大時間</summary>
-	private float maxTime = 0f;
-
+	private float maxTime = 0f;
+
 	/// <summary>頂点座標のキャッシュ</summary>
 	private Vector3[][] baseVertices = default;
 	/// <summary>頂点カラーのキャッシュ</summary>
@@ -75,29 +73,52 @@ public class TextMeshProGeometryAnimator : MonoBehaviour
 	private int characterCount = 0;
 
 
+	#region Unity Events
 #if UNITY_EDITOR
 	/// <summary>
 	/// Unity Event OnValidate
 	/// </summary>
 	private void OnValidate()
 	{
+		if (Application.isPlaying)
+			return;
+
 		if (this.textComponent == null)
-		{
-			this.textComponent = GetComponent<TMP_Text>();
-		}
+			this.textComponent = GetComponent<TMP_Text>();
+
+		if (this.textComponent == null)
+			return;
 
-		if (!Application.isPlaying)
-			this.time = this.maxTime * this.progress;
+		if (this.gameObject.activeSelf)
+			OnValidateChild();
+	}
 
-		UpdateMaxVisibleCharacters();
-		this.textComponent.ForceMeshUpdate(true);
+	/// <summary>
+	/// OnValidateの再帰メソッド
+	/// </summary>
+	private void OnValidateChild()
+	{
+		if (Application.isPlaying)
+			return;
 
-		UpdateText();
-		UpdateCachedVertex(true);
-		UpdateAnimation();
-	}
+		// シーンロード後およびコンパイル直後はTextInfoが準備できていないので強制更新する
+		this.textComponent.ForceMeshUpdate(true);
+
+		if (!Refresh(true))
+		{
+			// ゲームプレイ終了時はTextInfoが異常値な為,遅らせて処理する
+			UnityEditor.EditorApplication.delayCall += () =>
+			{
+				// ゲームプレイ終了時にDestroyされているケースを回避
+				if (this.textComponent == null)
+					return;
+
+				OnValidateChild();
+			};
+		}
+	}
 #endif
-
+
 	/// <summary>
 	/// Unity Event Awake
 	/// </summary>
@@ -114,10 +135,13 @@ private void OnEnable()
 	{
 		TMPro_EventManager.TEXT_CHANGED_EVENT.Add(OnChangedText);
 
+		// シーンロード時はTextInfoが異常値な為,強制更新する
+		this.textComponent?.ForceMeshUpdate(true);
+
 		if (this.playOnEnable)
 			Play();
 		else
-			Finish();
+			Refresh(true);
 	}
 
 	/// <summary>
@@ -126,60 +150,51 @@ private void OnEnable()
 	private void OnDisable()
 	{
 		TMPro_EventManager.TEXT_CHANGED_EVENT.Remove(OnChangedText);
-
-		Finish();
-	}
-
+	}
+
 	/// <summary>
 	/// Unity Event Update
 	/// </summary>
 	private void Update()
 	{
+		if (this.textComponent == null) { return; }
+		if (!this.textComponent.isActiveAndEnabled) { return; }
 		if (null == animationData) { return; }
-		if (null == textInfo) { return; }
-
-		if (playByProgress)
-		{
-			time = maxTime * progress;
-		}
-		else if (0f < maxTime)
-		{
-			if (!isPlaying) { return; }
-
-			time += Time.deltaTime * animationData.speed;
-
-			if (isLoop)
-			{
-				time += (time < 0f ? maxTime : 0f);
-				time %= maxTime;
-			}
-			else
-			{
-				time = Mathf.Clamp(time, 0f, maxTime);
-			}
-
-#if UNITY_EDITOR
-			progress = time / maxTime;
-#endif
-		}
-
-		UpdateAnimation();
+		if (null == textInfo) { return; }
+
+		if (this.isAnimating || this.playByProgress)
+		{
+			UpdateTime(this.playByProgress, Time.deltaTime);
+			UpdateAnimation();
+
+			if (this.isAnimating)
+			{
+				if ((this.animationData.speed > 0 && this.time >= this.maxTime) ||
+					(this.animationData.speed < 0 && this.time <= 0f))
+				{
+					this.isAnimating = false;
+					Log($"TMPA Stop: {this.textComponent.name}");
+				}
+			}
+		}
 	}
 
 	/// <summary>
 	/// TextMesh Proのtext変更時に呼び出されるメソッドです
 	/// OnEnableとOnDisableにてTMPro_EventManagerに登録しています
 	/// </summary>
-	/// <param name="obj"></param>
 	private void OnChangedText(Object obj)
 	{
 		if (obj == this.textComponent)
 		{
-			UpdateText();
-			UpdateAnimation();
+			Log($"TMPA OnChangedText: {this.textComponent.name}");
+			Refresh(this.playByProgress);
 		}
 	}
+	#endregion
 
+
+	#region For User
 	/// <summary>
 	/// アニメーションデータの上書き設定
 	/// </summary>
@@ -193,32 +208,111 @@ public void SetAnimation(TextMeshProGeometryAnimation animation)
 	/// </summary>
 	public void Play()
 	{
-		this.isPlaying = true;
-		this.time = 0.0f;
-		UpdateText();
-		UpdateAnimation();
+		Log($"TMPA Play: {this.textComponent.name}");
+		this.isAnimating = true;
+		Refresh(true);
 	}
 
 	/// <summary>
 	/// 強制終了
 	/// </summary>
-	public void Finish()
+	public void Finish(float normalizedTime = 0f)
 	{
-		this.isPlaying = false;
-		this.time = this.maxTime;
-		UpdateText();
-		UpdateAnimation();
+		Log($"TMPA Finish: {this.textComponent.name}");
+		this.isAnimating = false;
+		this.time = this.maxTime * normalizedTime;
+		Refresh(false);
+	}
+	#endregion
+
+
+	#region Private Methods
+	private bool Refresh(bool useProgress)
+	{
+		UpdateText();
+
+		if (VerifyTextInfo())
+		{
+			UpdateTime(useProgress, 0f);
+
+			// MaxVisibleCharactersに変動があった場合はForceMeshUpdateでメッシュを更新する必要がある
+			if (UpdateMaxVisibleCharacters())
+			{
+				this.textComponent?.ForceMeshUpdate(true);
+				UpdateCachedVertex(true);
+			}
+
+			UpdateAnimation();
+
+			return true;
+		}
+
+		return false;
+	}
+
+	/// <summary>
+	/// 時間の更新
+	/// </summary>
+	private void UpdateTime(bool useProgress, float elapsedTime)
+	{
+		if (useProgress)
+		{
+			this.time = this.maxTime * this.progress;
+		}
+		else if (0f < this.maxTime)
+		{
+			if (!this.isAnimating) { return; }
+
+			this.time += elapsedTime * this.animationData.speed;
+
+			if (this.isLoop)
+			{
+				this.time += (this.time < 0f ? this.maxTime : 0f);
+				this.time %= this.maxTime;
+			}
+			else
+			{
+				this.time = Mathf.Clamp(this.time, 0f, this.maxTime);
+			}
+		}
+	}
+
+	/// <summary>
+	/// TMPro Textの情報が有効かどうか(主に開始時に異常値が発生する)
+	/// </summary>
+	private bool VerifyTextInfo()
+	{
+		if (this.textComponent == null)
+			return false;
+
+		if (!this.textComponent.isActiveAndEnabled)
+			return false;
+
+		if (this.textInfo == null)
+				return false;
+
+		if (this.textInfo.characterCount <= 0)
+			return false;
+
+		for (int i = 0; i < this.textInfo.materialCount; i++)
+		{
+			if (this.textInfo.meshInfo[i].vertices == null ||
+				this.textInfo.meshInfo[i].colors32 == null)
+				return false;
+		}
+
+		return true;
 	}
 
 	/// <summary>
 	/// TMPro Textの情報更新
 	/// </summary>
 	private void UpdateText()
 	{
-		this.textInfo = textComponent.textInfo;
+		this.textInfo = this.textComponent.textInfo;
 
 		// 各アニメーション要素で、一番時間がかかるものを最大時間として計算
-		maxTime = Mathf.Max(
+		this.maxTime = Mathf.Max(
 			CalcAnimationTotalTime(this.textInfo.characterCount, this.animationData.position),
 			CalcAnimationTotalTime(this.textInfo.characterCount, this.animationData.rotation),
 			CalcAnimationTotalTime(this.textInfo.characterCount, this.animationData.scale),
@@ -235,7 +329,7 @@ private void UpdateText()
 	/// <summary>
 	/// 頂点データのキャッシュ
 	/// </summary>
-	/// <returns>成功判定</returns>
+	/// <returns>成功判定(失敗時は異常なTextInfoである, 主に開始時に発生)</returns>
 	private bool UpdateCachedVertex(bool forceCopy)
 	{
 		if (this.textInfo == null)
@@ -286,10 +380,14 @@ private bool UpdateCachedVertex(bool forceCopy)
 		return true;
 	}
 
-	private bool UpdateMaxVisibleCharacters()
-	{
-		// マーカーや下線等の追加描画物はどうしても描画されてしまうので、
-		// 表示最大数も合わせてアニメーションすることで対応しています。
+	/// <summary>
+	/// MaxVisibleCharactersの更新
+	/// </summary>
+	/// <returns></returns>
+	private bool UpdateMaxVisibleCharacters()
+	{
+		// マーカーや下線等の追加描画物はどうしても描画されてしまうので、
+		// 表示最大数も合わせてアニメーションすることで対応しています。
 		if (this.animationData.useMaxVisibleCharacter)
 		{
 			var visibleCharacters = CalcAnimationCharacterCount(time, this.animationData.alpha);
@@ -298,19 +396,20 @@ private bool UpdateMaxVisibleCharacters()
 				this.textComponent.maxVisibleCharacters = visibleCharacters;
 				return true;
 			}
-		}
-
-		return false;
+		}
+
+		return false;
 	}
 
 	/// <summary>
 	/// TMPro Textの頂点情報の編集
 	/// </summary>
 	private void UpdateAnimation()
 	{
+		// Wave位置(テキストの動き出し)に合わせて,MaxVisibleCharactersの最大値を更新する
 		bool forceCacheCopy = UpdateMaxVisibleCharacters();
-
-		// アニメーション用の頂点キャッシュ更新
+
+		// アニメーション用の頂点キャッシュ更新
 		if (!UpdateCachedVertex(forceCacheCopy))
 			return;
 
@@ -526,4 +625,13 @@ static private int CalcAnimationCharacterCount(float time, TextMeshProGeometryAn
 		if (item.wave <= 0.0f) { return int.MaxValue; }
 		return (int)((time - item.delay) / item.wave) + 1;
 	}
+
+	[System.Diagnostics.Conditional("TMPA_OUTPUT_LOG")]
+	static private void Log(string str)
+	{
+#if TMPA_OUTPUT_LOG
+		Debug.Log(str);
+#endif
+	}
+	#endregion
 }