Fixes #4730 and also introduces repeat-pageup/pagedown when holding the mouse on the area above or below the scrollbar handle.

2020-09-13 22:09:47 +02:00
parent d07937fa93
commit 0147e1ddfb
3 changed files with 277 additions and 29 deletions
@@ -18,17 +18,62 @@

 package appeng.client.gui.widgets;

-import com.mojang.blaze3d.systems.RenderSystem;
-
-import net.minecraftforge.fml.client.gui.GuiUtils;
-
 import appeng.client.gui.AEBaseScreen;
+import com.mojang.blaze3d.matrix.MatrixStack;
+import net.minecraft.client.gui.AbstractGui;
+import net.minecraft.client.renderer.Rectangle2d;
+import net.minecraft.util.ResourceLocation;

-public class Scrollbar implements IScrollSource {
+import java.time.Duration;

+public class Scrollbar extends AbstractGui implements IScrollSource {
+
+    /**
+     * Width of the scrollbar handle sprite in the source texture.
+     */
+    private static final int HANDLE_WIDTH = 12;
+
+    /**
+     * Height of the scrollbar handle sprite in the source texture.
+     */
+    private static final int HANDLE_HEIGHT = 15;
+
+    /**
+     * Texture containing the scrollbar handle sprites.
+     */
+    private static final ResourceLocation TEXTURE = new ResourceLocation("minecraft",
+            "textures/gui/container/creative_inventory/tabs.png");
+
+    /**
+     * Rectangle in the source texture that contains the sprite for an enabled
+     * handle.
+     */
+    private static final Rectangle2d ENABLED = new Rectangle2d(232, 0, HANDLE_WIDTH, HANDLE_HEIGHT);
+
+    /**
+     * Rectangle in the source texture that contains the sprite for a disabled
+     * handle.
+     */
+    private static final Rectangle2d DISABLED = new Rectangle2d(232 + HANDLE_WIDTH, 0, HANDLE_WIDTH, HANDLE_HEIGHT);
+
+    /**
+     * The screen x-coordinate of the scrollbar's inner track.
+     */
    private int displayX = 0;
+
+    /**
+     * The screen y-coordinate of the scrollbar's inner track.
+     */
    private int displayY = 0;
-    private int width = 12;
+
+    /**
+     * The inner width of the scrollbar track.
+     */
+    private int width = HANDLE_WIDTH;
+
+    /**
+     * The inner height of the scrollbar track.
+     */
    private int height = 16;
    private int pageSize = 1;

@@ -36,18 +81,51 @@ public class Scrollbar implements IScrollSource {
    private int minScroll = 0;
    private int currentScroll = 0;

-    public void draw(final AEBaseScreen<?> g) {
-        g.bindTexture("minecraft", "gui/container/creative_inventory/tabs.png");
-        RenderSystem.color4f(1.0f, 1.0f, 1.0f, 1.0f);
+    /**
+     * True if the scrollbar's handle is currently being dragged.
+     */
+    private boolean dragging;

+    private final EventRepeater eventRepeater = new EventRepeater(
+            Duration.ofMillis(250),
+            Duration.ofMillis(150)
+    );
+
+    /**
+     * Draws the handle of the scrollbar.
+     * <p>
+     * The GUI is assumed to already contain a prebaked scrollbar track in its
+     * background.
+     */
+    public void draw(MatrixStack matrices, final AEBaseScreen<?> g) {
+        setBlitOffset(g.getBlitOffset());
+
+        // Draw the track (nice for debugging)
+        // fill(matrices, displayX, displayY, this.displayX + width, this.displayY + height, 0xffff0000);
+
+        g.bindTexture(TEXTURE);
+
+        int yOffset;
+        Rectangle2d sourceRect;
        if (this.getRange() == 0) {
-            GuiUtils.drawTexturedModalRect(this.displayX, this.displayY, 232 + this.width, 0, this.width, 15,
-                    g.getBlitOffset());
+            yOffset = 0;
+            sourceRect = DISABLED;
        } else {
-            final int offset = (this.currentScroll - this.minScroll) * (this.height - 15) / this.getRange();
-            GuiUtils.drawTexturedModalRect(this.displayX, offset + this.displayY, 232, 0, this.width, 15,
-                    g.getBlitOffset());
+            yOffset = getHandleYOffset();
+            sourceRect = ENABLED;
        }
+
+        blit(matrices, this.displayX, this.displayY + yOffset, sourceRect.getX(), sourceRect.getY(),
+                sourceRect.getWidth(), sourceRect.getHeight());
+    }
+
+    /**
+     * Returns the y-position of the scrollbar handle in relation to the upper edge
+     * of the scrollbar's track.
+     */
+    private int getHandleYOffset() {
+        int availableHeight = this.height - HANDLE_HEIGHT;
+        return (this.currentScroll - this.minScroll) * availableHeight / this.getRange();
    }

    private int getRange() {
@@ -111,18 +189,55 @@ public class Scrollbar implements IScrollSource {
        return this.currentScroll;
    }

-    public void click(final double x, final double y) {
-        if (this.getRange() == 0) {
+    public boolean mouseDown(double x, double y) {
+        this.dragging = false;
+
+        // Clicks to the left or right of the scrollbar don't do anything
+        if (x < displayX || x >= displayX + width) {
+            return false;
+        }
+
+        // Clicks to the top or bottom don't do anything either
+        int relY = (int) Math.round(y - displayY);
+        if (relY < 0 || relY >= height) {
+            return false;
+        }
+
+        int handleYOffset = getHandleYOffset();
+
+        if (relY < handleYOffset) {
+            // Clicks above the handle will page up, repeatedly
+            repeatPageUp();
+            eventRepeater.repeat(this::repeatPageUp);
+
+        } else if (relY < handleYOffset + HANDLE_HEIGHT) {
+            // Clicks on the handle will initiate dragging it
+            this.dragging = true;
+        } else {
+            // Clicks below the handle will page down, repeatedly
+            repeatPageDown();
+            eventRepeater.repeat(this::repeatPageDown);
+        }
+
+        return true;
+    }
+
+    public boolean mouseUp(double x, double y) {
+        this.dragging = false;
+        this.eventRepeater.stop();
+        return false;
+    }
+
+    public void mouseDragged(double x, double y) {
+        if (this.getRange() == 0 || !this.dragging || this.eventRepeater.isRepeating()) {
            return;
        }

-        if (x > this.displayX && x <= this.displayX + this.width) {
-            if (y > this.displayY && y <= this.displayY + this.height) {
-                this.currentScroll = (int) (y - this.displayY);
-                this.currentScroll = this.minScroll + ((this.currentScroll * 2 * this.getRange() / this.height));
-                this.currentScroll = (this.currentScroll + 1) >> 1;
-                this.applyRange();
-            }
+        if (y > this.displayY && y <= this.displayY + this.height) {
+            this.currentScroll = (int) (y - this.displayY);
+            this.currentScroll = this.minScroll + ((this.currentScroll * 2 * this.getRange() / this.height));
+            this.currentScroll = (this.currentScroll + 1) >> 1;
+            this.applyRange();
        }
    }

@@ -131,4 +246,25 @@ public class Scrollbar implements IScrollSource {
        this.currentScroll += delta * this.pageSize;
        this.applyRange();
    }
+
+    /**
+     * Ticks the scrollbar for the purposes of input-repeats (since mouse-downs are not repeat-triggered),
+     * used to repeatedly page-up or page-down when the mouse is held in the area above or below the scrollbar handle.
+     */
+    public void tick() {
+        this.eventRepeater.tick();
+    }
+
+    private void repeatPageUp() {
+        System.out.println("REPEAT PAGE UP");
+        this.currentScroll -= this.pageSize;
+        this.applyRange();
+    }
+
+    private void repeatPageDown() {
+        System.out.println("REPEAT PAGE DOWN");
+        this.currentScroll += this.pageSize;
+        this.applyRange();
+    }
+
 }