View Space Lighting Tool

com.unity.render-pipelines.core/CHANGELOG.md

@@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 Version Updated
 The version number for this package has increased due to a version update of a related graphics package.
 
+### Added
+- New View Lighting Tool, a component which allow to setup light in the camera space 
+
 ## [10.2.0] - 2020-10-19
 
 Version Updated

com.unity.render-pipelines.core/Documentation~/TableOfContents.md

@@ -13,7 +13,7 @@
   * [RTHandle fundamentals](rthandle-system-fundamentals.md)
   * [Using the RTHandle system](rthandle-system-using.md)
 
-
 * [Look Dev](Look-Dev)
+  * [Environment Library](Look-Dev-Environment-Library)
 
-  * [Environment Library](Look-Dev-Environment-Library)
+* [View Lighting Tool](View-Lighting-Tool)

com.unity.render-pipelines.core/Documentation~/View-Lighting-Tool.md

@@ -0,0 +1,23 @@
+# View Lighting Tool
+
+View Lighting Tool is a tool that allow to setup lighting in the camera space. The main Camera (Game View) is used to setup the orientation of a light with spherical coordinate. We can choose a target and Yaw, Pitch and Roll (useful when a cookie or IES is setuped).
+
+![](Images/ViewLightingTool00.png)
+
+## Using View Lighting Tool
+
+From a light we can add a component following Rendering > Light Anchor. Select the light on the light in the hierachy and enable the tool:
+![](Images/ViewLightingTool01.png)
+
+Which change the gizmo of the light to setup the target.
+![](Images/ViewLightingTool02.gif)
+
+On the inspector we can orient the light relative to this target and the main camera.
+The distance:
+![](Images/ViewLightingTool03.gif)
+
+And the orientation:
+![](Images/ViewLightingTool04.gif)
+
+When a Cookie or an IES is setuped the last knob allow us to orient this one:
+![](Images/ViewLightingTool05.gif)

com.unity.render-pipelines.core/Editor/Lighting/GUIFramework/ClickAction.cs

@@ -0,0 +1,81 @@
+using System;
+using UnityEngine;
+
+namespace UnityEditor
+{
+    /// <summary>
+    /// Action for click
+    /// </summary>
+    public class ClickAction : HoveredControlAction
+    {
+        private int m_Button;
+        private bool m_UseEvent;
+        /// <summary>
+        /// Click count
+        /// </summary>
+        public int clickCount = 1;
+        /// <summary>
+        /// Action during onClick
+        /// </summary>
+        public Action<IGUIState, Control> onClick;
+        private int m_ClickCounter = 0;
+
+        /// <summary>
+        /// Constructor
+        /// </summary>
+        /// <param name="control">Current control</param>
+        /// <param name="button">Button ID</param>
+        /// <param name="useEvent">If use an event</param>
+        public ClickAction(Control control, int button, bool useEvent = true) : base(control)
+        {
+            m_Button = button;
+            m_UseEvent = useEvent;
+        }
+
+        /// <summary>
+        /// Get if the trigger condition is validated or not
+        /// </summary>
+        /// <param name="guiState">The gui state</param>
+        /// <returns></returns>
+        protected override bool GetTriggerCondition(IGUIState guiState)
+        {
+            if (guiState.mouseButton == m_Button && guiState.eventType == EventType.MouseDown)
+            {
+                if (guiState.clickCount == 1)
+                    m_ClickCounter = 0;
+
+                ++m_ClickCounter;
+
+                if (m_ClickCounter == clickCount)
+                    return true;
+            }
+
+            return false;
+        }
+
+        /// <summary>
+        /// On trigger
+        /// </summary>
+        /// <param name="guiState">The gui state</param>
+        protected override void OnTrigger(IGUIState guiState)
+        {
+            base.OnTrigger(guiState);
+
+            if (onClick != null)
+                onClick(guiState, hoveredControl);
+
+            if (m_UseEvent)
+                guiState.UseEvent();
+        }
+
+        /// <summary>
+        /// Get Finish Condition
+        /// </summary>
+        /// <param name="guiState">The gui state</param>
+        /// <returns>Always true</returns>
+        protected override bool GetFinishCondition(IGUIState guiState)
+        {
+            return true;
+        }
+    }
+}

com.unity.render-pipelines.core/Editor/Lighting/GUIFramework/CommandAction.cs

@@ -0,0 +1,70 @@
+using System;
+using UnityEngine;
+
+namespace UnityEditor
+{
+    /// <summary>
+    /// Command Acction
+    /// </summary>
+    public class CommandAction : GUIAction
+    {
+        private string m_CommandName;
+
+        /// <summary>
+        /// The command
+        /// </summary>
+        public Action<IGUIState> onCommand;
+
+        /// <summary>
+        /// Constructor
+        /// </summary>
+        /// <param name="commandName">Command name</param>
+        public CommandAction(string commandName)
+        {
+            m_CommandName = commandName;
+        }
+
+        /// <summary>
+        /// Get trigger condition
+        /// </summary>
+        /// <param name="guiState">The GUI State</param>
+        /// <returns>true if the trigger condition is validated</returns>
+        protected override bool GetTriggerCondition(IGUIState guiState)
+        {
+            if (guiState.eventType == EventType.ValidateCommand && guiState.commandName == m_CommandName)
+            {
+                guiState.UseEvent();
+                return true;
+            }
+
+            return false;
+        }
+
+        /// <summary>
+        /// Get finish conditions
+        /// </summary>
+        /// <param name="guiState">The gui state</param>
+        /// <returns>true if the trigger condition is finished</returns>
+        protected override bool GetFinishCondition(IGUIState guiState)
+        {
+            if (guiState.eventType == EventType.ExecuteCommand && guiState.commandName == m_CommandName)
+            {
+                guiState.UseEvent();
+
+                return true;
+            }
+
+            return false;
+        }
+
+        /// <summary>
+        /// On finish
+        /// </summary>
+        /// <param name="guiState">The gui state</param>
+        protected override void OnFinish(IGUIState guiState)
+        {
+            if (onCommand != null)
+                onCommand(guiState);
+        }
+    }
+}