Merge pull request #8411 from genetic-soybean/8243-ShowGroundMarkersOnMinimap

Add option to display ground markers on minimap

runelite-client/src/main/java/net/runelite/client/plugins/groundmarkers/GroundMarkerConfig.java

@@ -54,4 +54,14 @@ public interface GroundMarkerConfig extends Config
 	{
 		return false;
 	}
+
+	@ConfigItem(
+		keyName = "drawOnMinimap",
+		name = "Draw tiles on minimap",
+		description = "Configures whether marked tiles should be drawn on minimap"
+	)
+	default boolean drawTileOnMinimmap()
+	{
+		return false;
+	}
 }

runelite-client/src/main/java/net/runelite/client/plugins/groundmarkers/GroundMarkerMinimapOverlay.java

@@ -0,0 +1,117 @@
+/*
+ * Copyright (c) 2019, Benjamin <https://github.com/genetic-soybean>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package net.runelite.client.plugins.groundmarkers;
+
+import java.awt.Color;
+import java.awt.Dimension;
+import java.awt.Graphics2D;
+import java.util.Collection;
+import javax.inject.Inject;
+import net.runelite.api.Client;
+import net.runelite.api.Perspective;
+import net.runelite.api.Point;
+import net.runelite.api.coords.LocalPoint;
+import net.runelite.api.coords.WorldPoint;
+import net.runelite.client.ui.overlay.Overlay;
+import net.runelite.client.ui.overlay.OverlayLayer;
+import net.runelite.client.ui.overlay.OverlayPosition;
+import net.runelite.client.ui.overlay.OverlayPriority;
+import net.runelite.client.ui.overlay.OverlayUtil;
+
+class GroundMarkerMinimapOverlay extends Overlay
+{
+	private static final int MAX_DRAW_DISTANCE = 16;
+	private static final int TILE_WIDTH = 4;
+	private static final int TILE_HEIGHT = 4;
+
+	private final Client client;
+	private final GroundMarkerConfig config;
+	private final GroundMarkerPlugin plugin;
+
+	@Inject
+	private GroundMarkerMinimapOverlay(Client client, GroundMarkerConfig config, GroundMarkerPlugin plugin)
+	{
+		this.client = client;
+		this.config = config;
+		this.plugin = plugin;
+		setPosition(OverlayPosition.DYNAMIC);
+		setPriority(OverlayPriority.LOW);
+		setLayer(OverlayLayer.ABOVE_WIDGETS);
+	}
+
+	@Override
+	public Dimension render(Graphics2D graphics)
+	{
+		if (!config.drawTileOnMinimmap())
+		{
+			return null;
+		}
+
+		final Collection<ColorTileMarker> points = plugin.getPoints();
+		for (final ColorTileMarker point : points)
+		{
+			WorldPoint worldPoint = point.getWorldPoint();
+			if (worldPoint.getPlane() != client.getPlane())
+			{
+				continue;
+			}
+
+			Color tileColor = point.getColor();
+			if (tileColor == null || !config.rememberTileColors())
+			{
+				// If this is an old tile which has no color, or rememberTileColors is off, use marker color
+				tileColor = config.markerColor();
+			}
+
+			drawOnMinimap(graphics, worldPoint, tileColor);
+		}
+
+		return null;
+	}
+
+	private void drawOnMinimap(Graphics2D graphics, WorldPoint point, Color color)
+	{
+		WorldPoint playerLocation = client.getLocalPlayer().getWorldLocation();
+
+		if (point.distanceTo(playerLocation) >= MAX_DRAW_DISTANCE)
+		{
+			return;
+		}
+
+		LocalPoint lp = LocalPoint.fromWorld(client, point);
+		if (lp == null)
+		{
+			return;
+		}
+
+		Point posOnMinimap = Perspective.localToMinimap(client, lp);
+		if (posOnMinimap == null)
+		{
+			return;
+		}
+
+		OverlayUtil.renderMinimapRect(client, graphics, posOnMinimap, TILE_WIDTH, TILE_HEIGHT, color);
+	}
+}

runelite-client/src/main/java/net/runelite/client/plugins/groundmarkers/GroundMarkerPlugin.java

@@ -98,6 +98,9 @@ public class GroundMarkerPlugin extends Plugin
 	@Inject
 	private GroundMarkerOverlay overlay;
 
+	@Inject
+	private GroundMarkerMinimapOverlay minimapOverlay;
+
 	@Inject
 	private KeyManager keyManager;
 
@@ -238,6 +241,7 @@ public class GroundMarkerPlugin extends Plugin
 	protected void startUp()
 	{
 		overlayManager.add(overlay);
+		overlayManager.add(minimapOverlay);
 		keyManager.registerKeyListener(inputListener);
 		loadPoints();
 	}
@@ -246,6 +250,7 @@ public class GroundMarkerPlugin extends Plugin
 	protected void shutDown()
 	{
 		overlayManager.remove(overlay);
+		overlayManager.remove(minimapOverlay);
 		keyManager.unregisterKeyListener(inputListener);
 		points.clear();
 	}

runelite-client/src/main/java/net/runelite/client/ui/overlay/OverlayUtil.java

@@ -48,6 +48,7 @@ import net.runelite.api.coords.LocalPoint;
 public class OverlayUtil
 {
 	private static final int MINIMAP_DOT_RADIUS = 4;
+	private static final double UNIT = Math.PI / 1024.0d;
 
 	public static void renderPolygon(Graphics2D graphics, Polygon poly, Color color)
 	{
@@ -68,6 +69,16 @@ public class OverlayUtil
 		graphics.fillOval(mini.getX() - MINIMAP_DOT_RADIUS / 2, mini.getY() - MINIMAP_DOT_RADIUS / 2, MINIMAP_DOT_RADIUS, MINIMAP_DOT_RADIUS);
 	}
 
+	public static void renderMinimapRect(Client client, Graphics2D graphics, Point center, int width, int height, Color color)
+	{
+		double angle = client.getMapAngle() * UNIT;
+
+		graphics.setColor(color);
+		graphics.rotate(angle, center.getX(), center.getY());
+		graphics.drawRect(center.getX() - width / 2, center.getY() - height / 2, width, height);
+		graphics.rotate(-angle , center.getX(), center.getY());
+	}
+
 	public static void renderTextLocation(Graphics2D graphics, Point txtLoc, String text, Color color)
 	{
 		if (Strings.isNullOrEmpty(text))