feat(Avatar): add near touch overrides to avatar hand

The Avatar Hand Controller can now accept near touch overrides
for each of the finger axes.

Author: thestonefox

Assets/VRTK/Documentation/API.md

@@ -1176,10 +1176,12 @@ Provides a custom controller hand model with psuedo finger functionality.
  * **Pinky Axis Button:** The button type to listen for axis changes to control the pinky finger.
  * **Three Finger Axis Button:** The button type to listen for axis changes to control the middle, ring and pinky finger.
  * **Thumb State:** The Axis Type to utilise when dealing with the thumb state. Not all controllers support all axis types on all of the available buttons.
+ * **Near Touch Overrides:** Finger axis overrides on an Interact NearTouch event.
  * **Touch Overrides:** Finger axis overrides on an Interact Touch event.
  * **Grab Overrides:** Finger axis overrides on an Interact Grab event.
  * **Use Overrides:** Finger axis overrides on an Interact Use event.
  * **Controller Events:** The controller to listen for the events on. If this is left blank as it will be auto populated by finding the Controller Events script on the parent GameObject.
+ * **Interact Near Touch:** An optional Interact NearTouch to listen for near touch events on. If this is left blank as it will attempt to be auto populated by finding the Interact NearTouch script on the parent GameObject.
  * **Interact Touch:** An optional Interact Touch to listen for touch events on. If this is left blank as it will attempt to be auto populated by finding the Interact Touch script on the parent GameObject.
  * **Interact Grab:** An optional Interact Grab to listen for grab events on. If this is left blank as it will attempt to be auto populated by finding the Interact Grab script on the parent GameObject.
  * **Interact Use:** An optional Interact Use to listen for use events on. If this is left blank as it will attempt to be auto populated by finding the Interact Use script on the parent GameObject.

Assets/VRTK/Prefabs/AvatarHands/BasicHands/Models/VRTK_BasicHand_AnimationController.controller

@@ -8,6 +8,12 @@ AnimatorController:
   m_Name: VRTK_BasicHand_AnimationController
   serializedVersion: 5
   m_AnimatorParameters:
+  - m_Name: NearTouchState
+    m_Type: 1
+    m_DefaultFloat: -1
+    m_DefaultInt: 0
+    m_DefaultBool: 0
+    m_Controller: {fileID: 0}
   - m_Name: TouchState
     m_Type: 1
     m_DefaultFloat: -1

Assets/VRTK/Prefabs/Internal/Scripts/VRTK_AvatarHandController.cs

@@ -155,6 +155,8 @@ public class VRTK_AvatarHandController : MonoBehaviour
 
         [Header("Finger Axis Overrides")]
 
+        [Tooltip("Finger axis overrides on an Interact NearTouch event.")]
+        public AxisOverrides nearTouchOverrides;
         [Tooltip("Finger axis overrides on an Interact Touch event.")]
         public AxisOverrides touchOverrides;
         [Tooltip("Finger axis overrides on an Interact Grab event.")]
@@ -166,6 +168,8 @@ public class VRTK_AvatarHandController : MonoBehaviour
 
         [Tooltip("The controller to listen for the events on. If this is left blank as it will be auto populated by finding the Controller Events script on the parent GameObject.")]
         public VRTK_ControllerEvents controllerEvents;
+        [Tooltip("An optional Interact NearTouch to listen for near touch events on. If this is left blank as it will attempt to be auto populated by finding the Interact NearTouch script on the parent GameObject.")]
+        public VRTK_InteractNearTouch interactNearTouch;
         [Tooltip("An optional Interact Touch to listen for touch events on. If this is left blank as it will attempt to be auto populated by finding the Interact Touch script on the parent GameObject.")]
         public VRTK_InteractTouch interactTouch;
         [Tooltip("An optional Interact Grab to listen for grab events on. If this is left blank as it will attempt to be auto populated by finding the Interact Grab script on the parent GameObject.")]
@@ -220,6 +224,7 @@ protected virtual void OnEnable()
         {
             animator = GetComponent<Animator>();
             controllerEvents = (controllerEvents != null ? controllerEvents : GetComponentInParent<VRTK_ControllerEvents>());
+            interactNearTouch = (interactNearTouch != null ? interactNearTouch : GetComponentInParent<VRTK_InteractNearTouch>());
             interactTouch = (interactTouch != null ? interactTouch : GetComponentInParent<VRTK_InteractTouch>());
             interactGrab = (interactGrab != null ? interactGrab : GetComponentInParent<VRTK_InteractGrab>());
             interactUse = (interactUse != null ? interactUse : GetComponentInParent<VRTK_InteractUse>());
@@ -308,6 +313,12 @@ protected virtual void SubscribeEvents()
                 SubscribeButtonAxisEvent(threeFingerAxisButton, ref savedThreeFingerAxisButtonState, threeFingerState, DoThreeFingerAxisEvent);
             }
 
+            if (interactNearTouch != null)
+            {
+                interactNearTouch.ControllerNearTouchInteractableObject += DoControllerNearTouch;
+                interactNearTouch.ControllerNearUntouchInteractableObject += DoControllerNearUntouch;
+            }
+
             if (interactTouch != null)
             {
                 interactTouch.ControllerTouchInteractableObject += DoControllerTouch;
@@ -346,6 +357,12 @@ protected virtual void UnsubscribeEvents()
                 UnsubscribeButtonAxisEvent(savedThreeFingerAxisButtonState, threeFingerState, DoThreeFingerAxisEvent);
             }
 
+            if (interactNearTouch != null)
+            {
+                interactNearTouch.ControllerNearTouchInteractableObject -= DoControllerNearTouch;
+                interactNearTouch.ControllerNearUntouchInteractableObject -= DoControllerNearUntouch;
+            }
+
             if (interactTouch != null)
             {
                 interactTouch.ControllerTouchInteractableObject -= DoControllerTouch;
@@ -550,6 +567,32 @@ protected virtual void SetAnimatorStateOff(string state)
             animator.SetFloat(state, -1f);
         }
 
+        protected virtual void DoControllerNearTouch(object sender, ObjectInteractEventArgs e)
+        {
+            if (interactTouch != null && interactTouch.GetTouchedObject() == null)
+            {
+                SetAnimatorStateOn("NearTouchState", nearTouchOverrides);
+                HandleOverrideOn(nearTouchOverrides.ignoreAllOverrides, fingerAxis, GetOverridePermissions(nearTouchOverrides), GetOverrideValues(nearTouchOverrides));
+            }
+        }
+
+        protected virtual void DoControllerNearUntouch(object sender, ObjectInteractEventArgs e)
+        {
+            if (interactNearTouch.GetNearTouchedObjects().Count == 0 && (interactTouch == null || interactTouch.GetTouchedObject() == null))
+            {
+                for (int i = 0; i < fingerUntouchedAxis.Length; i++)
+                {
+                    if (!IsButtonPressed(i))
+                    {
+                        SetOverrideValue(i, ref overrideAxisValues, OverrideState.WasOverring);
+                        fingerForceAxis[i] = fingerUntouchedAxis[i];
+                    }
+                }
+                SetAnimatorStateOff("NearTouchState");
+                HandleOverrideOff(nearTouchOverrides.ignoreAllOverrides, GetOverridePermissions(nearTouchOverrides), false);
+            }
+        }
+
         protected virtual void DoControllerTouch(object sender, ObjectInteractEventArgs e)
         {
             SetAnimatorStateOn("TouchState", touchOverrides);
@@ -558,12 +601,15 @@ protected virtual void DoControllerTouch(object sender, ObjectInteractEventArgs
 
         protected virtual void DoControllerUntouch(object sender, ObjectInteractEventArgs e)
         {
-            for (int i = 0; i < fingerUntouchedAxis.Length; i++)
+            if (interactNearTouch == null || nearTouchOverrides.ignoreAllOverrides)
             {
-                if (!IsButtonPressed(i))
+                for (int i = 0; i < fingerUntouchedAxis.Length; i++)
                 {
-                    SetOverrideValue(i, ref overrideAxisValues, OverrideState.WasOverring);
-                    fingerForceAxis[i] = fingerUntouchedAxis[i];
+                    if (!IsButtonPressed(i))
+                    {
+                        SetOverrideValue(i, ref overrideAxisValues, OverrideState.WasOverring);
+                        fingerForceAxis[i] = fingerUntouchedAxis[i];
+                    }
                 }
             }
             SetAnimatorStateOff("TouchState");
@@ -702,7 +748,7 @@ protected virtual void ProcessFinger(VRTK_ControllerEvents.AxisType state, int a
             }
 
             //Final sanity check, if you're not touching anything but the override is still set, then clear the override.
-            if ((interactTouch == null || interactTouch.GetTouchedObject() == null) && overrideAxisValues[arrayIndex] != OverrideState.NoOverride)
+            if (((interactTouch == null && interactNearTouch == null) || (interactNearTouch == null && interactTouch.GetTouchedObject() == null) || (interactNearTouch != null && interactNearTouch.GetNearTouchedObjects().Count == 0)) && overrideAxisValues[arrayIndex] != OverrideState.NoOverride)
             {
                 SetOverrideValue(arrayIndex, ref overrideAxisValues, OverrideState.NoOverride);
             }