Fix constraint highlighting for custom contraints (#1078)

* Add missing AddComponentMenu attributes

* Formatting and updates

* Fix constraint highlighting for custom contraints

* Update CHANGELOG.md

Author: keveleigh

org.mixedrealitytoolkit.spatialmanipulation/BoundsControl/Visuals/SpatialManipulationReticle.cs

@@ -12,6 +12,7 @@ namespace MixedReality.Toolkit.SpatialManipulation
     /// A reticle used to visualize spatial manipulation capabilities when hovering over a bounding box handle.
     /// The reticle is oriented in relation to the bounding box, to indicate the direction for rotation or scaling.
     /// </summary>
+    [AddComponentMenu("MRTK/Spatial Manipulation/Spatial Manipulation Reticle")]
     public class SpatialManipulationReticle : MonoBehaviour, IReticleVisual
     {
         /// <summary>
@@ -113,7 +114,7 @@ private void RotateReticle(Vector3 reticleNormal, Transform hitTargetTransform)
                     }
                 default: break;
             }
-            
+
             // Cache the world rotation 
             worldRotationCache = transform.rotation;
         }

org.mixedrealitytoolkit.spatialmanipulation/CHANGELOG.md

@@ -18,6 +18,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 * Fixed issues with HandConstraint hand tracking events not being fired (OnFirstHandDetected/OnHandActivate/OnLastHandLost/OnHandDeactivate) when SolverHandler TrackedHand is set to Right or Left (not Both) [PR #956](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/956)
 * Updated dependencies to match Unity Asset Store packages. [PR #1054](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/1054)
   * org.mixedrealitytoolkit.core 3.2.2
+* Fixed `Constraint Manager` not properly highlighting custom constraints via the "Go to component" button. [PR #1078](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/1078)
 
 ## [3.3.0] - 2024-04-30
 

org.mixedrealitytoolkit.spatialmanipulation/Constraints/FixedDistanceConstraint.cs

@@ -13,6 +13,7 @@ namespace MixedReality.Toolkit.SpatialManipulation
     /// MRTK's constraint system might be redesigned in the near future. When
     /// this occurs, the old constraint components will be deprecated.
     /// </remarks>
+    [AddComponentMenu("MRTK/Spatial Manipulation/Fixed Distance Constraint")]
     public class FixedDistanceConstraint : TransformConstraint
     {
         #region Properties

org.mixedrealitytoolkit.spatialmanipulation/Constraints/FixedRotationToUserConstraint.cs

@@ -12,6 +12,7 @@ namespace MixedReality.Toolkit.SpatialManipulation
     /// MRTK's constraint system might be redesigned in the near future. When
     /// this occurs, the old constraint components will be deprecated.
     /// </remarks>
+    [AddComponentMenu("MRTK/Spatial Manipulation/Fixed Rotation to User Constraint")]
     public class FixedRotationToUserConstraint : TransformConstraint
     {
         #region Properties
@@ -46,4 +47,4 @@ public override void ApplyConstraint(ref MixedRealityTransform transform)
 
         #endregion Public Methods
     }
-}
+}

org.mixedrealitytoolkit.spatialmanipulation/Constraints/FixedRotationToWorldConstraint.cs

@@ -1,6 +1,8 @@
 // Copyright (c) Mixed Reality Toolkit Contributors
 // Licensed under the BSD 3-Clause
 
+using UnityEngine;
+
 namespace MixedReality.Toolkit.SpatialManipulation
 {
     /// <summary>
@@ -10,6 +12,7 @@ namespace MixedReality.Toolkit.SpatialManipulation
     /// MRTK's constraint system might be redesigned in the near future. When
     /// this occurs, the old constraint components will be deprecated.
     /// </remarks>
+    [AddComponentMenu("MRTK/Spatial Manipulation/Fixed Rotation to World Constraint")]
     public class FixedRotationToWorldConstraint : TransformConstraint
     {
         #region Properties
@@ -31,4 +34,4 @@ public override void ApplyConstraint(ref MixedRealityTransform transform)
 
         #endregion Public Methods
     }
-}
+}

org.mixedrealitytoolkit.spatialmanipulation/Constraints/MaintainApparentSizeConstraint.cs

@@ -13,6 +13,7 @@ namespace MixedReality.Toolkit.SpatialManipulation
     /// MRTK's constraint system might be redesigned in the near future. When
     /// this occurs, the old constraint components will be deprecated.
     /// </remarks>
+    [AddComponentMenu("MRTK/Spatial Manipulation/Maintain Apparent Size Constraint")]
     public class MaintainApparentSizeConstraint : TransformConstraint
     {
         #region Properties

org.mixedrealitytoolkit.spatialmanipulation/Constraints/MoveAxisConstraint.cs

@@ -13,6 +13,7 @@ namespace MixedReality.Toolkit.SpatialManipulation
     /// MRTK's constraint system might be redesigned in the near future. When
     /// this occurs, the old constraint components will be deprecated.
     /// </remarks>
+    [AddComponentMenu("MRTK/Spatial Manipulation/Move Axis Constraint")]
     public class MoveAxisConstraint : TransformConstraint
     {
         #region Properties
@@ -103,4 +104,4 @@ public override void ApplyConstraint(ref MixedRealityTransform transform)
 
         #endregion Public Methods
     }
-}
+}

org.mixedrealitytoolkit.spatialmanipulation/Constraints/RotationAxisConstraint.cs

@@ -12,6 +12,7 @@ namespace MixedReality.Toolkit.SpatialManipulation
     /// <remarks>
     /// The constraint system might be reworked in the future. In such a case, these existing components will be deprecated.
     /// </remarks>
+    [AddComponentMenu("MRTK/Spatial Manipulation/Rotation Axis Constraint")]
     public class RotationAxisConstraint : TransformConstraint
     {
         #region Properties
@@ -78,4 +79,4 @@ public override void ApplyConstraint(ref MixedRealityTransform transform)
 
         #endregion Public Methods
     }
-}
+}

org.mixedrealitytoolkit.spatialmanipulation/Editor/Constraints/ConstraintManagerEditor.cs

@@ -5,6 +5,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Reflection;
 using UnityEditor;
 using UnityEngine;
 
@@ -29,7 +30,7 @@ public class ConstraintManagerEditor : UnityEditor.Editor
         private ConstraintManager constraintManager;
 
         private const string autoMsg = "Constraint manager is currently set to auto mode. In auto mode all" +
-            " constraints attached to this gameobject will automatically be processed by this manager.";
+            " constraints attached to this GameObject will automatically be processed by this manager.";
         private const string manualMsg = "Constraint manager is currently set to manual mode. In manual mode" +
             " only constraints that are linked in the below component list will be processed by this manager.";
 
@@ -75,7 +76,7 @@ private static EntryAction RenderManualConstraintItem(SerializedProperty constra
                         return EntryAction.Highlight;
                     }
 
-                    if (InspectorUIUtility.FlexButton(new GUIContent("Remove Entry", "Remove constraint from constraint manager but keep constraint component attached to the gameobject.")))
+                    if (InspectorUIUtility.FlexButton(new GUIContent("Remove Entry", "Remove constraint from constraint manager but keep constraint component attached to the GameObject.")))
                     {
                         return EntryAction.Detach;
                     }
@@ -86,8 +87,8 @@ private static EntryAction RenderManualConstraintItem(SerializedProperty constra
 
         private void AddNewConstraint(Type t)
         {
-            var constraint = constraintManager.gameObject.AddComponent((Type)t);
-            AttachConstraint((TransformConstraint)constraint);
+            TransformConstraint constraint = constraintManager.gameObject.AddComponent(t) as TransformConstraint;
+            AttachConstraint(constraint);
         }
 
         private void AttachConstraint(TransformConstraint constraint)
@@ -101,23 +102,21 @@ private void AttachConstraint(TransformConstraint constraint)
         private void RenderAutoConstraintMenu()
         {
             // component list
-            var constraints = constraintManager.gameObject.GetComponents<TransformConstraint>();
-            foreach (var constraint in constraints)
+            TransformConstraint[] constraints = constraintManager.gameObject.GetComponents<TransformConstraint>();
+            foreach (TransformConstraint constraint in constraints)
             {
                 using (new EditorGUILayout.HorizontalScope())
                 {
-                    string constraintName = constraint.GetType().Name;
-                    EditorGUILayout.LabelField($"Priority {(constraint as TransformConstraint).ExecutionPriority}: {constraint.GetType().Name}");
+                    EditorGUILayout.LabelField($"Priority {constraint.ExecutionPriority}: {constraint.GetType().Name}");
                     if (GUILayout.Button("Go to component"))
                     {
-                        Highlighter.Highlight("Inspector", $"{ObjectNames.NicifyVariableName(constraintName)}");
-                        EditorGUIUtility.ExitGUI();
+                        HighlightConstraint(constraint.GetType());
                     }
                 }
             }
 
             // add button
-            if (EditorGUILayout.DropdownButton(new GUIContent("Add Constraint to GameObject", "Add a constraint to the gameobject that will be picked up by the constraint manager auto mode."), FocusType.Keyboard))
+            if (EditorGUILayout.DropdownButton(new GUIContent("Add Constraint to GameObject", "Add a constraint to the GameObject that will be picked up by the constraint manager auto mode."), FocusType.Keyboard))
             {
                 // create the menu and add items to it
                 GenericMenu menu = new GenericMenu();
@@ -129,8 +128,7 @@ private void RenderAutoConstraintMenu()
 
                 foreach (var derivedType in types)
                 {
-                    menu.AddItem(new GUIContent(derivedType.Name), false, t =>
-                     constraintManager.gameObject.AddComponent((Type)t), derivedType);
+                    menu.AddItem(new GUIContent(derivedType.Name), false, t => constraintManager.gameObject.AddComponent((Type)t), derivedType);
                 }
 
                 menu.ShowAsContext();
@@ -142,24 +140,22 @@ private void RenderManualConstraintMenu()
             for (int i = 0; i < selectedConstraints.arraySize; i++)
             {
                 SerializedProperty constraintProperty = selectedConstraints.GetArrayElementAtIndex(i);
-                var buttonAction = RenderManualConstraintItem(constraintProperty, true);
+                EntryAction buttonAction = RenderManualConstraintItem(constraintProperty, true);
                 if (buttonAction == EntryAction.Detach)
                 {
                     indicesToRemove.Add(i);
                 }
                 else if (buttonAction == EntryAction.Highlight)
                 {
-                    string constraintName = constraintProperty.objectReferenceValue.GetType().Name;
-                    Highlighter.Highlight("Inspector", $"{ObjectNames.NicifyVariableName(constraintName)}");
-                    EditorGUIUtility.ExitGUI();
+                    HighlightConstraint(constraintProperty.objectReferenceValue.GetType());
                 }
             }
 
             // add buttons
             {
                 using (new EditorGUILayout.HorizontalScope())
                 {
-                    if (EditorGUILayout.DropdownButton(new GUIContent("Add Entry", "Attach an already existing component from this gameobject to the constraint manager selection."), FocusType.Keyboard))
+                    if (EditorGUILayout.DropdownButton(new GUIContent("Add Entry", "Attach an already existing component from this GameObject to the constraint manager selection."), FocusType.Keyboard))
                     {
                         // create the menu and add items to it
                         GenericMenu menu = new GenericMenu();
@@ -175,8 +171,7 @@ private void RenderManualConstraintMenu()
                             {
                                 hasEntries = true;
                                 string constraintName = constraint.GetType().Name;
-                                menu.AddItem(new GUIContent(constraintName), false, t =>
-                                 AttachConstraint((TransformConstraint)t), constraint);
+                                menu.AddItem(new GUIContent(constraintName), false, t => AttachConstraint((TransformConstraint)t), constraint);
                             }
                         }
 
@@ -194,7 +189,7 @@ private void RenderManualConstraintMenu()
                         menu.ShowAsContext();
                     }
 
-                    if (EditorGUILayout.DropdownButton(new GUIContent("Add New Constraint", "Add a constraint to the gameobject and attach to this constraint manager selection."), FocusType.Keyboard))
+                    if (EditorGUILayout.DropdownButton(new GUIContent("Add New Constraint", "Add a constraint to the GameObject and attach to this constraint manager selection."), FocusType.Keyboard))
                     {
                         // create the menu and add items to it
                         GenericMenu menu = new GenericMenu();
@@ -206,8 +201,7 @@ private void RenderManualConstraintMenu()
 
                         foreach (var derivedType in types)
                         {
-                            menu.AddItem(new GUIContent(derivedType.Name), false, t =>
-                             AddNewConstraint((Type)t), derivedType);
+                            menu.AddItem(new GUIContent(derivedType.Name), false, t => AddNewConstraint((Type)t), derivedType);
                         }
 
                         menu.ShowAsContext();
@@ -216,6 +210,23 @@ private void RenderManualConstraintMenu()
             }
         }
 
+        private void HighlightConstraint(Type type)
+        {
+            string highlightName;
+            AddComponentMenu addComponentMenu = type.GetCustomAttribute<AddComponentMenu>();
+            if (addComponentMenu != null)
+            {
+                // Parse the "nice" name as the last item from the add component menu
+                highlightName = addComponentMenu.componentMenu.Replace('\\', '/').Split('/')[^1];
+            }
+            else
+            {
+                highlightName = $"{ObjectNames.NicifyVariableName(type.Name)} (Script)";
+            }
+            Highlighter.Highlight("Inspector", highlightName);
+            GUIUtility.ExitGUI();
+        }
+
         /// <summary>
         /// Called by the Unity editor to render custom inspector UI for this component.
         /// </summary>
@@ -233,8 +244,7 @@ public override void OnInspectorGUI()
                 {
                     EditorGUILayout.Space();
 
-                    EditorGUILayout.HelpBox(autoConstraintSelection.boolValue == true ? autoMsg : manualMsg
-                        , UnityEditor.MessageType.Info);
+                    EditorGUILayout.HelpBox(autoConstraintSelection.boolValue == true ? autoMsg : manualMsg, MessageType.Info);
                     EditorGUILayout.Space();
 
                     int tab = autoConstraintSelection.boolValue == true ? 0 : 1;
@@ -276,7 +286,7 @@ public override void OnInspectorGUI()
                     // we render the instance id of this component so our highlighting function can distinguish between 
                     // the different instances of constraint manager - highlighting in the inspector is currently 
                     // only available for string search which causes problems with multiple components of the same type 
-                    // attached to the same gameobject.
+                    // attached to the same GameObject.
                     EditorGUILayout.Space();
                     EditorGUILayout.LabelField("ComponentId: " + constraintManager.GetInstanceID(), EditorStyles.miniLabel);
 
@@ -302,15 +312,15 @@ public override void OnInspectorGUI()
         }
 
         /// <summary>
-        /// Util method for drawing a consistent constraints section.
+        /// Utility method for drawing a consistent constraints section.
         /// Use this method in a component inspector for linking to a constraint manager. 
         /// </summary>
         /// <param name="gameObject">Game object the constraint manager is attached to.</param>
         /// <param name="managerEnabled">Serialized property for enabling the manager - needs to be of type bool.</param>
         /// <param name="managerRef">Serialized property of the constraint manager component link - needs to be type of ConstraintManager.</param>
         /// <param name="isExpanded">Flag for indicating if the constraint foldout was previously collapsed or expanded.</param>
         /// <returns>Current state of expanded or collapsed constraint foldout. Returns true if expanded / contents visible.</returns>
-        static public bool DrawConstraintManagerFoldout(GameObject gameObject, SerializedProperty managerEnabled, SerializedProperty managerRef, bool isExpanded)
+        public static bool DrawConstraintManagerFoldout(GameObject gameObject, SerializedProperty managerEnabled, SerializedProperty managerRef, bool isExpanded)
         {
             isExpanded = EditorGUILayout.Foldout(isExpanded, "Constraints", true);
 
@@ -340,7 +350,7 @@ static public bool DrawConstraintManagerFoldout(GameObject gameObject, Serialize
 
                     // popups will only show unique elements
                     // in case of auto selection we don't care which one we're selecting as the behavior will be the same.
-                    // in case of manual selection users might want to differentiate which constraintmanager they are referring to.
+                    // in case of manual selection users might want to differentiate which ConstraintManager they are referring to.
                     if (manager.AutoConstraintSelection == true)
                     {
                         options[i] = manager.GetType().Name + " (auto)";
@@ -361,7 +371,7 @@ static public bool DrawConstraintManagerFoldout(GameObject gameObject, Serialize
                     {
                         EditorGUIUtility.PingObject(selectedConstraintManager);
                         Highlighter.Highlight("Inspector", $"ComponentId: {selectedConstraintManager.GetInstanceID()}");
-                        EditorGUIUtility.ExitGUI();
+                        GUIUtility.ExitGUI();
                     }
                 }