Merge pull request #16 from CoderGamester/develop

Release 0.8.0

Author: CoderGamester

CHANGELOG.md

@@ -4,6 +4,22 @@ All notable changes to this package will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html)
 
+## [0.8.0] - 2024-10-29
+
+- Added new *PresenterDelayerBase*, *AnimationDelayer* and *TimeDelayer* to support presenters that open/close with a delay
+- Added new *DelayUiPresenter* to interact with *PresenterDelayerBase* implementations and allow presenters to open/close with a delay
+- Improved performance of *UiService*
+
+***Changed**:
+- Removed *AnimatedUiPresenter*. Use the new *DelayUiPresenter* with one of the *PresenterDelayerBase* implementations
+- Removed *UiCloseActivePresenter*  and *UiCloseActivePresenterData*. Use the new *DelayUiPresenter* with one of the *PresenterDelayerBase* implementations
+- Removed the dependency of *UiPresenter* from Canvas. Allowing different structures of UI Unity project hierarchy to work with the *UiService*
+- Removed all Get and Has methods from *IUiService*. Replaced with IReadOnlyDictionaries for all the collections being requested from the service
+- Changed all OpenUi methods to be async. This guarantees the expected behaviour that will always load the Ui first before opening
+- Changed all CloseUi methods to be synchronous. Closing an Ui will now always be atomic. To get the close delay, you can request directly from the *DelayUiPresenter*
+- Changed *IUiAssetLoader* to unify the prefab instantiation into a single call. This simplefies the method so the caller doesn't have to worry about synchronous or async behaviour
+- Changed the *UiConfig* to know contain the information of the *UiPresenter* if is loaded sync or async
+
 ## [0.7.2] - 2021-05-09
 
 **Fixed**:

Editor/NonDrawingViewEditor.cs

@@ -5,7 +5,7 @@
 
 // ReSharper disable once CheckNamespace
 
-namespace FirstLightEditor.UiService
+namespace GameLoversEditor.UiService
 {
 	/// <summary>
 	/// <see cref="NonDrawingView"/> custom inspector

Editor/UiConfigsEditor.cs

@@ -55,30 +55,31 @@ public abstract class UiConfigsEditor<TSet> : Editor
 		private readonly List<string> _assetsPath = new List<string>();
 		private readonly List<string> _uiConfigsType = new List<string>();
 		private readonly List<ReorderableList> _setsConfigsList = new List<ReorderableList>();
-		private readonly GUIContent _uiConfigGuiContent = new GUIContent("Ui Config", 
+		private readonly GUIContent _uiConfigGuiContent = new GUIContent("Ui Config",
 			"All the Addressable addresses for every UiPresenter in the game.\n" +
 			"The second field is the layer where the UiPresenter should be shown. " +
 			"The higher the value, the closer is the UiPresenter to the camera.\n" +
 			"If the UiPresenter contains a Canvas in the root, the layer value is the same of the Canvas sorting order");
-		private readonly GUIContent _uiSetConfigGuiContent = new GUIContent("Ui Set", 
+		private readonly GUIContent _uiSetConfigGuiContent = new GUIContent("Ui Set",
 			"All the Ui Sets in the game.\n" +
 			"A UiSet groups a list of UiConfigs and shows them all at the same time via the UiService.\n" +
 			"The UiConfigs are all loaded in the order they are configured. Top = first; Bottom = Last");
-		
+
 		private string[] _uiConfigsAddress;
 		private SerializedProperty _configsProperty;
 		private SerializedProperty _setsProperty;
 		private ReorderableList _configList;
 		private ReorderableList _setList;
 		private bool _resetValues;
-		
+		private UiConfigs _scriptableObject;
+
 		private void OnEnable()
 		{
 			_resetValues = false;
-			
+
 			InitConfigValues();
 			InitReorderableLists();
-			
+
 			_setList.drawHeaderCallback = rect => EditorGUI.LabelField(rect, $"Ui {nameof(UiConfigs.Sets)}");
 			_setList.elementHeightCallback = index => _setsConfigsList[index].GetHeight();
 			_setList.drawElementCallback = (rect, index, active, focused) => _setsConfigsList[index].DoList(rect);
@@ -90,14 +91,17 @@ private void OnEnable()
 		public override void OnInspectorGUI()
 		{
 			serializedObject.Update();
-			
+
+			LoadingSpinnerLayout();
+
+			EditorGUILayout.Space();
 			EditorGUILayout.HelpBox(_uiConfigGuiContent.tooltip, MessageType.Info);
 			_configList.DoLayoutList();
 			EditorGUILayout.LabelField("", GUI.skin.horizontalSlider);
 			EditorGUILayout.Space();
 			EditorGUILayout.HelpBox(_uiSetConfigGuiContent.tooltip, MessageType.Info);
 			_setList.DoLayoutList();
-			
+
 			serializedObject.ApplyModifiedProperties();
 
 			if (_resetValues)
@@ -106,67 +110,94 @@ public override void OnInspectorGUI()
 			}
 		}
 
+		private void LoadingSpinnerLayout()
+		{
+			var uiPresentersNames = new List<string> { "<None>" };
+			var uiPresentersAssemblyNames = new List<string> { "<None>" };
+
+			foreach (var uiConfig in _scriptableObject.Configs)
+			{
+				uiPresentersNames.Add(uiConfig.UiType.Name);
+				uiPresentersAssemblyNames.Add(uiConfig.UiType.AssemblyQualifiedName);
+			}
+
+			var selectedIndex = 0;
+			if (_scriptableObject.LoadingSpinnerType != null)
+			{
+				selectedIndex = uiPresentersAssemblyNames.FindIndex(uiPresenterName =>
+																		_scriptableObject.LoadingSpinnerTypeString ==
+																		uiPresenterName);
+				selectedIndex = Math.Max(selectedIndex, 0);
+			}
+
+			selectedIndex = EditorGUILayout.Popup("Loading Spinner Presenter", selectedIndex, uiPresentersNames.ToArray());
+			_scriptableObject.LoadingSpinnerTypeString =
+				selectedIndex == 0 ? null : uiPresentersAssemblyNames[selectedIndex];
+		}
+
 		private void InitConfigValues()
 		{
 			var assetList = GetAssetList();
 			var gameObjectType = typeof(GameObject);
 			var uiConfigsAddress = new List<string>();
 			var configs = new List<UiConfig>();
-			var scriptableObject = target as UiConfigs;
-			
+			_scriptableObject = target as UiConfigs;
+
 			_uiConfigsType.Clear();
 			_assetsPath.Clear();
 
-			if (scriptableObject == null)
+			if (_scriptableObject == null)
 			{
 				throw new NullReferenceException($"The Object is not of type {nameof(UiConfigs)}");
 			}
 
-			var configsCache = scriptableObject.Configs;
-			
+			var configsCache = _scriptableObject.Configs;
+
 			for (int i = 0; i < assetList.Count; i++)
 			{
 				var assetAddress = assetList[i].address;
-				
+
 				if (AssetDatabase.GetMainAssetTypeAtPath(assetList[i].AssetPath) != gameObjectType)
 				{
 					continue;
 				}
-					
+
 				var uiPresenter = AssetDatabase.LoadAssetAtPath<UiPresenter>(assetList[i].AssetPath);
 
 				if (uiPresenter == null)
 				{
 					continue;
 				}
-				
+
 				_assetsPath.Add(assetList[i].AssetPath);
 
 				var canvas = uiPresenter.GetComponent<Canvas>();
 				var indexMatch = configsCache.FindIndex(configCheck => configCheck.AddressableAddress == assetAddress);
+				var type = uiPresenter.GetType();
 				var config = new UiConfig
 				{
 					AddressableAddress = assetList[i].address,
 					Layer = canvas == null ? 0 : canvas.sortingOrder,
-					UiType = uiPresenter.GetType()
-					
+					UiType = type,
+					LoadSynchronously = Attribute.IsDefined(type, typeof(LoadSynchronouslyAttribute))
+
 				};
-				
+
 				if (indexMatch > -1)
 				{
 					uiConfigsAddress.Add(config.AddressableAddress);
 					_uiConfigsType.Add(config.UiType.AssemblyQualifiedName);
 
 					config.Layer = canvas == null ? configsCache[indexMatch].Layer : config.Layer;
 				}
-				
+
 				configs.Add(config);
 			}
 
-			scriptableObject.Configs = configs;
+			_scriptableObject.Configs = configs;
 			_uiConfigsAddress = uiConfigsAddress.ToArray();
 
-			EditorUtility.SetDirty(scriptableObject);
+			EditorUtility.SetDirty(_scriptableObject);
 			AssetDatabase.SaveAssets();
 			Resources.UnloadUnusedAssets();
 		}
@@ -180,7 +211,7 @@ private void InitReorderableLists()
 			{
 				throw new NullReferenceException($"The Object is not of type {nameof(UiConfigs)}");
 			}
-			
+
 			scriptableObject.SetSetsSize(Enum.GetNames(typeof(TSet)).Length);
 
 			_configsProperty = serializedObject.FindProperty("_configs");
@@ -191,7 +222,7 @@ private void InitReorderableLists()
 			_setsConfigsList.Clear();
 			_setsConfigsList.Capacity = enumNames.Length;
 			_configList.onChangedCallback = reorderableList => _resetValues = true;
-			
+
 			for (int i = 0; i < enumNames.Length; i++)
 			{
 				var property = _setsProperty.GetArrayElementAtIndex(i).FindPropertyRelative($"{nameof(UiConfigs.UiSetConfigSerializable.UiConfigsType)}");
@@ -205,18 +236,18 @@ private void InitReorderableLists()
 					var serializedProperty = property.GetArrayElementAtIndex(index);
 					var typeIndex = string.IsNullOrEmpty(serializedProperty.stringValue) ?
 						0 : _uiConfigsType.FindIndex(type => type == serializedProperty.stringValue);
-					
+
 					serializedProperty.stringValue = _uiConfigsType[EditorGUI.Popup(rect, typeIndex, _uiConfigsAddress)];
 				};
-				
+
 				_setsConfigsList.Add(list);
 			}
 		}
 
 		private void DrawUiConfigElement(Rect rect, int index, bool isActive, bool isFocused)
 		{
 			const int layerRectWidth = 100;
-			
+
 			var addressRect = new Rect(rect.x, rect.y, rect.width - layerRectWidth - 5, rect.height);
 			var layerRect = new Rect(addressRect.xMax + 5, rect.y, layerRectWidth, rect.height);
 			var arrayElement = _configsProperty.GetArrayElementAtIndex(index);
@@ -233,14 +264,14 @@ private void DrawUiConfigElement(Rect rect, int index, bool isActive, bool isFoc
 			{
 				return;
 			}
-			
+
 			layer.intValue = newLayer;
-				
+
 			var canvas = AssetDatabase.LoadAssetAtPath<GameObject>(_assetsPath[index]).GetComponent<Canvas>();
 			if (canvas != null)
 			{
 				canvas.sortingOrder = newLayer;
-				
+
 				EditorUtility.SetDirty(canvas);
 				AssetDatabase.SaveAssets();
 			}
@@ -252,14 +283,14 @@ private static List<AddressableAssetEntry> GetAssetList()
 		{
 			var assetList = new List<AddressableAssetEntry>();
 			var assetsSettings = AddressableAssetSettingsDefaultObject.Settings;
-			
+
 			foreach (var settingsGroup in assetsSettings.groups)
 			{
 				if (settingsGroup.ReadOnly)
 				{
 					continue;
 				}
-				
+
 				settingsGroup.GatherAllAssets(assetList, true, true, true);
 			}