Merge pull request #10007 from Zee2/scalehandle-fix

Fixing BC Scale Handles

Author: Zee2

Assets/MRTK/SDK/Features/UX/Scripts/BoundsControl/BoundsControl.cs

@@ -1541,7 +1541,7 @@ private void UpdateVisuals()
                 links.UpdateLinkScales(currentBoundsExtents);
 
                 translationHandles.CalculateHandlePositions(ref boundsCorners);
-                scaleHandles.UpdateHandles(ref boundsCorners);
+                scaleHandles.CalculateHandlePositions(ref boundsCorners);
 
                 boxDisplay.UpdateDisplay(currentBoundsExtents, flattenAxis);
 

Assets/MRTK/SDK/Features/UX/Scripts/BoundsControl/Visuals/ScaleHandles.cs

@@ -16,8 +16,17 @@ public class ScaleHandles : HandlesBase
         protected override HandlesBaseConfiguration BaseConfig => config;
         private ScaleHandlesConfiguration config;
         private bool areHandlesFlattened = false;
+
+        /// <summary>
+        /// Cached handle positions - we keep track of handle positions in this array
+        /// in case we have to reload the handles due to configuration changes.
+        /// </summary>
+        protected Vector3[] HandlePositions { get; private set; }
+        private const int NumHandles = 8;
         internal ScaleHandles(ScaleHandlesConfiguration configuration)
         {
+            HandlePositions = new Vector3[NumHandles];
+
             Debug.Assert(configuration != null, "Can't create BoundsControlScaleHandles without valid configuration");
             config = configuration;
             config.handlesChanged.AddListener(HandlesChanged);
@@ -39,16 +48,30 @@ internal void UpdateVisibilityInInspector(HideFlags flags)
             }
         }
 
-        internal void UpdateHandles(ref Vector3[] boundsCorners)
+        internal void UpdateHandles()
         {
             for (int i = 0; i < handles.Count; ++i)
             {
-                handles[i].position = boundsCorners[i];
+                handles[i].position = HandlePositions[i];
+            }
+        }
+
+        internal void CalculateHandlePositions(ref Vector3[] boundsCorners)
+        {
+            if (boundsCorners != null && HandlePositions != null)
+            {
+                for (int i = 0; i < HandlePositions.Length; ++i)
+                {
+                    HandlePositions[i] = boundsCorners[i];
+                }
+                UpdateHandles();
             }
         }
 
         internal void Create(ref Vector3[] boundsCorners, Transform parent, bool isFlattened)
         {
+            CalculateHandlePositions(ref boundsCorners);
+
             // create corners
             for (int i = 0; i < boundsCorners.Length; ++i)
             {
@@ -57,20 +80,9 @@ internal void Create(ref Vector3[] boundsCorners, Transform parent, bool isFlatt
                     name = "corner_" + i.ToString()
                 };
                 corner.transform.parent = parent;
-                corner.transform.localPosition = boundsCorners[i];
+                corner.transform.localPosition = HandlePositions[i];
 
-                GameObject visualsScale = new GameObject();
-                visualsScale.name = "visualsScale";
-                visualsScale.transform.parent = corner.transform;
-                visualsScale.transform.localPosition = Vector3.zero;
-
-                // Compute mirroring scale
-                {
-                    Vector3 p = boundsCorners[i];
-                    visualsScale.transform.localScale = new Vector3(Mathf.Sign(p[0]), Mathf.Sign(p[1]), Mathf.Sign(p[2]));
-                }
-
-                Bounds visualBounds = CreateVisual(visualsScale, isFlattened);
+                Bounds visualBounds = CreateVisual(i, corner, isFlattened);
                 var invScale = visualBounds.size.x == 0.0f ? 0.0f : config.HandleSize / visualBounds.size.x;
                 VisualUtils.AddComponentsToAffordance(corner, new Bounds(visualBounds.center * invScale, visualBounds.size * invScale),
                     HandlePrefabCollider.Box, CursorContextInfo.CursorAction.Scale, config.ColliderPadding, parent, config.DrawTetherWhenManipulating);
@@ -85,93 +97,117 @@ protected override void RecreateVisuals()
         {
             for (int i = 0; i < handles.Count; ++i)
             {
-                // get parent of visual
-                Transform visualsScaleParent = handles[i].Find("visualsScale");
-                if (visualsScaleParent)
+                
+                Transform obsoleteChild = handles[i].Find(visualsName);
+                if (obsoleteChild)
+                {
+                    obsoleteChild.parent = null;
+                    Object.Destroy(obsoleteChild.gameObject);
+                }
+                else
                 {
-                    // get old child and remove it
-                    Transform obsoleteChild = visualsScaleParent.Find(visualsName);
-                    if (obsoleteChild)
-                    {
-                        obsoleteChild.parent = null;
-                        Object.Destroy(obsoleteChild.gameObject);
-                    }
-                    else
-                    {
-                        Debug.LogError("couldn't find corner visual on recreating visuals");
-                    }
-
-                    // create new visual
-                    Bounds cornerBounds = CreateVisual(visualsScaleParent.gameObject, areHandlesFlattened);
-
-                    // update handle collider bounds
-                    UpdateColliderBounds(handles[i], cornerBounds.size);
+                    Debug.LogError("Couldn't find corner visual on recreating visuals");
                 }
+
+                // create new visual
+                Bounds visualBounds = CreateVisual(i, handles[i].gameObject, areHandlesFlattened);
+
+                // update handle collider bounds
+                UpdateColliderBounds(handles[i], visualBounds.size);
             }
 
             objectsChangedEvent.Invoke(this);
         }
 
         protected override void UpdateColliderBounds(Transform handle, Vector3 visualSize)
         {
-            var invScale = visualSize.x == 0.0f ? 0.0f : config.HandleSize / visualSize.x;
+            float maxDim = VisualUtils.GetMaxComponent(visualSize);
+            float invScale = maxDim == 0.0f ? 0.0f : config.HandleSize / maxDim;
             GetVisual(handle).transform.localScale = new Vector3(invScale, invScale, invScale);
             BoxCollider collider = handle.gameObject.GetComponent<BoxCollider>();
             Vector3 colliderSize = visualSize * invScale;
             collider.size = colliderSize;
             collider.size += BaseConfig.ColliderPadding;
-            collider.center = new Vector3(collider.size.x, collider.size.y, collider.size.z) * 0.5f;
+            collider.center = Vector3.zero;
         }
 
         /// <summary>
         /// Creates the corner visual and returns the bounds of the created visual
         /// </summary>
+        /// <param name="handleIndex">cornerIndex</param>
         /// <param name="parent">parent of visual</param>
         /// <param name="isFlattened">instantiate in flattened mode - slate</param>
         /// <returns>bounds of the created visual</returns>
-        private Bounds CreateVisual(GameObject parent, bool isFlattened)
+        private Bounds CreateVisual(int handleIndex, GameObject parent, bool isFlattened)
         {
             // figure out which prefab to instantiate
-            GameObject cornerVisual = null;
+            GameObject handleVisual = null;
             areHandlesFlattened = isFlattened;
             GameObject prefabType = isFlattened ? config.HandleSlatePrefab : config.HandlePrefab;
             if (prefabType == null)
             {
                 // instantiate default prefab, a cube with box collider
-                cornerVisual = GameObject.CreatePrimitive(PrimitiveType.Cube);
-                cornerVisual.transform.parent = parent.transform;
-                cornerVisual.transform.localPosition = Vector3.zero;
+                handleVisual = GameObject.CreatePrimitive(PrimitiveType.Cube);
+                
                 // deactivate collider on visuals and register for deletion - actual collider
                 // of handle is attached to the handle gameobject, not the visual
-                var collider = cornerVisual.GetComponent<BoxCollider>();
+                var collider = handleVisual.GetComponent<BoxCollider>();
                 collider.enabled = false;
-                Object.Destroy(collider);
+                UnityEngine.Object.Destroy(collider);
             }
             else
             {
-                cornerVisual = GameObject.Instantiate(prefabType, parent.transform);
+                handleVisual = GameObject.Instantiate(prefabType, parent.transform);
             }
+            
+            // this is the size of the corner visuals
+            var handleVisualBounds = VisualUtils.GetMaxBounds(handleVisual);
+            float maxDim = VisualUtils.GetMaxComponent(handleVisualBounds.size);
+            float invScale = maxDim == 0.0f ? 0.0f : config.HandleSize / maxDim;
+
+            handleVisual.name = visualsName;
+            handleVisual.transform.parent = parent.transform;
+            handleVisual.transform.localScale = new Vector3(invScale, invScale, invScale);
+            handleVisual.transform.localPosition = Vector3.zero;
+            handleVisual.transform.localRotation = Quaternion.identity;
 
             if (isFlattened)
             {
                 // Rotate 2D slate handle asset for proper orientation
-                cornerVisual.transform.Rotate(0, 0, -90);
+                parent.transform.Rotate(0, 0, -90);
+            }
+            else
+            {
+                Quaternion realignment = GetRotationRealignment(handleIndex);
+                parent.transform.localRotation = realignment;
             }
 
-            cornerVisual.name = visualsName;
+            if(config.HandleMaterial != null)
+            {
+                VisualUtils.ApplyMaterialToAllRenderers(handleVisual, config.HandleMaterial);
+            }
 
-            // this is the size of the corner visuals
-            var cornerbounds = VisualUtils.GetMaxBounds(cornerVisual);
-            float maxDim = Mathf.Max(Mathf.Max(cornerbounds.size.x, cornerbounds.size.y), cornerbounds.size.z);
-            cornerbounds.size = maxDim * Vector3.one;
+            return handleVisualBounds;
+        }
+
+        protected Quaternion GetRotationRealignment(int handleIndex)
+        {
+            // Helper lambda to sign a vector.
+            Vector3 signVector(Vector3 i) => new Vector3(Mathf.Sign(i.x), Mathf.Sign(i.y), Mathf.Sign(i.z));
 
-            // we need to multiply by this amount to get to desired scale handle size
-            var invScale = cornerbounds.size.x == 0.0f ? 0.0f : config.HandleSize / cornerbounds.size.x;
-            cornerVisual.transform.localScale = new Vector3(invScale, invScale, invScale);
+            // The neutral handle is the handle position at which
+            // the corner handle model is appropriately aligned, sans any rotation
+            Vector3 neutralHandle = signVector(HandlePositions[6]);
+            Vector3 handlePos = signVector(HandlePositions[handleIndex]);
 
-            VisualUtils.ApplyMaterialToAllRenderers(cornerVisual, config.HandleMaterial);
+            // Flip the handle if it's on the underside of the bounds.
+            Quaternion flip = Quaternion.Euler(0, 0, handlePos.y > 0 ? 0 : 90);
 
-            return cornerbounds;
+            float angleAroundVertical = Vector3.SignedAngle(new Vector3(neutralHandle.x, 0, neutralHandle.z),
+                                                            new Vector3(handlePos.x, 0, handlePos.z),
+                                                            Vector3.up);
+
+            return Quaternion.Euler(0, angleAroundVertical, 0) * flip;
         }
 
         internal void Reset(bool areHandlesActive, FlattenModeType flattenAxis)
@@ -191,13 +227,7 @@ internal void Reset(bool areHandlesActive, FlattenModeType flattenAxis)
 
         protected override Transform GetVisual(Transform handle)
         {
-            Transform firstChild = handle.GetChild(0);
-            if (firstChild == null)
-            {
-                return null;
-            }
-
-            Transform visual = firstChild.GetChild(0);
+            Transform visual = handle.GetChild(0);
             if (visual != null && visual.name == visualsName)
             {
                 return visual;