Merge pull request #3501 from Microsoft/beta2-stabilization

Beta2 stabilization -> mrtk development

Author: David Kline

Assets/MixedRealityToolkit.Providers/MixedReality.Toolkit.Providers.nuspec

@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<package >
+  <metadata>
+    <id>Microsoft.MixedReality.Toolkit.Providers</id>
+    <version>$version$</version>
+    <authors>Microsoft</authors>
+    <owners>Microsoft,MixedReality</owners>
+    <licenseUrl>https://github.com/Microsoft/MixedRealityToolkit-Unity/blob/master/License.txt</licenseUrl>
+    <projectUrl>https://github.com/Microsoft/MixedRealityToolkit-Unity</projectUrl>
+    <requireLicenseAcceptance>true</requireLicenseAcceptance>
+    <description>The Mixed Reality Toolkit is a collection of scripts and components intended to accelerate development of applications targeting Microsoft HoloLens and Windows Mixed Reality headsets.</description>
+    <copyright>© Microsoft Corporation. All rights reserved.</copyright>
+    <releaseNotes>$releaseNotes$</releaseNotes>
+    <tags>Unity MixedReality</tags>
+  </metadata>
+</package>

Assets/MixedRealityToolkit.Providers/MixedReality.Toolkit.Providers.nuspec.meta

@@ -96,8 +96,8 @@ protected override GenericJoystickController GetOrAddController(string joystickN
 
             if (!detectedController.SetupConfiguration(controllerType))
             {
-                // Controller failed to be setup correctly.
-                Debug.LogError($"Failed to Setup {controllerType.Name} controller");
+                // Controller failed to be set up correctly.
+                Debug.LogError($"Failed to set up {controllerType.Name} controller");
                 // Return null so we don't raise the source detected.
                 return null;
             }

Assets/MixedRealityToolkit.Providers/OpenVR/OpenVRDeviceManager.cs

@@ -394,7 +394,7 @@ private void UpdateTriggerData(InteractionSourceState interactionSourceState, Mi
             switch (interactionMapping.InputType)
             {
                 case DeviceInputType.TriggerPress:
-                    //Update the interaction data source
+                    // Update the interaction data source
                     interactionMapping.BoolData = interactionSourceState.grasped;
 
                     // If our value changed raise it.

Assets/MixedRealityToolkit.Providers/WindowsMixedReality/WindowsMixedRealityController.cs

@@ -59,6 +59,8 @@ public override IMixedRealityController[] GetActiveControllers()
             return activeControllers.Values.ToArray();
         }
 
+        #region Gesture Settings
+
         private static bool gestureRecognizerEnabled;
 
         /// <summary>
@@ -222,6 +224,8 @@ public static bool UseRailsNavigation
         private static WsaGestureSettings WSANavigationSettings => (WsaGestureSettings)navigationSettings;
         private static WsaGestureSettings WSARailsNavigationSettings => (WsaGestureSettings)railsNavigationSettings;
 
+        #endregion Gesture Settings
+
         #region IMixedRealityDeviceManager Interface
 
         /// <inheritdoc/>
@@ -294,7 +298,9 @@ public override void Update()
 
             for (var i = 0; i < interactionmanagerStates?.Length; i++)
             {
-                var controller = GetController(interactionmanagerStates[i].source);
+                // SourceDetected gets raised when a new controller is detected and, if previously present, 
+                // when OnEnable is called. Do not create a new controller here.
+                var controller = GetController(interactionmanagerStates[i].source, false);
 
                 if (controller != null)
                 {
@@ -373,7 +379,7 @@ public override void Disable()
             InteractionSourceState[] states = InteractionManager.GetCurrentReading();
             for (var i = 0; i < states.Length; i++)
             {
-                RemoveController(states[i]);
+                RemoveController(states[i].source);
             }
         }
 
@@ -438,16 +444,16 @@ private WindowsMixedRealityController GetController(InteractionSource interactio
         /// Remove the selected controller from the Active Store
         /// </summary>
         /// <param name="interactionSourceState">Source State provided by the SDK to remove</param>
-        private void RemoveController(InteractionSourceState interactionSourceState)
+        private void RemoveController(InteractionSource interactionSource)
         {
-            var controller = GetController(interactionSourceState.source, false);
+            var controller = GetController(interactionSource, false);
 
             if (controller != null)
             {
                 MixedRealityToolkit.InputSystem?.RaiseSourceLost(controller.InputSource, controller);
             }
 
-            activeControllers.Remove(interactionSourceState.source.id);
+            activeControllers.Remove(interactionSource.id);
         }
 
         #endregion Controller Utilities
@@ -478,7 +484,7 @@ private void InteractionManager_InteractionSourceDetected(InteractionSourceDetec
         /// <param name="args">SDK source updated event arguments</param>
         private void InteractionManager_InteractionSourceLost(InteractionSourceLostEventArgs args)
         {
-            RemoveController(args.state);
+            RemoveController(args.state.source);
         }
 
         #endregion Unity InteractionManager Events

Assets/MixedRealityToolkit.Providers/WindowsMixedReality/WindowsMixedRealityDeviceManager.cs

@@ -69,26 +69,24 @@ private void ReadProfile()
 
         #region IMixedRealityToolkit implementation
 
+#if UNITY_WSA
+
         /// <inheritdoc />
         public override void Initialize()
         {
             // Only initialize if the Spatial Awareness system has been enabled in the configuration profile.
             if (!MixedRealityToolkit.Instance.ActiveProfile.IsSpatialAwarenessSystemEnabled) { return; }
 
-#if UNITY_WSA
             CreateObserver();
 
             // Apply the initial observer volume settings.
             ConfigureObserverVolume();
-#endif // UNITY_WSA
         }
 
         /// <inheritdoc />
         public override void Reset()
         {
-#if UNITY_WSA
             CleanupObserver();
-#endif // UNITY_WSA
             Initialize();
         }
 
@@ -101,9 +99,7 @@ public override void Enable()
         /// <inheritdoc />
         public override void Update()
         {
-#if UNITY_WSA
             UpdateObserver();
-#endif // UNITY_WSA
         }
 
         /// <inheritdoc />
@@ -115,11 +111,11 @@ public override void Disable()
         /// <inheritdoc />
         public override void Destroy()
         {
-#if UNITY_WSA
             CleanupObserver();
-#endif // UNITY_WSA
         }
 
+#endif // UNITY_WSA
+
         #endregion IMixedRealityToolkit implementation
 
         #region IMixedRealitySpatialAwarenessObserver implementation
@@ -140,6 +136,28 @@ public override void Destroy()
         private IMixedRealitySpatialAwarenessSystem SpatialAwarenessSystem => spatialAwarenessSystem ?? (spatialAwarenessSystem = MixedRealityToolkit.SpatialAwarenessSystem);
 
 #if UNITY_WSA
+        /// <inheritdoc />
+        protected override void Dispose(bool disposing)
+        {
+            if (disposed) { return; }
+
+            base.Dispose(disposing);
+
+            if (IsRunning)
+            {
+                Suspend();
+            }
+
+            if (disposing)
+            {
+                CleanupObservedObjects();
+            }
+
+            DisposeObserver();
+
+            disposed = true;
+        }
+
         /// <summary>
         /// The surface observer providing the spatial data.
         /// </summary>
@@ -292,24 +310,23 @@ private void CreateObserver()
         /// </summary>
         private void CleanupObserver()
         {
-            if (observer != null)
-            {
-                if (IsRunning)
-                {
-                    Suspend();
-                }
-                observer.Dispose();
-                observer = null;
-            }
+            // Destroys all observed objects and the observer.
+            Dispose(true);
+        }
 
+        /// <summary>
+        /// Cleans up the objects created during observation.
+        /// </summary>
+        private void CleanupObservedObjects()
+        {
             if (Application.isPlaying)
             {
                 // Cleanup the scene objects are managing
                 if (observedObjectParent != null)
                 {
                     observedObjectParent.transform.DetachChildren();
                 }
-                
+
                 foreach (SpatialAwarenessMeshObject meshObject in meshes.Values)
                 {
                     if (meshObject != null)
@@ -338,6 +355,18 @@ private void CleanupObserver()
             }
         }
 
+        /// <summary>
+        /// Implements proper cleanup of the SurfaceObserver.
+        /// </summary>
+        private void DisposeObserver()
+        {
+            if (observer != null)
+            {
+                observer.Dispose();
+                observer = null;
+            }
+        }
+
         /// <summary>
         /// Requests updates from the surface observer.
         /// </summary>

Assets/MixedRealityToolkit.Providers/WindowsMixedReality/WindowsMixedRealitySpatialMeshObserver.cs

@@ -9,7 +9,7 @@ namespace Microsoft.MixedReality.Toolkit.SDK.UX.Interactable.Layout
 {
     /// <summary>
     /// Scales an object relative the scale of the Anchor Transform
-    /// Works best when using with Layout3DPixelSize, but not requied - See LayoutPixelSize for more info
+    /// Works best when using with Layout3DPixelSize, but not required - See LayoutPixelSize for more info
     /// Use Case:
     /// Create a button, then add another element who's size should maintain a consistent size relative to the Anchor.
     /// Like creating a button background using a Cube and ButtonSize. The add another Cube that is 40 pixels smaller than the background.
@@ -20,7 +20,7 @@ public class ButtonBackgroundSizeOffset : MonoBehaviour
     {
         /// <summary>
         /// A scale factor for layout3D, default is based on 2048 pixels to 1 meter.
-        /// Similar to values used in designer and 2D art programs and helps create consistancy across teams.
+        /// Similar to values used in designer and 2D art programs and helps create consistency across teams.
         /// </summary>
         [Tooltip("A pixel to Unity unit conversion, Default: 2048x2048 pixels covers a 1x1 Unity Unit or default primitive size")]
         [SerializeField]
@@ -31,7 +31,7 @@ public class ButtonBackgroundSizeOffset : MonoBehaviour
         /// </summary>
         [Tooltip("The transform this object should be linked and aligned to")]
         [SerializeField]
-        private Transform AnchorTransform;
+        private Transform AnchorTransform = null;
 
         /// <summary>
         /// Make this object's size scaled relative to the Anchor's size

Assets/MixedRealityToolkit.SDK/Features/UX/Interactable/Scripts/Layout/ButtonBackgroundSizeOffset.cs

@@ -8,20 +8,20 @@
 namespace Microsoft.MixedReality.Toolkit.SDK.UX.Interactable.Layout
 {
     /// <summary>
-    /// Use a Unity primitive Cube or cylindar as a border segment relative to the scale of the AnchorTransform
+    /// Use a Unity primitive Cube or cylinder as a border segment relative to the scale of the AnchorTransform
     /// Use with ButtonSize on the component and the Anchor for consistent results
-    /// Works best when using with ButtonSize, but not requied - See ButtonSize for more info.
+    /// Works best when using with ButtonSize, but not required - See ButtonSize for more info.
     /// </summary>
     [ExecuteInEditMode]
     public class ButtonBorder : MonoBehaviour
     {
         /// <summary>
         /// A scale factor for button layouts, default is based on 2048 pixels to 1 meter.
-        /// Similar to values used in designer and 2D art programs and helps create consistancy across teams.
+        /// Similar to values used in designer and 2D art programs and helps create consistency across teams.
         /// 
         /// Use Case:
         /// A designer created a basic button background using a Cube and ButtonSize
-        /// Add some more borders, using more cubes or cylenders, that will scale to the edges of the background size
+        /// Add some more borders, using more cubes or cylinders, that will scale to the edges of the background size
         /// </summary>
         [Tooltip("A pixel to Unity unit conversion, Default: 2048x2048 pixels covers a 1x1 Unity Unit or default primitive size")]
         [SerializeField]
@@ -32,7 +32,7 @@ public class ButtonBorder : MonoBehaviour
         /// </summary>
         [Tooltip("The transform this object should be linked and aligned to")]
         [SerializeField]
-        private Transform AnchorTransform;
+        private Transform AnchorTransform = null;
 
         /// <summary>
         /// Width of the border
@@ -55,14 +55,14 @@ public class ButtonBorder : MonoBehaviour
         /// </summary>
         [Tooltip("Where to set this object's center point in relation to the Anchor's center point")]
         [SerializeField]
-        private Vector3 Alignment;
+        private Vector3 Alignment = Vector3.zero;
 
         /// <summary>
         /// An absolute value to offset the border from the Anchor's edge
         /// </summary>
         [Tooltip("That absolute amount to offset the position")]
         [SerializeField]
-        private Vector3 PositionOffset;
+        private Vector3 PositionOffset = Vector3.zero;
 
         /// <summary>
         /// Overlap the edge it is assigned to so there are not gaps in the corners

Assets/MixedRealityToolkit.SDK/Features/UX/Interactable/Scripts/Layout/ButtonBorder.cs

@@ -192,11 +192,11 @@ public string ToolTipText
 
         [SerializeField]
         [Tooltip("The padding around the content (height / width)")]
-        private Vector2 backgroundPadding;
+        private Vector2 backgroundPadding = Vector2.zero;
 
         [SerializeField]
         [Tooltip("The offset of the background (x / y / z)")]
-        private Vector3 backgroundOffset;
+        private Vector3 backgroundOffset = Vector3.zero;
 
         /// <summary>
         /// The offset of the background (x / y / z)

Assets/MixedRealityToolkit.SDK/Features/UX/Scripts/Tooltips/ToolTip.cs

@@ -30,7 +30,7 @@ public class ToolTipBackgroundBlob : MonoBehaviour, IToolTipBackground
         private Transform attachPointOffset = null;
 
         [SerializeField]
-        private ToolTip toolTip;
+        private ToolTip toolTip = null;
 
         #endregion Transform Targets