VR4Medical/ICI/Library/PackageCache/com.unity.xr.interaction.toolkit@42ef3600567b/Runtime/Locomotion/Movement/GrabMoveProvider.cs

using System.Collections.Generic;
using UnityEngine.InputSystem.Controls;
using UnityEngine.Scripting.APIUpdating;
using UnityEngine.XR.Interaction.Toolkit.Inputs;
using UnityEngine.XR.Interaction.Toolkit.Inputs.Readers;
using UnityEngine.XR.Interaction.Toolkit.Interactors;

namespace UnityEngine.XR.Interaction.Toolkit.Locomotion.Movement
{
    /// <summary>
    /// Locomotion provider that allows the user to move as if grabbing the whole world around them.
    /// When the controller moves, the XR Origin counter-moves in order to keep the controller fixed relative to the world.
    /// </summary>
    /// <seealso cref="TwoHandedGrabMoveProvider"/>
    /// <seealso cref="LocomotionProvider"/>
    [AddComponentMenu("XR/Locomotion/Grab Move Provider", 11)]
    [HelpURL(XRHelpURLConstants.k_GrabMoveProvider)]
    [MovedFrom("UnityEngine.XR.Interaction.Toolkit")]
    public partial class GrabMoveProvider : ConstrainedMoveProvider
    {
        [SerializeField]
        Transform m_ControllerTransform;
        /// <summary>
        /// The controller Transform that will drive grab movement with its local position. Will use this GameObject's
        /// Transform if not set.
        /// </summary>
        public Transform controllerTransform
        {
            get => m_ControllerTransform;
            set
            {
                m_ControllerTransform = value;
                GatherControllerInteractors();
            }
        }

        [SerializeField]
        bool m_EnableMoveWhileSelecting;
        /// <summary>
        /// Controls whether to allow grab move locomotion while the controller is selecting an interactable.
        /// </summary>
        public bool enableMoveWhileSelecting
        {
            get => m_EnableMoveWhileSelecting;
            set => m_EnableMoveWhileSelecting = value;
        }

        [SerializeField]
        float m_MoveFactor = 1f;
        /// <summary>
        /// The ratio of actual movement distance to controller movement distance.
        /// </summary>
        public float moveFactor
        {
            get => m_MoveFactor;
            set => m_MoveFactor = value;
        }

        [SerializeField]
        XRInputButtonReader m_GrabMoveInput = new XRInputButtonReader("Grab Move");

        /// <summary>
        /// Input data that will be used to perform grab movement while held.
        /// If the source is an Input Action, it must have a button-like interaction where phase equals performed when pressed.
        /// Typically a <see cref="ButtonControl"/> Control or a Value type action with a Press interaction.
        /// </summary>
        public XRInputButtonReader grabMoveInput
        {
            get => m_GrabMoveInput;
            set => XRInputReaderUtility.SetInputProperty(ref m_GrabMoveInput, value, this);
        }

        /// <summary>
        /// Controls whether this provider can move the XR Origin.
        /// </summary>
        public bool canMove { get; set; } = true;

        bool m_IsMoving;

        Vector3 m_PreviousControllerLocalPosition;

        readonly List<IXRSelectInteractor> m_ControllerInteractors = new List<IXRSelectInteractor>();

        /// <summary>
        /// See <see cref="MonoBehaviour"/>.
        /// </summary>
        protected override void Awake()
        {
            base.Awake();

            if (m_ControllerTransform == null)
                m_ControllerTransform = transform;

            GatherControllerInteractors();

#pragma warning disable CS0618 // Type or member is obsolete
            if (m_GrabMoveAction.reference != null || (m_GrabMoveAction.action != null && m_GrabMoveAction.action.bindings.Count > 0))
                Debug.LogWarning("Grab Move Action has been deprecated. Please configure input action using Grab Move Input instead.", this);
#pragma warning restore CS0618
        }

        /// <summary>
        /// See <see cref="MonoBehaviour"/>.
        /// </summary>
        protected void OnEnable()
        {
            // Enable and disable directly serialized actions with this behavior's enabled lifecycle.
            m_GrabMoveInput.EnableDirectActionIfModeUsed();
#pragma warning disable CS0618 // Using deprecated action to help with backwards compatibility with existing user assets.
            m_GrabMoveAction.EnableDirectAction();
#pragma warning restore CS0618
        }

        /// <summary>
        /// See <see cref="MonoBehaviour"/>.
        /// </summary>
        protected void OnDisable()
        {
            m_GrabMoveInput.DisableDirectActionIfModeUsed();
#pragma warning disable CS0618 // Using deprecated action to help with backwards compatibility with existing user assets.
            m_GrabMoveAction.DisableDirectAction();
#pragma warning restore CS0618
        }

        /// <inheritdoc/>
        protected override Vector3 ComputeDesiredMove(out bool attemptingMove)
        {
            attemptingMove = false;
            var xrOrigin = mediator.xrOrigin?.Origin;
            var wasMoving = m_IsMoving;
            m_IsMoving = canMove && IsGrabbing() && xrOrigin != null;
            if (!m_IsMoving)
                return Vector3.zero;

            var controllerLocalPosition = controllerTransform.localPosition;
            if (!wasMoving && m_IsMoving) // Cannot simply check locomotionPhase because it might always be in moving state, due to gravity application mode
            {
                // Do not move the first frame of grab
                m_PreviousControllerLocalPosition = controllerLocalPosition;
                return Vector3.zero;
            }

            attemptingMove = true;
            var originTransform = xrOrigin.transform;
            var move = originTransform.TransformVector(m_PreviousControllerLocalPosition - controllerLocalPosition) * m_MoveFactor;
            m_PreviousControllerLocalPosition = controllerLocalPosition;
            return move;
        }

        /// <summary>
        /// Determines whether grab move is active.
        /// </summary>
        /// <returns>Whether grab move is active.</returns>
        public bool IsGrabbing()
        {
            var isPerformed = m_GrabMoveInput.ReadIsPerformed();

#pragma warning disable CS0618 // Using deprecated action to help with backwards compatibility with existing user assets.
            var deprecatedAction = m_GrabMoveAction.action;
#pragma warning restore CS0618
            if (deprecatedAction != null)
            {
                isPerformed |= deprecatedAction.IsPressed();
            }

            return isPerformed && (m_EnableMoveWhileSelecting || !ControllerHasSelection());
        }

        void GatherControllerInteractors()
        {
            m_ControllerInteractors.Clear();
            if (m_ControllerTransform != null)
                m_ControllerTransform.transform.GetComponentsInChildren(m_ControllerInteractors);
        }

        bool ControllerHasSelection()
        {
            for (var index = 0; index < m_ControllerInteractors.Count; ++index)
            {
                var interactor = m_ControllerInteractors[index];
                if (interactor.hasSelection)
                    return true;
            }

            return false;
        }
    }
}