Add WidgetItemOverlay

This simplifies the logic required for plugins to draw an overlay over an item.

runelite-client/src/main/java/net/runelite/client/callback/Hooks.java

@@ -43,6 +43,7 @@ import lombok.extern.slf4j.Slf4j;
 import net.runelite.api.BufferProvider;
 import net.runelite.api.Client;
 import net.runelite.api.MainBufferProvider;
+import net.runelite.api.NullItemID;
 import net.runelite.api.RenderOverview;
 import net.runelite.api.Renderable;
 import net.runelite.api.WorldMapManager;
@@ -52,6 +53,7 @@ import net.runelite.api.hooks.Callbacks;
 import net.runelite.api.hooks.DrawCallbacks;
 import net.runelite.api.widgets.Widget;
 import static net.runelite.api.widgets.WidgetInfo.WORLD_MAP_VIEW;
+import net.runelite.api.widgets.WidgetItem;
 import net.runelite.client.Notifier;
 import net.runelite.client.RuneLite;
 import net.runelite.client.chat.ChatMessageManager;
@@ -62,6 +64,7 @@ import net.runelite.client.task.Scheduler;
 import net.runelite.client.ui.ClientUI;
 import net.runelite.client.ui.DrawManager;
 import net.runelite.client.ui.overlay.OverlayLayer;
+import net.runelite.client.ui.overlay.OverlayManager;
 import net.runelite.client.ui.overlay.OverlayRenderer;
 import net.runelite.client.ui.overlay.infobox.InfoBoxManager;
 import net.runelite.client.util.DeferredEventBus;
@@ -80,6 +83,7 @@ public class Hooks implements Callbacks
 	private static final Injector injector = RuneLite.getInjector();
 	private static final Client client = injector.getInstance(Client.class);
 	private static final OverlayRenderer renderer = injector.getInstance(OverlayRenderer.class);
+	private static final OverlayManager overlayManager = injector.getInstance(OverlayManager.class);
 
 	private static final GameTick GAME_TICK = new GameTick();
 	private static final BeforeRender BEFORE_RENDER = new BeforeRender();
@@ -443,6 +447,10 @@ public class Hooks implements Callbacks
 		{
 			graphics2d.dispose();
 		}
+
+		// WidgetItemOverlays render at ABOVE_WIDGETS, reset widget item
+		// list for next frame.
+		overlayManager.getItemWidgets().clear();
 	}
 
 	@Override
@@ -490,4 +498,14 @@ public class Hooks implements Callbacks
 			pixelPos += pixelJump;
 		}
 	}
+
+	@Override
+	public void drawItem(int itemId, WidgetItem widgetItem)
+	{
+		// Empty bank item
+		if (widgetItem.getId() != NullItemID.NULL_6512)
+		{
+			overlayManager.getItemWidgets().add(widgetItem);
+		}
+	}
 }

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

@@ -41,6 +41,7 @@ import lombok.AccessLevel;
 import lombok.Getter;
 import net.runelite.api.MenuAction;
 import net.runelite.api.events.MenuOptionClicked;
+import net.runelite.api.widgets.WidgetItem;
 import net.runelite.client.config.ConfigGroup;
 import net.runelite.client.config.ConfigManager;
 import net.runelite.client.config.RuneLiteConfig;
@@ -96,6 +97,8 @@ public class OverlayManager
 	 */
 	@Getter(AccessLevel.PACKAGE)
 	private final List<Overlay> overlays = new ArrayList<>();
+	@Getter
+	private final List<WidgetItem> itemWidgets = new ArrayList<>();
 
 	private final Map<OverlayLayer, List<Overlay>> overlayLayers = new EnumMap<>(OverlayLayer.class);
 
@@ -168,6 +171,12 @@ public class OverlayManager
 		// Add is always true
 		overlays.add(overlay);
 		loadOverlay(overlay);
+		// WidgetItemOverlays have a reference to the overlay manager in order to get the WidgetItems
+		// for each frame.
+		if (overlay instanceof WidgetItemOverlay)
+		{
+			((WidgetItemOverlay) overlay).setOverlayManager(this);
+		}
 		rebuildOverlayLayers();
 		return true;
 	}

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

@@ -0,0 +1,78 @@
+/*
+ * Copyright (c) 2019, Adam <Adam@sigterm.info>
+ * 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.ui.overlay;
+
+import java.awt.Dimension;
+import java.awt.Graphics2D;
+import java.util.List;
+import lombok.AccessLevel;
+import lombok.Setter;
+import net.runelite.api.widgets.WidgetItem;
+
+public abstract class WidgetItemOverlay extends Overlay
+{
+	@Setter(AccessLevel.PACKAGE)
+	private OverlayManager overlayManager;
+
+	protected WidgetItemOverlay()
+	{
+		super.setPosition(OverlayPosition.DYNAMIC);
+		super.setPriority(OverlayPriority.LOW);
+		super.setLayer(OverlayLayer.ABOVE_WIDGETS);
+	}
+
+	public abstract void renderItemOverlay(Graphics2D graphics, int itemId, WidgetItem itemWidget);
+
+	@Override
+	public Dimension render(Graphics2D graphics)
+	{
+		final List<WidgetItem> itemWidgets = overlayManager.getItemWidgets();
+		for (WidgetItem widget : itemWidgets)
+		{
+			renderItemOverlay(graphics, widget.getId(), widget);
+		}
+		return null;
+	}
+
+	// Don't allow setting position, priority, or layer
+
+	@Override
+	public void setPosition(OverlayPosition position)
+	{
+		throw new IllegalStateException();
+	}
+
+	@Override
+	public void setPriority(OverlayPriority priority)
+	{
+		throw new IllegalStateException();
+	}
+
+	@Override
+	public void setLayer(OverlayLayer layer)
+	{
+		throw new IllegalStateException();
+	}
+}