feat(UIPointer): add option to do click when pointer is deactivated

A new option on the UI Pointer script is now available that when
enabled will automatically attempt a click event on the last hovered
UI element before the UI Pointer was deactivated.

This provides the ability to just enable the UI Pointer and point at
an object then release the pointer to perform a click, rather than
having to press a separate button to perform the click action.

Assets/VRTK/Examples/Resources/Scripts/VRTK_ControllerUIPointerEvents_ListenerExample.cs

@@ -27,7 +27,7 @@ private void Start()
 
         private void VRTK_ControllerUIPointerEvents_ListenerExample_UIPointerElementEnter(object sender, UIPointerEventArgs e)
         {
-            Debug.Log("UI Pointer entered " + e.currentTarget.name + " on Controller index [" + e.controllerIndex + "]");
+            Debug.Log("UI Pointer entered " + e.currentTarget.name + " on Controller index [" + e.controllerIndex + "] and the state was " + e.isActive);
             if (togglePointerOnHit && GetComponent<VRTK_SimplePointer>())
             {
                 GetComponent<VRTK_SimplePointer>().ToggleBeam(true);
@@ -36,7 +36,7 @@ private void VRTK_ControllerUIPointerEvents_ListenerExample_UIPointerElementEnte
 
         private void VRTK_ControllerUIPointerEvents_ListenerExample_UIPointerElementExit(object sender, UIPointerEventArgs e)
         {
-            Debug.Log("UI Pointer exited " + e.previousTarget.name + " on Controller index [" + e.controllerIndex + "]");
+            Debug.Log("UI Pointer exited " + e.previousTarget.name + " on Controller index [" + e.controllerIndex + "] and the state was " + e.isActive);
             if (togglePointerOnHit && GetComponent<VRTK_SimplePointer>())
             {
                 GetComponent<VRTK_SimplePointer>().ToggleBeam(false);

Assets/VRTK/Scripts/VRTK_UIPointer.cs

@@ -9,11 +9,13 @@ namespace VRTK
     /// Event Payload
     /// </summary>
     /// <param name="controllerIndex">The index of the controller that was used.</param>
+    /// <param name="isActive">The state of whether the UI Pointer is currently active or not.</param>
     /// <param name="currentTarget">The current UI element that the pointer is colliding with.</param>
     /// <param name="previousTarget">The previous UI element that the pointer was colliding with.</param>
     public struct UIPointerEventArgs
     {
         public uint controllerIndex;
+        public bool isActive;
         public GameObject currentTarget;
         public GameObject previousTarget;
     }
@@ -55,10 +57,12 @@ public enum ActivationMethods
 
         [Tooltip("The controller that will be used to toggle the pointer. If the script is being applied onto a controller then this parameter can be left blank as it will be auto populated by the controller the script is on at runtime.")]
         public VRTK_ControllerEvents controller;
-        [Tooltip("A string that specifies a canvas Tag or the name of a Script attached to a canvas and denotes that any world canvases that contain this tag or script will be ignored by the UI Pointer.")]
-        public string ignoreCanvasWithTagOrClass;
         [Tooltip("Determines when the UI pointer should be active.")]
         public ActivationMethods activationMode = ActivationMethods.Hold_Button;
+        [Tooltip("Determines whether the UI click action should be triggered when the pointer is deactivated. If the pointer is hovering over a clickable element then it will invoke the click action on that element.")]
+        public bool attemptClickOnDeactivate = false;
+        [Tooltip("A string that specifies a canvas Tag or the name of a Script attached to a canvas and denotes that any world canvases that contain this tag or script will be ignored by the UI Pointer.")]
+        public string ignoreCanvasWithTagOrClass;
         [Tooltip("A specified VRTK_TagOrScriptPolicyList to use to determine whether any world canvases will be acted upon by the UI Pointer. If a list is provided then the 'Ignore Canvas With Tag Or Class' parameter will be ignored.")]
         public VRTK_TagOrScriptPolicyList canvasTagOrScriptListPolicy;
 
@@ -95,13 +99,19 @@ public virtual void OnUIPointerElementExit(UIPointerEventArgs e)
             if (UIPointerElementExit != null)
             {
                 UIPointerElementExit(this, e);
+
+                if (attemptClickOnDeactivate && !e.isActive && e.previousTarget)
+                {
+                    pointerEventData.pointerPress = e.previousTarget;
+                }
             }
         }
 
         public UIPointerEventArgs SetUIPointerEvent(GameObject currentTarget, GameObject lastTarget = null)
         {
             UIPointerEventArgs e;
             e.controllerIndex = VRTK_DeviceFinder.GetControllerIndex(controller.gameObject);
+            e.isActive = PointerActive();
             e.currentTarget = currentTarget;
             e.previousTarget = lastTarget;
             return e;

DOCUMENTATION.md

@@ -1097,8 +1097,9 @@ The UI pointer is activated via the `Pointer` alias on the `Controller Events` a
 ### Inspector Parameters
 
  * **Controller:** The controller that will be used to toggle the pointer. If the script is being applied onto a controller then this parameter can be left blank as it will be auto populated by the controller the script is on at runtime.
- * **Ignore Canvas With Tag Or Class:** A string that specifies a canvas Tag or the name of a Script attached to a canvas and denotes that any world canvases that contain this tag or script will be ignored by the UI Pointer.
  * **Activation Mode:** Determines when the UI pointer should be active.
+ * **Attempt Click On Deactivate:** Determines whether the UI click action should be triggered when the pointer is deactivated. If the pointer is hovering over a clickable element then it will invoke the click action on that element.
+ * **Ignore Canvas With Tag Or Class:** A string that specifies a canvas Tag or the name of a Script attached to a canvas and denotes that any world canvases that contain this tag or script will be ignored by the UI Pointer.
  * **Canvas Tag Or Script List Policy:** A specified VRTK_TagOrScriptPolicyList to use to determine whether any world canvases will be acted upon by the UI Pointer. If a list is provided then the 'Ignore Canvas With Tag Or Class' parameter will be ignored.
 
 ### Class Variables
@@ -1123,6 +1124,7 @@ Adding the `VRTK_UIPointer_UnityEvents` component to `VRTK_UIPointer` object all
 ### Event Payload
 
  * `uint controllerIndex` - The index of the controller that was used.
+ * `bool isActive` - The state of whether the UI Pointer is currently active or not.
  * `GameObject currentTarget` - The current UI element that the pointer is colliding with.
  * `GameObject previousTarget` - The previous UI element that the pointer was colliding with.