Merge pull request #57 from OpenCommissioning/56-un_boundingbox

56 un boundingbox

Author: Preliy

Documentation/Images/BoundBoxColliderSize_Inspector.png

@@ -1033,6 +1033,13 @@ In this example, groups based on the   [`Hierarchy`](#defining-the-device-hierar
 components in the project tree are created in the configuration file that contain
 the devices located within the child objects of these groups.
 
+## Useful Functions
+### Auto Box Collider Size
+Calculates and adjusts a GameObject's `Box Collider` to tightly enclose all child `MeshRenderer` meshes.
+In the Unity Editor, select the Material Flow component in the Inspector and open its context menu:
+You can call this function from the Material Flow component’s context menu in the Inspector.
+
+![BoundBoxColliderSize_Inspector.png](Documentation/Images/BoundBoxColliderSize_Inspector.png)
 
 # Contributing
 

Documentation/Images/BoundBoxColliderSize_Inspector.png.meta

@@ -1,3 +1,4 @@
+using System;
 using System.Collections;
 using System.Collections.Generic;
 using System.Linq;
@@ -98,30 +99,61 @@ public static void Destroy(this Object obj)
                 Object.Destroy(obj);
             }
         }
-        
-        public static Bounds GetLocalBoundsForChildrenMeshes(GameObject go)
+
+        /// <summary>
+        /// Adjusts the GameObject’s BoxCollider to bounding box for all child meshes.
+        /// </summary>
+        /// <param name="gameObject">Target GameObject.</param>
+        /// <param name="boxCollider">The BoxCollider if found and updated; null otherwise.</param>
+        /// <returns>True if the collider was found and updated; false on error.</returns>
+        public static bool TryBoundBoxColliderSize(GameObject gameObject, out BoxCollider boxCollider)
         {
-            var referenceTransform = go.transform;
-            var b = new Bounds(Vector3.zero, Vector3.zero);
-            RecurseEncapsulate(referenceTransform, ref b);
-            return b;
-                       
-            void RecurseEncapsulate(Transform child, ref Bounds bounds)
+            try
             {
-                var mesh = child.GetComponent<MeshFilter>();
-                if (mesh)
-                {
-                    var lsBounds = mesh.sharedMesh.bounds;
-                    var wsMin = child.TransformPoint(lsBounds.center - lsBounds.extents);
-                    var wsMax = child.TransformPoint(lsBounds.center + lsBounds.extents);
-                    bounds.Encapsulate(referenceTransform.InverseTransformPoint(wsMin));
-                    bounds.Encapsulate(referenceTransform.InverseTransformPoint(wsMax));
-                }
-                foreach (Transform grandChild in child.transform)
+                if (gameObject == null) throw new NullReferenceException("GameObject is null");
+                boxCollider = gameObject.GetComponent<BoxCollider>();
+                if (boxCollider == null)
                 {
-                    RecurseEncapsulate(grandChild, ref bounds);
+                    throw new NullReferenceException("BoxCollider is null");
                 }
+#if UNITY_EDITOR
+                UnityEditor.Undo.RecordObject(boxCollider, "Set Box Collider Bound Size");
+#endif               
+                var bounds = GetLocalBoundsForChildrenMeshes(gameObject);
+                boxCollider.center = bounds.center;
+                boxCollider.size = bounds.size;
+                
+#if UNITY_EDITOR
+                
+                UnityEditor.EditorUtility.SetDirty(gameObject);
+#endif
+                return true;
+            }
+            catch (Exception exception)
+            {
+                Debug.LogError($"TryBoundBoxColliderSize: {exception}", gameObject);
+                boxCollider = null;
+                return false;
+            }
+        }
+        
+        /// <summary>
+        /// Computes the local-space axis-aligned Bounds that encapsulate all MeshFilter meshes in the given GameObject’s hierarchy.
+        /// </summary>
+        /// <param name="gameObject">Target GameObject.</param>
+        /// <returns>Bounds in the GameObject’s local space covering all child meshes.</returns>
+        public static Bounds GetLocalBoundsForChildrenMeshes(GameObject gameObject)
+        {
+            var transform = gameObject.transform;
+            var localBounds = new Bounds(Vector3.zero, Vector3.zero);
+            var filters = gameObject.GetComponentsInChildren<MeshFilter>();
+            foreach (var meshFilter in filters)
+            {
+                var matrix = transform.localToWorldMatrix.inverse * meshFilter.transform.localToWorldMatrix;
+                var axisAlignedBounds = GeometryUtility.CalculateBounds(meshFilter.sharedMesh.vertices, matrix);
+                localBounds.Encapsulate(axisAlignedBounds);
             }
+            return localBounds;
         }
     }
 }

README.md

@@ -76,6 +76,15 @@ private void Reset()
             _length.OnValidate();
         }
 
+        [ContextMenu("Bound Box Collider Size", false, 100)]
+        public new void BoundBoxColliderSize()
+        {
+            if (Utils.TryBoundBoxColliderSize(gameObject, out _))
+            {
+                _useBoxCollider = true;
+            }
+        }
+
         protected override void OnCollisionChangedAction(bool value)
         {
             base.OnCollisionChangedAction(value);

Runtime/Scripts/Common/Utils.cs

@@ -1,7 +1,6 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using NaughtyAttributes;
 using UnityEngine;
 using UnityEngine.Events;
 using UnityEngine.EventSystems;
@@ -64,7 +63,7 @@ protected void OnDestroy()
 
         private void Reset()
         {
-            BoundColliderSize();
+            BoundBoxColliderSize();
             gameObject.layer = (int)DefaultLayers.Interactions;
         }
 
@@ -126,15 +125,13 @@ public void OnPointerUp(PointerEventData eventData)
             if (_mode.HasFlag(InteractionMode.Click)) OnPointerUpEvent?.Invoke();
         }
 
-        [Button]
-        public void BoundColliderSize()
+        [ContextMenu("Bound Box Collider Size", false, 100)]
+        public void BoundBoxColliderSize()
         {
-            var bounds = Utils.GetLocalBoundsForChildrenMeshes(gameObject);
-
-            var boxCollider = GetComponent<BoxCollider>();
-            boxCollider.isTrigger = true;
-            boxCollider.center = bounds.center;
-            boxCollider.size = bounds.size;
+            if (Utils.TryBoundBoxColliderSize(gameObject, out var boxCollider))
+            {
+                boxCollider.isTrigger = true;
+            }
         }
     }
 }

Runtime/Scripts/Components/SensorBinary.cs

@@ -84,5 +84,11 @@ protected virtual void OnPayloadExitAction(PayloadBase payloadBase)
             "Static",
             "Storage"
         };
+        
+        [ContextMenu("Bound Box Collider Size", false, 100)]
+        public void BoundBoxColliderSize()
+        {
+            Utils.TryBoundBoxColliderSize(gameObject, out _);
+        }
     }
 }

Runtime/Scripts/Interactions/Interaction.cs

@@ -8,7 +8,6 @@ namespace OC.MaterialFlow
     [SelectionBase]
     [DisallowMultipleComponent]
     [RequireComponent(typeof(Rigidbody))]
-    [RequireComponent(typeof(BoxCollider))]
     public class Payload : PayloadBase, IInteractable
     {
         public IProperty<ControlState> ControlState => _controlState;
@@ -53,6 +52,7 @@ private void Awake()
         {
             _rigidbody = GetComponent<Rigidbody>();
             _collider = GetComponent<Collider>();
+            if (_collider == null) Debug.LogError($"Collider not found on {gameObject}", this);
         }
 
         private void OnEnable()
@@ -85,6 +85,14 @@ private void OnEnable()
             UnregistrateInParent();
         }
 
+        private void Reset()
+        {
+            if (GetComponent<Collider>() == null)
+            {
+                gameObject.AddComponent<BoxCollider>();
+            }
+        }
+
         public void Registrate(ulong uniqueId = 0)
         {
             _isRegistered = true;
@@ -97,7 +105,7 @@ public void Unregistrate(ulong uniqueId = 0)
             _uniqueId = uniqueId;
         }
 
-        public void ApplyDiscription(PayloadDescription description)
+        public void ApplyDescription(PayloadDescription description)
         {
             Unregistrate(description.UniqueId);
             name = description.Name;
@@ -108,6 +116,12 @@ public void ApplyDiscription(PayloadDescription description)
             _typeId = description.TypeId;
             _parentUniqueId = description.ParentUniqueId;
         }
+        
+        [ContextMenu("Bound Box Collider Size", false, 100)]
+        public void BoundBoxColliderSize()
+        {
+            Utils.TryBoundBoxColliderSize(gameObject, out _);
+        }
 
         private void OnControlStateChanged(ControlState state)
         {

Runtime/Scripts/MaterialFlow/Detector.cs

@@ -111,7 +111,7 @@ public Payload Instantiate(PayloadDescription description)
             var payload = Instantiate(description.Transform.GetPosition(), description.Transform.rotation, description.TypeId, description.UniqueId);
             if (payload is null) return null;
 
-            payload.ApplyDiscription(description);
+            payload.ApplyDescription(description);
 
             var parent = FindPayload(description.ParentUniqueId);
             if (parent is not null)