Teleport property TRNG-102

Editor/Properties/TeleportationPropertyEditor.cs

@@ -0,0 +1,106 @@
+using System;
+using UnityEditor;
+using UnityEngine;
+using Innoactive.Creator.Core.Properties;
+using UnityEngine.UIElements;
+using UnityEngine.XR.Interaction.Toolkit;
+
+namespace Innoactive.CreatorEditor.XRInteraction
+{
+    /// <summary>
+    /// Custom inspector for <see cref="TeleportationProperty"/>, adding a button to automatically configure <see cref="Innoactive.Creator.XRInteraction.TeleportationAnchor"/>s.
+    /// </summary>
+    [CustomEditor(typeof(TeleportationProperty)), CanEditMultipleObjects]
+    internal class TeleportationPropertyEditor : Editor
+    {
+        private const string AnchorPrefabName = "Anchor";
+        private const string ReticlePrefab = "TeleportReticle";
+        private const string TeleportLayerName = "XR Teleport";
+        private LayerMask teleportLayer;
+        private bool isSetup;
+
+        private void OnEnable()
+        {
+            TeleportationProperty teleportationProperty = target as TeleportationProperty;
+            TeleportationAnchor teleportAnchor = teleportationProperty.GetComponent<TeleportationAnchor>();
+
+            if (teleportationProperty.transform.childCount != 0 && teleportAnchor.teleportAnchorTransform.name == AnchorPrefabName)
+            {
+                isSetup = true;
+            }
+        }
+
+        public override void OnInspectorGUI()
+        {
+            base.OnInspectorGUI();
+            EditorGUILayout.Space();
+
+            ShowConfigurationButton();
+        }
+
+        private void ShowConfigurationButton()
+        {
+            if (isSetup == false && GUILayout.Button("Set Default Teleportation Anchor"))
+            {
+                foreach (UnityEngine.Object targetObject in serializedObject.targetObjects)
+                {
+                    if (targetObject is TeleportationProperty teleportationAnchor)
+                    {
+                        ConfigureDefaultTeleportationAnchor(teleportationAnchor);
+                    }
+                }
+            }
+        }
+
+        private void ConfigureDefaultTeleportationAnchor(TeleportationProperty teleportationAnchor)
+        {
+            teleportLayer = LayerMask.NameToLayer(TeleportLayerName);
+
+            try
+            {
+                GameObject anchorPrefab = CreateVisualEffect(teleportationAnchor);
+                ConfigureTeleportationAnchor(teleportationAnchor, anchorPrefab.transform);
+                ConfigureCollider(teleportationAnchor);
+
+                isSetup = true;
+            }
+            catch (Exception e)
+            {
+                Debug.LogError($"There was an exception of type '{e.GetType()}' when trying to setup {name} as default Teleportation Anchor\n{e.Message}", teleportationAnchor.gameObject);
+            }
+        }
+
+        private GameObject CreateVisualEffect(TeleportationProperty teleportationAnchor)
+        {
+            Transform anchorTransform = teleportationAnchor.transform;
+
+            GameObject anchorPrefab = Instantiate(Resources.Load<GameObject>(AnchorPrefabName));
+            anchorPrefab.name = anchorPrefab.name.Remove(AnchorPrefabName.Length);
+
+            anchorPrefab.transform.SetPositionAndRotation((anchorTransform.position + (Vector3.up * 0.01f)), anchorTransform.rotation);
+            anchorPrefab.transform.SetParent(anchorTransform);
+
+            teleportationAnchor.gameObject.layer = teleportLayer;
+
+            return anchorPrefab;
+        }
+
+        private void ConfigureTeleportationAnchor(TeleportationProperty teleportationAnchor, Transform prefabTransform)
+        {
+            TeleportationAnchor teleportAnchor = teleportationAnchor.GetComponent<TeleportationAnchor>();
+
+            teleportAnchor.teleportAnchorTransform = prefabTransform;
+            teleportAnchor.interactionLayerMask = 1 << teleportLayer;
+            teleportAnchor.customReticle = Resources.Load<GameObject>(ReticlePrefab);
+            teleportAnchor.matchOrientation = MatchOrientation.TargetUpAndForward;
+        }
+
+        private void ConfigureCollider(TeleportationProperty teleportationAnchor)
+        {
+            BoxCollider propertyCollider = teleportationAnchor.GetComponent<BoxCollider>();
+
+            propertyCollider.center = new Vector3(0f, 0.02f, 0f);
+            propertyCollider.size = new Vector3(1f, 0.01f, 1f);
+        }
+    }
+}

Runtime/Properties/TeleportationProperty.cs

@@ -0,0 +1,111 @@
+using System;
+using UnityEngine;
+using UnityEngine.XR.Interaction.Toolkit;
+using Innoactive.Creator.BasicInteraction.Properties;
+
+namespace Innoactive.Creator.Core.Properties
+{
+    /// <summary>
+    /// XR implementation of <see cref="ITeleportationProperty"/>.
+    /// </summary>
+    /// <remarks>
+    /// This implementation is based on 'TeleportationAnchor'.
+    /// </remarks>
+    [RequireComponent(typeof(TeleportationAnchor), typeof(BoxCollider))]
+    public class TeleportationProperty : LockableProperty, ITeleportationProperty
+    {
+        /// <inheritdoc />
+        public event EventHandler<EventArgs> Teleported;
+
+        /// <inheritdoc />
+        public bool WasUsedToTeleport => wasUsedToTeleport;
+
+        private TeleportationAnchor teleportationInteractable;
+        private Renderer[] renderers;
+        private bool wasUsedToTeleport;
+
+        protected void Awake()
+        {
+            renderers = GetComponentsInChildren<Renderer>();
+            teleportationInteractable = GetComponent<TeleportationAnchor>();
+        }
+
+        protected override void OnEnable()
+        {
+            base.OnEnable();
+
+            switch (teleportationInteractable.teleportTrigger)
+            {
+                case BaseTeleportationInteractable.TeleportTrigger.OnActivated:
+                    teleportationInteractable.activated.AddListener(args =>
+                    {
+                        EmitTeleported();
+                    });
+                    break;
+                case BaseTeleportationInteractable.TeleportTrigger.OnDeactivated:
+                    teleportationInteractable.deactivated.AddListener(args =>
+                    {
+                        EmitTeleported();
+                    });
+                    break;
+                case BaseTeleportationInteractable.TeleportTrigger.OnSelectEntered:
+                    teleportationInteractable.selectEntered.AddListener(args =>
+                    {
+                        EmitTeleported();
+                    });
+                    break;
+                case BaseTeleportationInteractable.TeleportTrigger.OnSelectExited:
+                    teleportationInteractable.selectExited.AddListener(args =>
+                    {
+                        EmitTeleported();
+                    });
+                    break;
+            }
+        }
+
+        /// <inheritdoc />
+        public void Initialize()
+        {
+            wasUsedToTeleport = false;
+        }
+
+        /// <inheritdoc />
+        public void FastForwardTeleport()
+        {
+            TeleportRequest teleportRequest = new TeleportRequest
+            {
+                requestTime = Time.time,
+                matchOrientation = teleportationInteractable.matchOrientation,
+                destinationPosition = teleportationInteractable.teleportAnchorTransform.position,
+                destinationRotation = teleportationInteractable.teleportAnchorTransform.rotation
+            };
+
+            teleportationInteractable.teleportationProvider.QueueTeleportRequest(teleportRequest);
+        }
+
+        /// <inheritdoc />
+        protected override void InternalSetLocked(bool lockState)
+        {
+            foreach (Collider collider in teleportationInteractable.colliders)
+            {
+                collider.enabled = !lockState;
+            }
+
+            teleportationInteractable.enabled = !lockState;
+
+            if (renderers != null)
+            {
+                foreach (Renderer anchorRenderer in renderers)
+                {
+                    anchorRenderer.enabled = !lockState;
+                }
+            }
+        }
+
+        protected void EmitTeleported()
+        {
+            wasUsedToTeleport = true;
+            Teleported?.Invoke(this, EventArgs.Empty);
+        }
+    }
+}