feat(Locomotion): allow alternative axis for touchpad control

thestonefox · thestonefox · commit c4bf5d8afb5e · 2017-11-22T09:28:16.000Z
The Touchpad Control script can now use an alternative coordinate axis
for the control, such as touchpad two.
diff --git a/Assets/VRTK/Documentation/API.md b/Assets/VRTK/Documentation/API.md
@@ -2222,6 +2222,7 @@ Provides the ability to control a GameObject's position based on the position of
 
 ### Inspector Parameters
 
+ * **Coordinate Axis:** The axis to use for the direction coordinates.
  * **Primary Activation Button:** An optional button that has to be engaged to allow the touchpad control to activate.
  * **Action Modifier Button:** An optional button that when engaged will activate the modifier on the touchpad control action.
  * **Axis Deadzone:** A deadzone threshold on the touchpad that will ignore input if the touch position is within the specified deadzone. Between `0f` and `1f`.
diff --git a/Assets/VRTK/Source/Scripts/Locomotion/VRTK_TouchpadControl.cs b/Assets/VRTK/Source/Scripts/Locomotion/VRTK_TouchpadControl.cs
@@ -28,6 +28,8 @@ public class VRTK_TouchpadControl : VRTK_ObjectControl
     {
         [Header("Touchpad Control Settings")]
 
+        [Tooltip("The axis to use for the direction coordinates.")]
+        public SDK_BaseController.Vector2Axis coordinateAxis = SDK_BaseController.Vector2Axis.Touchpad;
         [Tooltip("An optional button that has to be engaged to allow the touchpad control to activate.")]
         public VRTK_ControllerEvents.ButtonAlias primaryActivationButton = VRTK_ControllerEvents.ButtonAlias.TouchpadTouch;
         [Tooltip("An optional button that when engaged will activate the modifier on the touchpad control action.")]
@@ -38,12 +40,14 @@ public class VRTK_TouchpadControl : VRTK_ObjectControl
         protected bool touchpadFirstChange;
         protected bool otherTouchpadControlEnabledState;
         protected bool otherTouchpadControlEnabledStateSet;
+        protected VRTK_ControllerEvents.ButtonAlias coordniateButtonAlias;
 
         protected override void OnEnable()
         {
             base.OnEnable();
             touchpadFirstChange = true;
             otherTouchpadControlEnabledStateSet = false;
+            coordniateButtonAlias = (coordinateAxis == SDK_BaseController.Vector2Axis.Touchpad ? VRTK_ControllerEvents.ButtonAlias.TouchpadTouch : VRTK_ControllerEvents.ButtonAlias.TouchpadTwoTouch);
         }
 
         protected override void ControlFixedUpdate()
@@ -63,7 +67,7 @@ protected override void ControlFixedUpdate()
         protected override VRTK_ObjectControl GetOtherControl()
         {
             GameObject foundController = (VRTK_DeviceFinder.IsControllerLeftHand(gameObject) ? VRTK_DeviceFinder.GetControllerRightHand(false) : VRTK_DeviceFinder.GetControllerLeftHand(false));
-            if (foundController)
+            if (foundController != null)
             {
                 return foundController.GetComponentInChildren<VRTK_TouchpadControl>();
             }
@@ -72,17 +76,35 @@ protected override VRTK_ObjectControl GetOtherControl()
 
         protected override void SetListeners(bool state)
         {
-            if (controllerEvents)
+            if (controllerEvents != null)
             {
                 if (state)
                 {
-                    controllerEvents.TouchpadAxisChanged += TouchpadAxisChanged;
-                    controllerEvents.TouchpadTouchEnd += TouchpadTouchEnd;
+                    switch (coordinateAxis)
+                    {
+                        case SDK_BaseController.Vector2Axis.Touchpad:
+                            controllerEvents.TouchpadAxisChanged += TouchpadAxisChanged;
+                            controllerEvents.TouchpadTouchEnd += TouchpadTouchEnd;
+                            break;
+                        case SDK_BaseController.Vector2Axis.TouchpadTwo:
+                            controllerEvents.TouchpadTwoAxisChanged += TouchpadAxisChanged;
+                            controllerEvents.TouchpadTwoTouchEnd += TouchpadTouchEnd;
+                            break;
+                    }
                 }
                 else
                 {
-                    controllerEvents.TouchpadAxisChanged -= TouchpadAxisChanged;
-                    controllerEvents.TouchpadTouchEnd -= TouchpadTouchEnd;
+                    switch (coordinateAxis)
+                    {
+                        case SDK_BaseController.Vector2Axis.Touchpad:
+                            controllerEvents.TouchpadAxisChanged -= TouchpadAxisChanged;
+                            controllerEvents.TouchpadTouchEnd -= TouchpadTouchEnd;
+                            break;
+                        case SDK_BaseController.Vector2Axis.TouchpadTwo:
+                            controllerEvents.TouchpadTwoAxisChanged -= TouchpadAxisChanged;
+                            controllerEvents.TouchpadTwoTouchEnd -= TouchpadTouchEnd;
+                            break;
+                    }
                 }
             }
         }
@@ -109,18 +131,19 @@ protected virtual void ModifierButtonActive()
 
         protected virtual bool TouchpadTouched()
         {
-            return (controllerEvents && controllerEvents.IsButtonPressed(VRTK_ControllerEvents.ButtonAlias.TouchpadTouch));
+            return (controllerEvents && controllerEvents.IsButtonPressed(coordniateButtonAlias));
         }
 
         protected virtual void TouchpadAxisChanged(object sender, ControllerInteractionEventArgs e)
         {
-            if (touchpadFirstChange && otherObjectControl != null && disableOtherControlsOnActive && e.touchpadAxis != Vector2.zero)
+            Vector2 actualAxis = (coordinateAxis == SDK_BaseController.Vector2Axis.Touchpad ? e.touchpadAxis : e.touchpadTwoAxis);
+            if (touchpadFirstChange && otherObjectControl != null && disableOtherControlsOnActive && actualAxis != Vector2.zero)
             {
                 otherTouchpadControlEnabledState = otherObjectControl.enabled;
                 otherTouchpadControlEnabledStateSet = true;
                 otherObjectControl.enabled = false;
             }
-            currentAxis = (ValidPrimaryButton() ? e.touchpadAxis : Vector2.zero);
+            currentAxis = (ValidPrimaryButton() ? actualAxis : Vector2.zero);
 
             if (currentAxis != Vector2.zero)
             {

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,8 @@ public class VRTK_TouchpadControl : VRTK_ObjectControl`
`28`	`28`	`{`
`29`	`29`	`[Header("Touchpad Control Settings")]`
`30`	`30`
	`31`	`+ [Tooltip("The axis to use for the direction coordinates.")]`
	`32`	`+ public SDK_BaseController.Vector2Axis coordinateAxis = SDK_BaseController.Vector2Axis.Touchpad;`
`31`	`33`	`[Tooltip("An optional button that has to be engaged to allow the touchpad control to activate.")]`
`32`	`34`	`public VRTK_ControllerEvents.ButtonAlias primaryActivationButton = VRTK_ControllerEvents.ButtonAlias.TouchpadTouch;`
`33`	`35`	`[Tooltip("An optional button that when engaged will activate the modifier on the touchpad control action.")]`
`@@ -38,12 +40,14 @@ public class VRTK_TouchpadControl : VRTK_ObjectControl`
`38`	`40`	`protected bool touchpadFirstChange;`
`39`	`41`	`protected bool otherTouchpadControlEnabledState;`
`40`	`42`	`protected bool otherTouchpadControlEnabledStateSet;`
	`43`	`+ protected VRTK_ControllerEvents.ButtonAlias coordniateButtonAlias;`
`41`	`44`
`42`	`45`	`protected override void OnEnable()`
`43`	`46`	`{`
`44`	`47`	`base.OnEnable();`
`45`	`48`	`touchpadFirstChange = true;`
`46`	`49`	`otherTouchpadControlEnabledStateSet = false;`
	`50`	`+ coordniateButtonAlias = (coordinateAxis == SDK_BaseController.Vector2Axis.Touchpad ? VRTK_ControllerEvents.ButtonAlias.TouchpadTouch : VRTK_ControllerEvents.ButtonAlias.TouchpadTwoTouch);`
`47`	`51`	`}`
`48`	`52`
`49`	`53`	`protected override void ControlFixedUpdate()`
`@@ -63,7 +67,7 @@ protected override void ControlFixedUpdate()`
`63`	`67`	`protected override VRTK_ObjectControl GetOtherControl()`
`64`	`68`	`{`
`65`	`69`	`GameObject foundController = (VRTK_DeviceFinder.IsControllerLeftHand(gameObject) ? VRTK_DeviceFinder.GetControllerRightHand(false) : VRTK_DeviceFinder.GetControllerLeftHand(false));`
`66`		`- if (foundController)`
	`70`	`+ if (foundController != null)`
`67`	`71`	`{`
`68`	`72`	`return foundController.GetComponentInChildren<VRTK_TouchpadControl>();`
`69`	`73`	`}`
`@@ -72,17 +76,35 @@ protected override VRTK_ObjectControl GetOtherControl()`
`72`	`76`
`73`	`77`	`protected override void SetListeners(bool state)`
`74`	`78`	`{`
`75`		`- if (controllerEvents)`
	`79`	`+ if (controllerEvents != null)`
`76`	`80`	`{`
`77`	`81`	`if (state)`
`78`	`82`	`{`
`79`		`- controllerEvents.TouchpadAxisChanged += TouchpadAxisChanged;`
`80`		`- controllerEvents.TouchpadTouchEnd += TouchpadTouchEnd;`
	`83`	`+ switch (coordinateAxis)`
	`84`	`+ {`
	`85`	`+ case SDK_BaseController.Vector2Axis.Touchpad:`
	`86`	`+ controllerEvents.TouchpadAxisChanged += TouchpadAxisChanged;`
	`87`	`+ controllerEvents.TouchpadTouchEnd += TouchpadTouchEnd;`
	`88`	`+ break;`
	`89`	`+ case SDK_BaseController.Vector2Axis.TouchpadTwo:`
	`90`	`+ controllerEvents.TouchpadTwoAxisChanged += TouchpadAxisChanged;`
	`91`	`+ controllerEvents.TouchpadTwoTouchEnd += TouchpadTouchEnd;`
	`92`	`+ break;`
	`93`	`+ }`
`81`	`94`	`}`
`82`	`95`	`else`
`83`	`96`	`{`
`84`		`- controllerEvents.TouchpadAxisChanged -= TouchpadAxisChanged;`
`85`		`- controllerEvents.TouchpadTouchEnd -= TouchpadTouchEnd;`
	`97`	`+ switch (coordinateAxis)`
	`98`	`+ {`
	`99`	`+ case SDK_BaseController.Vector2Axis.Touchpad:`
	`100`	`+ controllerEvents.TouchpadAxisChanged -= TouchpadAxisChanged;`
	`101`	`+ controllerEvents.TouchpadTouchEnd -= TouchpadTouchEnd;`
	`102`	`+ break;`
	`103`	`+ case SDK_BaseController.Vector2Axis.TouchpadTwo:`
	`104`	`+ controllerEvents.TouchpadTwoAxisChanged -= TouchpadAxisChanged;`
	`105`	`+ controllerEvents.TouchpadTwoTouchEnd -= TouchpadTouchEnd;`
	`106`	`+ break;`
	`107`	`+ }`
`86`	`108`	`}`
`87`	`109`	`}`
`88`	`110`	`}`
`@@ -109,18 +131,19 @@ protected virtual void ModifierButtonActive()`
`109`	`131`
`110`	`132`	`protected virtual bool TouchpadTouched()`
`111`	`133`	`{`
`112`		`- return (controllerEvents && controllerEvents.IsButtonPressed(VRTK_ControllerEvents.ButtonAlias.TouchpadTouch));`
	`134`	`+ return (controllerEvents && controllerEvents.IsButtonPressed(coordniateButtonAlias));`
`113`	`135`	`}`
`114`	`136`
`115`	`137`	`protected virtual void TouchpadAxisChanged(object sender, ControllerInteractionEventArgs e)`
`116`	`138`	`{`
`117`		`- if (touchpadFirstChange && otherObjectControl != null && disableOtherControlsOnActive && e.touchpadAxis != Vector2.zero)`
	`139`	`+ Vector2 actualAxis = (coordinateAxis == SDK_BaseController.Vector2Axis.Touchpad ? e.touchpadAxis : e.touchpadTwoAxis);`
	`140`	`+ if (touchpadFirstChange && otherObjectControl != null && disableOtherControlsOnActive && actualAxis != Vector2.zero)`
`118`	`141`	`{`
`119`	`142`	`otherTouchpadControlEnabledState = otherObjectControl.enabled;`
`120`	`143`	`otherTouchpadControlEnabledStateSet = true;`
`121`	`144`	`otherObjectControl.enabled = false;`
`122`	`145`	`}`
`123`		`- currentAxis = (ValidPrimaryButton() ? e.touchpadAxis : Vector2.zero);`
	`146`	`+ currentAxis = (ValidPrimaryButton() ? actualAxis : Vector2.zero);`
`124`	`147`
`125`	`148`	`if (currentAxis != Vector2.zero)`
`126`	`149`	`{`