Fixed various Look Dev issues after exiting Playmode (#2956)

JulienIgnace-Unity · web-flow · commit a9c4c2784c17 · 2021-01-11T10:40:26.000+01:00
* Fixed access to invalid Contexts references after exiting playmode.

* Fixed comparison gizmo after playmode.

* Fixes from PR feedback
diff --git a/com.unity.render-pipelines.core/Editor/LookDev/CameraController.cs b/com.unity.render-pipelines.core/Editor/LookDev/CameraController.cs
@@ -129,13 +129,17 @@ virtual protected bool isDragging
             }
         }
 
-        public CameraController(CameraState cameraState, DisplayWindow window, Action focused)
+        public CameraController(DisplayWindow window, Action focused)
         {
-            m_CameraState = cameraState;
             m_Window = window;
             m_Focused = focused;
         }
 
+        public void UpdateCameraState(Context context, ViewIndex index)
+        {
+            m_CameraState = context.GetViewContent(index).camera;
+        }
+
         private void ResetCameraControl()
         {
             isDragging = false;
@@ -458,16 +462,22 @@ class SwitchableCameraController : CameraController
         bool switchedDrag = false;
         bool switchedWheel = false;
 
-        public SwitchableCameraController(CameraState cameraStateFirstView, CameraState cameraStateSecondView, DisplayWindow window, Action<ViewIndex> focused)
-            : base(cameraStateFirstView, window, null)
+        public SwitchableCameraController(DisplayWindow window, Action<ViewIndex> focused)
+            : base(window, null)
         {
-            m_FirstView = cameraStateFirstView;
-            m_SecondView = cameraStateSecondView;
             m_CurrentViewIndex = ViewIndex.First;
 
             m_Focused = () => focused?.Invoke(m_CurrentViewIndex);
         }
 
+        public void UpdateCameraState(Context context)
+        {
+            m_FirstView = context.GetViewContent(ViewIndex.First).camera;
+            m_SecondView = context.GetViewContent(ViewIndex.Second).camera;
+
+            m_CameraState = m_CurrentViewIndex == ViewIndex.First ? m_FirstView : m_SecondView;
+        }
+
         void SwitchTo(ViewIndex index)
         {
             CameraState stateToSwitch;
diff --git a/com.unity.render-pipelines.core/Editor/LookDev/ComparisonGizmoController.cs b/com.unity.render-pipelines.core/Editor/LookDev/ComparisonGizmoController.cs
@@ -49,12 +49,16 @@ bool isDragging
             }
         }
 
-        public ComparisonGizmoController(ComparisonGizmoState state, SwitchableCameraController switcher)
+        public ComparisonGizmoController(SwitchableCameraController switcher)
         {
-            m_State = state;
             m_Switcher = switcher;
         }
 
+        public void UpdateGizmoState(ComparisonGizmoState state)
+        {
+            m_State = state;
+        }
+
         protected override void RegisterCallbacksOnTarget()
         {
             target.RegisterCallback<MouseDownEvent>(OnMouseDown);
diff --git a/com.unity.render-pipelines.core/Editor/LookDev/Compositor.cs b/com.unity.render-pipelines.core/Editor/LookDev/Compositor.cs
@@ -150,17 +150,15 @@ public bool pixelPerfect
 
         public Compositer(
             IViewDisplayer displayer,
-            Context contexts,
             IDataProvider dataProvider,
             StageCache stages)
         {
             m_Displayer = displayer;
-            m_Contexts = contexts;
 
             m_RenderDataCache = new RenderingData[2]
             {
-                new RenderingData() { stage = stages[ViewIndex.First], updater = contexts.GetViewContent(ViewIndex.First).camera },
-                new RenderingData() { stage = stages[ViewIndex.Second], updater = contexts.GetViewContent(ViewIndex.Second).camera }
+                new RenderingData() { stage = stages[ViewIndex.First] },
+                new RenderingData() { stage = stages[ViewIndex.Second] }
             };
 
             m_Displayer.OnRenderDocAcquisitionTriggered += RenderDocAcquisitionRequested;
@@ -197,6 +195,12 @@ public void Dispose()
 
         public void Render()
         {
+            // This can happen when entering/leaving playmode.
+            if (LookDev.dataProvider == null)
+                return;
+
+            m_Contexts = LookDev.currentContext;
+
             //TODO: make integration EditorWindow agnostic!
             if (UnityEditorInternal.RenderDoc.IsLoaded() && UnityEditorInternal.RenderDoc.IsSupported() && m_RenderDocAcquisitionRequested)
                 UnityEditorInternal.RenderDoc.BeginCaptureRenderDoc(m_Displayer as EditorWindow);
@@ -236,11 +240,13 @@ void AcquireDataForView(ViewIndex index, Rect viewport)
 
             m_RenderTextures.UpdateSize(renderingData.viewPort, index, m_Renderer.pixelPerfect, renderingData.stage.camera);
 
-            int debugMode = m_Contexts.GetViewContent(index).debug.viewMode;
+            int debugMode = view.debug.viewMode;
             if (debugMode != -1)
                 LookDev.dataProvider.UpdateDebugMode(debugMode);
 
             renderingData.output = m_RenderTextures[index, ShadowCompositionPass.MainView];
+            renderingData.updater = view.camera;
+
             m_Renderer.BeginRendering(renderingData, LookDev.dataProvider);
             m_Renderer.Acquire(renderingData);
 
diff --git a/com.unity.render-pipelines.core/Editor/LookDev/DisplayWindow.cs b/com.unity.render-pipelines.core/Editor/LookDev/DisplayWindow.cs
@@ -217,6 +217,10 @@ event Action IViewDisplayer.OnUpdateRequested
         StyleSheet styleSheet = null;
         StyleSheet styleSheetLight = null;
 
+        SwitchableCameraController m_FirstOrCompositeManipulator;
+        CameraController m_SecondManipulator;
+        ComparisonGizmoController m_GizmoManipulator;
+
         void ReloadStyleSheets()
         {
             if (styleSheet == null || styleSheet.Equals(null))
@@ -395,9 +399,7 @@ void CreateViews()
             m_Views[(int)ViewIndex.Second] = new Image() { name = Style.k_SecondViewName, image = Texture2D.blackTexture };
             m_ViewContainer.Add(m_Views[(int)ViewIndex.Second]);
 
-            var firstOrCompositeManipulator = new SwitchableCameraController(
-                LookDev.currentContext.GetViewContent(ViewIndex.First).camera,
-                LookDev.currentContext.GetViewContent(ViewIndex.Second).camera,
+            m_FirstOrCompositeManipulator = new SwitchableCameraController(
                 this,
                 index =>
                 {
@@ -406,8 +408,7 @@ void CreateViews()
                     if (sidePanel == SidePanel.Environment && environment != null && LookDev.currentContext.environmentLibrary != null)
                         m_EnvironmentList.selectedIndex = LookDev.currentContext.environmentLibrary.IndexOf(environment);
                 });
-            var secondManipulator = new CameraController(
-                LookDev.currentContext.GetViewContent(ViewIndex.Second).camera,
+            m_SecondManipulator = new CameraController(
                 this,
                 () =>
                 {
@@ -416,10 +417,10 @@ void CreateViews()
                     if (sidePanel == SidePanel.Environment && environment != null && LookDev.currentContext.environmentLibrary != null)
                         m_EnvironmentList.selectedIndex = LookDev.currentContext.environmentLibrary.IndexOf(environment);
                 });
-            var gizmoManipulator = new ComparisonGizmoController(LookDev.currentContext.layout.gizmoState, firstOrCompositeManipulator);
-            m_Views[(int)ViewIndex.First].AddManipulator(gizmoManipulator); //must take event first to switch the firstOrCompositeManipulator
-            m_Views[(int)ViewIndex.First].AddManipulator(firstOrCompositeManipulator);
-            m_Views[(int)ViewIndex.Second].AddManipulator(secondManipulator);
+            m_GizmoManipulator = new ComparisonGizmoController(m_FirstOrCompositeManipulator);
+            m_Views[(int)ViewIndex.First].AddManipulator(m_GizmoManipulator); //must take event first to switch the firstOrCompositeManipulator
+            m_Views[(int)ViewIndex.First].AddManipulator(m_FirstOrCompositeManipulator);
+            m_Views[(int)ViewIndex.Second].AddManipulator(m_SecondManipulator);
 
             m_NoObject1 = new Label(Style.k_DragAndDropObject);
             m_NoObject1.style.flexGrow = 1;
@@ -667,6 +668,11 @@ void Update()
                     Debug.LogError("LookDev is not supported: No SRP detected.");
                 LookDev.Close();
             }
+
+            // All those states coming from the Contexts can become invalid after a domain reload so we need to update them.
+            m_FirstOrCompositeManipulator.UpdateCameraState(LookDev.currentContext);
+            m_SecondManipulator.UpdateCameraState(LookDev.currentContext, ViewIndex.Second);
+            m_GizmoManipulator.UpdateGizmoState(LookDev.currentContext.layout.gizmoState);
         }
 
         void OnGUI()
diff --git a/com.unity.render-pipelines.core/Editor/LookDev/LookDev.cs b/com.unity.render-pipelines.core/Editor/LookDev/LookDev.cs
@@ -28,7 +28,18 @@ internal static IDataProvider dataProvider
         internal static Context currentContext
         {
             //Lazy init: load it when needed instead in static even if you do not support lookdev
-            get => s_CurrentContext ?? (s_CurrentContext = LoadConfigInternal() ?? defaultContext);
+            get
+            {
+                if (s_CurrentContext == null || s_CurrentContext.Equals(null))
+                {
+                    s_CurrentContext = LoadConfigInternal();
+                    if (s_CurrentContext == null)
+                        s_CurrentContext = defaultContext;
+
+                    ReloadStage(false);
+                }
+                return s_CurrentContext;
+            }
             private set => s_CurrentContext = value;
         }
 
@@ -161,9 +172,9 @@ static void WaitingSRPReloadForConfiguringRenderer(int maxAttempt, bool reloadWi
         static void ConfigureRenderer(bool reloadWithTemporaryID)
         {
             s_Stages?.Dispose(); //clean previous occurrence on reloading
-            s_Stages = new StageCache(dataProvider, currentContext);
+            s_Stages = new StageCache(dataProvider);
             s_Compositor?.Dispose(); //clean previous occurrence on reloading
-            s_Compositor = new Compositer(s_ViewDisplayer, currentContext, dataProvider, s_Stages);
+            s_Compositor = new Compositer(s_ViewDisplayer, dataProvider, s_Stages);
         }
 
         static void LinkViewDisplayer()
diff --git a/com.unity.render-pipelines.core/Editor/LookDev/Stage.cs b/com.unity.render-pipelines.core/Editor/LookDev/Stage.cs
@@ -284,17 +284,15 @@ class StageCache : IDisposable
         const string secondStageName = "LookDevSecondView";
 
         Stage[] m_Stages;
-        Context m_Contexts;
         IDataProvider m_CurrentDataProvider;
 
         public Stage this[ViewIndex index]
             => m_Stages[(int)index];
 
         public bool initialized { get; private set; }
 
-        public StageCache(IDataProvider dataProvider, Context contexts)
+        public StageCache(IDataProvider dataProvider)
         {
-            m_Contexts = contexts;
             m_Stages = new Stage[2]
             {
                 InitStage(ViewIndex.First, dataProvider),
@@ -333,7 +331,7 @@ public void UpdateSceneObjects(ViewIndex index)
             Stage stage = this[index];
             stage.Clear();
 
-            var viewContent = m_Contexts.GetViewContent(index);
+            var viewContent = LookDev.currentContext.GetViewContent(index);
             if (viewContent == null)
             {
                 viewContent.viewedInstanceInPreview = null;
@@ -347,7 +345,7 @@ public void UpdateSceneObjects(ViewIndex index)
         public void UpdateSceneLighting(ViewIndex index, IDataProvider provider)
         {
             Stage stage = this[index];
-            Environment environment = m_Contexts.GetViewContent(index).environment;
+            Environment environment = LookDev.currentContext.GetViewContent(index).environment;
             provider.UpdateSky(stage.camera,
                 environment == null ? default : environment.sky,
                     stage.runtimeInterface);

Original file line number	Diff line number	Diff line change
`@@ -129,13 +129,17 @@ virtual protected bool isDragging`
`129`	`129`	`}`
`130`	`130`	`}`
`131`	`131`
`132`		`- public CameraController(CameraState cameraState, DisplayWindow window, Action focused)`
	`132`	`+ public CameraController(DisplayWindow window, Action focused)`
`133`	`133`	`{`
`134`		`- m_CameraState = cameraState;`
`135`	`134`	`m_Window = window;`
`136`	`135`	`m_Focused = focused;`
`137`	`136`	`}`
`138`	`137`
	`138`	`+ public void UpdateCameraState(Context context, ViewIndex index)`
	`139`	`+ {`
	`140`	`+ m_CameraState = context.GetViewContent(index).camera;`
	`141`	`+ }`
	`142`	`+`
`139`	`143`	`private void ResetCameraControl()`
`140`	`144`	`{`
`141`	`145`	`isDragging = false;`
`@@ -458,16 +462,22 @@ class SwitchableCameraController : CameraController`
`458`	`462`	`bool switchedDrag = false;`
`459`	`463`	`bool switchedWheel = false;`
`460`	`464`
`461`		`- public SwitchableCameraController(CameraState cameraStateFirstView, CameraState cameraStateSecondView, DisplayWindow window, Action<ViewIndex> focused)`
`462`		`- : base(cameraStateFirstView, window, null)`
	`465`	`+ public SwitchableCameraController(DisplayWindow window, Action<ViewIndex> focused)`
	`466`	`+ : base(window, null)`
`463`	`467`	`{`
`464`		`- m_FirstView = cameraStateFirstView;`
`465`		`- m_SecondView = cameraStateSecondView;`
`466`	`468`	`m_CurrentViewIndex = ViewIndex.First;`
`467`	`469`
`468`	`470`	`m_Focused = () => focused?.Invoke(m_CurrentViewIndex);`
`469`	`471`	`}`
`470`	`472`
	`473`	`+ public void UpdateCameraState(Context context)`
	`474`	`+ {`
	`475`	`+ m_FirstView = context.GetViewContent(ViewIndex.First).camera;`
	`476`	`+ m_SecondView = context.GetViewContent(ViewIndex.Second).camera;`
	`477`	`+`
	`478`	`+ m_CameraState = m_CurrentViewIndex == ViewIndex.First ? m_FirstView : m_SecondView;`
	`479`	`+ }`
	`480`	`+`
`471`	`481`	`void SwitchTo(ViewIndex index)`
`472`	`482`	`{`
`473`	`483`	`CameraState stateToSwitch;`
Original file line number	Diff line number	Diff line change
`@@ -49,12 +49,16 @@ bool isDragging`
`49`	`49`	`}`
`50`	`50`	`}`
`51`	`51`
`52`		`- public ComparisonGizmoController(ComparisonGizmoState state, SwitchableCameraController switcher)`
	`52`	`+ public ComparisonGizmoController(SwitchableCameraController switcher)`
`53`	`53`	`{`
`54`		`- m_State = state;`
`55`	`54`	`m_Switcher = switcher;`
`56`	`55`	`}`
`57`	`56`
	`57`	`+ public void UpdateGizmoState(ComparisonGizmoState state)`
	`58`	`+ {`
	`59`	`+ m_State = state;`
	`60`	`+ }`
	`61`	`+`
`58`	`62`	`protected override void RegisterCallbacksOnTarget()`
`59`	`63`	`{`
`60`	`64`	`target.RegisterCallback<MouseDownEvent>(OnMouseDown);`