fixed cpl of bugs in bounds control when accessing visuals when they haven't been created yet

finished migration handler (added folder generation and check, added appbar migration)
made app bar use generic target that implements new IBoundsTargetProvider so we can use both boundscontrol and boundingbox with it
deprecated boundingbox specific methods in boundingboxhelper / added generic variants of methods

Author: bethalha-havok

Assets/MixedRealityToolkit.SDK/Experimental/Features/UX/BoundsControl/BoundsControl.cs

@@ -24,7 +24,8 @@ namespace Microsoft.MixedReality.Toolkit.Experimental.UI.BoundsControl
     public class BoundsControl : MonoBehaviour,
         IMixedRealitySourceStateHandler,
         IMixedRealityFocusChangedHandler,
-        IMixedRealityFocusHandler
+        IMixedRealityFocusHandler,
+        IBoundsTargetProvider
     {
         #region Serialized Fields and Properties
         [SerializeField]
@@ -215,7 +216,7 @@ public Vector3 BoxPadding
         /// <summary>
         /// This section defines the links / lines that are drawn between the corners of the control.
         /// </summary>
-        public LinksConfiguration LinksConfiguration { get => linksConfiguration; set => LinksConfiguration = value; }
+        public LinksConfiguration LinksConfiguration { get => linksConfiguration; set => linksConfiguration = value; }
 
         [SerializeField]
         [Tooltip("Configuration of the scale handles.")]
@@ -430,6 +431,11 @@ public void UnhighlightWires()
         /// </summary>
         public void CreateRig()
         {
+            if (!IsInitialized())
+            {
+                return;
+            }
+
             DestroyRig();
             InitializeRigRoot();
             InitializeDataStructures();
@@ -786,7 +792,10 @@ private void UpdateBounds()
             }
         }
 
-        
+        private bool IsInitialized()
+        {
+            return scaleHandles != null && rotationHandles != null && boxDisplay != null && links != null && proximityEffect != null;
+        }
 
         private bool DoesActivationMatchFocus(FocusEventData eventData)
         {
@@ -857,6 +866,9 @@ private void DestroyRig()
 
         private void UpdateRigVisibilityInInspector()
         {
+            if (!IsInitialized())
+                return;
+
             HideFlags desiredFlags = hideElementsInInspector ? HideFlags.HideInHierarchy | HideFlags.HideInInspector : HideFlags.None;
             scaleHandles.UpdateVisibilityInInspector(desiredFlags);
             links.UpdateVisibilityInInspector(desiredFlags);
@@ -1108,7 +1120,7 @@ private void SetHighlighted(Transform activeHandle)
 
         private void ResetVisuals()
         {
-            if (currentPointer != null)
+            if (currentPointer != null || !IsInitialized())
             {
                 return;
             }

Assets/MixedRealityToolkit.SDK/Experimental/Features/UX/BoundsControl/Visuals/Links.cs

@@ -134,7 +134,7 @@ internal void Flatten(ref int[] flattenedHandles)
         internal void CreateLinks(RotationHandles rotationHandles, Transform parent, Vector3 currentBoundsExtents)
         {
             // create links
-            if (links != null)
+            if (links != null && config.ShowWireFrame)
             {
                 GameObject link;
                 Vector3 linkDimensions = GetLinkDimensions(currentBoundsExtents);

Assets/MixedRealityToolkit.SDK/Experimental/Features/Utilities/Migration/BoundsControlMigrationHandler.cs

@@ -26,46 +26,58 @@ public void Migrate(GameObject gameObject)
             var boundingBox = gameObject.GetComponent<BoundingBox>();
             var boundsControl = gameObject.AddComponent<BoundsControl>();
 
-            // migrate logic settings
-            boundsControl.Target = boundingBox.Target;
-            boundsControl.BoundsOverride = boundingBox.BoundsOverride;
-            boundsControl.CalculationMethod = MigrateCalculationMethod(boundingBox.CalculationMethod);
-            boundsControl.BoundsControlActivation = MigrateActivationFlag(boundingBox.BoundingBoxActivation);
-
-            // only carry over min max scaling values if user hasn't attached min max scale constraint component yet 
-            if (gameObject.GetComponent<MinMaxScaleConstraint>() == null)
             {
-                MinMaxScaleConstraint scaleConstraint = gameObject.AddComponent<MinMaxScaleConstraint>();
+                Undo.RecordObject(gameObject, "BoundsControl migration: swapping BoundingBox with BoundsControl.");
+                
+                // migrate logic settings
+                boundsControl.Target = boundingBox.Target;
+                boundsControl.BoundsOverride = boundingBox.BoundsOverride;
+                boundsControl.CalculationMethod = MigrateCalculationMethod(boundingBox.CalculationMethod);
+                boundsControl.BoundsControlActivation = MigrateActivationFlag(boundingBox.BoundingBoxActivation);
+
+                // only carry over min max scaling values if user hasn't attached min max scale constraint component yet 
+                if (gameObject.GetComponent<MinMaxScaleConstraint>() == null)
+                {
 #pragma warning disable 0618
-                scaleConstraint.ScaleMinimum = boundingBox.ScaleMinimum;
-                scaleConstraint.ScaleMaximum = boundingBox.ScaleMaximum;
+                    // create a minmaxscaleconstraint in case there's a min max scale set up
+                    if (boundingBox.ScaleMinimum != 0.0f || boundingBox.ScaleMaximum != 0.0f)
+                    {
+                        MinMaxScaleConstraint scaleConstraint = gameObject.AddComponent<MinMaxScaleConstraint>();
+                        scaleConstraint.ScaleMinimum = boundingBox.ScaleMinimum;
+                        scaleConstraint.ScaleMaximum = boundingBox.ScaleMaximum;
+                    }
 #pragma warning restore 0618
+                }
+
+                // migrate visuals
+                boundsControl.DrawTetherWhenManipulating = boundingBox.DrawTetherWhenManipulating;
+                boundsControl.HandlesIgnoreCollider = boundingBox.HandlesIgnoreCollider;
+                boundsControl.FlattenAxis = MigrateFlattenAxis(boundingBox.FlattenAxis);
+                boundsControl.BoxPadding = boundingBox.BoxPadding;
+                string configDir = GetBoundsControlConfigDirectory(boundingBox);
+                MigrateBoxDisplay(boundsControl, boundingBox, configDir);
+                MigrateLinks(boundsControl, boundingBox, configDir);
+                MigrateScaleHandles(boundsControl, boundingBox, configDir);
+                MigrateRotationHandles(boundsControl, boundingBox, configDir);
+                MigrateProximityEffect(boundsControl, boundingBox, configDir);
+
+                // debug properties
+                boundsControl.DebugText = boundingBox.debugText;
+                boundsControl.HideElementsInInspector = boundingBox.HideElementsInInspector;
+
+                // events
+                boundsControl.RotateStarted = boundingBox.RotateStarted;
+                boundsControl.RotateStopped = boundingBox.RotateStopped;
+                boundsControl.ScaleStarted = boundingBox.ScaleStarted;
+                boundsControl.ScaleStopped = boundingBox.ScaleStopped;
+
+                // destroy obsolete component
+                Object.DestroyImmediate(boundingBox);
             }
 
-            // migrate visuals
-            boundsControl.DrawTetherWhenManipulating = boundingBox.DrawTetherWhenManipulating;
-            boundsControl.HandlesIgnoreCollider = boundingBox.HandlesIgnoreCollider;
-            boundsControl.FlattenAxis = MigrateFlattenAxis(boundingBox.FlattenAxis);
-            boundsControl.BoxPadding = boundingBox.BoxPadding;
-            string configDir = GetBoundsControlConfigDirectory(boundingBox);
-            MigrateBoxDisplay(boundsControl, boundingBox, configDir);
-            MigrateLinks(boundsControl, boundingBox, configDir);
-            MigrateScaleHandles(boundsControl, boundingBox, configDir);
-            MigrateRotationHandles(boundsControl, boundingBox, configDir);
-            MigrateProximityEffect(boundsControl, boundingBox, configDir);
-
-            // debug properties
-            boundsControl.DebugText = boundingBox.debugText;
-            boundsControl.HideElementsInInspector = boundingBox.HideElementsInInspector;
-
-            // events
-            boundsControl.RotateStarted = boundingBox.RotateStarted;
-            boundsControl.RotateStopped = boundingBox.RotateStopped;
-            boundsControl.ScaleStarted = boundingBox.ScaleStarted;
-            boundsControl.ScaleStopped = boundingBox.ScaleStopped;
-
-            // destroy obsolete component
-            UnityEngine.Object.DestroyImmediate(boundingBox);
+            // look in the scene for app bars and upgrade them too to point to the new component
+            MigrateAppBar(boundingBox, boundsControl);
+
         }
 
         private string GetBoundsControlConfigDirectory(BoundingBox boundingBox)
@@ -75,18 +87,30 @@ private string GetBoundsControlConfigDirectory(BoundingBox boundingBox)
             if (scene != null)
             {
                 string scenePath = scene.path;
-                string dirPath = System.IO.Path.GetDirectoryName(scenePath);
-                string configPath = System.IO.Path.Combine(dirPath, "BoundsControlConfigs/");
-                return configPath;
+                string sceneDir = System.IO.Path.GetDirectoryName(scenePath);
+
+                const string configDir = "BoundsControlConfigs";
+                string configPath = System.IO.Path.Combine(sceneDir, configDir);
+                if (AssetDatabase.IsValidFolder(configPath))
+                {
+                    return configPath;
+                }
+                else
+                {
+                    string guid = AssetDatabase.CreateFolder(sceneDir, configDir);
+                    return AssetDatabase.GUIDToAssetPath(guid);
+                }
             }
 
             return "";
         }
         private string GenerateUniqueConfigName(string directory, GameObject migratingFrom, string configName)
         {
-            return directory + migratingFrom.name + migratingFrom.GetInstanceID() + configName + ".asset";
+            return directory + "/" + migratingFrom.name + migratingFrom.GetInstanceID() + configName + ".asset";
         }
 
+        #region Flags Migration
+
         private BoundsCalculationMethod MigrateCalculationMethod(BoundingBox.BoundsCalculationMethod calculationMethod)
         {
             switch (calculationMethod)
@@ -173,9 +197,13 @@ private RotationHandlePrefabCollider MigrateRotationHandleColliderType(BoundingB
             return RotationHandlePrefabCollider.Sphere;
         }
 
+        #endregion Flags Migration
+
+        #region Visuals Configuration Migration
+
         private void MigrateBoxDisplay(BoundsControl control, BoundingBox box, string configAssetDirectory)
         {
-            BoxDisplayConfiguration config = new BoxDisplayConfiguration();
+            BoxDisplayConfiguration config = ScriptableObject.CreateInstance<BoxDisplayConfiguration>();
             AssetDatabase.CreateAsset(config, GenerateUniqueConfigName(configAssetDirectory, box.gameObject, "BoxDisplayConfiguration"));
 
             config.BoxMaterial = box.BoxMaterial;
@@ -187,7 +215,7 @@ private void MigrateBoxDisplay(BoundsControl control, BoundingBox box, string co
 
         private void MigrateLinks(BoundsControl control, BoundingBox box, string configAssetDirectory)
         {
-            LinksConfiguration config = new LinksConfiguration();
+            LinksConfiguration config = ScriptableObject.CreateInstance<LinksConfiguration>();
             AssetDatabase.CreateAsset(config, GenerateUniqueConfigName(configAssetDirectory, box.gameObject, "LinksConfiguration"));
 
             config.WireframeMaterial = box.WireframeMaterial;
@@ -201,7 +229,7 @@ private void MigrateLinks(BoundsControl control, BoundingBox box, string configA
 
         private void MigrateScaleHandles(BoundsControl control, BoundingBox box, string configAssetDirectory)
         {
-            ScaleHandlesConfiguration config = new ScaleHandlesConfiguration();
+            ScaleHandlesConfiguration config = ScriptableObject.CreateInstance<ScaleHandlesConfiguration>();
             AssetDatabase.CreateAsset(config, GenerateUniqueConfigName(configAssetDirectory, box.gameObject, "ScaleHandlesConfiguration"));
 
             config.HandleSlatePrefab = box.ScaleHandleSlatePrefab;
@@ -217,7 +245,7 @@ private void MigrateScaleHandles(BoundsControl control, BoundingBox box, string
 
         private void MigrateRotationHandles(BoundsControl control, BoundingBox box, string configAssetDirectory)
         {
-            RotationHandlesConfiguration config = new RotationHandlesConfiguration();
+            RotationHandlesConfiguration config = ScriptableObject.CreateInstance<RotationHandlesConfiguration>();
             AssetDatabase.CreateAsset(config, GenerateUniqueConfigName(configAssetDirectory, box.gameObject, "RotationHandlesConfiguration"));
 
             config.RotationHandlePrefabColliderType = MigrateRotationHandleColliderType(box.RotationHandlePrefabColliderType);
@@ -235,7 +263,7 @@ private void MigrateRotationHandles(BoundsControl control, BoundingBox box, stri
 
         private void MigrateProximityEffect(BoundsControl control, BoundingBox box, string configAssetDirectory)
         {
-            ProximityEffectConfiguration config = new ProximityEffectConfiguration();
+            ProximityEffectConfiguration config = ScriptableObject.CreateInstance<ProximityEffectConfiguration>();
             AssetDatabase.CreateAsset(config, GenerateUniqueConfigName(configAssetDirectory, box.gameObject, "ProximityEffectConfiguration"));
 
             config.ProximityEffectActive = box.ProximityEffectActive;
@@ -250,5 +278,22 @@ private void MigrateProximityEffect(BoundsControl control, BoundingBox box, stri
 
             control.HandleProximityEffectConfiguration = config;
         }
+
+        #endregion Visuals Configuration Migration
+        private void MigrateAppBar(BoundingBox boundingBox, BoundsControl boundsControl)
+        {
+            // note: this might be expensive for larger scenes but we don't know where the appbar is 
+            // placed in the hierarchy so we have to search the scene for it
+            AppBar[] appBars = Object.FindObjectsOfType<AppBar>(); 
+            for (int i = 0; i < appBars.Length; ++i)
+            {
+                AppBar appBar = appBars[i];
+                if (appBar.BoundingBox == boundingBox)
+                {
+                    Undo.RecordObject(appBar, "BoundsControl migration: changed target of app bar.");
+                    appBar.BoundingBox = boundsControl;
+                }
+            }
+        }
     }
 }

Assets/MixedRealityToolkit.SDK/Features/UX/Scripts/AppBar/AppBar.cs

@@ -111,7 +111,12 @@ public bool UseHide
 
         [Header("Target Bounding Box")]
         [SerializeField]
-        private BoundingBox boundingBox = null;
+        [Tooltip("Object the app bar is controlling - This object must implement the IBoundsTargetProvider.")]
+        private MonoBehaviour boundingBox = null;
+        /// <summary>
+        /// Object the app bar is controlling - This object must implement the IBoundsTargetProvider.
+        /// </summary>
+        public MonoBehaviour BoundingBox { get => boundingBox; set => boundingBox = value; }
 
         [SerializeField]
         private GameObject baseRenderer = null;
@@ -200,7 +205,7 @@ private void LateUpdate()
         public void Reset()
         {
             state = AppBarStateEnum.Default;
-            FollowBoundingBox(false);
+            FollowTargetObject(false);
             lastTimeTapped = Time.time + coolDownTime;
         }
 
@@ -241,8 +246,12 @@ public void OnButtonPressed(AppBarButton button)
         protected virtual void OnClickRemove()
         {
             // Set the app bar and bounding box to inactive
-            boundingBox.Target.SetActive(false);
-            boundingBox.gameObject.SetActive(false);
+            var boundsProvider = BoundingBox as IBoundsTargetProvider;
+            if (boundsProvider != null)
+            {
+                boundsProvider.Target.SetActive(false);
+            }
+            BoundingBox.gameObject.SetActive(false);
             gameObject.SetActive(false);
         }
 
@@ -275,8 +284,8 @@ private void InitializeButtons()
         private void UpdateAppBar()
         {
             UpdateButtons();
-            UpdateBoundingBox();
-            FollowBoundingBox(true);
+            UpdateTargetObject();
+            FollowTargetObject(true);
         }
 
         private void UpdateButtons()
@@ -331,9 +340,10 @@ private void UpdateButtons()
             backgroundBar.transform.localPosition = Vector3.forward * buttonDepth / 2;
         }
 
-        private void UpdateBoundingBox()
+        private void UpdateTargetObject()
         {
-            if (boundingBox == null || boundingBox.Target == null)
+            var boundsProvider = BoundingBox as IBoundsTargetProvider;
+            if (boundsProvider == null || boundsProvider.Target == null)
             {
                 if (displayType == AppBarDisplayTypeEnum.Manipulation)
                 {
@@ -347,36 +357,37 @@ private void UpdateBoundingBox()
                 return;
             }
 
-            // BoundingBox can't update in editor mode
+            // Target can't be updated in editor mode
             if (!Application.isPlaying)
                 return;
 
-            if (boundingBox == null)
+            if (boundsProvider == null)
                 return;
 
             switch (state)
             {
                 case AppBarStateEnum.Manipulation:
-                    boundingBox.Active = true;
+                    boundsProvider.Active = true;
                     break;
 
                 default:
-                    boundingBox.Active = false;
+                    boundsProvider.Active = false;
                     break;
             }
         }
 
-        private void FollowBoundingBox(bool smooth)
+        private void FollowTargetObject(bool smooth)
         {
-            if (boundingBox == null)
+            var boundsProvider = BoundingBox as IBoundsTargetProvider;
+            if (boundsProvider == null)
                 return;
 
             //calculate best follow position for AppBar
             Vector3 finalPosition = Vector3.zero;
             Vector3 headPosition = CameraCache.Main.transform.position;
             boundsPoints.Clear();
 
-            helper.UpdateNonAABoundingBoxCornerPositions(boundingBox, boundsPoints);
+            helper.UpdateNonAABoundsCornerPositions(boundsProvider.TargetBounds, boundsPoints);
             int followingFaceIndex = helper.GetIndexOfForwardFace(headPosition);
             Vector3 faceNormal = helper.GetFaceNormal(followingFaceIndex);
 
@@ -387,7 +398,7 @@ private void FollowBoundingBox(bool smooth)
             transform.position = smooth ? Vector3.Lerp(transform.position, finalPosition, Time.deltaTime * backgroundBarMoveSpeed) : finalPosition;
 
             // Rotate on the y axis
-            Vector3 direction = (boundingBox.TargetBounds.bounds.center - finalPosition).normalized;
+            Vector3 direction = (boundsProvider.TargetBounds.bounds.center - finalPosition).normalized;
             if (direction != Vector3.zero)
             {
                 Vector3 eulerAngles = Quaternion.LookRotation(direction, Vector3.up).eulerAngles;