Update to v1.11.0

* New Features
  - Add compatibility with **Unity 2020.1**
  - Add support for **Unity XR Platform** (OpenVR, Oculus, and Windows MR)
    - VIU Settings automatically installs proper XR Loader from **PackageManager** for supported devices
      - **OpenVR XR Plugin**
      - **Oculus XR Plugin**
      - **Windows XR Plugin**
  - Add support for Oculus controller render model (Requires [Oculus SDK](https://assetstore.unity.com/packages/tools/integration/oculus-integration-82022))
  - Add new **ControllerButton.DPadCenter** & **ControllerButton.DPadCenterTouch**
    - Also change **VIUSettings.virtualDPadDeadZone** default value from 0.15 to **0.25**
    - This settings is not available in VIU Settings UI yet, but can be manually modified in HTC.UnityPlugin/ViveInputUtility/Resources/**VIUSettings.asset**

* Changes
  - Now use relative path when choosing Oculus Android AndroidManifest.xml file with picker (#175)
  - Update **ControllerManagerSample**
    - Fix support for StickyGrabbables
    - Clean up side cases where updateactivity was needed
    - Add more button options for laser pointer
    - Fix typo
  - Slightly change **ColliderEventCaster**'s behaviour
    - Now IColliderEventPressUpHandler will be treggered only if IColliderEventPressDownHandler also implemented
    - This is for aligning IPointerUpHandler and IPointerDownHandler behaviour
  - Improve **Grabbable**
    - Now **BasicGrabbable** & **StickyGrabbable** able to accept more then one grab button
      - Add new property **primaryGrabButton** so it can be specified with VIU ControllerButton
      - Obsolete property grabButton and add new property **secondaryGrabButton** as a substitute
      - Note that you must setup **ViveColliderEventCaster** properly to send the specified grab button event
  - Improve **Teleportable**
    - Now **Teleportable** able to accept more then one teleport button
      - Add new property **PrimeryTeleportButton** so it can specify with VIU ControllerButton
        - Obsolete property teleportButton and add new property **SecondaryTeleportButton** as a substitute
        - Note that you must setup **ViveRaycaster** properly to send the specified teleport button event
      - Add new property **TriggeredType**
        - **ButtonUp** : perform teleport on button press up (default)
        - **ButtonDown** : perform teleport on button press down
        - **ButtonClick** : perform teleport on button press up only if pointed object when press down/up are the same
      - Add new property **RotateToHitObjectFront**
        - When set to true, teleportation will rotate pivot front to hit object front
      - Add new property **TeleportToHitObjectPivot**
        - When set to true, teleportation will move pivot to hit object pivot instead of the hit point
      - Add new property **UseSteamVRFade**
        - Only works when [SteamVR Plugin](https://assetstore.unity.com/packages/tools/integration/steamvr-plugin-32647) is installed
        - When set to false or SteamVR Plugin is not installed, the teleportation will delay for half of fadeDuration without fading effect
        - This provides an option for developer to implement their custom fading effect in the OnBeforeTeleport event
      - Add event **OnBeforeTeleport(Teleportable src, RaycastResult hitResult, float delay)**
        - Emit before fade duration start counting down
        - Usually delay argument is half of fade duration (0 if fadeDuration is ignored)
        - Possible usage is to start custom fading effect in this callback
      - Add event **OnAfterTeleport(Teleportable src, RaycastResult hitResult, float delay)**
        - Emit after teleportation is performed
      - Add static event **OnBeforeAnyTeleport(Teleportable src, RaycastResult hitResult, float delay)**
        - Static version of OnBeforeTeleport
        - Emit before OnBeforeTeleport
      - Add static event **OnAfterAnyTeleport(Teleportable src, RaycastResult hitResult, float delay)**
        - Static version of OnAfterTeleport
        - Emit before OnAfterTeleport
      - Add property **AdditionalTeleportRotation**
        - The rotation value will be multiplied on the target (around pivot) when teleporting
        - Possible usage is to set the value (according to other input like pad or joystick direction) in the OnBeforeTeleport callback
      - Add method **AbortTeleport()**
        - Cancel the teleportation during fading
        - Possible usage is to abort in the OnBeforeTeleport callback to perform a custom teleportation
        - Another usage is to interrupt the fade-in effect progress so that the Teleportable able to trigger next teleport event immediatly

* Bug Fixes
  - Fix left Cosmos controller did not bind button X and Y
  - Fix saving of Oculus Android XML path setting (#175)
  - Fix applying some recommended settings didn't trigger editor to compile
  - Fix "recommended settings" button in VIU Settings disappeared after exiting editor play mode

Author: lawwong

.gitignore

@@ -26,6 +26,8 @@ Assets/HTC.UnityPlugin/ViveInputUtility/Scripts/Editor/VIUProjectSettings.asset.
 *.json
 *.vrmanifest
 
+!package.json
+
 # Autogenerated VS/MD/Consulo solution and project files
 ExportedObj/
 .consulo/

Assets/HTC.UnityPlugin/ColliderEvent/ColliderEventCaster.cs

@@ -1,4 +1,4 @@
-//========= Copyright 2016-2019, HTC Corporation. All rights reserved. ===========
+//========= Copyright 2016-2020, HTC Corporation. All rights reserved. ===========
 
 using HTC.UnityPlugin.Utility;
 using System.Collections.Generic;
@@ -13,6 +13,8 @@ public interface IColliderEventCaster
         Transform transform { get; }
         MonoBehaviour monoBehaviour { get; }
 
+        IIndexedSetReadOnly<Collider> enteredColliders { get; }
+
         Rigidbody rigid { get; }
     }
 
@@ -68,13 +70,18 @@ public Rigidbody rigid
             get { return m_rigid ?? (m_rigid = GetComponent<Rigidbody>()); }
         }
 
+        public IIndexedSetReadOnly<Collider> enteredColliders
+        {
+            get { return stayingColliders.ReadOnly; }
+        }
+
         public ColliderHoverEventData HoverEventData
         {
             get { return hoverEventData ?? (hoverEventData = new ColliderHoverEventData(this)); }
             protected set { hoverEventData = value; }
         }
 
-        private bool CannotHandlerDragAnymore(GameObject handler)
+        private bool CannotHandlDragAnymore(GameObject handler)
         {
             return !ExecuteEvents.CanHandleEvent<IColliderEventDragStartHandler>(handler);
         }
@@ -94,7 +101,7 @@ protected virtual void FixedUpdate()
                 var eventData = buttonEventDataList[i];
                 var handlers = GetButtonHandlers(i);
 
-                eventData.draggingHandlers.RemoveAll(CannotHandlerDragAnymore);
+                eventData.draggingHandlers.RemoveAll(CannotHandlDragAnymore);
 
                 if (!eventData.isPressed) { continue; }
 
@@ -162,7 +169,7 @@ protected virtual void Update()
                 var eventData = buttonEventDataList[i];
                 var handlers = GetButtonHandlers(i);
 
-                eventData.draggingHandlers.RemoveAll(CannotHandlerDragAnymore);
+                eventData.draggingHandlers.RemoveAll(CannotHandlDragAnymore);
 
                 // process button press
                 if (!eventData.isPressed)
@@ -224,7 +231,7 @@ protected virtual void Update()
             for (int i = 0, imax = axisEventDataList.Count; i < imax; ++i)
             {
                 var eventData = axisEventDataList[i];
-                
+
                 if ((eventData.v4 = eventData.GetDelta()) == Vector4.zero) { continue; }
 
                 var handlers = GetAxisHandlers(i);
@@ -248,56 +255,54 @@ protected void ProcessPressDown(ColliderButtonEventData eventData, ButtonHandler
             eventData.pressPosition = transform.position;
             eventData.pressRotation = transform.rotation;
 
+            for (int i = stayingColliders.Count - 1; i >= 0; --i)
+            {
+                if (stayingColliders[i] != null) { eventData.pressedRawObjects.AddUnique(stayingColliders[i].gameObject); }
+            }
+
+            // press down
+            GetEventHandlersFromHoveredColliders<IColliderEventPressDownHandler>(eventData.pressedHandlers, handlers.pressDownHandlers);
             // click start
             GetEventHandlersFromHoveredColliders<IColliderEventClickHandler>(eventData.clickingHandlers);
-            // press down
-            GetEventHandlersFromHoveredColliders<IColliderEventPressDownHandler>(handlers.pressDownHandlers);
             // drag start
             GetEventHandlersFromHoveredColliders<IColliderEventDragStartHandler>(eventData.draggingHandlers, handlers.dragStartHandlers);
         }
 
         protected void ProcessPressing(ColliderButtonEventData eventData, ButtonHandlers handlers)
         {
             // dragging
-            for (int i = eventData.draggingHandlers.Count - 1; i >= 0; --i)
-            {
-                handlers.dragUpdateHandlers.Add(eventData.draggingHandlers[i]);
-            }
+            handlers.dragUpdateHandlers.AddRange(eventData.draggingHandlers);
         }
 
         protected void ProcessPressUp(ColliderButtonEventData eventData, ButtonHandlers handlers)
         {
+            IndexedSet<GameObject> tmp;
             eventData.isPressed = false;
 
+            tmp = eventData.lastPressedRawObjects;
+            eventData.lastPressedRawObjects = eventData.pressedRawObjects;
+            eventData.pressedRawObjects = tmp;
+
             // press up
-            GetEventHandlersFromHoveredColliders<IColliderEventPressUpHandler>(handlers.pressUpHandlers);
+            handlers.pressUpHandlers.AddRange(eventData.pressedHandlers);
+
+            tmp = eventData.lastPressedHandlers;
+            eventData.lastPressedHandlers = eventData.pressedHandlers;
+            eventData.pressedHandlers = tmp;
+
             // drag end
-            for (int i = eventData.draggingHandlers.Count - 1; i >= 0; --i)
-            {
-                handlers.dragEndHandlers.Add(eventData.draggingHandlers[i]);
-            }
+            handlers.dragEndHandlers.AddRange(eventData.draggingHandlers);
             // drop
-            if (eventData.draggingHandlers.Count > 0)
+            if (eventData.isDragging)
             {
                 GetEventHandlersFromHoveredColliders<IColliderEventDropHandler>(handlers.dropHandlers);
             }
-            // click end (execute only if pressDown handler and pressUp handler are the same)
 
-            for (int i = stayingColliders.Count - 1; i >= 0; --i)
-            {
-                var collider = stayingColliders[i];
-
-                if (collider == null) { continue; }
-
-                var handler = ExecuteEvents.GetEventHandler<IColliderEventClickHandler>(collider.gameObject);
-
-                if (ReferenceEquals(handler, null)) { continue; }
-
-                if (!eventData.clickingHandlers.Remove(handler)) { continue; }
-
-                handlers.clickHandlers.Add(handler);
-            }
+            // click end (execute only if pressDown handler and pressUp handler are the same)
+            GetMatchedEventHandlersFromHoveredColliders<IColliderEventClickHandler>(h => eventData.clickingHandlers.Remove(h), handlers.clickHandlers);
 
+            eventData.pressedRawObjects.Clear();
+            eventData.pressedHandlers.Clear();
             eventData.clickingHandlers.Clear();
             eventData.draggingHandlers.Clear();
         }
@@ -320,7 +325,7 @@ private void CleanUp()
                 var eventData = buttonEventDataList[i];
                 var handlers = GetButtonHandlers(i);
 
-                eventData.draggingHandlers.RemoveAll(CannotHandlerDragAnymore);
+                eventData.draggingHandlers.RemoveAll(CannotHandlDragAnymore);
 
                 if (eventData.isPressed)
                 {
@@ -331,10 +336,6 @@ private void CleanUp()
                 {
                     handlers.pressExitHandlers.Add(eventData.pressEnteredObjects[j]);
                 }
-
-                eventData.clickingHandlers.Clear();
-                eventData.draggingHandlers.Clear();
-                eventData.pressEnteredObjects.Clear();
             }
 
             // exit all
@@ -362,7 +363,12 @@ private AxisHandlers GetAxisHandlers(int i)
             return axisEventHanderList[i] ?? (axisEventHanderList[i] = new AxisHandlers());
         }
 
-        private void GetEventHandlersFromHoveredColliders<T>(params IList<GameObject>[] appendHandlers) where T : IEventSystemHandler
+        private void GetEventHandlersFromHoveredColliders<T>(IList<GameObject> appendHandler, IList<GameObject> appendHandler2 = null) where T : IEventSystemHandler
+        {
+            GetMatchedEventHandlersFromHoveredColliders<T>(null, appendHandler, appendHandler2);
+        }
+
+        private void GetMatchedEventHandlersFromHoveredColliders<T>(System.Predicate<GameObject> match, IList<GameObject> appendHandler, IList<GameObject> appendHandler2 = null) where T : IEventSystemHandler
         {
             for (int i = stayingColliders.Count - 1; i >= 0; --i)
             {
@@ -376,10 +382,10 @@ private void GetEventHandlersFromHoveredColliders<T>(params IList<GameObject>[]
 
                 if (!s_gos.Add(handler.GetInstanceID())) { continue; }
 
-                foreach (var handlers in appendHandlers)
-                {
-                    handlers.Add(handler);
-                }
+                if (match != null && !match(handler)) { continue; }
+
+                if (appendHandler != null) { appendHandler.Add(handler); }
+                if (appendHandler2 != null) { appendHandler2.Add(handler); }
             }
 
             s_gos.Clear();
@@ -420,6 +426,8 @@ private void ExecuteAllEvents()
 
         private void ExcuteHandlersEvents<T>(List<GameObject> handlers, BaseEventData eventData, ExecuteEvents.EventFunction<T> functor) where T : IEventSystemHandler
         {
+            if (handlers.Count == 0) { return; }
+
             for (int i = handlers.Count - 1; i >= 0; --i)
             {
                 ExecuteEvents.Execute(handlers[i], eventData, functor);

Assets/HTC.UnityPlugin/ColliderEvent/ColliderEventData.cs

@@ -1,4 +1,4 @@
-//========= Copyright 2016-2019, HTC Corporation. All rights reserved. ===========
+//========= Copyright 2016-2020, HTC Corporation. All rights reserved. ===========
 
 using HTC.UnityPlugin.Utility;
 using UnityEngine;
@@ -45,13 +45,18 @@ public abstract class ColliderButtonEventData : ColliderEventData
     {
         public enum InputButton
         {
+            None = -1,
             Trigger,
             PadOrStick,
             GripOrHandTrigger,
             FunctionKey,
         }
 
-        public IndexedSet<GameObject> pressEnteredObjects = new IndexedSet<GameObject>();
+        public IndexedSet<GameObject> pressEnteredObjects = new IndexedSet<GameObject>(); // Includes full entered objects hierorchy
+        public IndexedSet<GameObject> pressedRawObjects = new IndexedSet<GameObject>();
+        public IndexedSet<GameObject> lastPressedRawObjects = new IndexedSet<GameObject>();
+        public IndexedSet<GameObject> pressedHandlers = new IndexedSet<GameObject>();
+        public IndexedSet<GameObject> lastPressedHandlers = new IndexedSet<GameObject>();
         public IndexedSet<GameObject> draggingHandlers = new IndexedSet<GameObject>();
         public IndexedSet<GameObject> clickingHandlers = new IndexedSet<GameObject>();
 
@@ -90,7 +95,7 @@ public enum Dim
             D3,
             D4,
         }
-        
+
         // raw delta values
         private float m_x;
         private float m_y;

Assets/HTC.UnityPlugin/ColliderEvent/ColliderEventInterfaces.cs

@@ -1,4 +1,4 @@
-//========= Copyright 2016-2019, HTC Corporation. All rights reserved. ===========
+//========= Copyright 2016-2020, HTC Corporation. All rights reserved. ===========
 
 using UnityEngine.EventSystems;
 

Assets/HTC.UnityPlugin/ColliderEvent/ExecuteColliderEvents.cs

@@ -1,4 +1,4 @@
-//========= Copyright 2016-2019, HTC Corporation. All rights reserved. ===========
+//========= Copyright 2016-2020, HTC Corporation. All rights reserved. ===========
 
 using UnityEngine.EventSystems;
 

Assets/HTC.UnityPlugin/HTC.ViveInputUtility.asmdef

@@ -0,0 +1,20 @@
+{
+    "name": "HTC.ViveInputUtility",
+    "references": [
+        "Unity.XR.Management",
+        "SteamVR",
+        "Oculus.Avatar",
+        "Oculus.VR",
+        "Oculus.Platform",
+        "UnityEngine.SpatialTracking"
+    ],
+    "includePlatforms": [],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
+}

Assets/HTC.UnityPlugin/HTC.ViveInputUtility.asmdef.meta

@@ -1,4 +1,4 @@
-//========= Copyright 2016-2019, HTC Corporation. All rights reserved. ===========
+//========= Copyright 2016-2020, HTC Corporation. All rights reserved. ===========
 
 using UnityEngine.EventSystems;
 

Assets/HTC.UnityPlugin/Pointer3D/ExecutePointer3DEvents.cs

@@ -1,4 +1,4 @@
-//========= Copyright 2016-2019, HTC Corporation. All rights reserved. ===========
+//========= Copyright 2016-2020, HTC Corporation. All rights reserved. ===========
 
 using UnityEngine;
 using UnityEngine.EventSystems;

Assets/HTC.UnityPlugin/Pointer3D/Pointer3DEventData.cs

@@ -1,4 +1,4 @@
-//========= Copyright 2016-2019, HTC Corporation. All rights reserved. ===========
+//========= Copyright 2016-2020, HTC Corporation. All rights reserved. ===========
 
 using UnityEngine.EventSystems;