Add migration path for FontIconSelector

Author: keveleigh

org.mixedrealitytoolkit.uxcore/FontIcons/FontIconSelector.cs

@@ -1,7 +1,7 @@
 // Copyright (c) Mixed Reality Toolkit Contributors
 // Licensed under the BSD 3-Clause
 
-using System;
+using System.Collections.Generic;
 using TMPro;
 using UnityEngine;
 
@@ -11,7 +11,7 @@ namespace MixedReality.Toolkit.UX
     /// Allows the user to select a specific icon for display via a Unity text component.
     /// </summary>
     [AddComponentMenu("MRTK/UX/Font Icon Selector")]
-    public class FontIconSelector : MonoBehaviour
+    public class FontIconSelector : MonoBehaviour, ISerializationCallbackReceiver
     {
         [Tooltip("The FontIconSet that contains the icons available for use.")]
         [SerializeField]
@@ -52,6 +52,11 @@ public string CurrentIconName
         /// </summary>
         public TMP_Text TextMeshProComponent => textMeshProComponent;
 
+        // A temporary variable used to migrate instances of FontIconSelector to use new FontIconSetDefinition names.
+        // TODO: Remove this after some time to ensure users have successfully migrated.
+        [SerializeField, HideInInspector]
+        private bool migratedSuccessfully = false;
+
         /// <summary>
         /// A Unity event function that is called when an enabled script instance is being loaded.
         /// </summary>
@@ -83,12 +88,32 @@ private void OnValidate()
 
         private void SetIcon(string newIconName)
         {
-            if (fontIcons != null && textMeshProComponent != null)
+            if (fontIcons != null && textMeshProComponent != null && fontIcons.TryGetGlyphIcon(newIconName, out uint unicodeValue))
+            {
+                currentIconName = newIconName;
+                textMeshProComponent.text = FontIconSet.ConvertUnicodeToHexString(unicodeValue);
+            }
+        }
+
+        void ISerializationCallbackReceiver.OnBeforeSerialize() { }
+
+        void ISerializationCallbackReceiver.OnAfterDeserialize()
+        {
+            if (!migratedSuccessfully && fontIcons != null && fontIcons.FontIconSetDefinition != null && textMeshProComponent != null)
             {
-                if (fontIcons.TryGetGlyphIcon(newIconName, out uint unicodeValue))
+                uint unicodeValue = FontIconSet.ConvertHexStringToUnicode(textMeshProComponent.text);
+                foreach (KeyValuePair<string, uint> kv in fontIcons.GlyphIconsByName)
                 {
-                    currentIconName = newIconName;
-                    textMeshProComponent.text = FontIconSet.ConvertUnicodeToHexString(unicodeValue);
+                    if (kv.Value == unicodeValue)
+                    {
+                        if (currentIconName != kv.Key)
+                        {
+                            Debug.Log($"[{nameof(FontIconSelector)}] Successfully migrated icon: \"{currentIconName}\" to \"{kv.Key}\"", this);
+                            currentIconName = kv.Key;
+                            migratedSuccessfully = true;
+                        }
+                        break;
+                    }
                 }
             }
         }