Merge branch 'WES-127-Refactor-ThemeList' into 'development'

Resolve WES-127-Refactor_Themelist

See merge request wesign/unity-application!69

Assets/Common/Interfaces/ModelIndex.cs

@@ -0,0 +1,11 @@
+using System.Collections;
+using System.Collections.Generic;
+using UnityEngine;
+/// <summary>
+/// This enum is used to identify each of the SignLanguage models
+/// </summary>
+public enum ModelIndex 
+{
+    FINGERSPELLING,
+    NONE
+}

Assets/Common/Interfaces/ModelIndex.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 6dbd5e1100bc81648b52206df369d0a1
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

Assets/Common/Interfaces/ModelList.cs

@@ -0,0 +1,57 @@
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using UnityEngine;
+using Unity.Barracuda;
+/// <summary>
+/// This scriptable will hold tupples of Courseindices and models
+/// </summary>
+[CreateAssetMenu(menuName = "Create new Scriptable/ModelList")]
+public class ModelList : ScriptableObject
+{
+    /// <summary>
+    /// Small class to link a model to a courseIndex irrespective of its position in a list
+    /// </summary>
+    [Serializable]
+    public class ModelTuple
+    {
+        /// <summary>
+        /// ModelIndex to which the model corresponds
+        /// </summary>
+        public ModelIndex index;
+        /// <summary>
+        /// The model itself
+        /// </summary>
+        public NNModel model;
+    }
+
+
+    /// <summary>
+    /// Index of the currently active model
+    /// </summary>
+    public int currentModelIndex = 0;
+
+    /// <summary>
+    /// A list of all the models
+    /// </summary>
+    public List<ModelTuple> models = new List<ModelTuple>();
+
+    /// <summary>
+    /// Get a model by modelindex
+    /// </summary>
+    /// <param name="modelIndex">ModelIndex of the model</param>
+    /// <returns>Model associated with this index, null if no model was found</returns>
+    public NNModel GetCurrentModel()
+    {
+        return models.Find(x => x.model == models[currentModelIndex].model)?.model;
+    }
+
+    /// <summary>
+    /// Function to find a model-index in the list based on its index
+    /// </summary>
+    /// <param name="title"></param>
+    public void SetCurrentModel(ModelIndex index)
+    {
+        currentModelIndex = models.FindIndex((m) => m.index == index);
+    }
+}

Assets/Common/Interfaces/ModelList.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 78a3f61c93a08c04496c49ffd10b9021
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

Assets/Common/Interfaces/Theme.cs

@@ -1,5 +1,4 @@
 using System.Collections.Generic;
-using Unity.Barracuda;
 using UnityEngine;
 
 /// <summary>
@@ -24,9 +23,9 @@ public class Theme : ScriptableObject
     public ThemeIndex index;
 
     /// <summary>
-    /// Reference to the model used in the SignPredictor
+    /// The index of the model you want to use
     /// </summary>
-    public NNModel model;
+    public ModelIndex modelIndex;
 
     /// <summary>
     /// List of all learnable words/letters

Assets/Common/ScriptableObjects/AnimalsTheme.asset

@@ -16,6 +16,7 @@ MonoBehaviour:
   description: Van vis tot leeuw
   index: 2
   model: {fileID: 0}
+  modelIndex: 1
   learnables:
   - name: Walvis
     image: {fileID: 21300000, guid: 2b01165a5836ab14593d7a5862bd6793, type: 3}

Assets/Common/ScriptableObjects/ClothesTheme.asset

@@ -15,6 +15,8 @@ MonoBehaviour:
   title: Kleren en Kleuren
   description: Van rok tot sok
   index: 1
+  model: {fileID: 0}
+  modelIndex: 1
   learnables:
   - name: Blauw
     image: {fileID: 21300000, guid: 182fb89eba9c64041bef31ca35c4bcd8, type: 3}

Assets/Common/ScriptableObjects/FamilyTheme.asset

@@ -15,6 +15,8 @@ MonoBehaviour:
   title: Familie
   description: Van generatie tot generatie
   index: 6
+  model: {fileID: 0}
+  modelIndex: 1
   learnables:
   - name: Broer
     image: {fileID: 21300000, guid: eecf67266f150f1489717049489cf16d, type: 3}

Assets/Common/ScriptableObjects/FoodTheme.asset

@@ -16,6 +16,7 @@ MonoBehaviour:
   description: Van kers tot pompoen
   index: 3
   model: {fileID: 0}
+  modelIndex: 1
   learnables:
   - name: Aardappel
     image: {fileID: 21300000, guid: 2610cdbc24a125f43ada7fed67d8f51b, type: 3}

Assets/Common/ScriptableObjects/HobbyTheme.asset

@@ -15,6 +15,8 @@ MonoBehaviour:
   title: Hobbies
   description: Van schilderen tot reizen
   index: 4
+  model: {fileID: 0}
+  modelIndex: 1
   learnables:
   - name: Dansen
     image: {fileID: 21300000, guid: 6d405f607ae817744b49f921f0611088, type: 3}

Assets/Common/ScriptableObjects/HouseTheme.asset

@@ -15,6 +15,8 @@ MonoBehaviour:
   title: Huis beschrijven
   description: Van zetel tot villa
   index: 5
+  model: {fileID: 0}
+  modelIndex: 1
   learnables:
   - name: Keuken
     image: {fileID: 21300000, guid: b17ce5bf59092b847b084d3400e7a1b4, type: 3}

Assets/Common/Scripts/CourseActivityScreen.cs

@@ -56,8 +56,8 @@ public class CourseActivityScreen : MonoBehaviour
         Course course = courseList.courses[index];
 
         // vvv TEMPORARY STUFF vvv
-        playButton.SetActive(course.theme.model != null);
-        previewButton.SetActive(course.theme.model == null);
+        playButton.SetActive(course.theme.modelIndex != ModelIndex.NONE);
+        previewButton.SetActive(course.theme.modelIndex == ModelIndex.NONE);
         // ^^^ TEMPORARY STUFF ^^^
 
         title.text = course.title;

Assets/Common/Tests/CommonTests.asmdef

@@ -5,7 +5,9 @@
         "UnityEngine.TestRunner",
         "UnityEditor.TestRunner",
         "CommonScripts",
-        "InterfacesScripts"
+        "InterfacesScripts",
+        "Unity.Barracuda",
+        "SignPredictor"
     ],
     "includePlatforms": [
         "Editor"

Assets/Common/Tests/ModelListTest.cs

@@ -0,0 +1,80 @@
+using NUnit.Framework;
+using Unity.Barracuda;
+using UnityEngine;
+/// <summary>
+/// Test the ModelList class
+/// </summary>
+[TestFixture]
+public class ModelListTest
+{
+    private ModelList modelList;
+
+    /// <summary>
+    /// Setup a ModelList with all possible Models in the enum
+    /// </summary>
+    [SetUp]
+    public void Setup_Model()
+    {
+        modelList = ScriptableObject.CreateInstance<ModelList>();
+
+        // Add a Model for each index in the enum
+
+        // Dumb way to access each index in the enum, couldn't find a different way to do it though
+        foreach (var field in typeof(ModelIndex).GetFields())
+        {
+            if (field.IsLiteral)
+            {
+                ModelIndex value = (ModelIndex)field.GetValue(null);
+                string name = field.Name;
+                ModelList.ModelTuple model = new ModelList.ModelTuple();
+                // This is all we will need to distinguish 
+                model.index = value;
+
+                // Insert in front to guarantee that ModelIndex will not line up with listIndex
+                modelList.models.Insert(0, model);
+            }
+        }
+    }
+    /// <summary>
+    /// Check if current model can be correctly gotten as current via GetCurrentModel
+    /// </summary>
+    [Test]
+    public void TestGetCurrentModel()
+    {
+        System.Random random = new System.Random();
+        ModelIndex value = (ModelIndex)random.Next(modelList.models.Count);
+        modelList.SetCurrentModel(value);
+
+        Assert.AreEqual(modelList.models[modelList.currentModelIndex].model, modelList.GetCurrentModel());
+
+        // Check if empty model fails gracefully (returns null)
+        Assert.IsNull(ScriptableObject.CreateInstance<ModelList>().GetCurrentModel());
+    }
+
+    /// <summary>
+    /// Check if all models can be correctly set as current via SetCurrentModel
+    /// </summary>
+    [Test]
+    public void TestSetCurrentModel()
+    {
+        foreach (var field in typeof(ModelIndex).GetFields())
+        {
+            if (field.IsLiteral)
+            {
+                ModelIndex value = (ModelIndex)field.GetValue(null);
+                string name = field.Name;
+                modelList.SetCurrentModel(value);
+
+                // Fetch the current model and check if its name is the same as the one we made into the current one 
+                ModelList.ModelTuple m = modelList.models[modelList.currentModelIndex];
+
+                Assert.AreEqual(m.index, value);
+                Assert.IsTrue(m.model is NNModel || m.model is null);
+            }
+        }
+        ModelList emptyList = ScriptableObject.CreateInstance<ModelList>();
+        emptyList.SetCurrentModel(ModelIndex.FINGERSPELLING);
+
+        Assert.IsTrue(emptyList.currentModelIndex == -1);
+    }
+}

Assets/Common/Tests/ModelListTest.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 1313e0cc80244354eb6e2d0c1e891941
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

Assets/Courses/Scenes/TemplateCourse.unity

@@ -1301,6 +1301,7 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: 043ccd99cf82b3cc9bf2e00956ce2b93, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
+  modelList: {fileID: 11400000, guid: 39516e4e6e56f0f4f80647d9c4d8034c, type: 2}
   model: {fileID: 5022602860645237092, guid: e6d85df707405ad4f97c23b07227ee99, type: 3}
   modelInfoFile: {fileID: 4900000, guid: fb8b51022bdcd654a9f29c054832a1b5, type: 3}
   configAsset: {fileID: 4900000, guid: 6288c43cdca97374782dac1ea87aa029, type: 3}

Assets/Courses/Scripts/TemplateCourse.cs

@@ -128,13 +128,14 @@ public class TemplateCourse : MonoBehaviour
     {
         // Setting up course
         course = courselist.courses[courselist.currentCourseIndex];
-        feedback.signPredictor.model = course.theme.model;
+        feedback.signPredictor.ChangeModel(course.theme.modelIndex);
         maxWords = course.theme.learnables.Count;
 
         // vvv TEMPORARY STUFF vvv
-        feedbackProgressBar.SetActive(course.theme.model != null);
-        previewMessage.SetActive(course.theme.model == null);
-        feedback.signPredictor.model = previewModel;
+        feedbackProgressBar.SetActive(course.theme.modelIndex != ModelIndex.NONE);
+        previewMessage.SetActive(course.theme.modelIndex == ModelIndex.NONE);
+        // Instead, the NONE-modelIndex points to Fingerspelling, which gives the same result
+        //feedback.signPredictor.model = previewModel;
         // ^^^ TEMPORARY STUFF ^^^
 
         // Create entry in current user for keeping track of progress

Assets/Hangman/Scenes/Hangman.unity

@@ -6245,6 +6245,7 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: 043ccd99cf82b3cc9bf2e00956ce2b93, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
+  modelList: {fileID: 11400000, guid: 39516e4e6e56f0f4f80647d9c4d8034c, type: 2}
   model: {fileID: 5022602860645237092, guid: e6d85df707405ad4f97c23b07227ee99, type: 3}
   modelInfoFile: {fileID: 4900000, guid: fb8b51022bdcd654a9f29c054832a1b5, type: 3}
   configAsset: {fileID: 4900000, guid: 6288c43cdca97374782dac1ea87aa029, type: 3}

Assets/Hangman/Scripts/HangmanGameController.cs

@@ -241,6 +241,9 @@ public class HangmanGameController : MonoBehaviour
         }
         userList.Save();
 
+        // Hangman always uses fingerspelling
+        feedback.signPredictor.ChangeModel(ModelIndex.FINGERSPELLING);
+
         // Set calllbacks
         feedback.getSignCallback = () =>
         {

Assets/MediaPipeUnity/ScriptableObjects.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: 438a3ced42dd6fc4ab38e3a16c1e43a7
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

Assets/MediaPipeUnity/ScriptableObjects/ModelList.asset

@@ -0,0 +1,20 @@
+%YAML 1.1
+%TAG !u! tag:unity3d.com,2011:
+--- !u!114 &11400000
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 0}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: 78a3f61c93a08c04496c49ffd10b9021, type: 3}
+  m_Name: ModelList
+  m_EditorClassIdentifier: 
+  currentModelIndex: 0
+  models:
+  - index: 0
+    model: {fileID: 5022602860645237092, guid: e6d85df707405ad4f97c23b07227ee99, type: 3}
+  - index: 1
+    model: {fileID: 5022602860645237092, guid: e6d85df707405ad4f97c23b07227ee99, type: 3}

Assets/MediaPipeUnity/ScriptableObjects/ModelList.asset.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: 39516e4e6e56f0f4f80647d9c4d8034c
+NativeFormatImporter:
+  externalObjects: {}
+  mainObjectFileID: 11400000
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

Assets/MediaPipeUnity/Scripts/SignPredictor.asmdef

@@ -6,7 +6,8 @@
         "GUID:5c2b5ba89f9e74e418232e154bc5cc7a",
         "GUID:04c4d86a70aa56c55a78c61f1ab1a56d",
         "GUID:edc93f477bb73a743a97d6882ed330b3",
-        "GUID:58e104b97fb3752438ada2902a36dcbf"
+        "GUID:58e104b97fb3752438ada2902a36dcbf",
+        "GUID:7f2d0ee6dd21e1d4eb25b71b7a749d25"
     ],
     "includePlatforms": [],
     "excludePlatforms": [],

Assets/MediaPipeUnity/Scripts/SignPredictor.cs

@@ -19,9 +19,9 @@ namespace Mediapipe.Unity.Tutorial
     public class SignPredictor : MonoBehaviour
     {
         /// <summary>
-        /// Reference to the model used in the SignPredictor
+        /// ModelList, used to change model using ModelIndex
         /// </summary>
-        public NNModel model;
+        public ModelList modelList;
 
         /// <summary>
         /// Reference to the model info file
@@ -210,12 +210,22 @@ namespace Mediapipe.Unity.Tutorial
 
             // check if model exists at path
             //var model = ModelLoader.Load(Resources.Load<NNModel>("Models/Fingerspelling/model_A-L"));
-            worker = model.CreateWorker();
+            worker = modelList.GetCurrentModel().CreateWorker();
 
             StartCoroutine(SignRecognitionCoroutine());
             StartCoroutine(MediapipeCoroutine());
         }
 
+        public void ChangeModel(ModelIndex index)
+        {
+            this.modelList.SetCurrentModel(index);
+            // If a worker already existed, we throw it out
+            worker?.Dispose();
+
+            // Add a new worker for the new model
+            worker = modelList.GetCurrentModel().CreateWorker();
+        }
+
         /// <summary>
         /// Coroutine which executes the mediapipe pipeline
         /// </summary>

Assets/SpellingBee/Scenes/Game.unity

@@ -3900,6 +3900,7 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: 043ccd99cf82b3cc9bf2e00956ce2b93, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
+  modelList: {fileID: 11400000, guid: 39516e4e6e56f0f4f80647d9c4d8034c, type: 2}
   model: {fileID: 5022602860645237092, guid: e6d85df707405ad4f97c23b07227ee99, type: 3}
   modelInfoFile: {fileID: 4900000, guid: fb8b51022bdcd654a9f29c054832a1b5, type: 3}
   configAsset: {fileID: 4900000, guid: 6288c43cdca97374782dac1ea87aa029, type: 3}

Assets/SpellingBee/Scripts/GameController.cs

@@ -182,7 +182,7 @@ public partial class GameController : MonoBehaviour
         userList.Save();
 
         currentTheme = minigame.themeList.themes[minigame.themeList.currentThemeIndex];
-        feedback.signPredictor.model = currentTheme.model;
+        feedback.signPredictor.ChangeModel(currentTheme.modelIndex);
         words.AddRange(currentTheme.learnables);
         ShuffleWords();
         NextWord();