CU-868fbqk0h: Add Auto Resolve button to SceneExportWindow (#25)

Pressing the button and confirming the message that follows will automatically resolve the following issues:
- CustomScriptFound by removing the script from the gameobject
- CameraFound by deleting camera gameobjects
- AudioListenerFound by deleting the AudioListener component
- EventSystemFound by deleting event system gameobjects
- NoUserAreaProviderFound by creating a new gameobject and attaching MonoCircularUserAreaProvider component to it

All the above changes are undoable using Ctrl+Z.

Author: adrenak

Assets/MXRUS/Editor/SceneExportValidator.cs

@@ -128,7 +128,10 @@ private List<SceneExportViolation> GetScriptViolations() {
                 true,
                 "Custom scripts/components are not supported. Please remove or disable the gameobjects on the scene referencing them.",
                 x
-            )).ToList();
+            ).SetAutoResolver("Custom scripts attached to GameObjects in the scene will be removed.", obj => {
+                Undo.DestroyObjectImmediate(obj as MonoBehaviour);
+            }))
+            .ToList();
         }
 
         /// <summary>
@@ -142,7 +145,11 @@ private List<SceneExportViolation> GetCameraViolations() {
                 true,
                 "Scene cameras are not supported. Please remove cameras from the scene.",
                 x
-            )).ToList();
+            )
+            .SetAutoResolver("GameObjects in the scene with Camera component will be destroyed.", obj => {
+                Undo.DestroyObjectImmediate((obj as Camera).gameObject);
+            })
+            ).ToList();
         }
 
         /// <summary>
@@ -178,7 +185,10 @@ private List<SceneExportViolation> GetAudioListenerViolations() {
                 "The scene cannot have any AudioListeners. When running in the ManageXR " +
                 "Homescreen, an AudioListener would already be present.",
                 x
-            )).ToList();
+            ).SetAutoResolver("AudioListener components in the scene will be removed from their GameObjects.", obj => {
+                Undo.DestroyObjectImmediate(obj as AudioListener);
+            })
+            ).ToList();
         }
 
         /// <summary>
@@ -192,7 +202,10 @@ private List<SceneExportViolation> GetEventSystemViolations() {
                 true,
                 "There cannot be an EventSystem on the scene. Please remove them from the scene.",
                 x
-            )).ToList();
+            ).SetAutoResolver("GameObjects in the scene with EventSystem component will be destroyed.", obj => {
+                Undo.DestroyObjectImmediate((obj as EventSystem).gameObject);
+            })
+            ).ToList();
         }
 
         /// <summary>
@@ -206,9 +219,15 @@ private List<SceneExportViolation> GetUserAreaViolations() {
                     new SceneExportViolation (
                         SceneExportViolation.Types.NoUserAreaProviderFound,
                         true,
-                        "No MonoUserAreaProvider component found on the scene.",
+                        "No user area provider found on the scene.",
                         null
-                    )
+                    ).SetAutoResolver("A new GameObject will be added to the scene with a user area provider.", obj =>{
+                        var userAreaProvider = new GameObject("User Area Provider");
+                        userAreaProvider.AddComponent<MonoCircularUserAreaProvider>();
+                        Selection.activeGameObject = userAreaProvider;
+                        SceneView.lastActiveSceneView.FrameSelected();
+                        Undo.RegisterCreatedObjectUndo(userAreaProvider, "Created User Area Provider");
+                    })
                 };
             else if (userAreas.Length > 1) {
                 return userAreas.Select(x => new SceneExportViolation(

Assets/MXRUS/Editor/SceneExportViolation.cs

@@ -1,4 +1,8 @@
-using UnityEngine;
+using System;
+
+using UnityEngine;
+
+using Object = UnityEngine.Object;
 
 namespace MXRUS.SDK.Editor {
     internal class SceneExportViolation {
@@ -72,6 +76,18 @@ public enum Types {
         /// </summary>
         public bool PreventsExport { get; private set; }
 
+        /// <summary>
+        /// Whether this violation can be automatically resolved
+        /// by the scene export window
+        /// </summary>
+        public bool CanBeAutoResolved { get; private set; }
+
+        /// <summary>
+        /// The confirmation message to be shown when the user
+        /// attempts to auto resolve this violation.
+        /// </summary>
+        public string AutoResolveConfirmationMessage { get; private set; }
+
         /// <summary>
         /// Description of the violation
         /// </summary>
@@ -82,11 +98,26 @@ public enum Types {
         /// </summary>
         public Object Object { get; private set; }
 
+        private Action<Object> _resolveMethod;
+
         public SceneExportViolation(Types type, bool preventsExport, string description, Object obj = null) {
             Type = type;
             PreventsExport = preventsExport;
             Description = description;
             Object = obj;
         }
+
+        public SceneExportViolation SetAutoResolver(string message, Action<Object> resolveMethod) {
+            AutoResolveConfirmationMessage = message;
+            CanBeAutoResolved = true;
+            _resolveMethod = resolveMethod;
+            return this;
+        }
+
+        public void AutoResolve() {
+            if (CanBeAutoResolved) {
+                _resolveMethod?.Invoke(Object);
+            }
+        }
     }
 }

Assets/MXRUS/Editor/SceneExportWindow.cs

@@ -207,13 +207,38 @@ private void ShowViolationsSummary() {
 
                 var preventsExport = first.PreventsExport;
                 var description = first.Description;
+                var canBeAutoResolved = first.CanBeAutoResolved;
+
+                // Show the violation type with the Auto Resolve button, if applicable for this violation type
+                EditorGUILayout.BeginHorizontal();
+                {
+                    _foldoutStates[i] = EditorGUILayout.Foldout(
+                        _foldoutStates[i],
+                        $"{_violationTypes[i]} {(preventsExport ? " (Error)" : " (Warning)")}",
+                        true,
+                        preventsExport ? _errorFoldoutStyle : _warningFoldoutStyle
+                    );
+                    if (canBeAutoResolved) {
+                        GUILayout.Label("");
+                        if (GUILayout.Button("Auto Resolve")) {
+                            var accepted = EditorUtility.DisplayDialog(
+                                "Auto Resolving",
+                                first.AutoResolveConfirmationMessage + "\n\nDo you want to proceed?",
+                                "OK"
+                            );
+                            if (accepted) {
+                                foreach (var violationToResolve in violations) {
+                                    violationToResolve.AutoResolve();
+                                }
+                                Validate();
+                                EditorGUILayout.EndHorizontal();
+                                return;
+                            }
+                        }
+                    }
+                }
+                EditorGUILayout.EndHorizontal();
 
-                _foldoutStates[i] = EditorGUILayout.Foldout(
-                    _foldoutStates[i],
-                    $"{_violationTypes[i]} {(preventsExport ? " (Error)" : " (Warning)")}",
-                    true,
-                    preventsExport ? _errorFoldoutStyle : _warningFoldoutStyle
-                );
                 EditorGUILayout.Space(10);
 
                 if (!_foldoutStates[i]) continue;