Resolve WES-131-Feedback-REfactor

Assets/Courses/Scripts/CourseScripts.asmdef

@@ -5,8 +5,8 @@
         "Unity.TextMeshPro",
         "AccountsScripts",
         "InterfacesScripts",
-        "SignPredictor",
-        "Unity.Barracuda"
+        "Tween",
+        "SignPredictor"
     ],
     "includePlatforms": [],
     "excludePlatforms": [],

Assets/Courses/Scripts/CoursesController.cs

@@ -1,6 +1,7 @@
+using DigitalRuby.Tween;
 using System;
+using System.Collections;
 using TMPro;
-using Unity.Barracuda;
 using UnityEngine;
 using UnityEngine.UI;
 using UnityEngine.Video;
@@ -8,13 +9,10 @@ using UnityEngine.Video;
 /// <summary>
 /// TemplateCourse scene manager
 /// </summary>
-public class CoursesController : MonoBehaviour
+public class CoursesController : AbstractFeedback
 {
-    // vvv TEMPORARY STUFF vvv
-    public NNModel previewModel;
     public GameObject feedbackProgressBar;
     public GameObject previewMessage;
-    // ^^^ TEMPORARY STUFF ^^^
 
     /// <summary>
     /// Reference to instructional video player
@@ -112,10 +110,37 @@ public class CoursesController : MonoBehaviour
     /// </summary>
     public TMP_Text timeSpent;
 
+
     /// <summary>
-    /// Reference to the feedback script on the Feedback prefab
+    /// Reference to the feedback field
     /// </summary>
-    public Feedback feedback;
+    public TMP_Text feedbackText;
+
+    /// <summary>
+    /// Reference to the progress bar
+    /// </summary>
+    public Slider feedbackProgress;
+
+    /// <summary>
+    /// Reference to the progress bar image, so we can add fancy colors
+    /// </summary>
+    public Image feedbackProgressImage;
+
+    /// <summary>
+    /// Timer to keep track of how long a incorrect sign is performed
+    /// </summary>
+    protected DateTime timer;
+
+    /// <summary>
+    /// Current predicted sign
+    /// </summary>
+    protected string predictedSign = null;
+
+    /// <summary>
+    /// Previous incorrect sign, so we can keep track whether the user is wrong or the user is still changing signs
+    /// </summary>
+    protected string previousIncorrectSign = null;
+
 
     /// <summary>
     /// This function is called when the script is initialised.
@@ -124,19 +149,25 @@ public class CoursesController : MonoBehaviour
     /// Then it checks whether or not the User has started the course yet, to possibly create a new progress atribute for the course.
     /// Then it sets up the course-screen to display relevant information from the course-scriptable.
     /// </summary>
-    void Awake()
+    void Start()
+    {
+        StartCourseController();
+
+        signPredictor.SetModel(course.theme.modelIndex);
+        AddSelfAsListener();
+    }
+    /// <summary>
+    /// Holds the course-specific logic to start the controller, it is seperated to allow the course to be reset (if that would become needed)
+    /// </summary>
+    public void StartCourseController()
     {
         // Setting up course
         course = courselist.courses[courselist.currentCourseIndex];
-        feedback.signPredictor.ChangeModel(course.theme.modelIndex);
         maxWords = course.theme.learnables.Count;
 
-        // vvv TEMPORARY STUFF vvv
+        // Show preview messages if there is no model
         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
         userList.Load();
@@ -164,23 +195,6 @@ public class CoursesController : MonoBehaviour
         ResultPanel.SetActive(false);
         // Set the startTime
         startMoment = DateTime.Now;
-
-        // Set callbacks
-        feedback.getSignCallback = () =>
-        {
-            if (currentWordIndex < course.theme.learnables.Count)
-            {
-                return course.theme.learnables[currentWordIndex].name;
-            }
-            return null;
-        };
-        feedback.predictSignCallback = (sign) =>
-        {
-            if (sign == course.theme.learnables[currentWordIndex].name)
-            {
-                NextSign();
-            }
-        };
     }
 
     /// <summary>
@@ -287,4 +301,104 @@ public class CoursesController : MonoBehaviour
         progress.AddOrUpdate<float>("courseProgress", 1f);
         userList.Save();
     }
+    /// <summary>
+    /// The updateFunction that is called when new probabilities become available
+    /// </summary>
+    /// <returns></returns>
+    protected override IEnumerator UpdateFeedback()
+    {
+        // Get current sign
+        string currentSign = course.theme.learnables[currentWordIndex].name;
+        // Get the predicted sign
+        if (signPredictor != null && signPredictor.learnableProbabilities != null &&
+            currentSign != null && signPredictor.learnableProbabilities.ContainsKey(currentSign))
+        {
+            float accuracy = signPredictor.learnableProbabilities[currentSign];
+            if (feedbackText != null && feedbackProgressImage != null)
+            {
+                if (accuracy > 0.90)
+                {
+                    feedbackText.text = "Goed";
+                    feedbackText.color = Color.green;
+                    feedbackProgressImage.color = Color.green;
+                }
+                else if (accuracy > 0.80)
+                {
+                    feedbackText.text = "Bijna...";
+                    Color col = new Color(0xff / 255.0f, 0x66 / 255.0f, 0x00 / 255.0f);
+                    feedbackText.color = col;
+                    feedbackProgressImage.color = col;
+                }
+                else
+                {
+                    feedbackText.text = "Detecteren...";
+                    feedbackText.color = Color.red;
+                    feedbackProgressImage.color = Color.red;
+                }
+
+                float oldValue = feedbackProgress.value;
+                // use an exponential scale 
+                float newValue = Mathf.Exp(4 * (accuracy - 1.0f));
+                feedbackProgress.gameObject.Tween("FeedbackUpdate", oldValue, newValue, 0.2f, TweenScaleFunctions.CubicEaseInOut, (t) =>
+                {
+                    if (feedbackProgress != null)
+                    {
+                        feedbackProgress.value = t.CurrentValue;
+                    }
+                });
+            }
+
+            // Check whether (in)correct sign has high accuracy
+            foreach (var kv in signPredictor.learnableProbabilities)
+            {
+                if (kv.Value > 0.90)
+                {
+                    predictedSign = kv.Key;
+                    // Correct sign
+                    if (predictedSign == currentSign)
+                    {
+                        yield return new WaitForSeconds(1.0f);
+                        CheckEquality(predictedSign);
+                        timer = DateTime.Now;
+                        predictedSign = null;
+                        previousIncorrectSign = null;
+                    }
+                    // Incorrect sign
+                    else
+                    {
+                        if (previousIncorrectSign != predictedSign)
+                        {
+                            timer = DateTime.Now;
+                            previousIncorrectSign = predictedSign;
+                        }
+                        else if (DateTime.Now - timer > TimeSpan.FromSeconds(2.0f))
+                        {
+                            CheckEquality(predictedSign);
+                            timer = DateTime.Now;
+                            predictedSign = null;
+                            previousIncorrectSign = null;
+                        }
+                    }
+                    break;
+                }
+            }
+        }
+        else if (feedbackProgress != null)
+        {
+
+            feedbackProgress.value = 0.0f;
+        }
+
+    }
+    /// <summary>
+    /// Function to check equality between the current sign and the sign that the model predicted, if they are equal then the next sign is fetched.
+    /// </summary>
+    /// <param name="predicted"></param>
+    private void CheckEquality(string predicted)
+    {
+        if (predicted == course.theme.learnables[currentWordIndex].name)
+        {
+            NextSign();
+        }
+    }
 }