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

@@ -1,8 +1,8 @@
-* [SRP Core](index)
+* [SRP Core](index.md)
 
 * Camera components
-  * [Free Camera](Free-Camera)
-  * [Camera Switcher](Camera-Switcher)
+  * [Free Camera](Free-Camera.md)
+  * [Camera Switcher](Camera-Switcher.md)
 
 * [Render Graph](render-graph-system.md)
   * [Benefits of the render graph system](render-graph-benefits.md)
@@ -13,7 +13,7 @@
   * [RTHandle fundamentals](rthandle-system-fundamentals.md)
   * [Using the RTHandle system](rthandle-system-using.md)
 
-
-* [Look Dev](Look-Dev)
+* [Look Dev](Look-Dev.md)
+  * [Environment Library](Look-Dev-Environment-Library.md)
 
-  * [Environment Library](Look-Dev-Environment-Library)
+* [View Lighting Tool](view-lighting-tool.md)

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

@@ -0,0 +1,24 @@
+## View Lighting tool
+
+The View Lighting tool allows you to set up lighting in camera space. It uses the main Camera (the one that renders to the Game view) to set the orientation of the Light using spherical coordinates, and it uses a target and distance to set the position of the Light. 
+
+Since the View Lighting tool uses camera-space, it is especially useful when setting up lighting for cinematics.
+
+## Using the View Lighting tool
+
+The View Lighting tool uses the Light Anchor component to position and orient the Light. When this component is attached to a Light, you can use a custom Scene view gizmo to position the Light, and use the component's Inspector to orient the Light.
+
+To get started with the View Lighting tool:
+
+1. In the Scene view or Hierarchy, select a GameObject with an attached Light component.
+2. In the Inspector click **Add Component > Rendering > Light Anchor**.
+3. To use the Light Anchor gizmo, click the custom tool button then, in the drop-down, click **Light Anchor**.<br/>![](Images/view-lighting-tool-gizmo.png)
+4. You can now use the gizmo to move the Light's target. This gizmo also shows you a visualization of the yaw, pitch, and roll from the target to the Light. To change the yaw, pitch, and roll, as well as the distance from the Light to the target, see [Light Anchor](#light-anchor).
+
+### Light Anchor
+
+The Light Anchor controls the Light's orientation and the distance it is from the target position. **Yaw** and **Pitch** control the orientation and **Distance** controls the distance between the Light and the target. If the Light has a cookie or uses [IES](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@latest/index.html?subfolder=/manual/IES-Profile.html), **Roll** controls the orientation of the cookie or IES profile.
+
+![](Images/view-lighting-tool-light-anchor.png)
+
+The Light Anchor component also includes a list of **Presets** that you can use to quickly set the Light's orientation relative to the Game view.

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

@@ -0,0 +1,81 @@
+using System;
+using UnityEngine;
+
+namespace UnityEditor
+{
+    /// <summary>
+    /// Represents an Action to process when the user clicks a particular mouse button a certain number of times.
+    /// </summary>
+    public class ClickAction : HoveredControlAction
+    {
+        private int m_Button;
+        private bool m_UseEvent;
+        /// <summary>
+        /// The number of button clicks required to satisfy the trigger condition
+        /// </summary>
+        public int clickCount = 1;
+        /// <summary>
+        /// The Action to execute when the user satisfies the trigger condition.
+        /// </summary>
+        public Action<IGUIState, Control> onClick;
+        private int m_ClickCounter = 0;
+
+        /// <summary>
+        /// Initializes and returns an instance of ClickAction
+        /// </summary>
+        /// <param name="control">Current control</param>
+        /// <param name="button">The mouse button to check for.</param>
+        /// <param name="useEvent">Whether to Use the current event after the trigger condition has been met.</param>
+        public ClickAction(Control control, int button, bool useEvent = true) : base(control)
+        {
+            m_Button = button;
+            m_UseEvent = useEvent;
+        }
+
+        /// <summary>
+        /// Checks to see if the trigger condition has been met or not.
+        /// </summary>
+        /// <param name="guiState">The current state of the custom editor.</param>
+        /// <returns>Returns `true` if the trigger condition has been met. Otherwise, returns false.</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>
+        /// Calls the methods in its invocation list when the trigger conditions are met.
+        /// </summary>
+        /// <param name="guiState">The current state of the custom editor.</param>
+        protected override void OnTrigger(IGUIState guiState)
+        {
+            base.OnTrigger(guiState);
+
+            if (onClick != null)
+                onClick(guiState, hoveredControl);
+
+            if (m_UseEvent)
+                guiState.UseEvent();
+        }
+
+        /// <summary>
+        /// Checks to see if the finish condition has been met or not. For a ClickAction, this is always `true`.
+        /// </summary>
+        /// <param name="guiState">The current state of the custom editor.</param>
+        /// <returns>Returns `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>
+    /// Represents an Action to process when the custom editor validates a command.
+    /// </summary>
+    public class CommandAction : GUIAction
+    {
+        private string m_CommandName;
+
+        /// <summary>
+        /// The Action to execute.
+        /// </summary>
+        public Action<IGUIState> onCommand;
+
+        /// <summary>
+        /// Initializes and returns an instance of CommandAction
+        /// </summary>
+        /// <param name="commandName">The name of the command. When the custom editor validates a command with this name, it triggers the action.</param>
+        public CommandAction(string commandName)
+        {
+            m_CommandName = commandName;
+        }
+
+        /// <summary>
+        /// Checks to see if the trigger condition has been met or not.
+        /// </summary>
+        /// <param name="guiState">The current state of the custom editor.</param>
+        /// <returns>Returns `true` if the trigger condition has been met. Otherwise, returns `false`.</returns>
+        protected override bool GetTriggerCondition(IGUIState guiState)
+        {
+            if (guiState.eventType == EventType.ValidateCommand && guiState.commandName == m_CommandName)
+            {
+                guiState.UseEvent();
+                return true;
+            }
+
+            return false;
+        }
+
+        /// <summary>
+        /// Checks to see if the finish condition has been met or not. 
+        /// </summary>
+        /// <param name="guiState">The current state of the custom editor.</param>
+        /// <returns>Returns `true` if the trigger condition is finished. Otherwise, returns `false`.</returns>
+        protected override bool GetFinishCondition(IGUIState guiState)
+        {
+            if (guiState.eventType == EventType.ExecuteCommand && guiState.commandName == m_CommandName)
+            {
+                guiState.UseEvent();
+
+                return true;
+            }
+
+            return false;
+        }
+
+        /// <summary>
+        /// Calls the methods in its invocation list when the finish condition is met.
+        /// </summary>
+        /// <param name="guiState">The current state of the custom editor.</param>
+        protected override void OnFinish(IGUIState guiState)
+        {
+            if (onCommand != null)
+                onCommand(guiState);
+        }
+    }
+}