CHANGE: Moved UI to be an optional dependency. (#1113)

Remove hard dependency on UI and added compiler defines for UI, Physics and Physics2D.

Author: karljj1

Packages/com.unity.inputsystem/CHANGELOG.md

@@ -14,7 +14,8 @@ however, it has to be formatted properly to pass verification tests.
 - `VirtualMouseInput` not moving the software cursor when set to `HardwareCursorIsAvailable` but not having a hardware cursor ()
 - Can now override built-in Android gamepad layouts. Previously, the input system would always choose its default defaults even after registering more specific layouts using `InputSystem.RegisterLayout`.
 - `InputControlPath.TryGetControlLayout` no longer throws `NotImplementedException` for `<Mouse>/scroll/x` and similar paths where the layout is modifying a control it inherited from its base layout ([thread](https://forum.unity.com/threads/notimplementedexception-when-using-inputcontrolpath-trygetcontrollayout-on-mouse-controls.847129/)).
-- Fixed compilation errors when disabling built-in VR and XR packages. ([case 1214248](https://issuetracker.unity3d.com/issues/enable-input-system-symbol-is-not-being-updated-when-the-input-system-is-changed-in-player-settings/)).
+- Fixed compilation errors when disabling built-in VR and XR modules. ([case 1214248](https://issuetracker.unity3d.com/issues/enable-input-system-symbol-is-not-being-updated-when-the-input-system-is-changed-in-player-settings/)).
+- Fixed compilation errors when disabling built-in Physics and Physics2D modules. ([case 1191392](https://issuetracker.unity3d.com/issues/inputsystem-trackeddeviceraycaster-has-hard-references-on-both-physics-and-physics2d)).
 - No longer throws `NotImplementedException` when matching against a field of `InputDeviceDescription.capabilities` when the value of the field used scientific notation.
 - No longer incorrectly matches fields of `InputDeviceDescription.capabilities` by prefix only (i.e. previously it would find the field "foo" when actually looking for "foobar").
 
@@ -39,6 +40,7 @@ however, it has to be formatted properly to pass verification tests.
 
 - `InputDevice.all` has been deprecated due to the confusion it creates with other getters like `Gamepad.all`. Use `InputSystem.devices` instead ([case 1231216](https://issuetracker.unity3d.com/issues/joystick-dot-all-lists-more-than-just-joysticks)).
   * In the same vein, we added a new `Joystick.all` getter that works the same as `Gamepad.all`.
+- Changed UI Package to be optional dependency. Removing the package will now disable all UI relevant Input code.
 
 ## [1.0.0-preview.6] - 2020-03-06
 

Packages/com.unity.inputsystem/InputSystem/Controls/InputControlExtensions.cs

@@ -5,7 +5,6 @@
 using Unity.Collections.LowLevel.Unsafe;
 using UnityEngine.InputSystem.Controls;
 using UnityEngine.InputSystem.LowLevel;
-using UnityEngine.InputSystem.UI;
 using UnityEngine.InputSystem.Utilities;
 
 ////REVIEW: some of the stuff here is really low-level; should we move it into a separate static class inside of .LowLevel?

Packages/com.unity.inputsystem/InputSystem/Plugins/OnScreen/OnScreenButton.cs

@@ -1,3 +1,4 @@
+#if PACKAGE_DOCS_GENERATION || UNITY_INPUT_SYSTEM_ENABLE_UI
 using UnityEngine.EventSystems;
 using UnityEngine.InputSystem.Layouts;
 
@@ -44,3 +45,4 @@ protected override string controlPathInternal
         }
     }
 }
+#endif

Packages/com.unity.inputsystem/InputSystem/Plugins/OnScreen/OnScreenStick.cs

@@ -1,3 +1,4 @@
+#if PACKAGE_DOCS_GENERATION || UNITY_INPUT_SYSTEM_ENABLE_UI
 using UnityEngine.EventSystems;
 using UnityEngine.Serialization;
 using UnityEngine.InputSystem.Layouts;
@@ -71,3 +72,4 @@ protected override string controlPathInternal
         }
     }
 }
+#endif

Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInput.cs

@@ -2,10 +2,13 @@
 using System.Collections.Generic;
 using UnityEngine.Events;
 using UnityEngine.InputSystem.LowLevel;
-using UnityEngine.InputSystem.UI;
 using UnityEngine.InputSystem.Users;
 using UnityEngine.InputSystem.Utilities;
 
+#if PACKAGE_DOCS_GENERATION || UNITY_INPUT_SYSTEM_ENABLE_UI
+using UnityEngine.InputSystem.UI;
+#endif
+
 ////TODO: allow PlayerInput to be set up in a way where it's in an unpaired/non-functional state and expects additional configuration
 
 ////REVIEW: having everything coupled to component enable/disable is quite restrictive; can we allow PlayerInputs
@@ -40,7 +43,7 @@ namespace UnityEngine.InputSystem
     /// <remarks>
     /// PlayerInput is a high-level wrapper around much of the input system's functionality
     /// which is meant to help getting set up with the new input system quickly. It takes
-    /// care of <see cref="InputAction"/> bookkeeping and has a custom UI to help
+    /// care of <see cref="InputAction"/> bookkeeping and has a custom UI(requires the "Unity UI" package) to help
     /// setting up input.
     ///
     /// The component supports local multiplayer implicitly. Each PlayerInput instance
@@ -49,8 +52,8 @@ namespace UnityEngine.InputSystem
     /// <see cref="UnityEngine.InputSystem.PlayerInputManager"/>.
     ///
     /// The way PlayerInput notifies script code of events is determined by <see cref="notificationBehavior"/>.
-    /// By default, this is set to <see cref="UnityEngine.InputSystem.PlayerNotifications.SendMessages"/> which will use <see
-    /// cref="GameObject.SendMessage(string,object)"/> to send messages to the <see cref="GameObject"/>
+    /// By default, this is set to <see cref="UnityEngine.InputSystem.PlayerNotifications.SendMessages"/> which will use
+    /// <see cref="GameObject.SendMessage(string,object)"/> to send messages to the <see cref="GameObject"/>
     /// that PlayerInput sits on.
     ///
     /// <example>
@@ -173,8 +176,8 @@ namespace UnityEngine.InputSystem
     ///
     /// Device pairings can be changed at any time by either manually controlling pairing through
     /// <see cref="InputUser.PerformPairingWithDevice"/> (and related methods) using a PlayerInput's
-    /// assigned <see cref="user"/> or by switching control schemes (e.g. using <see
-    /// cref="SwitchCurrentControlScheme(string,InputDevice[])"/>), if any are present in the PlayerInput's
+    /// assigned <see cref="user"/> or by switching control schemes (e.g. using
+    /// <see cref="SwitchCurrentControlScheme(string,InputDevice[])"/>), if any are present in the PlayerInput's
     /// <see cref="actions"/>.
     ///
     /// When a player loses a device paired to it (e.g. when it is unplugged or loses power), <see cref="InputUser"/>
@@ -184,8 +187,8 @@ namespace UnityEngine.InputSystem
     /// which also is surfaced as a message, as <see cref="deviceRegainedEvent"/>, or <see cref="onDeviceRegained"/>
     /// (depending on <see cref="notificationBehavior"/>).
     ///
-    /// When there is only a single active PlayerInput in the game, joining is not enabled (see <see
-    /// cref="PlayerInputManager.joiningEnabled"/>), and <see cref="neverAutoSwitchControlSchemes"/> is not
+    /// When there is only a single active PlayerInput in the game, joining is not enabled (see
+    /// <see cref="PlayerInputManager.joiningEnabled"/>), and <see cref="neverAutoSwitchControlSchemes"/> is not
     /// set to <c>true</c>, device pairings for the player will also update automatically based on device usage.
     ///
     /// If control schemes are present in <see cref="actions"/>, then if a device is used (not merely plugged in
@@ -708,6 +711,7 @@ Camera camera
             set => m_Camera = value;
         }
 
+        #if PACKAGE_DOCS_GENERATION || UNITY_INPUT_SYSTEM_ENABLE_UI
         /// <summary>
         /// UI InputModule that should have it's input actions synchronized to this PlayerInput's actions.
         /// </summary>
@@ -728,6 +732,7 @@ public InputSystemUIInputModule uiInputModule
                     m_UIInputModule.actionsAsset = m_Actions;
             }
         }
+        #endif
 
         /// <summary>
         /// The internal user tied to the player.
@@ -1054,8 +1059,12 @@ private static PlayerInput DoInstantiate(GameObject prefab)
         [Tooltip("Determine how notifications should be sent when an input-related event associated with the player happens.")]
         [SerializeField] internal PlayerNotifications m_NotificationBehavior;
         [Tooltip("UI InputModule that should have it's input actions synchronized to this PlayerInput's actions.")]
+
+        #if UNITY_INPUT_SYSTEM_ENABLE_UI
         [SerializeField] internal InputSystemUIInputModule m_UIInputModule;
         [Tooltip("Event that is triggered when the PlayerInput loses a paired device (e.g. its battery runs out).")]
+        #endif
+
         [SerializeField] internal DeviceLostEvent m_DeviceLostEvent;
         [SerializeField] internal DeviceRegainedEvent m_DeviceRegainedEvent;
         [SerializeField] internal ControlsChangedEvent m_ControlsChangedEvent;
@@ -1127,8 +1136,10 @@ private void InitializeActions()
                     break;
                 }
 
+            #if UNITY_INPUT_SYSTEM_ENABLE_UI
             if (uiInputModule != null)
                 uiInputModule.actionsAsset = m_Actions;
+            #endif
 
             switch (m_NotificationBehavior)
             {

Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInputEditor.cs

@@ -5,11 +5,14 @@
 using System.Linq;
 using System.Text;
 using UnityEditor;
-using UnityEngine.InputSystem.UI;
-using UnityEngine.InputSystem.UI.Editor;
 using UnityEngine.InputSystem.Users;
 using UnityEngine.InputSystem.Utilities;
 
+#if UNITY_INPUT_SYSTEM_ENABLE_UI
+using UnityEngine.InputSystem.UI;
+using UnityEngine.InputSystem.UI.Editor;
+#endif
+
 ////TODO: detect if new input system isn't enabled and provide UI to enable it
 #pragma warning disable 0414
 namespace UnityEngine.InputSystem.Editor
@@ -33,13 +36,16 @@ public void OnEnable()
             m_DefaultControlSchemeProperty = serializedObject.FindProperty("m_DefaultControlScheme");
             m_NeverAutoSwitchControlSchemesProperty = serializedObject.FindProperty("m_NeverAutoSwitchControlSchemes");
             m_DefaultActionMapProperty = serializedObject.FindProperty("m_DefaultActionMap");
-            m_UIInputModuleProperty = serializedObject.FindProperty("m_UIInputModule");
             m_NotificationBehaviorProperty = serializedObject.FindProperty("m_NotificationBehavior");
             m_CameraProperty = serializedObject.FindProperty("m_Camera");
             m_ActionEventsProperty = serializedObject.FindProperty("m_ActionEvents");
             m_DeviceLostEventProperty = serializedObject.FindProperty("m_DeviceLostEvent");
             m_DeviceRegainedEventProperty = serializedObject.FindProperty("m_DeviceRegainedEvent");
             m_ControlsChangedEventProperty = serializedObject.FindProperty("m_ControlsChangedEvent");
+
+            #if UNITY_INPUT_SYSTEM_ENABLE_UI
+            m_UIInputModuleProperty = serializedObject.FindProperty("m_UIInputModule");
+            #endif
         }
 
         public void OnDestroy()
@@ -124,6 +130,7 @@ public override void OnInspectorGUI()
             --EditorGUI.indentLevel;
             DoHelpCreateAssetUI();
 
+            #if UNITY_INPUT_SYSTEM_ENABLE_UI
             // UI config section.
             if (m_UIPropertyText == null)
                 m_UIPropertyText = EditorGUIUtility.TrTextContent("UI Input Module", m_UIInputModuleProperty.tooltip);
@@ -137,11 +144,12 @@ public override void OnInspectorGUI()
                 var uiModule = m_UIInputModuleProperty.objectReferenceValue as InputSystemUIInputModule;
                 if (m_ActionsProperty.objectReferenceValue != null && uiModule.actionsAsset != m_ActionsProperty.objectReferenceValue)
                 {
-                    EditorGUILayout.HelpBox("The referenced InputSystemUIInputModule is configured using differnet input actions then this PlayerInput. They should match if you want to synchronize PlayerInput actions to the UI input.", MessageType.Warning);
+                    EditorGUILayout.HelpBox("The referenced InputSystemUIInputModule is configured using different input actions then this PlayerInput. They should match if you want to synchronize PlayerInput actions to the UI input.", MessageType.Warning);
                     if (GUILayout.Button(m_FixInputModuleText))
                         InputSystemUIInputModuleEditor.ReassignActions(uiModule, m_ActionsProperty.objectReferenceValue as InputActionAsset);
                 }
             }
+            #endif
 
             // Camera section.
             if (m_CameraPropertyText == null)
@@ -546,7 +554,9 @@ void AddEntry(InputAction action, PlayerInput.ActionEvent actionEvent)
         [NonSerialized] private SerializedProperty m_DefaultActionMapProperty;
         [NonSerialized] private SerializedProperty m_NeverAutoSwitchControlSchemesProperty;
         [NonSerialized] private SerializedProperty m_NotificationBehaviorProperty;
+        #if UNITY_INPUT_SYSTEM_ENABLE_UI
         [NonSerialized] private SerializedProperty m_UIInputModuleProperty;
+        #endif
         [NonSerialized] private SerializedProperty m_ActionEventsProperty;
         [NonSerialized] private SerializedProperty m_CameraProperty;
         [NonSerialized] private SerializedProperty m_DeviceLostEventProperty;

Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInputManager.cs

@@ -4,7 +4,6 @@
 using UnityEngine.InputSystem.LowLevel;
 using UnityEngine.InputSystem.Users;
 using UnityEngine.InputSystem.Utilities;
-using UnityEngine.UI;
 
 ////REVIEW: should we automatically pool/retain up to maxPlayerCount player instances?
 

Packages/com.unity.inputsystem/InputSystem/Plugins/UI/BaseInputOverride.cs

@@ -1,3 +1,4 @@
+#if UNITY_INPUT_SYSTEM_ENABLE_UI
 using UnityEngine.EventSystems;
 
 namespace UnityEngine.InputSystem.UI
@@ -7,3 +8,4 @@ internal class BaseInputOverride : BaseInput
         public override string compositionString { get; }
     }
 }
+#endif

Packages/com.unity.inputsystem/InputSystem/Plugins/UI/ExtendedPointerEventData.cs

@@ -1,3 +1,4 @@
+#if PACKAGE_DOCS_GENERATION || UNITY_INPUT_SYSTEM_ENABLE_UI
 using System.Text;
 using UnityEngine.EventSystems;
 using UnityEngine.InputSystem.Controls;
@@ -162,3 +163,4 @@ public enum UIPointerBehavior
         AllPointersAsIs,
     }
 }
+#endif

Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs

@@ -1,3 +1,4 @@
+#if PACKAGE_DOCS_GENERATION || UNITY_INPUT_SYSTEM_ENABLE_UI
 using System;
 using UnityEngine.EventSystems;
 using UnityEngine.InputSystem.Controls;
@@ -1723,3 +1724,4 @@ public InputActionAsset actionsAsset
         private NavigationModel m_NavigationState;
     }
 }
+#endif