Adjust project structure

Author: Mogoson

README.md

@@ -1,3 +1,5 @@
+[TOC]
+
 # MGS.ObjectPool
 
 ## Summary
@@ -54,12 +56,12 @@
   {
       public void Reset()
       {
-          //Reset the object.
+          //TODO: Reset the object.
       }
 
       public void Dispose()
       {
-          //Dispose the object.
+          //TODO: Dispose the object.
       }
   }
 

UnityProject/Assets/MGS.Packages/Common/Plugins/MGS.DesignPattern.dll

@@ -0,0 +1,117 @@
+[TOC]
+
+# MGS.DesignPattern.dll
+
+## Summary
+
+- Design pattern code for C# project develop.
+
+## Environment
+
+- .Net Framework 3.5 or above.
+
+## Dependence
+
+- System.dll
+
+## Demand
+
+- Provide a single instance of the specified type T.
+- Generic object pool.
+
+## Implemented
+
+### ObjectPool
+
+```C#
+/// <summary>
+/// Generic object pool.
+/// </summary>
+/// <typeparam name="T">Specified type of object.</typeparam>
+public abstract class ObjectPool<T>{}
+
+/// <summary>
+/// Generic object pool.
+/// </summary>
+public class GenericPool<T> : ObjectPool<T> where T : IResettable, new()
+```
+
+### Singleton
+
+```C#
+/// <summary>
+/// Provide a single instance of the specified type T;
+/// Inheritance class should with the sealed access modifier
+/// and a private parameterless constructor to ensure singleton.
+/// </summary>
+/// <typeparam name="T">Specified type.</typeparam>
+public abstract class Singleton<T> where T : class{}
+
+/// <summary>
+/// Provide a single instance with a timer to tick update for the specified type T;
+/// Inheritance class should with the sealed access modifier
+/// and a private parameterless constructor to ensure singleton.
+/// </summary>
+/// <typeparam name="T">Specified type.</typeparam>
+public abstract class SingleTimer<T> : Singleton<T> where T : class{}
+```
+
+## Usage
+
+### ObjectPool
+
+```C#
+//Implement custom object.
+public class CustomObject : IResettable
+{
+    public void Reset()
+    {
+        //TODO: Reset the object.
+    }
+
+    public void Dispose()
+    {
+        //TODO: Dispose the object.
+    }
+}
+
+//Use GenericPool in your class.
+public class TestCase
+{
+    public TestCase()
+    {
+        //Create pool for CustomObject.
+        var pool = new GenericPool<CustomObject>();
+
+        //Take a instance of CustomObject from pool.
+        var obj = pool.Take();
+
+        //Recycle object to pool if we do not need it.
+        pool.Recycle(obj);
+    }
+}
+```
+
+### Singleton
+
+```C#
+//Custom classs with a single instance.
+public sealed class TestSingleton : Singleton<TestSingleton>
+{
+    public string testField = "Test Field";
+
+    //Private parameterless constructor to ensure singleton.
+    private TestSingleton() { }
+}
+
+//Use Instance to accessing fields, properties and methods. 
+var testInfo = TestSingleton.Instance.testField;
+```
+
+------
+
+[Previous](../../README.md)
+
+------
+
+Copyright © 2021 Mogoson.	mogoson@outlook.com

UnityProject/Assets/MGS.Packages/Common/Plugins/MGS.DesignPattern.md

@@ -0,0 +1,131 @@
+[TOC]
+
+# MGS.UDesignPattern.dll
+
+## Summary
+
+- Design pattern code for Unity project develop.
+
+## Environment
+
+- Unity 5.0 or above.
+- .Net Framework 3.5 or above.
+
+## Dependence
+
+- System.dll
+- UnityEngine.dll
+- MGS.Logger.dll
+- MGS.DesignPattern.dll
+
+## Demand
+
+- Provide a single instance of the specified MonoBehaviour.
+- Generic game object pool.
+
+## Implemented
+
+### ObjectPool
+
+```C#
+/// <summary>
+/// Pool of gameobject.
+/// </summary>
+public class GOPool : ObjectPool<GameObject>{}
+
+/// <summary>
+/// Manager of gameobject pool.
+/// </summary>
+public sealed class GOPoolManager : Singleton<GOPoolManager>
+```
+
+### Singleton
+
+```C#
+/// <summary>
+/// Generic base class for single Component.
+/// Inheritance class should with the sealed access modifier to ensure distinct singleton.
+/// </summary>
+[DisallowMultipleComponent]
+public abstract class SingleComponent<T> : MonoBehaviour where T : Component{}
+
+/// <summary>
+/// Generic single behaviour.
+/// Auto create the generic instance, do not add this component to any GameObject by yourself.
+/// </summary>
+public sealed class SingleBehaviour : SingleComponent<SingleBehaviour>{}
+```
+
+## Usage
+
+### ObjectPool
+1. Create game object pool.
+
+   ```c#
+   //The prefab as template of reusable game object.
+   var pool = GOPoolManager.Instance.CreatePool(poolName, prefab);
+   ```
+
+1. Use pool to Take, Recycle game object.
+
+   ```C#
+   //Use pool name to find the instance of pool from manager if we do not hold it.
+   var pool = GOPoolManager.Instance.FindPool(poolName);
+   
+   //Take a game object same as prefab.
+   var go = pool.Take();
+   
+   //Recycle the game object to pool if we do not need it.
+   pool.Recycle(go);
+   
+   //Take a game object and get or add component.
+   var cpnt = pool.Take<Bullet>();
+   
+   //Recycle the game object of component to pool if we do not need it.
+   pool.Recycle(cpnt);
+   ```
+
+### Singleton
+
+- SingleComponent
+
+  ```C#
+  //Derived custom single component.
+  //Inheritance class should with the sealed access modifier to ensure distinct singleton.
+  public sealed class UIManager : SingleComponent<UIManager>
+  {
+      private void Start()
+      {
+          //TODO:
+      }
+  
+      public RectTransfrom FindUI(string name)
+      {
+          //TODO:
+      }
+  }
+  
+  //Use Instance to accessing fields, properties and methods. 
+  var ui = UIManager.Instance.FindUI("UI_Help");
+  ```
+
+- SingleBehaviour
+
+  ```C#
+  //Use the properties and methods inherit from MonoBehaviour.
+  SingleBehaviour.Instance.StartCoroutine(routine);
+  
+  //Use the extended events.
+  SingleBehaviour.Instance.OnApplicationQuitEvent += () =>
+  {
+      //TODO:
+  };
+  ```
+
+------
+
+[Previous](../../README.md)
+
+------
+
+Copyright © 2021 Mogoson.	mogoson@outlook.com