| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246 |
- using Unity.Mathematics;
- using Unity.XR.CoreUtils.Bindings;
- using UnityEngine;
- using UnityEngine.XR.Interaction.Toolkit.AffordanceSystem.State;
- using UnityEngine.XR.Interaction.Toolkit.Filtering;
- using UnityEngine.XR.Interaction.Toolkit.Utilities.Tweenables.Primitives;
- namespace Unity.VRTemplate
- {
- /// <summary>
- /// Follow animation affordance for <see cref="IPokeStateDataProvider"/>, such as <see cref="XRPokeFilter"/>.
- /// Used to animate a pressed transform, such as a button to follow the poke position.
- /// </summary>
- [AddComponentMenu("XR/XR Poke Follow Affordance Fill", 22)]
- public class XRPokeFollowAffordanceFill : MonoBehaviour
- {
- [SerializeField]
- [Tooltip("Transform that will move in the poke direction when this or a parent GameObject is poked." +
- "\nNote: Should be a direct child GameObject.")]
- Transform m_PokeFollowTransform;
- [SerializeField]
- [Tooltip("Transform that will scale the mask when this interactable is poked.")]
- RectTransform m_PokeFill;
- [SerializeField]
- [Tooltip("The max width size for the poke fill image when pressed")]
- float m_PokeFillMaxSizeX;
- [SerializeField]
- [Tooltip("The max height size for the poke fill image when pressed")]
- float m_PokeFillMaxSizeY;
- /// <summary>
- /// Transform that will animate along the axis of interaction when this interactable is poked.
- /// Note: Must be a direct child GameObject as it moves in local space relative to the poke target's transform.
- /// </summary>
- public Transform pokeFollowTransform
- {
- get => m_PokeFollowTransform;
- set => m_PokeFollowTransform = value;
- }
- [SerializeField]
- [Range(0f, 20f)]
- [Tooltip("Multiplies transform position interpolation as a factor of Time.deltaTime. If 0, no smoothing will be applied.")]
- float m_SmoothingSpeed = 8f;
- /// <summary>
- /// Multiplies transform position interpolation as a factor of <see cref="Time.deltaTime"/>. If <c>0</c>, no smoothing will be applied.
- /// </summary>
- public float smoothingSpeed
- {
- get => m_SmoothingSpeed;
- set => m_SmoothingSpeed = value;
- }
- [SerializeField]
- [Tooltip("When this component is no longer the target of the poke, the Poke Follow Transform returns to the original position.")]
- bool m_ReturnToInitialPosition = true;
- /// <summary>
- /// When this component is no longer the target of the poke, the <see cref="pokeFollowTransform"/> returns to the original position.
- /// </summary>
- public bool returnToInitialPosition
- {
- get => m_ReturnToInitialPosition;
- set => m_ReturnToInitialPosition = value;
- }
- [SerializeField]
- [Tooltip("Whether to apply the follow animation if the target of the poke is a child of this transform. " +
- "This is useful for UI objects that may have child graphics.")]
- bool m_ApplyIfChildIsTarget = true;
- /// <summary>
- /// Whether to apply the follow animation if the target of the poke is a child of this transform.
- /// This is useful for UI objects that may have child graphics.
- /// </summary>
- public bool applyIfChildIsTarget
- {
- get => m_ApplyIfChildIsTarget;
- set => m_ApplyIfChildIsTarget = value;
- }
- [Header("Distance Clamping")]
- [SerializeField]
- [Tooltip("Whether to keep the Poke Follow Transform from moving past a minimum distance from the poke target.")]
- bool m_ClampToMinDistance;
- /// <summary>
- /// Whether to keep the <see cref="pokeFollowTransform"/> from moving past <see cref="minDistance"/> from the poke target.
- /// </summary>
- public bool clampToMinDistance
- {
- get => m_ClampToMinDistance;
- set => m_ClampToMinDistance = value;
- }
- [SerializeField]
- [Tooltip("The minimum distance from this transform that the Poke Follow Transform can move.")]
- float m_MinDistance;
- /// <summary>
- /// The minimum distance from this transform that the <see cref="pokeFollowTransform"/> can move when
- /// <see cref="clampToMinDistance"/> is <see langword="true"/>.
- /// </summary>
- public float minDistance
- {
- get => m_MinDistance;
- set => m_MinDistance = value;
- }
- [Space]
- [SerializeField]
- [Tooltip("Whether to keep the Poke Follow Transform from moving past a maximum distance from the poke target.")]
- bool m_ClampToMaxDistance;
- /// <summary>
- /// Whether to keep the <see cref="pokeFollowTransform"/> from moving past <see cref="maxDistance"/> from the poke target.
- /// </summary>
- public bool clampToMaxDistance
- {
- get => m_ClampToMaxDistance;
- set => m_ClampToMaxDistance = value;
- }
- [SerializeField]
- [Tooltip("The maximum distance from this transform that the Poke Follow Transform can move. Will shrink to the distance of initial position if that is smaller, or if this is 0.")]
- float m_MaxDistance;
- /// <summary>
- /// The maximum distance from this transform that the <see cref="pokeFollowTransform"/> can move when
- /// <see cref="clampToMaxDistance"/> is <see langword="true"/>.
- /// </summary>
- public float maxDistance
- {
- get => m_MaxDistance;
- set => m_MaxDistance = value;
- }
- IPokeStateDataProvider m_PokeDataProvider;
- #pragma warning disable CS0618 // Type or member is obsolete
- readonly Vector3TweenableVariable m_TransformTweenableVariable = new Vector3TweenableVariable();
- readonly FloatTweenableVariable m_PokeStrengthTweenableVariable = new FloatTweenableVariable();
- #pragma warning restore CS0618 // Type or member is obsolete
- readonly BindingsGroup m_BindingsGroup = new BindingsGroup();
- Vector3 m_InitialPosition;
- bool m_IsFirstFrame;
- /// <summary>
- /// See <see cref="MonoBehaviour"/>.
- /// </summary>
- protected void Awake()
- {
- m_PokeDataProvider = GetComponentInParent<IPokeStateDataProvider>();
- }
- /// <summary>
- /// See <see cref="MonoBehaviour"/>.
- /// </summary>
- protected void Start()
- {
- if (m_PokeFollowTransform != null)
- {
- m_InitialPosition = m_PokeFollowTransform.localPosition;
- m_MaxDistance = m_MaxDistance > 0f ? Mathf.Min(m_InitialPosition.magnitude, m_MaxDistance) : m_InitialPosition.magnitude;
- m_BindingsGroup.AddBinding(m_TransformTweenableVariable.Subscribe(OnTransformTweenableVariableUpdated));
- m_BindingsGroup.AddBinding(m_PokeStrengthTweenableVariable.Subscribe(OnPokeStrengthChanged));
- m_BindingsGroup.AddBinding(m_PokeDataProvider.pokeStateData.SubscribeAndUpdate(OnPokeStateDataUpdated));
- }
- else
- {
- enabled = false;
- Debug.LogWarning($"Missing Poke Follow Transform assignment on {this}. Disabling component.", this);
- }
- }
- /// <summary>
- /// See <see cref="MonoBehaviour"/>.
- /// </summary>
- protected void OnDestroy()
- {
- m_BindingsGroup.Clear();
- m_TransformTweenableVariable?.Dispose();
- }
- /// <summary>
- /// See <see cref="MonoBehaviour"/>.
- /// </summary>
- protected void LateUpdate()
- {
- if (m_IsFirstFrame)
- {
- m_TransformTweenableVariable.HandleTween(1f);
- m_PokeStrengthTweenableVariable.target = 0f;
- m_PokeStrengthTweenableVariable.HandleTween(1f);
- m_IsFirstFrame = false;
- return;
- }
- float tweenAmt = m_SmoothingSpeed > 0f ? Time.deltaTime * m_SmoothingSpeed : 1f;
- m_TransformTweenableVariable.HandleTween(tweenAmt);
- m_PokeStrengthTweenableVariable.HandleTween(tweenAmt);
- }
- void OnTransformTweenableVariableUpdated(float3 position)
- {
- m_PokeFollowTransform.localPosition = position;
- }
- void OnPokeStrengthChanged(float newStrength)
- {
- var newX = m_PokeFillMaxSizeX * newStrength;
- var newY = m_PokeFillMaxSizeY * newStrength;
- m_PokeFill.sizeDelta = new Vector2(newX, newY);
- }
- void OnPokeStateDataUpdated(PokeStateData data)
- {
- var pokeTarget = data.target;
- var applyFollow = m_ApplyIfChildIsTarget
- ? pokeTarget != null && pokeTarget.IsChildOf(transform)
- : pokeTarget == transform;
- if (applyFollow)
- {
- var targetPosition = pokeTarget.InverseTransformPoint(data.axisAlignedPokeInteractionPoint);
- if (m_ClampToMinDistance && targetPosition.sqrMagnitude < m_MinDistance * m_MinDistance)
- targetPosition = Vector3.ClampMagnitude(targetPosition, m_MinDistance);
- if (m_ClampToMaxDistance && targetPosition.sqrMagnitude > m_MaxDistance * m_MaxDistance)
- targetPosition = Vector3.ClampMagnitude(targetPosition, m_MaxDistance);
- m_TransformTweenableVariable.target = targetPosition;
- m_PokeStrengthTweenableVariable.target = Mathf.Clamp01(data.interactionStrength);
- }
- else if (m_ReturnToInitialPosition)
- {
- m_TransformTweenableVariable.target = m_InitialPosition;
- m_PokeStrengthTweenableVariable.target = 0f;
- }
- }
- }
- }
|