osu-framework/osu.Framework/Graphics/Cursor/CursorContainer.cs

// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.

using osu.Framework.Allocation;
using osu.Framework.Extensions.ObjectExtensions;
using osu.Framework.Graphics.Containers;
using osu.Framework.Graphics.Effects;
using osu.Framework.Graphics.Shapes;
using osu.Framework.Graphics.UserInterface;
using osu.Framework.Input;
using osu.Framework.Input.Events;
using osuTK;
using osuTK.Graphics;

namespace osu.Framework.Graphics.Cursor
{
    public partial class CursorContainer : VisibilityContainer, IRequireHighFrequencyMousePosition
    {
        public Drawable ActiveCursor { get; protected set; }

        private TouchLongPressFeedback longPressFeedback = null!;

        private InputManager inputManager = null!;

        public CursorContainer()
        {
            Depth = float.MinValue;
            RelativeSizeAxes = Axes.Both;

            State.Value = Visibility.Visible;

            ActiveCursor = CreateCursor();
        }

        [BackgroundDependencyLoader]
        private void load()
        {
            Add(ActiveCursor);
            Add(longPressFeedback = CreateLongPressFeedback());
        }

        protected override void LoadComplete()
        {
            base.LoadComplete();

            inputManager = GetContainingInputManager();
            inputManager.TouchLongPressBegan += onLongPressBegan;
            inputManager.TouchLongPressCancelled += longPressFeedback.CancelAnimation;
        }

        private void onLongPressBegan(Vector2 position, double duration)
        {
            if (Parent == null) return;

            longPressFeedback.Position = Parent.ToLocalSpace(position);
            longPressFeedback.BeginAnimation(duration);
        }

        protected virtual Drawable CreateCursor() => new Cursor();

        /// <summary>
        /// Creates a drawable providing visual feedback for touch long-presses, signaled via <see cref="TouchLongPressFeedback.BeginAnimation"/> and <see cref="TouchLongPressFeedback.CancelAnimation"/>.
        /// </summary>
        protected virtual TouchLongPressFeedback CreateLongPressFeedback() => new CircularLongPressFeedback();

        public override bool ReceivePositionalInputAt(Vector2 screenSpacePos) => true;

        // make sure we always receive positional input, regardless of our visibility state.
        public override bool PropagatePositionalInputSubTree => true;

        protected override bool OnMouseMove(MouseMoveEvent e)
        {
            ActiveCursor.Position = e.MousePosition;
            return base.OnMouseMove(e);
        }

        protected override void PopIn()
        {
            Alpha = 1;
        }

        protected override void PopOut()
        {
            Alpha = 0;
        }

        protected override void Dispose(bool isDisposing)
        {
            base.Dispose(isDisposing);

            if (inputManager.IsNotNull())
            {
                inputManager.TouchLongPressBegan -= onLongPressBegan;
                inputManager.TouchLongPressCancelled -= longPressFeedback.CancelAnimation;
            }
        }

        private partial class Cursor : CircularContainer
        {
            public Cursor()
            {
                AutoSizeAxes = Axes.Both;
                Origin = Anchor.Centre;

                BorderThickness = 2;
                BorderColour = new Color4(247, 99, 164, 255);

                Masking = true;
                EdgeEffect = new EdgeEffectParameters
                {
                    Type = EdgeEffectType.Glow,
                    Colour = new Color4(247, 99, 164, 6),
                    Radius = 50
                };

                Child = new Box
                {
                    Size = new Vector2(8, 8),
                    Origin = Anchor.Centre,
                    Anchor = Anchor.Centre,
                };
            }
        }

        private partial class CircularLongPressFeedback : TouchLongPressFeedback
        {
            private readonly CircularProgress progress;

            public CircularLongPressFeedback()
            {
                AutoSizeAxes = Axes.Both;
                Origin = Anchor.Centre;

                InternalChild = progress = new CircularProgress
                {
                    Size = new Vector2(180),
                };

                Alpha = 0;
            }

            public override void BeginAnimation(double duration)
            {
                using (BeginDelayedSequence(duration / 3))
                {
                    this.FadeInFromZero();

                    progress.FadeColour(Color4.SkyBlue)
                            .TransformTo(nameof(progress.InnerRadius), 0.2f)
                            .TransformTo(nameof(progress.InnerRadius), 0.3f, 150, Easing.OutQuint)
                            .TransformBindableTo(progress.Current, 0)
                            .TransformBindableTo(progress.Current, 1, duration / 3 * 2);

                    using (BeginDelayedSequence(duration / 3 * 2))
                    {
                        this.FadeOut(500, Easing.OutQuint);

                        progress.FadeColour(Color4.White, 800, Easing.OutQuint)
                                .TransformTo(nameof(progress.InnerRadius), 0.6f, 500, Easing.OutQuint);
                    }
                }
            }

            public override void CancelAnimation()
            {
                this.FadeOut(400, Easing.OutQuint);

                progress.TransformBindableTo(progress.Current, 0, 400, Easing.OutQuint)
                        .TransformTo(nameof(progress.InnerRadius), 0.2f, 50, Easing.OutQuint);
            }
        }
    }
}