com.valectric.mooserunner 2.1.21 → 2.1.23

package/Samples~/Demos/MooseRunner.Demo.Support/MessageDisplayManager.cs

@@ -1,291 +1,291 @@
-using UnityEngine;
-using UnityEngine.UI;
-using System.Collections.Generic;
-using System.Diagnostics;
-using System.Reflection;
-using static UnityEngine.EventSystems.EventTrigger;
-using Debug = System.Diagnostics.Debug;
-
-namespace MooseRunner.Internal.Tests
-{
-    /// <summary>
-    /// Manages the display of messages in a persistent UI canvas.
-    /// Messages are displayed in a vertical list and are automatically removed after their lifetime expires.
-    /// </summary>
-    public class MessageDisplayManager : MonoBehaviour
-    {
-        /// <summary>
-        /// The singleton instance of the <see cref="MessageDisplayManager"/>.
-        /// </summary>
-        private static MessageDisplayManager _instance;
-
-        /// <summary>
-        /// Provides global access to the <see cref="MessageDisplayManager"/> instance. 
-        /// Ensures that the manager is created and persists across scenes.
-        /// </summary>
-        public static MessageDisplayManager Instance
-        {
-            get
-            {
-                // If instance exists, return it
-                if (_instance != null) return _instance;
-
-                // 1. Find any existing instance in the scene
-                MessageDisplayManager[] instances = FindObjectsByType<MessageDisplayManager>(FindObjectsSortMode.None);
-                if (instances.Length > 0)
-                {
-                    _instance = instances[0];
-
-                    if (instances.Length > 1)
-                    {
-                        UnityEngine.Debug.LogWarning("Multiple TestRunnerHelper instances found! Using the first one.");
-                        // Optionally, destroy duplicates here
-                        for (int i = 1; i < instances.Length; i++)
-                        {
-                            Destroy(instances[i].gameObject);
-                        }
-                    }
-                    return _instance;
-                }
-
-                // 2. No instance found, instantiate the prefab
-                if (_instance == null)
-                {
-                    GameObject obj = new GameObject("MessageDisplayManager");
-                    _instance = obj.AddComponent<MessageDisplayManager>();
-                    DontDestroyOnLoad(obj); // Ensure it persists across scenes
-                }
-                return _instance;
-            }
-        }
-
-        /// <summary>
-        /// The canvas used to display the message UI.
-        /// </summary>
-        private Canvas _canvas;
-
-        /// <summary>
-        /// The content area within the canvas that holds all displayed messages.
-        /// </summary>
-        private RectTransform _contentArea;
-
-        /// <summary>
-        /// A dictionary that stores active messages, indexed by a unique key derived from the caller's context.
-        /// </summary>
-        private readonly Dictionary<string, MessageEntry> _messages = new Dictionary<string, MessageEntry>();
-
-        /// <summary>
-        /// The default duration (in seconds) for which a message remains visible.
-        /// </summary>
-        private const float MessageLifetime = 10f;
-
-        ///<summary>
-        ///Keeps track of last method
-        /// </summary>
-        private string _lastMethod;
-
-
-        /// <summary>
-        /// Represents a single message entry in the display manager.
-        /// </summary>
-        private class MessageEntry
-        {
-            /// <summary>
-            /// The text content of the message.
-            /// </summary>
-            public string DisplayText;
-
-            /// <summary>
-            /// The remaining lifetime of the message, in seconds.
-            /// </summary>
-            public float RemainingTime;
-
-            /// <summary>
-            /// The UI element used to display the message.
-            /// </summary>
-            public Text UIElement;
-
-            /// <summary>
-            /// Initializes a new instance of the <see cref="MessageEntry"/> class.
-            /// </summary>
-            /// <param name="text">The message text to display.</param>
-            /// <param name="duration">The duration the message should remain visible.</param>
-            /// <param name="uiElement">The UI text element associated with the message.</param>
-            public MessageEntry(string text, float duration, Text uiElement)
-            {
-                DisplayText = text;
-                RemainingTime = duration;
-                UIElement = uiElement;
-            }
-        }
-
-        /// <summary>
-        /// Ensures that the UI elements for displaying messages are created and properly configured.
-        /// </summary>
-        private void EnsureUIExists()
-        {
-            if (_canvas == null)
-            {
-                
-                // Create Canvas
-                _canvas = gameObject.AddComponent<Canvas>();
-                _canvas.renderMode = RenderMode.ScreenSpaceOverlay;
-                DontDestroyOnLoad(gameObject);
-                
-                // Add a Canvas Scaler
-                CanvasScaler scaler = gameObject.AddComponent<CanvasScaler>();
-                scaler.uiScaleMode = CanvasScaler.ScaleMode.ScaleWithScreenSize;
-
-                // Add a Scroll View for Messages
-                GameObject scrollViewObj = new GameObject("ScrollView");
-                scrollViewObj.transform.SetParent(gameObject.transform);
-                RectTransform scrollRectTransform = scrollViewObj.AddComponent<RectTransform>();
-                scrollRectTransform.anchorMin = new Vector2(0, 0);
-                scrollRectTransform.anchorMax = new Vector2(1, 1);
-                scrollRectTransform.sizeDelta = Vector2.zero;
-                scrollRectTransform.offsetMin = new Vector2(10, 10);
-                scrollRectTransform.offsetMax = new Vector2(-10, -10);
-
-                ScrollRect scrollRect = scrollViewObj.AddComponent<ScrollRect>();
-                scrollRect.horizontal = false;
-
-                // Create Content Area
-                GameObject contentObj = new GameObject("Content");
-                contentObj.transform.SetParent(scrollViewObj.transform);
-                _contentArea = contentObj.AddComponent<RectTransform>();
-
-                _contentArea.anchorMin = new Vector2(0, 1);
-                _contentArea.anchorMax = new Vector2(1, 1);
-                _contentArea.pivot = new Vector2(0.5f, 1);
-                _contentArea.sizeDelta = new Vector2(0, 0);
-                _contentArea.offsetMin = new Vector2(0, 0);
-                _contentArea.offsetMax = new Vector2(0, 0);
-
-                scrollRect.content = _contentArea;
-
-                VerticalLayoutGroup layoutGroup = contentObj.AddComponent<VerticalLayoutGroup>();
-                layoutGroup.childAlignment = TextAnchor.UpperCenter;
-                layoutGroup.childScaleWidth = true;
-                layoutGroup.childScaleHeight = true;
-                layoutGroup.childControlWidth = false;
-                layoutGroup.childControlHeight = false;
-                layoutGroup.childForceExpandWidth = false;
-                layoutGroup.childForceExpandHeight = false;
-
-                Mask mask = scrollViewObj.AddComponent<Mask>();
-                mask.showMaskGraphic = false;
-                scrollViewObj.AddComponent<Image>();
-            
-            }
-        }
-
-        /// <summary>
-        /// Displays a message in the UI with an optional duration.
-        /// </summary>
-        /// <param name="message">The message text to display.</param>
-        /// <param name="duration">The duration the message remains visible (in seconds).</param>
-        public void ShowMessage(string message, float duration = MessageLifetime)
-        {
-            EnsureUIExists();
-
-            // Get caller details using reflection
-            StackFrame frame = new StackFrame(1);
-            MethodBase method = frame.GetMethod();
-            string assemblyName = method.Module.Assembly.GetName().Name;
-            string methodKey = $"{assemblyName}.{method.ReflectedType.FullName}.{method.Name}";
-            if(_lastMethod != methodKey)
-            {
-                //Removes any method key which comes back so that they are in right order.
-                if (_messages.ContainsKey(methodKey)){
-                    MessageEntry curr = _messages[methodKey];
-                    Destroy(curr.UIElement.gameObject);
-                    _messages.Remove(methodKey);
-                }
-            }
-            _lastMethod = methodKey;
-
-            if (_messages.ContainsKey(methodKey))
-            {
-                _messages[methodKey].DisplayText = message;
-                _messages[methodKey].RemainingTime = duration;
-            }
-            else
-            {
-                GameObject messageObj = new GameObject("Message");
-                messageObj.transform.SetParent(_contentArea.transform);
-
-                Text messageText = messageObj.AddComponent<Text>();
-                messageText.fontStyle = FontStyle.Normal;
-                messageText.font = Resources.GetBuiltinResource<Font>("LegacyRuntime.ttf");
-                messageText.fontSize = 70;
-                messageText.color = Color.black;
-
-                _messages[methodKey] = new MessageEntry(message, duration, messageText);
-
-                RectTransform rectTransform = messageText.GetComponent<RectTransform>();
-                rectTransform.anchorMin = new Vector2(0, 1);
-                rectTransform.anchorMax = new Vector2(1, 1);
-                rectTransform.pivot = new Vector2(0.5f, 1);
-                rectTransform.sizeDelta = new Vector2(3000, 100);
-                rectTransform.localScale = new Vector3(0.2f, 0.2f, 1);
-            }
-
-            UpdateDisplayedMessages();
-        }
-
-        /// <summary>
-        /// Unity's Update method. Manages message lifetime and removes expired messages.
-        /// </summary>
-        private void Update()
-        {
-            if (_instance == null)
-            {
-                Transform content = gameObject.transform.GetChild(0).GetChild(0);
-                for (int i = content.childCount - 1; i >= 0; i--)
-                {
-                    Destroy(content.GetChild(i).gameObject);
-                }
-
-            }
-            List<string> keysToRemove = new List<string>();
-            bool displayDirty = false;
-
-            foreach (var entry in _messages)
-            {
-                entry.Value.RemainingTime -= Time.unscaledDeltaTime;
-                if (entry.Value.RemainingTime <= 0)
-                {
-                    Destroy(entry.Value.UIElement.gameObject);
-                    keysToRemove.Add(entry.Key);
-                    displayDirty = true;
-                }
-            }
-
-            foreach (var key in keysToRemove)
-            {
-                _messages.Remove(key);
-                displayDirty = true;
-            }
-
-            if (displayDirty)
-            {
-                UpdateDisplayedMessages();
-            }
-        }
-
-        /// <summary>
-        /// Updates the layout and content size of the displayed messages.
-        /// </summary>
-        private void UpdateDisplayedMessages()
-        {
-            float contentHeight = 0;
-            foreach (var entry in _messages.Values)
-            {
-                entry.UIElement.text = entry.DisplayText;
-                contentHeight += entry.UIElement.preferredHeight;
-            }
-
-            _contentArea.sizeDelta = new Vector2(_contentArea.sizeDelta.x, contentHeight);
-        }
-    }
-}
+using UnityEngine;
+using UnityEngine.UI;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Reflection;
+using static UnityEngine.EventSystems.EventTrigger;
+using Debug = System.Diagnostics.Debug;
+
+namespace MooseRunner.Internal.Tests
+{
+    /// <summary>
+    /// Manages the display of messages in a persistent UI canvas.
+    /// Messages are displayed in a vertical list and are automatically removed after their lifetime expires.
+    /// </summary>
+    public class MessageDisplayManager : MonoBehaviour
+    {
+        /// <summary>
+        /// The singleton instance of the <see cref="MessageDisplayManager"/>.
+        /// </summary>
+        private static MessageDisplayManager _instance;
+
+        /// <summary>
+        /// Provides global access to the <see cref="MessageDisplayManager"/> instance. 
+        /// Ensures that the manager is created and persists across scenes.
+        /// </summary>
+        public static MessageDisplayManager Instance
+        {
+            get
+            {
+                // If instance exists, return it
+                if (_instance != null) return _instance;
+
+                // 1. Find any existing instance in the scene
+                MessageDisplayManager[] instances = FindObjectsByType<MessageDisplayManager>(FindObjectsSortMode.None);
+                if (instances.Length > 0)
+                {
+                    _instance = instances[0];
+
+                    if (instances.Length > 1)
+                    {
+                        UnityEngine.Debug.LogWarning("Multiple TestRunnerHelper instances found! Using the first one.");
+                        // Optionally, destroy duplicates here
+                        for (int i = 1; i < instances.Length; i++)
+                        {
+                            Destroy(instances[i].gameObject);
+                        }
+                    }
+                    return _instance;
+                }
+
+                // 2. No instance found, instantiate the prefab
+                if (_instance == null)
+                {
+                    GameObject obj = new GameObject("MessageDisplayManager");
+                    _instance = obj.AddComponent<MessageDisplayManager>();
+                    DontDestroyOnLoad(obj); // Ensure it persists across scenes
+                }
+                return _instance;
+            }
+        }
+
+        /// <summary>
+        /// The canvas used to display the message UI.
+        /// </summary>
+        private Canvas _canvas;
+
+        /// <summary>
+        /// The content area within the canvas that holds all displayed messages.
+        /// </summary>
+        private RectTransform _contentArea;
+
+        /// <summary>
+        /// A dictionary that stores active messages, indexed by a unique key derived from the caller's context.
+        /// </summary>
+        private readonly Dictionary<string, MessageEntry> _messages = new Dictionary<string, MessageEntry>();
+
+        /// <summary>
+        /// The default duration (in seconds) for which a message remains visible.
+        /// </summary>
+        private const float MessageLifetime = 10f;
+
+        ///<summary>
+        ///Keeps track of last method
+        /// </summary>
+        private string _lastMethod;
+
+
+        /// <summary>
+        /// Represents a single message entry in the display manager.
+        /// </summary>
+        private class MessageEntry
+        {
+            /// <summary>
+            /// The text content of the message.
+            /// </summary>
+            public string DisplayText;
+
+            /// <summary>
+            /// The remaining lifetime of the message, in seconds.
+            /// </summary>
+            public float RemainingTime;
+
+            /// <summary>
+            /// The UI element used to display the message.
+            /// </summary>
+            public Text UIElement;
+
+            /// <summary>
+            /// Initializes a new instance of the <see cref="MessageEntry"/> class.
+            /// </summary>
+            /// <param name="text">The message text to display.</param>
+            /// <param name="duration">The duration the message should remain visible.</param>
+            /// <param name="uiElement">The UI text element associated with the message.</param>
+            public MessageEntry(string text, float duration, Text uiElement)
+            {
+                DisplayText = text;
+                RemainingTime = duration;
+                UIElement = uiElement;
+            }
+        }
+
+        /// <summary>
+        /// Ensures that the UI elements for displaying messages are created and properly configured.
+        /// </summary>
+        private void EnsureUIExists()
+        {
+            if (_canvas == null)
+            {
+                
+                // Create Canvas
+                _canvas = gameObject.AddComponent<Canvas>();
+                _canvas.renderMode = RenderMode.ScreenSpaceOverlay;
+                DontDestroyOnLoad(gameObject);
+                
+                // Add a Canvas Scaler
+                CanvasScaler scaler = gameObject.AddComponent<CanvasScaler>();
+                scaler.uiScaleMode = CanvasScaler.ScaleMode.ScaleWithScreenSize;
+
+                // Add a Scroll View for Messages
+                GameObject scrollViewObj = new GameObject("ScrollView");
+                scrollViewObj.transform.SetParent(gameObject.transform);
+                RectTransform scrollRectTransform = scrollViewObj.AddComponent<RectTransform>();
+                scrollRectTransform.anchorMin = new Vector2(0, 0);
+                scrollRectTransform.anchorMax = new Vector2(1, 1);
+                scrollRectTransform.sizeDelta = Vector2.zero;
+                scrollRectTransform.offsetMin = new Vector2(10, 10);
+                scrollRectTransform.offsetMax = new Vector2(-10, -10);
+
+                ScrollRect scrollRect = scrollViewObj.AddComponent<ScrollRect>();
+                scrollRect.horizontal = false;
+
+                // Create Content Area
+                GameObject contentObj = new GameObject("Content");
+                contentObj.transform.SetParent(scrollViewObj.transform);
+                _contentArea = contentObj.AddComponent<RectTransform>();
+
+                _contentArea.anchorMin = new Vector2(0, 1);
+                _contentArea.anchorMax = new Vector2(1, 1);
+                _contentArea.pivot = new Vector2(0.5f, 1);
+                _contentArea.sizeDelta = new Vector2(0, 0);
+                _contentArea.offsetMin = new Vector2(0, 0);
+                _contentArea.offsetMax = new Vector2(0, 0);
+
+                scrollRect.content = _contentArea;
+
+                VerticalLayoutGroup layoutGroup = contentObj.AddComponent<VerticalLayoutGroup>();
+                layoutGroup.childAlignment = TextAnchor.UpperCenter;
+                layoutGroup.childScaleWidth = true;
+                layoutGroup.childScaleHeight = true;
+                layoutGroup.childControlWidth = false;
+                layoutGroup.childControlHeight = false;
+                layoutGroup.childForceExpandWidth = false;
+                layoutGroup.childForceExpandHeight = false;
+
+                Mask mask = scrollViewObj.AddComponent<Mask>();
+                mask.showMaskGraphic = false;
+                scrollViewObj.AddComponent<Image>();
+            
+            }
+        }
+
+        /// <summary>
+        /// Displays a message in the UI with an optional duration.
+        /// </summary>
+        /// <param name="message">The message text to display.</param>
+        /// <param name="duration">The duration the message remains visible (in seconds).</param>
+        public void ShowMessage(string message, float duration = MessageLifetime)
+        {
+            EnsureUIExists();
+
+            // Get caller details using reflection
+            StackFrame frame = new StackFrame(1);
+            MethodBase method = frame.GetMethod();
+            string assemblyName = method.Module.Assembly.GetName().Name;
+            string methodKey = $"{assemblyName}.{method.ReflectedType.FullName}.{method.Name}";
+            if(_lastMethod != methodKey)
+            {
+                //Removes any method key which comes back so that they are in right order.
+                if (_messages.ContainsKey(methodKey)){
+                    MessageEntry curr = _messages[methodKey];
+                    Destroy(curr.UIElement.gameObject);
+                    _messages.Remove(methodKey);
+                }
+            }
+            _lastMethod = methodKey;
+
+            if (_messages.ContainsKey(methodKey))
+            {
+                _messages[methodKey].DisplayText = message;
+                _messages[methodKey].RemainingTime = duration;
+            }
+            else
+            {
+                GameObject messageObj = new GameObject("Message");
+                messageObj.transform.SetParent(_contentArea.transform);
+
+                Text messageText = messageObj.AddComponent<Text>();
+                messageText.fontStyle = FontStyle.Normal;
+                messageText.font = Resources.GetBuiltinResource<Font>("LegacyRuntime.ttf");
+                messageText.fontSize = 70;
+                messageText.color = Color.black;
+
+                _messages[methodKey] = new MessageEntry(message, duration, messageText);
+
+                RectTransform rectTransform = messageText.GetComponent<RectTransform>();
+                rectTransform.anchorMin = new Vector2(0, 1);
+                rectTransform.anchorMax = new Vector2(1, 1);
+                rectTransform.pivot = new Vector2(0.5f, 1);
+                rectTransform.sizeDelta = new Vector2(3000, 100);
+                rectTransform.localScale = new Vector3(0.2f, 0.2f, 1);
+            }
+
+            UpdateDisplayedMessages();
+        }
+
+        /// <summary>
+        /// Unity's Update method. Manages message lifetime and removes expired messages.
+        /// </summary>
+        private void Update()
+        {
+            if (_instance == null)
+            {
+                Transform content = gameObject.transform.GetChild(0).GetChild(0);
+                for (int i = content.childCount - 1; i >= 0; i--)
+                {
+                    Destroy(content.GetChild(i).gameObject);
+                }
+
+            }
+            List<string> keysToRemove = new List<string>();
+            bool displayDirty = false;
+
+            foreach (var entry in _messages)
+            {
+                entry.Value.RemainingTime -= Time.unscaledDeltaTime;
+                if (entry.Value.RemainingTime <= 0)
+                {
+                    Destroy(entry.Value.UIElement.gameObject);
+                    keysToRemove.Add(entry.Key);
+                    displayDirty = true;
+                }
+            }
+
+            foreach (var key in keysToRemove)
+            {
+                _messages.Remove(key);
+                displayDirty = true;
+            }
+
+            if (displayDirty)
+            {
+                UpdateDisplayedMessages();
+            }
+        }
+
+        /// <summary>
+        /// Updates the layout and content size of the displayed messages.
+        /// </summary>
+        private void UpdateDisplayedMessages()
+        {
+            float contentHeight = 0;
+            foreach (var entry in _messages.Values)
+            {
+                entry.UIElement.text = entry.DisplayText;
+                contentHeight += entry.UIElement.preferredHeight;
+            }
+
+            _contentArea.sizeDelta = new Vector2(_contentArea.sizeDelta.x, contentHeight);
+        }
+    }
+}