Merge pull request #8 from CoderGamester/develop

0.3.2

Author: CoderGamester

CHANGELOG.md

@@ -4,6 +4,10 @@ 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.3.2] - 2020-04-18
+
+- Moved interface *IUiService* to a separate file to improve the code readability
+
 ## [0.3.1] - 2020-02-15
 
 - Updated dependency packages

Runtime/IUiService.cs

@@ -0,0 +1,295 @@
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using UnityEngine;
+
+// ReSharper disable CheckNamespace
+
+namespace GameLovers.UiService
+{
+	/// <summary>
+	/// This service provides an abstraction layer to interact with the game's <seealso cref="UiPresenter"/>
+	/// The Ui Service is organized by layers. The higher the layer the more close is to the camera viewport
+	/// </summary>
+	public interface IUiService
+	{
+		/// <summary>
+		/// Requests the <see cref="Canvas"/> of the given <paramref name="layer"/>
+		/// </summary>
+		Canvas GetLayer(int layer);
+		
+		/// <summary>
+		/// Adds the given UI <paramref name="config"/> to the service
+		/// </summary>
+		/// <exception cref="ArgumentException">
+		/// Thrown if the service already contains the given <paramref name="config"/>
+		/// </exception>
+		void AddUiConfig(UiConfig config);
+		
+		/// <summary>
+		/// Adds the given <paramref name="uiPresenter"/> to the service and to be included inside the given <paramref name="layer"/>.
+		/// If the given <paramref name="openAfter"/> is true, will open the <see cref="UiPresenter"/> after adding it to the service
+		/// </summary>
+		/// <exception cref="ArgumentException">
+		/// Thrown if the service already contains the given <paramref name="uiPresenter"/>
+		/// </exception>
+		void AddUi<T>(T uiPresenter, int layer, bool openAfter = false) where T : UiPresenter;
+		
+		/// <summary>
+		/// Removes and returns the UI of the given type <typeparamref name="T"/> without unloading it from the service
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain an <see cref="UiPresenter"/> of the given type <typeparamref name="T"/>
+		/// </exception>
+		T RemoveUi<T>() where T : UiPresenter;
+
+		/// <summary>
+		/// Removes and returns the UI of the given <paramref name="type"/> without unloading it from the service
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain an <see cref="UiPresenter"/> of the given <paramref name="type"/>
+		/// </exception>
+		UiPresenter RemoveUi(Type type);
+
+		/// <summary>
+		/// Removes and returns the given <paramref name="uiPresenter"/> without unloading it from the service
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain an <see cref="UiPresenter"/>
+		/// </exception>
+		T RemoveUi<T>(T uiPresenter) where T : UiPresenter;
+		
+		/// <summary>
+		/// Loads an UI asynchronously with the given <typeparamref name="T"/>.
+		/// This method can be controlled in an async method and returns the UI loaded.
+		/// If the given <paramref name="openAfter"/> is true, will open the <see cref="UiPresenter"/> after loading
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain a <see cref="UiConfig"/> of the given type <typeparamref name="T"/>.
+		/// You need to call <seealso cref="AddUiConfig"/> or <seealso cref="AddUi{T}"/> or initialize the service first
+		/// </exception>
+		Task<T> LoadUiAsync<T>(bool openAfter = false) where T : UiPresenter;
+		
+		/// <summary>
+		/// Loads an UI asynchronously with the given <paramref name="type"/>.
+		/// This method can be controlled in an async method and returns the UI loaded.
+		/// If the given <paramref name="openAfter"/> is true, will open the <see cref="UiPresenter"/> after loading
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain a <see cref="UiConfig"/> of the given <paramref name="type"/>
+		/// You need to call <seealso cref="AddUiConfig"/> or <seealso cref="AddUi{T}"/> or initialize the service first
+		/// </exception>
+		Task<UiPresenter> LoadUiAsync(Type type, bool openAfter = false);
+		
+		/// <summary>
+		/// Unloads the UI of the given type <typeparamref name="T"/>
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain an <see cref="UiPresenter"/> of the given type <typeparamref name="T"/>
+		/// </exception>
+		void UnloadUi<T>() where T : UiPresenter;
+		
+		/// <summary>
+		/// Unloads the UI of the given <paramref name="type"/>
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain an <see cref="UiPresenter"/> of the given <paramref name="type"/>
+		/// </exception>
+		void UnloadUi(Type type);
+
+		/// <summary>
+		/// Unloads the UI of the given <paramref name="uiPresenter"/>
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain an <see cref="UiPresenter"/> of the given <paramref name="type"/>
+		/// </exception>
+		void UnloadUi<T>(T uiPresenter) where T : UiPresenter;
+		
+		/// <summary>
+		/// Checks if the service contains <seealso cref="UiPresenter"/> of the given <typeparamref name="T"/>
+		/// </summary>
+		bool HasUiPresenter<T>() where T : UiPresenter;
+		
+		/// <summary>
+		/// Checks if the service contains <seealso cref="UiPresenter"/> of the given <paramref name="type"/> is loaded or not 
+		/// </summary>
+		bool HasUiPresenter(Type type);
+		
+		/// <summary>
+		/// Requests the UI of given type <typeparamref name="T"/>
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain an <see cref="UiPresenter"/> of the given <typeparamref name="T"/>
+		/// </exception>
+		T GetUi<T>() where T : UiPresenter;
+		
+		/// <summary>
+		/// Requests the UI of given <paramref name="type"/>
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain an <see cref="UiPresenter"/> of the given <paramref name="type"/>
+		/// </exception>
+		UiPresenter GetUi(Type type);
+
+		/// <summary>
+		/// Requests the list all the visible UIs' <seealso cref="Type"/> on the screen
+		/// </summary>
+		List<Type> GetAllVisibleUi();
+
+		/// <summary>
+		/// Opens and returns the UI of given type <typeparamref name="T"/>
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain an <see cref="UiPresenter"/> of the given <typeparamref name="T"/>
+		/// </exception>
+		T OpenUi<T>() where T : UiPresenter;
+
+		/// <summary>
+		/// Opens and returns the UI of given <paramref name="type"/>
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain an <see cref="UiPresenter"/> of the given <paramref name="type"/>
+		/// </exception>
+		UiPresenter OpenUi(Type type);
+
+		///<inheritdoc cref="OpenUi{T}()"/>
+		/// <remarks>
+		/// It sets the given <paramref name="initialData"/> data BEFORE opening the UI
+		/// </remarks>
+		T OpenUi<T, TData>(TData initialData) 
+			where T : class, IUiPresenterData 
+			where TData : struct;
+
+		///<inheritdoc cref="OpenUi(Type)"/>
+		/// <exception cref="ArgumentException">
+		/// Thrown if the the given <paramref name="type"/> is not of inhereting from <see cref="UiPresenterData{T}"/> class
+		/// </exception>
+		/// <remarks>
+		/// It sets the given <paramref name="initialData"/> data BEFORE opening the UI
+		/// </remarks>
+		UiPresenter OpenUi<TData>(Type type, TData initialData) where TData : struct;
+
+		/// <summary>
+		/// Closes and returns the UI of given type <typeparamref name="T"/>
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain an <see cref="UiPresenter"/> of the given type <typeparamref name="T"/>
+		/// </exception>
+		T CloseUi<T>() where T : UiPresenter;
+
+		/// <summary>
+		/// Closes and returns the UI of given <paramref name="type"/>
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain an <see cref="UiPresenter"/> of the given <paramref name="type"/>
+		/// </exception>
+		UiPresenter CloseUi(Type type);
+
+		/// <summary>
+		/// Closes and returns the same given <paramref name="uiPresenter"/>
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain the given <paramref name="uiPresenter"/>
+		/// </exception>
+		T CloseUi<T>(T uiPresenter) where T : UiPresenter;
+
+		/// <summary>
+		/// Closes all the visible <seealso cref="UiPresenter"/>
+		/// </summary>
+		void CloseAllUi();
+
+		/// <summary>
+		/// Closes all the visible <seealso cref="UiPresenter"/> in the given <paramref name="layer"/>
+		/// </summary>
+		void CloseAllUi(int layer);
+
+		/// <summary>
+		/// Closes all the visible <seealso cref="UiPresenter"/> in front or in the same layer of the given type <typeparamref name="T"/>
+		/// It excludes any visible  <seealso cref="UiPresenter"/> present in layers of the given <paramref name="excludeLayers"/>
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain an <see cref="UiPresenter"/> of the given type <typeparamref name="T"/>
+		/// </exception>
+		void CloseUiAndAllInFront<T>(params int[] excludeLayers) where T : UiPresenter;
+
+		/// <summary>
+		/// Adds the given <paramref name="uiSet"/> to the service
+		/// </summary>
+		/// <exception cref="ArgumentException">
+		/// Thrown if the service already contains the given <paramref name="uiSet"/>
+		/// </exception>
+		void AddUiSet(UiSetConfig uiSet);
+
+		/// <summary>
+		/// Removes and returns all the <see cref="UiPresenter"/> from given <paramref name="setId "/> that are still present in the service
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain an <see cref="UiSetConfig"/> with the given <paramref name="setId"/>.
+		/// You need to add it first by calling <seealso cref="AddUiSet"/>
+		/// </exception>
+		List<UiPresenter> RemoveUiPresentersFromSet(int setId);
+		
+		/// <summary>
+		/// Loads asynchronously all the <see cref="UiPresenter"/> from given <paramref name="setId "/> and have not yet been loaded.
+		/// This method can be controlled in an async method and returns every UI when completes loaded.
+		/// This method can be controlled in a foreach loop and it will return the UIs in a first-load-first-return scheme 
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain an <see cref="UiSetConfig"/> with the given <paramref name="setId"/>.
+		/// You need to add it first by calling <seealso cref="AddUiSet"/>
+		/// </exception>
+		Task<Task<UiPresenter>>[] LoadUiSetAsync(int setId);
+
+		/// <summary>
+		/// Unloads all the <see cref="UiPresenter"/> from given <paramref name="setId "/> that are still present in the service
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain an <see cref="UiSetConfig"/> with the given <paramref name="setId"/>.
+		/// You need to add it first by calling <seealso cref="AddUiSet"/>
+		/// </exception>
+		void UnloadUiSet(int setId);
+
+		/// <summary>
+		/// Checks if the service contains or not the <seealso cref="UiSetConfig"/> of the given <paramref name="setId"/>
+		/// </summary>
+		bool HasUiSet(int setId);
+
+		/// <summary>
+		/// Checks if the service containers all the <seealso cref="UiPresenter"/> belonging in the given <paramref name="setId"/>
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain an <see cref="UiSetConfig"/> with the given <paramref name="setId"/>.
+		/// You need to add it first by calling <seealso cref="AddUiSet"/>
+		/// </exception>
+		bool HasAllUiPresentersInSet(int setId);
+		
+		/// <summary>
+		/// Requests the <seealso cref="UiSetConfig"/> of given type <paramref name="setId"/>
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain an <see cref="UiSetConfig"/> with the given <paramref name="setId"/>.
+		/// You need to add it first by calling <seealso cref="AddUiSet"/>
+		/// </exception>
+		UiSetConfig GetUiSet(int setId);
+		
+		/// <summary>
+		/// Opens all the <seealso cref="UiPresenter"/> that are part of the given <paramref name="setId"/>
+		/// If the given <paramref name="closeVisibleUi"/> is set to true, will close the currently open <seealso cref="UiPresenter"/>
+		/// that are not part of the given <paramref name="setId"/>
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain an <see cref="UiSetConfig"/> with the given <paramref name="setId"/>.
+		/// You need to add it first by calling <seealso cref="AddUiSet"/>
+		/// </exception>
+		void OpenUiSet(int setId, bool closeVisibleUi);
+		
+		/// <summary>
+		/// Closes all the <seealso cref="UiPresenter"/> that are part of the given <paramref name="setId"/>
+		/// </summary>
+		/// <exception cref="KeyNotFoundException">
+		/// Thrown if the service does NOT contain an <see cref="UiSetConfig"/> with the given <paramref name="setId"/>.
+		/// You need to add it first by calling <seealso cref="AddUiSet"/>
+		/// </exception>
+		void CloseUiSet(int setId);
+	}
+}