Merge pull request #431 from Unity-Technologies/improvements/dylanu/scene-camera-settings-copy

EditorVR camera better represents what is seen in the game view

Author: mtschoen-unity

Editor/EditingContextManagerEditor.cs

@@ -21,7 +21,13 @@ void Awake()
         public override void OnInspectorGUI()
         {
             GUILayout.Label("Available Contexts");
-            EditingContextManager.DoGUI(m_ContextNames, ref m_SelectedContextIndex, () => { m_Settings.defaultContextName = m_ContextNames[m_SelectedContextIndex]; });
+
+            m_SelectedContextIndex = EditorGUILayout.Popup(string.Empty, m_SelectedContextIndex, m_ContextNames);
+            if (GUI.changed)
+            {
+                m_Settings.defaultContextName = m_ContextNames[m_SelectedContextIndex];
+                GUIUtility.ExitGUI();
+            }
 
             EditorGUILayout.Space();
 

Models/Vive/Materials/ViveController.mat

@@ -75,7 +75,7 @@ Material:
     - _SpecularHighlights: 1
     - _SrcBlend: 5
     - _UVSec: 0
-    - _ZWrite: 0
+    - _ZWrite: 1
     m_Colors:
     - _Color: {r: 1, g: 1, b: 1, a: 1}
     - _EmissionColor: {r: 0, g: 0, b: 0, a: 1}

Scripts/Core/Contexts/EditingContextManager.cs

@@ -22,28 +22,32 @@ sealed class EditingContextManager : MonoBehaviour
 
         const string k_LaunchOnExitPlaymode = "EditingContextManager.LaunchOnExitPlaymode";
 
+        IEditingContext m_CurrentContext;
+
         internal static EditingContextManager s_Instance;
         static InputManager s_InputManager;
+        static List<IEditingContext> s_AvailableContexts;
+        static EditingContextManagerSettings s_Settings;
+        static UnityObject s_DefaultContext;
 
-        EditingContextManagerSettings m_Settings = null;
-
-        List<IEditingContext> m_AvailableContexts;
-        string[] m_ContextNames = null;
+        string[] m_ContextNames;
         int m_SelectedContextIndex;
 
-        IEditingContext m_CurrentContext;
+        Rect m_EditingContextPopupRect = new Rect(0, 0, 150, 20); // Y and X position will be set based on window size
+
         readonly List<IEditingContext> m_PreviousContexts = new List<IEditingContext>();
 
-        internal IEditingContext defaultContext
+        internal static IEditingContext defaultContext
         {
             get
             {
-                var context = m_AvailableContexts.Find(c => c.Equals(m_DefaultContext)) ?? m_AvailableContexts.First();
+                var availableContexts = GetAvailableEditingContexts();
+                var context = availableContexts.Find(c => c.Equals(s_DefaultContext)) ?? availableContexts.First();
 
-                var defaultContextName = m_Settings.defaultContextName;
+                var defaultContextName = settings.defaultContextName;
                 if (!string.IsNullOrEmpty(defaultContextName))
                 {
-                    var foundContext = m_AvailableContexts.Find(c => c.name == defaultContextName);
+                    var foundContext = availableContexts.Find(c => c.name == defaultContextName);
                     if (foundContext != null)
                         context = foundContext;
                 }
@@ -52,7 +56,7 @@ internal IEditingContext defaultContext
             }
             set
             {
-                m_Settings.defaultContextName = value.name;
+                settings.defaultContextName = value.name;
             }
         }
 
@@ -61,6 +65,17 @@ internal IEditingContext currentContext
             get { return m_CurrentContext; }
         }
 
+        static EditingContextManagerSettings settings
+        {
+            get
+            {
+                if (!s_Settings)
+                    s_Settings = LoadUserSettings();
+
+                return s_Settings;
+            }
+        }
+
         static EditingContextManager()
         {
             VRView.viewEnabled += OnVRViewEnabled;
@@ -129,31 +144,34 @@ static void OnPlayModeStateChanged(PlayModeStateChange stateChange)
             }
         }
 
-        void OnEnable()
+        void Awake()
         {
-            m_Settings = LoadUserSettings();
-
-            ISetEditingContextMethods.getAvailableEditingContexts = GetAvailableEditingContexts;
-            ISetEditingContextMethods.getPreviousEditingContexts = GetPreviousEditingContexts;
-            ISetEditingContextMethods.setEditingContext = SetEditingContext;
-            ISetEditingContextMethods.restorePreviousEditingContext = RestorePreviousContext;
+            s_DefaultContext = m_DefaultContext;
 
             var availableContexts = GetAvailableEditingContexts();
             m_ContextNames = availableContexts.Select(c => c.name).ToArray();
 
-            if (m_AvailableContexts.Count == 0)
+            if (s_AvailableContexts.Count == 0)
                 throw new Exception("You can't start EditorXR without at least one context. Try re-importing the package or use version control to restore the default context asset");
 
-            SetEditingContext(defaultContext);
-
-            if (m_AvailableContexts.Count > 1)
+            if (s_AvailableContexts.Count > 1)
                 VRView.afterOnGUI += OnVRViewGUI;
+        }
+
+        void OnEnable()
+        {
+            ISetEditingContextMethods.getAvailableEditingContexts = GetAvailableEditingContexts;
+            ISetEditingContextMethods.getPreviousEditingContexts = GetPreviousEditingContexts;
+            ISetEditingContextMethods.setEditingContext = SetEditingContext;
+            ISetEditingContextMethods.restorePreviousEditingContext = RestorePreviousContext;
 
             // Force the window to repaint every tick, since we need live updating
             // This also allows scripts with [ExecuteInEditMode] to run
             EditorApplication.update += EditorApplication.QueuePlayerLoopUpdate;
 
             EditorApplication.playModeStateChanged += OnPlayModeStateChanged;
+
+            SetEditingContext(defaultContext);
         }
 
         void OnDisable()
@@ -170,40 +188,29 @@ void OnDisable()
                 m_CurrentContext.Dispose();
             }
 
-            m_AvailableContexts = null;
+            s_AvailableContexts = null;
+
+            SetEditingContext(null);
 
             ISetEditingContextMethods.getAvailableEditingContexts = null;
             ISetEditingContextMethods.getPreviousEditingContexts = null;
             ISetEditingContextMethods.setEditingContext = null;
             ISetEditingContextMethods.restorePreviousEditingContext = null;
 
-            SaveUserSettings(m_Settings);
+            SaveUserSettings(settings);
         }
 #endif
 
-        void OnVRViewGUI(EditorWindow window)
+        void OnVRViewGUI(VRView view)
         {
-            var view = (VRView)window;
-            GUILayout.BeginArea(view.guiRect);
-            {
-                GUILayout.FlexibleSpace();
-                GUILayout.BeginHorizontal();
-                {
-                    DoGUI(m_ContextNames, ref m_SelectedContextIndex, () => SetEditingContext(m_AvailableContexts[m_SelectedContextIndex]));
-                    GUILayout.FlexibleSpace();
-                }
-                GUILayout.EndHorizontal();
-            }
-            GUILayout.EndArea();
-        }
+            var position = view.position;
+            m_EditingContextPopupRect.y = position.height - m_EditingContextPopupRect.height;
+            m_EditingContextPopupRect.x = position.width - m_EditingContextPopupRect.width;
 
-        internal static void DoGUI(string[] contextNames, ref int selectedContextIndex, Action callback = null)
-        {
-            selectedContextIndex = EditorGUILayout.Popup(string.Empty, selectedContextIndex, contextNames);
+            m_SelectedContextIndex = EditorGUI.Popup(m_EditingContextPopupRect, string.Empty, m_SelectedContextIndex, m_ContextNames);
             if (GUI.changed)
             {
-                if (callback != null)
-                    callback();
+                SetEditingContext(s_AvailableContexts[m_SelectedContextIndex]);
                 GUIUtility.ExitGUI();
             }
         }
@@ -216,13 +223,15 @@ internal void SetEditingContext(IEditingContext context)
             if (m_CurrentContext != null)
             {
                 m_PreviousContexts.Insert(0, m_CurrentContext);
-                m_CurrentContext.Dispose();
+
+                if (m_CurrentContext.instanceExists)
+                    m_CurrentContext.Dispose();
             }
 
             context.Setup();
             m_CurrentContext = context;
 
-            m_SelectedContextIndex = m_AvailableContexts.IndexOf(context);
+            m_SelectedContextIndex = s_AvailableContexts.IndexOf(context);
         }
 
         internal void RestorePreviousContext()
@@ -254,12 +263,12 @@ internal static string[] GetEditingContextNames()
             return availableContexts.Select(c => c.name).ToArray();
         }
 
-        List<IEditingContext> GetAvailableEditingContexts()
+        static List<IEditingContext> GetAvailableEditingContexts()
         {
-            if (m_AvailableContexts == null)
-                m_AvailableContexts = GetEditingContextAssets();
+            if (s_AvailableContexts == null)
+                s_AvailableContexts = GetEditingContextAssets();
 
-            return m_AvailableContexts;
+            return s_AvailableContexts;
         }
 
         List<IEditingContext> GetPreviousEditingContexts()

Scripts/Core/Contexts/EditorVR.asset

@@ -12,6 +12,7 @@ MonoBehaviour:
   m_Name: EditorVR
   m_EditorClassIdentifier: 
   m_RenderScale: 1
+  m_CopySceneCameraSettings: 1
   m_DefaultToolStack:
   - {fileID: 11500000, guid: 882053426a5f76d46b5505d9a20be912, type: 3}
   - {fileID: 11500000, guid: aab8fcc587f237c4cb48fb7bc8a59909, type: 3}

Scripts/Core/Contexts/EditorVRContext.cs

@@ -13,16 +13,22 @@ class EditorVRContext : ScriptableObject, IEditingContext
         [SerializeField]
         float m_RenderScale = 1f;
 
+        [SerializeField]
+        bool m_CopyExistingCameraSettings = true;
+
         [SerializeField]
         internal List<MonoScript> m_DefaultToolStack;
 
         EditorVR m_Instance;
 
+        public bool copyExistingCameraSettings { get { return m_CopyExistingCameraSettings; } }
+
+        public bool instanceExists { get { return m_Instance != null; } }
+
         public void Setup()
         {
             EditorVR.defaultTools = m_DefaultToolStack.Select(ms => ms.GetClass()).ToArray();
             m_Instance = ObjectUtils.CreateGameObjectWithComponent<EditorVR>();
-
             XRSettings.eyeTextureResolutionScale = m_RenderScale;
         }
 

Scripts/Core/VRView.cs

@@ -1,10 +1,11 @@
 #if UNITY_EDITOR
 using System;
-using UnityEngine;
-using UnityEngine.Assertions;
 using System.Collections;
-using UnityEditor.Experimental.EditorVR.Helpers;
 using System.Reflection;
+using UnityEditor.Experimental.EditorVR.Helpers;
+using UnityEditor.Experimental.EditorVR.Utilities;
+using UnityEngine;
+using UnityEngine.Assertions;
 using UnityEngine.XR;
 
 #if ENABLE_STEAMVR_INPUT
@@ -18,6 +19,10 @@ sealed class VRView : EditorWindow
         public const float HeadHeight = 1.7f;
         const string k_ShowDeviceView = "VRView.ShowDeviceView";
         const string k_UseCustomPreviewCamera = "VRView.UseCustomPreviewCamera";
+        const string k_CameraName = "VRCamera";
+
+        static Camera s_ExistingSceneMainCamera;
+        static bool s_ExistingSceneMainCameraEnabledState;
 
         DrawCameraMode m_RenderMode = DrawCameraMode.Textured;
 
@@ -54,7 +59,7 @@ public static Camera customPreviewCamera
         bool m_UseCustomPreviewCamera;
 
         Rect m_ToggleDeviceViewRect = new Rect(0, 0, 0, 20); // Width will be set based on window size
-        Rect m_PresentationCameraRect = new Rect(0, 0, 0, 20); // Y position and width will be set based on window size
+        Rect m_PresentationCameraRect = new Rect(0, 0, 160, 20); // Y position and width will be set based on window size
 
         public static Transform cameraRig
         {
@@ -111,8 +116,8 @@ public static Vector3 headCenteredOrigin
 
         public static event Action viewEnabled;
         public static event Action viewDisabled;
-        public static event Action<EditorWindow> beforeOnGUI;
-        public static event Action<EditorWindow> afterOnGUI;
+        public static event Action<VRView> beforeOnGUI;
+        public static event Action<VRView> afterOnGUI;
         public static event Action<bool> hmdStatusChange;
 
         public Rect guiRect { get; private set; }
@@ -134,18 +139,53 @@ public void OnEnable()
 
             autoRepaintOnSceneChange = true;
             s_ActiveView = this;
+            const float nearClipPlane = 0.01f;
+            const float farClipPlane = 1000f;
+
+            s_ExistingSceneMainCamera = Camera.main;
+            // TODO: Copy camera settings when changing contexts
+            if (EditingContextManager.defaultContext.copyExistingCameraSettings && s_ExistingSceneMainCamera && s_ExistingSceneMainCamera.enabled)
+            {
+                GameObject cameraGO = EditorUtility.CreateGameObjectWithHideFlags(k_CameraName, HideFlags.HideAndDontSave);
+                m_Camera = ObjectUtils.CopyComponent(s_ExistingSceneMainCamera, cameraGO);
+
+                if (m_Camera.nearClipPlane > nearClipPlane)
+                {
+                    Debug.LogWarning("Copying settings from scene camera that is tagged 'MainCamera'." + Environment.NewLine +
+                        " Clipping issues may occur with NearClipPlane values is greater than " + nearClipPlane);
+
+                    m_Camera.nearClipPlane = nearClipPlane;
+                }
+
+                // TODO: Support multiple cameras
+                if (m_Camera.clearFlags == CameraClearFlags.Nothing)
+                    m_Camera.clearFlags = CameraClearFlags.SolidColor;
+
+                m_Camera.stereoTargetEye = StereoTargetEyeMask.Both;
+                // Force HDR on because of a bug in the mirror view
+                m_Camera.allowHDR = true;
+            }
+            else
+            {
+                GameObject cameraGO = EditorUtility.CreateGameObjectWithHideFlags(k_CameraName, HideFlags.HideAndDontSave, typeof(Camera));
+                m_Camera = cameraGO.GetComponent<Camera>();
+
+                m_Camera.nearClipPlane = nearClipPlane;
+                m_Camera.farClipPlane = farClipPlane;
+            }
+
+            if (s_ExistingSceneMainCamera)
+            {
+                s_ExistingSceneMainCameraEnabledState = s_ExistingSceneMainCamera.enabled;
+                s_ExistingSceneMainCamera.enabled = false; // Disable existing MainCamera in the scene
+            }
 
-            GameObject cameraGO = EditorUtility.CreateGameObjectWithHideFlags("VRCamera", HideFlags.HideAndDontSave, typeof(Camera));
-            m_Camera = cameraGO.GetComponent<Camera>();
-            m_Camera.useOcclusionCulling = false;
             m_Camera.enabled = false;
             m_Camera.cameraType = CameraType.VR;
-
+            m_Camera.useOcclusionCulling = false;
             GameObject rigGO = EditorUtility.CreateGameObjectWithHideFlags("VRCameraRig", HideFlags.HideAndDontSave, typeof(EditorMonoBehaviour));
             m_CameraRig = rigGO.transform;
             m_Camera.transform.parent = m_CameraRig;
-            m_Camera.nearClipPlane = 0.01f;
-            m_Camera.farClipPlane = 1000f;
             m_CameraRig.position = headCenteredOrigin;
             m_CameraRig.rotation = Quaternion.identity;
 
@@ -186,6 +226,9 @@ public void OnDisable()
 
             Assert.IsNotNull(s_ActiveView, "EditorXR should have an active view");
             s_ActiveView = null;
+
+            if (s_ExistingSceneMainCamera)
+                s_ExistingSceneMainCamera.enabled = s_ExistingSceneMainCameraEnabledState;
         }
 
         void UpdateCameraTransform()
@@ -279,7 +322,6 @@ void OnGUI()
 
             m_ToggleDeviceViewRect.width = width;
             m_PresentationCameraRect.y = height - m_PresentationCameraRect.height;
-            m_PresentationCameraRect.width = width;
 
             if (GUI.Button(m_ToggleDeviceViewRect, "Toggle Device View", EditorStyles.toolbarButton))
                 m_ShowDeviceView = !m_ShowDeviceView;