Refactor iota rendering API to move most functions out of Provider

Author: object-Object

Common/src/main/java/gay/object/hexdebug/api/client/splicing/SplicingTableIotaRenderer.java

@@ -1,9 +1,88 @@
 package gay.object.hexdebug.api.client.splicing;
 
+import at.petrak.hexcasting.api.casting.iota.IotaType;
+import at.petrak.hexcasting.common.lib.hex.HexIotaTypes;
+import gay.object.hexdebug.api.splicing.SplicingTableIotaClientView;
+import gay.object.hexdebug.gui.splicing.SplicingTableScreen;
 import net.minecraft.client.gui.GuiGraphics;
+import net.minecraft.client.gui.components.Tooltip;
+import net.minecraft.network.chat.Component;
 import org.jetbrains.annotations.NotNull;
 
-@FunctionalInterface
-public interface SplicingTableIotaRenderer {
-    void render(@NotNull GuiGraphics guiGraphics, int mouseX, int mouseY, float partialTick);
+public abstract class SplicingTableIotaRenderer {
+    @NotNull
+    private final IotaType<?> type;
+    @NotNull
+    private final SplicingTableIotaClientView iota;
+    private final int x;
+    private final int y;
+
+    public SplicingTableIotaRenderer(
+        @NotNull IotaType<?> type,
+        @NotNull SplicingTableIotaClientView iota,
+        int x,
+        int y
+    ) {
+        this.type = type;
+        this.iota = iota;
+        this.x = x;
+        this.y = y;
+    }
+
+    @NotNull
+    public final IotaType<?> getType() {
+        return type;
+    }
+
+    @NotNull
+    public final SplicingTableIotaClientView getIota() {
+        return iota;
+    }
+
+    public final int getX() {
+        return x;
+    }
+
+    public final int getY() {
+        return y;
+    }
+
+    /** Renders one frame of this iota. */
+    public abstract void render(@NotNull GuiGraphics guiGraphics, int mouseX, int mouseY, float partialTick);
+
+    /** Returns the background type for this renderer. */
+    @NotNull
+    public SplicingTableIotaBackgroundType getBackgroundType() {
+        return SplicingTableIotaBackgroundType.GOLD;
+    }
+
+    /**
+     * Creates and returns a new {@link Tooltip} for the provided iota.
+     * <br>
+     * In most cases, you'll likely want to override
+     * {@link SplicingTableIotaRenderer#buildTooltip} instead.
+     */
+    @NotNull
+    public Tooltip createTooltip() {
+        return buildTooltip().build();
+    }
+
+    /**
+     * Creates and returns a new {@link SplicingTableIotaTooltipBuilder} for the provided iota.
+     * <br>
+     * If you want to provide a tooltip directly instead of using this builder, you can override
+     * {@link SplicingTableIotaRenderer#createTooltip} instead.
+     */
+    @NotNull
+    protected SplicingTableIotaTooltipBuilder buildTooltip() {
+        var builder = new SplicingTableIotaTooltipBuilder(iota.name())
+            .addDetailsLine(SplicingTableScreen.tooltipText("index", iota.index()));
+
+        var typeKey = HexIotaTypes.REGISTRY.getKey(type);
+        if (typeKey != null) {
+            builder.addAdvancedLine(Component.literal(typeKey.toString()));
+        }
+
+        return builder.addAdvancedLine(SplicingTableScreen.tooltipText("depth", iota.depth()));
+    }
 }

Common/src/main/java/gay/object/hexdebug/api/client/splicing/SplicingTableIotaRendererParser.java

@@ -2,6 +2,8 @@
 
 import com.google.gson.Gson;
 import com.google.gson.JsonObject;
+import com.mojang.datafixers.util.Function3;
+import com.mojang.datafixers.util.Function4;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -15,11 +17,9 @@ public interface SplicingTableIotaRendererParser<T extends SplicingTableIotaRend
     @NotNull
     T parse(@NotNull Gson gson, @NotNull JsonObject jsonObject, @Nullable T parent);
 
-    /**
-     * Creates a parser that always returns the given instance.
-     */
+    /** Creates a parser that always returns the given provider. */
     @NotNull
-    static <T extends SplicingTableIotaRendererProvider> SplicingTableIotaRendererParser<T> of(T instance) {
-        return (gson, jsonObject, parent) -> instance;
+    static SplicingTableIotaRendererParser<?> simple(SplicingTableIotaRendererProvider provider) {
+        return (gson, jsonObject, parent) -> provider;
     }
 }

Common/src/main/java/gay/object/hexdebug/api/client/splicing/SplicingTableIotaRendererProvider.java

@@ -9,18 +9,17 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
-/**
- * A factory for {@link SplicingTableIotaRenderer} instances.
- * <br>
- * Every method in this interface is called every time the splicing table changes which iotas are
- * currently visible, so don't do anything too laggy in here.
- */
+/** A factory for {@link SplicingTableIotaRenderer} instances. */
+@FunctionalInterface
 public interface SplicingTableIotaRendererProvider {
     /**
      * Creates and returns a new {@link SplicingTableIotaRenderer} for the provided iota.
      * <br>
      * May return null if unable to create a renderer for the given iota; in that case, the default
      * renderer will be used instead.
+     * <br>
+     * This is called every time the splicing table changes which iotas are currently visible, so
+     * don't do anything too laggy in here.
      */
     @Nullable
     SplicingTableIotaRenderer createRenderer(
@@ -29,49 +28,4 @@ SplicingTableIotaRenderer createRenderer(
         int x,
         int y
     );
-
-    /**
-     * Creates and returns a new {@link Tooltip} for the provided iota.
-     * <br>
-     * In most cases, you'll likely want to override
-     * {@link SplicingTableIotaRendererProvider#getTooltipBuilder} instead.
-     */
-    @NotNull
-    default Tooltip createTooltip(
-        @NotNull IotaType<?> type,
-        @NotNull SplicingTableIotaClientView iota
-    ) {
-        return getTooltipBuilder(type, iota).build();
-    }
-
-    /**
-     * Creates and returns a new {@link SplicingTableIotaTooltipBuilder} for the provided iota.
-     * <br>
-     * If you want to provide a tooltip directly instead of using this builder, you can override
-     * {@link SplicingTableIotaRendererProvider#createTooltip} instead.
-     */
-    @NotNull
-    default SplicingTableIotaTooltipBuilder getTooltipBuilder(
-        @NotNull IotaType<?> type,
-        @NotNull SplicingTableIotaClientView iota
-    ) {
-        var builder = new SplicingTableIotaTooltipBuilder(iota.name())
-            .addDetailsLine(SplicingTableScreen.tooltipText("index", iota.index()));
-
-        var typeKey = HexIotaTypes.REGISTRY.getKey(type);
-        if (typeKey != null) {
-            builder.addAdvancedLine(Component.literal(typeKey.toString()));
-        }
-
-        return builder.addAdvancedLine(SplicingTableScreen.tooltipText("depth", iota.depth()));
-    }
-
-    /** Returns the background type for this renderer. */
-    @NotNull
-    default SplicingTableIotaBackgroundType getBackgroundType(
-        @NotNull IotaType<?> type,
-        @NotNull SplicingTableIotaClientView iota
-    ) {
-        return SplicingTableIotaBackgroundType.GOLD;
-    }
 }

Common/src/main/java/gay/object/hexdebug/api/client/splicing/SplicingTableIotaTooltipBuilder.java

@@ -10,7 +10,7 @@
 
 import java.util.ArrayList;
 
-public class SplicingTableIotaTooltipBuilder {
+public final class SplicingTableIotaTooltipBuilder {
     private final Component name;
     private final ArrayList<Component> body;
     private final ArrayList<Component> details;
@@ -51,29 +51,34 @@ public Component getNarration() {
     }
 
     /** Append a line to the tooltip's body. */
+    @NotNull
     public SplicingTableIotaTooltipBuilder addBodyLine(@NotNull Component line) {
         body.add(line);
         return this;
     }
 
     /** Append a line to the tooltip's details. */
+    @NotNull
     public SplicingTableIotaTooltipBuilder addDetailsLine(@NotNull Component line) {
         details.add(line);
         return this;
     }
 
     /** Append a line to the tooltip's "advanced tooltips" section. */
+    @NotNull
     public SplicingTableIotaTooltipBuilder addAdvancedLine(@NotNull Component line) {
         advanced.add(line);
         return this;
     }
 
     /** Set the tooltip's narration. */
+    @NotNull
     public SplicingTableIotaTooltipBuilder setNarration(@Nullable Component narration) {
         this.narration = narration;
         return this;
     }
 
+    @NotNull
     public Tooltip build() {
         var lines = new ArrayList<Component>();
         lines.add(name);

Common/src/main/kotlin/gay/object/hexdebug/HexDebugClient.kt

@@ -13,7 +13,7 @@ import gay.`object`.hexdebug.config.HexDebugClientConfig
 import gay.`object`.hexdebug.config.HexDebugServerConfig
 import gay.`object`.hexdebug.gui.splicing.renderers.ItemRendererProvider
 import gay.`object`.hexdebug.gui.splicing.renderers.ListRendererProvider
-import gay.`object`.hexdebug.gui.splicing.renderers.PatternRendererProvider
+import gay.`object`.hexdebug.gui.splicing.renderers.PatternRenderer
 import gay.`object`.hexdebug.gui.splicing.renderers.TextureRendererProvider
 import gay.`object`.hexdebug.registry.HexDebugBlocks
 import gay.`object`.hexdebug.resources.splicing.SplicingTableIotasResourceReloadListener
@@ -99,7 +99,7 @@ object HexDebugClient {
         for ((name, parser) in arrayOf(
             "item" to ItemRendererProvider.PARSER,
             "list" to ListRendererProvider.PARSER,
-            "pattern" to PatternRendererProvider.PARSER,
+            "pattern" to PatternRenderer.PARSER,
             "texture" to TextureRendererProvider.PARSER,
         )) {
             SplicingTableIotaRenderers.register(HexDebug.id(name), parser)

Common/src/main/kotlin/gay/object/hexdebug/gui/splicing/renderers/ItemRendererProvider.kt

@@ -7,6 +7,7 @@ import gay.`object`.hexdebug.api.client.splicing.SplicingTableIotaRendererProvid
 import gay.`object`.hexdebug.api.splicing.SplicingTableIotaClientView
 import gay.`object`.hexdebug.utils.*
 import net.minecraft.client.Minecraft
+import net.minecraft.client.gui.GuiGraphics
 import net.minecraft.commands.arguments.NbtPathArgument.NbtPath
 import net.minecraft.core.registries.BuiltInRegistries
 import net.minecraft.nbt.CompoundTag
@@ -41,9 +42,18 @@ class ItemRendererProvider(
         val stack = ItemStack(item, count)
         stack.tag = tag
 
-        return SplicingTableIotaRenderer { guiGraphics, _, _, _ ->
-            val ps = guiGraphics.pose()
-            ps.pushPose {
+        return ItemRenderer(type, iota, x, y, stack)
+    }
+
+    inner class ItemRenderer(
+        type: IotaType<*>,
+        iota: SplicingTableIotaClientView,
+        x: Int,
+        y: Int,
+        val stack: ItemStack,
+    ) : SplicingTableIotaRenderer(type, iota, x, y) {
+        override fun render(guiGraphics: GuiGraphics, mouseX: Int, mouseY: Int, partialTick: Float) {
+            guiGraphics.pose().letPushPose { ps ->
                 // align to center of iota display
                 ps.translate(x + (18f / 2f) + xOffset, y + (21f / 2f) + yOffset, 0f)
                 ps.scale(scale)

Common/src/main/kotlin/gay/object/hexdebug/gui/splicing/renderers/ListRendererProvider.kt

@@ -3,6 +3,7 @@ package gay.`object`.hexdebug.gui.splicing.renderers
 import at.petrak.hexcasting.api.casting.iota.IotaType
 import at.petrak.hexcasting.api.utils.downcast
 import gay.`object`.hexdebug.HexDebug
+import gay.`object`.hexdebug.api.client.splicing.SplicingTableIotaRenderer
 import gay.`object`.hexdebug.api.client.splicing.SplicingTableIotaRendererParser
 import gay.`object`.hexdebug.api.client.splicing.SplicingTableIotaTooltipBuilder
 import gay.`object`.hexdebug.api.splicing.SplicingTableIotaClientView
@@ -20,14 +21,27 @@ object ListRendererProvider : TextureRendererProvider(
     textureWidth = 512,
     textureHeight = 512,
 ) {
-    override fun getTooltipBuilder(
+    override fun createRenderer(
         type: IotaType<*>,
         iota: SplicingTableIotaClientView,
-    ): SplicingTableIotaTooltipBuilder {
-        val listTag = iota.data!!.downcast(ListTag.TYPE)
-        return super.getTooltipBuilder(type, iota)
-            .addAdvancedLine(SplicingTableScreen.tooltipText("length", listTag.size))
+        x: Int,
+        y: Int
+    ): SplicingTableIotaRenderer {
+        return ListRenderer(type, iota, x, y)
     }
 
-    val PARSER = SplicingTableIotaRendererParser.of(this)
+    class ListRenderer(
+        type: IotaType<*>,
+        iota: SplicingTableIotaClientView,
+        x: Int,
+        y: Int,
+    ) : TextureRenderer(type, iota, x, y) {
+        override fun buildTooltip(): SplicingTableIotaTooltipBuilder {
+            val listTag = iota.data!!.downcast(ListTag.TYPE)
+            return super.buildTooltip()
+                .addAdvancedLine(SplicingTableScreen.tooltipText("length", listTag.size))
+        }
+    }
+
+    val PARSER = SplicingTableIotaRendererParser.simple(::ListRenderer)
 }