// 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 System; using System.Diagnostics; using System.Runtime.InteropServices; using osu.Framework.Allocation; using osu.Framework.Graphics; using osu.Framework.Graphics.Batches; using osu.Framework.Graphics.OpenGL.Vertices; using osu.Framework.Graphics.Primitives; using osu.Framework.Graphics.Shaders; using osu.Framework.Graphics.Textures; using osu.Framework.Input; using osu.Framework.Input.Events; using osu.Framework.Layout; using osu.Framework.Timing; using osuTK; using osuTK.Graphics; using osuTK.Graphics.ES30; namespace osu.Game.Rulesets.Osu.UI.Cursor { public class CursorTrail : Drawable, IRequireHighFrequencyMousePosition { private const int max_sprites = 2048; private readonly TrailPart[] parts = new TrailPart[max_sprites]; private int currentIndex; private IShader shader; private double timeOffset; private float time; public CursorTrail() { // as we are currently very dependent on having a running clock, let's make our own clock for the time being. Clock = new FramedClock(); RelativeSizeAxes = Axes.Both; for (int i = 0; i < max_sprites; i++) { // -1 signals that the part is unusable, and should not be drawn parts[i].InvalidationID = -1; } AddLayout(partSizeCache); } [BackgroundDependencyLoader] private void load(ShaderManager shaders) { shader = shaders.Load(@"CursorTrail", FragmentShaderDescriptor.TEXTURE); } protected override void LoadComplete() { base.LoadComplete(); resetTime(); } private Texture texture = Texture.WhitePixel; public Texture Texture { get => texture; set { if (texture == value) return; texture = value; Invalidate(Invalidation.DrawNode); } } private readonly LayoutValue<Vector2> partSizeCache = new LayoutValue<Vector2>(Invalidation.DrawInfo | Invalidation.RequiredParentSizeToFit | Invalidation.Presence); private Vector2 partSize => partSizeCache.IsValid ? partSizeCache.Value : (partSizeCache.Value = new Vector2(Texture.DisplayWidth, Texture.DisplayHeight) * DrawInfo.Matrix.ExtractScale().Xy); /// <summary> /// The amount of time to fade the cursor trail pieces. /// </summary> protected virtual double FadeDuration => 300; public override bool IsPresent => true; protected override void Update() { base.Update(); Invalidate(Invalidation.DrawNode); const int fade_clock_reset_threshold = 1000000; time = (float)((Time.Current - timeOffset) / FadeDuration); if (time > fade_clock_reset_threshold) resetTime(); } private void resetTime() { for (int i = 0; i < parts.Length; ++i) { parts[i].Time -= time; if (parts[i].InvalidationID != -1) ++parts[i].InvalidationID; } time = 0; timeOffset = Time.Current; } /// <summary> /// Whether to interpolate mouse movements and add trail pieces at intermediate points. /// </summary> protected virtual bool InterpolateMovements => true; private Vector2? lastPosition; private readonly InputResampler resampler = new InputResampler(); public override bool ReceivePositionalInputAt(Vector2 screenSpacePos) => true; protected override bool OnMouseMove(MouseMoveEvent e) { Vector2 pos = e.ScreenSpaceMousePosition; if (lastPosition == null) { lastPosition = pos; resampler.AddPosition(lastPosition.Value); return base.OnMouseMove(e); } foreach (Vector2 pos2 in resampler.AddPosition(pos)) { Trace.Assert(lastPosition.HasValue); if (InterpolateMovements) { // ReSharper disable once PossibleInvalidOperationException Vector2 pos1 = lastPosition.Value; Vector2 diff = pos2 - pos1; float distance = diff.Length; Vector2 direction = diff / distance; float interval = partSize.X / 2.5f; for (float d = interval; d < distance; d += interval) { lastPosition = pos1 + direction * d; addPart(lastPosition.Value); } } else { lastPosition = pos2; addPart(lastPosition.Value); } } return base.OnMouseMove(e); } private void addPart(Vector2 screenSpacePosition) { parts[currentIndex].Position = screenSpacePosition; parts[currentIndex].Time = time + 1; ++parts[currentIndex].InvalidationID; currentIndex = (currentIndex + 1) % max_sprites; } protected override DrawNode CreateDrawNode() => new TrailDrawNode(this); private struct TrailPart { public Vector2 Position; public float Time; public long InvalidationID; } private class TrailDrawNode : DrawNode { protected new CursorTrail Source => (CursorTrail)base.Source; private IShader shader; private Texture texture; private float time; private readonly TrailPart[] parts = new TrailPart[max_sprites]; private Vector2 size; private readonly QuadBatch<TexturedTrailVertex> vertexBatch = new QuadBatch<TexturedTrailVertex>(max_sprites, 1); public TrailDrawNode(CursorTrail source) : base(source) { } public override void ApplyState() { base.ApplyState(); shader = Source.shader; texture = Source.texture; size = Source.partSize; time = Source.time; Source.parts.CopyTo(parts, 0); } public override void Draw(Action<TexturedVertex2D> vertexAction) { base.Draw(vertexAction); shader.Bind(); shader.GetUniform<float>("g_FadeClock").UpdateValue(ref time); texture.TextureGL.Bind(); RectangleF textureRect = texture.GetTextureRect(); foreach (var part in parts) { if (part.InvalidationID == -1) continue; if (time - part.Time >= 1) continue; vertexBatch.Add(new TexturedTrailVertex { Position = new Vector2(part.Position.X - size.X / 2, part.Position.Y + size.Y / 2), TexturePosition = textureRect.BottomLeft, Colour = DrawColourInfo.Colour.BottomLeft.Linear, Time = part.Time }); vertexBatch.Add(new TexturedTrailVertex { Position = new Vector2(part.Position.X + size.X / 2, part.Position.Y + size.Y / 2), TexturePosition = textureRect.BottomRight, Colour = DrawColourInfo.Colour.BottomRight.Linear, Time = part.Time }); vertexBatch.Add(new TexturedTrailVertex { Position = new Vector2(part.Position.X + size.X / 2, part.Position.Y - size.Y / 2), TexturePosition = textureRect.TopRight, Colour = DrawColourInfo.Colour.TopRight.Linear, Time = part.Time }); vertexBatch.Add(new TexturedTrailVertex { Position = new Vector2(part.Position.X - size.X / 2, part.Position.Y - size.Y / 2), TexturePosition = textureRect.TopLeft, Colour = DrawColourInfo.Colour.TopLeft.Linear, Time = part.Time }); } vertexBatch.Draw(); shader.Unbind(); } protected override void Dispose(bool isDisposing) { base.Dispose(isDisposing); vertexBatch.Dispose(); } } [StructLayout(LayoutKind.Sequential)] public struct TexturedTrailVertex : IEquatable<TexturedTrailVertex>, IVertex { [VertexMember(2, VertexAttribPointerType.Float)] public Vector2 Position; [VertexMember(4, VertexAttribPointerType.Float)] public Color4 Colour; [VertexMember(2, VertexAttribPointerType.Float)] public Vector2 TexturePosition; [VertexMember(1, VertexAttribPointerType.Float)] public float Time; public bool Equals(TexturedTrailVertex other) { return Position.Equals(other.Position) && TexturePosition.Equals(other.TexturePosition) && Colour.Equals(other.Colour) && Time.Equals(other.Time); } } } }