feat(Portal): Separated PortalVicinity and PortalCollisionFiltering

Author: Vaso64

Assets/MainScene.unity

@@ -0,0 +1,25 @@
+using UnityEngine;
+using PerceptionVR.Portal;
+
+namespace PerceptionVR.Extensions
+{
+    public static class PortalExtensions
+    {
+        public static Pose PairPose(this Portal.Portal portal, Pose pose) => portal.PairPose(pose, out _);
+
+        public static Pose PairPose(this Portal.Portal portal, Pose pose, out Quaternion portalRotationDelta)
+        {
+            Pose resultPose;
+            
+            portalRotationDelta = portal.portalPair.transform.rotation * Quaternion.Euler(0, 180, 0) * Quaternion.Inverse(portal.transform.rotation);
+
+            // Calculate position
+            resultPose.position = portal.portalPair.transform.position + portalRotationDelta * (pose.position - portal.transform.position);
+
+            // Rotation rotation
+            resultPose.rotation = portalRotationDelta * pose.rotation;
+
+            return resultPose;
+        }
+    }
+}

Assets/Prefabs/Portal.prefab

@@ -40,20 +40,10 @@ private void ProcessQueue()
         {
             OnBeforeProcessQueue?.Invoke();
             while (onTriggerEnterQueue.Count > 0)
-            {
-                var col = onTriggerEnterQueue.Dequeue();
-                if(col == null) continue;
-                Debugger.LogInfo($"TriggerEnter dequeue {col}");
-                onTriggerEnter?.Invoke(col);
-            }
-    
+                onTriggerEnter?.Invoke(onTriggerEnterQueue.Dequeue());
+
             while (onTriggerExitQueue.Count > 0)
-            {
-                var col = onTriggerExitQueue.Dequeue();
-                if(col == null) continue;
-                Debugger.LogInfo($"TriggerExit dequeue {col}");
-                onTriggerExit?.Invoke(col);
-            }
+                onTriggerExit?.Invoke(onTriggerExitQueue.Dequeue());
         }
 
         protected virtual void OnTriggerEnter(Collider other)

Assets/Scripts/Extensions/PortalExtensions.cs

@@ -475,6 +475,17 @@ public @PlayerInputAction()
                     ""isComposite"": false,
                     ""isPartOfComposite"": false
                 },
+                {
+                    ""name"": """",
+                    ""id"": ""4f2d01e6-ed72-427c-a9b6-9d79ba4594cc"",
+                    ""path"": ""<ViveWand>{LeftHand}/trackpad"",
+                    ""interactions"": """",
+                    ""processors"": """",
+                    ""groups"": """",
+                    ""action"": ""Move"",
+                    ""isComposite"": false,
+                    ""isPartOfComposite"": false
+                },
                 {
                     ""name"": """",
                     ""id"": ""103599a4-4b1b-4263-865d-36cffb67fdeb"",
@@ -486,6 +497,17 @@ public @PlayerInputAction()
                     ""isComposite"": false,
                     ""isPartOfComposite"": false
                 },
+                {
+                    ""name"": """",
+                    ""id"": ""2844d8da-04ba-4277-b839-58adde80e639"",
+                    ""path"": ""<ViveWand>{RightHand}/trackpad"",
+                    ""interactions"": """",
+                    ""processors"": """",
+                    ""groups"": """",
+                    ""action"": ""Rotate"",
+                    ""isComposite"": false,
+                    ""isPartOfComposite"": false
+                },
                 {
                     ""name"": """",
                     ""id"": ""1fe5a410-5756-462b-beb4-01f8d7455f3d"",

Assets/Scripts/Extensions/PortalExtensions.cs.meta

@@ -453,6 +453,17 @@
                     "isComposite": false,
                     "isPartOfComposite": false
                 },
+                {
+                    "name": "",
+                    "id": "4f2d01e6-ed72-427c-a9b6-9d79ba4594cc",
+                    "path": "<ViveWand>{LeftHand}/trackpad",
+                    "interactions": "",
+                    "processors": "",
+                    "groups": "",
+                    "action": "Move",
+                    "isComposite": false,
+                    "isPartOfComposite": false
+                },
                 {
                     "name": "",
                     "id": "103599a4-4b1b-4263-865d-36cffb67fdeb",
@@ -464,6 +475,17 @@
                     "isComposite": false,
                     "isPartOfComposite": false
                 },
+                {
+                    "name": "",
+                    "id": "2844d8da-04ba-4277-b839-58adde80e639",
+                    "path": "<ViveWand>{RightHand}/trackpad",
+                    "interactions": "",
+                    "processors": "",
+                    "groups": "",
+                    "action": "Rotate",
+                    "isComposite": false,
+                    "isPartOfComposite": false
+                },
                 {
                     "name": "",
                     "id": "1fe5a410-5756-462b-beb4-01f8d7455f3d",

Assets/Scripts/Physics/Colliders/Subscribable/SubscribableTrigger.cs

@@ -10,45 +10,60 @@
 
 namespace PerceptionVR.Portal
 {
-    public class PortalCloneSystem : PortalCollisionFilteringSystem
+    [RequireComponent(typeof(Portal), typeof(PortalVicinity), typeof(PortalCollisionFilteringSystem))]
+    public class PortalCloneSystem : MonoBehaviour
     {
-        [SerializeField] private List<NearbyTeleportable> vicinity = new();
+        [SerializeField] private List<NearbyTeleportable> objectsInVicinity = new();
 
+        private Portal portal;
+        private PortalVicinity vicinity;
+        private PortalCollisionFilteringSystem collisionFilteringSystem;
         private PortalCloneSystem pairCloneSystem;
 
-        protected override void Awake()
+        private void Awake()
         {
-            base.Awake();
+            portal = GetComponent<Portal>();
+            vicinity = GetComponent<PortalVicinity>();
+            collisionFilteringSystem = GetComponent<PortalCollisionFilteringSystem>();
+            
             portal.OnPortalPairSet += portalPair =>
             {
                 pairCloneSystem = portalPair.transform.GetComponentInChildren<PortalCloneSystem>();
             };
             portal.OnPortalPairUnset += () =>
             {
-                vicinity.ToList().ForEach(UnregisterTeleportable);
+                objectsInVicinity.ToList().ForEach(UnregisterTeleportable);
                 pairCloneSystem = null;
             };
 
-            OnEnteredVicinity += OnVicinityEnter;
-            OnExitedVicinity += OnVicinityExit;
+            vicinity.OnOutsideToFront += OnVicinityEnter;
+            vicinity.OnFrontToOutside += OnVicinityExit;
+            
+            vicinity.OnBackToFront    += OnVicinityEnter;
+            vicinity.OnFrontToBack    += OnVicinityExit;
+            
             GlobalEvents.OnTeleport += OnTeleportCallback;
         }
 
 
         private void OnVicinityEnter(Collider other)
         {
+            // Ignore if clone is coming around the portal
+            if(collisionFilteringSystem.cloneGroup.Contains(other))
+                return;
+            
             Debugger.LogInfo($"{other} entered vicinity of {this}");
             var tp = other.GetComponentInParent<ITeleportable>();
 
             // Get nearby teleportable
-            var nearbyTeleportable = vicinity.FirstOrDefault(x => x.teleportable == tp);
+            var nearbyTeleportable = objectsInVicinity.FirstOrDefault(x => x.teleportable == tp);
             if (nearbyTeleportable != null)
             {
                 nearbyTeleportable.collidersInVicinity.Add(other);
                 return;
             }
 
-            nearbyTeleportable = pairCloneSystem.vicinity.FirstOrDefault(x => x.cloneTeleportable == tp);
+            nearbyTeleportable = pairCloneSystem.objectsInVicinity.FirstOrDefault(x => x.cloneTeleportable == tp);
             if (nearbyTeleportable != null)
             {
                 nearbyTeleportable.cloneColliderInPairVicinity.Add(other);
@@ -64,10 +79,14 @@ private void OnVicinityEnter(Collider other)
 
         private void OnVicinityExit(Collider other)
         {
+            // Ignore if clone is coming around the portal
+            if(collisionFilteringSystem.cloneGroup.Contains(other))
+                return;
+            
             Debugger.LogInfo($"{other} exited vicinity of {this}");
             var tp = other.GetComponentInParent<ITeleportable>();
 
-            var nearbyTeleportable = vicinity.FirstOrDefault(x => x.teleportable == tp);
+            var nearbyTeleportable = objectsInVicinity.FirstOrDefault(x => x.teleportable == tp);
             if (nearbyTeleportable != null)
             {
                 nearbyTeleportable.collidersInVicinity.Remove(other);
@@ -76,7 +95,7 @@ private void OnVicinityExit(Collider other)
                 return;
             }
 
-            nearbyTeleportable = pairCloneSystem.vicinity.FirstOrDefault(x => x.cloneTeleportable == tp);
+            nearbyTeleportable = pairCloneSystem.objectsInVicinity.FirstOrDefault(x => x.cloneTeleportable == tp);
             if (nearbyTeleportable != null)
                 nearbyTeleportable.cloneColliderInPairVicinity.Remove(other);
         }
@@ -90,12 +109,12 @@ private NearbyTeleportable RegisterTeleportable(ITeleportable teleportable)
 
             // Register teleportable
             var nearbyTeleportable = new NearbyTeleportable(teleportable, clone);
-            vicinity.Add(nearbyTeleportable);
+            objectsInVicinity.Add(nearbyTeleportable);
 
             // Add clone colliders to nearbyTeleportable and pair's cloneGroup
             var cloneColliders = clone.transform.GetComponentsInChildren<Collider>();
             nearbyTeleportable.cloneColliderInPairVicinity.AddRange(cloneColliders);
-            pairCloneSystem.cloneGroup.AddRange(cloneColliders);
+            pairCloneSystem.collisionFilteringSystem.cloneGroup.AddRange(cloneColliders);
 
             return nearbyTeleportable;
         }
@@ -108,15 +127,15 @@ private void UnregisterTeleportable(NearbyTeleportable teleportable)
             GameObjectUtility.DestroyNotify(teleportable.cloneTeleportable.gameObject);
 
             // Unregister teleportable
-            vicinity.Remove(teleportable);
+            objectsInVicinity.Remove(teleportable);
         }
 
 
         private void OnTeleportCallback(TeleportData teleportData)
         {
             // nt = "nearby teleportable"
 
-            var nt = vicinity.FirstOrDefault(x => x.teleportable == teleportData.teleportable && portal == teleportData.inPortal);
+            var nt = objectsInVicinity.FirstOrDefault(x => x.teleportable == teleportData.teleportable && portal == teleportData.inPortal);
             if(nt == null)
                 return;
 
@@ -135,8 +154,8 @@ private void OnTeleportCallback(TeleportData teleportData)
             (nt.collidersInVicinity, nt.cloneColliderInPairVicinity) = (nt.cloneColliderInPairVicinity, nt.collidersInVicinity);
 
             // Transfer nt to pair
-            vicinity.Remove(nt);
-            pairCloneSystem.vicinity.Add(nt);
+            objectsInVicinity.Remove(nt);
+            pairCloneSystem.objectsInVicinity.Add(nt);
         }
 
 

Assets/Scripts/Player/PlayerInputAction.cs

@@ -30,10 +30,9 @@ private void Start()
 
         public void Teleport(ITeleportable teleportable)
         {
-            var pairPose = PairPose(teleportable.transform.GetPose(), out var rotationDelta);
-
             // Teleport the object
-            teleportable.transform.SetPositionAndRotation(pairPose.position, pairPose.rotation);
+            var pairPose = this.PairPose(teleportable.transform.GetPose(), out var rotationDelta);
+            teleportable.transform.SetPose(pairPose);
 
             // Translate velocity
             foreach (var teleportedRB in teleportable.transform.GetComponentsInChildren<Rigidbody>())
@@ -55,25 +54,5 @@ public void Teleport(ITeleportable teleportable)
             GlobalEvents.OnTeleport?.Invoke(teleportData);
             teleportable.OnTeleport?.Invoke(teleportData);
         }
-
-        
-        public virtual Pose PairPose(Pose pose) => PairPose(pose, out _);
-
-        public virtual Pose PairPose(Pose pose, out Quaternion portalRotationDelta)
-        {
-            Pose resultPose;
-            
-            portalRotationDelta = portalPair.transform.rotation * Quaternion.Euler(0, 180, 0) * Quaternion.Inverse(transform.rotation);
-
-            // Calculate position
-            resultPose.position = portalPair.transform.position + portalRotationDelta * (pose.position - transform.position);
-
-            // Rotation rotation
-            resultPose.rotation = portalRotationDelta * pose.rotation;
-
-            return resultPose;
-        }
     }
 }
-
-