Add synchronous CloseImmediate() functions to IProgressIndicator (#10323)

* Add synchronous CloseImmediate() functions to IProgressIndicator

Some UI in our application cannot be easily deactivated asynchronously. In particular, we determine the visibility of a child window based on if there are any active `GameObject` children.

We've added a synchronous `CloseImmediate()` function to turn the `GameObject off immediately and set the appropriate state.

* Add inheritdoc tags

* orb color setting cleanup

Co-authored-by: Victor Jia <[email protected]>
Co-authored-by: Kurtis <[email protected]>
Co-authored-by: Roger Liu <[email protected]>

Author: 4 people

Assets/MRTK/SDK/Features/UX/Scripts/ProgressIndicators/IProgressIndicator.cs

@@ -44,5 +44,10 @@ public interface IProgressIndicator
         /// </summary>
         Task CloseAsync();
 
+        /// <summary>
+        /// Closes the progress indicator immediately. No fade out animation. All gameObjects for the progress indicator are reset  to the correct values.
+        /// </summary>
+        void CloseImmediate();
+
     }
 }

Assets/MRTK/SDK/Features/UX/Scripts/ProgressIndicators/ProgressIndicatorLoadingBar.cs

@@ -98,6 +98,18 @@ public async Task CloseAsync()
             gameObject.SetActive(false);
         }
 
+        /// <inheritdoc/>
+        public void CloseImmediate()
+        {
+            if (state != ProgressIndicatorState.Open)
+            {
+                throw new System.Exception("Can't close in state " + state);
+            }
+
+            state = ProgressIndicatorState.Closed;
+            gameObject.SetActive(false);
+        }
+
         /// <inheritdoc/>
         public async Task AwaitTransitionAsync()
         {

Assets/MRTK/SDK/Features/UX/Scripts/ProgressIndicators/ProgressIndicatorObjectDisplay.cs

@@ -145,6 +145,30 @@ public async Task CloseAsync()
             gameObject.SetActive(false);
         }
 
+        /// <inheritdoc/>
+        public void CloseImmediate()
+        {
+            if (closeCurve.length == 0)
+            {
+                Debug.LogWarning("Open curve length is zero - this may result in an infinite loop.");
+            }
+
+            float minScale = closeCurve.Evaluate(Mathf.Infinity);
+            if (minScale > 0)
+            {
+                Debug.LogWarning("Open curve value never reaches 0 - this may result in an infinite loop.");
+            }
+
+            if (state != ProgressIndicatorState.Open)
+            {
+                throw new System.Exception("Can't close in state " + state);
+            }
+
+            scaleTargetObject.transform.localScale = Vector3.zero;
+            state = ProgressIndicatorState.Closed;
+            gameObject.SetActive(false);
+        }
+
         /// <inheritdoc/>
         public async Task AwaitTransitionAsync()
         {

Assets/MRTK/SDK/Features/UX/Scripts/ProgressIndicators/ProgressIndicatorOrbsRotator.cs

@@ -91,7 +91,19 @@ public async Task CloseAsync()
             }
 
             state = ProgressIndicatorState.Closed;
+            gameObject.SetActive(false);
+        }
+
+        /// <inheritdoc/>
+        public void CloseImmediate()
+        {
+            if (state != ProgressIndicatorState.Open)
+            {
+                throw new System.Exception("Can't close in state " + state);
+            }
 
+            StopOrbsImmediately();
+            state = ProgressIndicatorState.Closed;
             gameObject.SetActive(false);
         }
 
@@ -130,7 +142,7 @@ private void StartOrbs()
 
             for (int i = 0; i < orbs.Length; ++i)
             {
-                propertyBlocks[i].SetColor("_Color", new Color(1, 1, 1, 1));
+                propertyBlocks[i].SetColor("_Color", Color.white);
                 dots[i].SetPropertyBlock(propertyBlocks[i]);
                 orbs[i].transform.localRotation = Quaternion.identity;
             }
@@ -142,6 +154,20 @@ public void StopOrbs()
             rotationWhenStopped = angles[0];
         }
 
+        private void StopOrbsImmediately()
+        {
+            for (int i = 0; i < orbs.Length; ++i)
+            {
+                Color orbColor = propertyBlocks[i].GetColor("_Color");
+                orbColor.a = 0.0f;
+                propertyBlocks[i].SetColor("_Color", orbColor);
+                dots[i].SetPropertyBlock(propertyBlocks[i]);
+                orbs[i].transform.localRotation = Quaternion.identity;
+            }
+
+            hasAnimationFinished = true;
+        }
+
         private void Awake()
         {
             angles = new float[orbs.Length];
@@ -151,7 +177,7 @@ private void Awake()
             for (int i = 0; i < orbs.Length; ++i)
             {
                 propertyBlocks[i] = new MaterialPropertyBlock();
-                propertyBlocks[i].SetColor("_Color", new Color(1, 1, 1, 1));
+                propertyBlocks[i].SetColor("_Color", Color.white);
                 dots[i] = orbs[i].transform.GetChild(0).gameObject.GetComponent<Renderer>();
                 dots[i].SetPropertyBlock(propertyBlocks[i]);
                 angles[i] = 0;