helpers for drawing entities

brachy84 · brachy84 · commit f61dc8e27a5f · 2025-08-24T14:34:08.000+02:00
diff --git a/src/main/java/com/cleanroommc/modularui/drawable/GuiDraw.java b/src/main/java/com/cleanroommc/modularui/drawable/GuiDraw.java
@@ -3,6 +3,7 @@
 import com.cleanroommc.modularui.drawable.text.TextRenderer;
 import com.cleanroommc.modularui.screen.RichTooltip;
 import com.cleanroommc.modularui.screen.RichTooltipEvent;
+import com.cleanroommc.modularui.screen.viewport.GuiContext;
 import com.cleanroommc.modularui.utils.Alignment;
 import com.cleanroommc.modularui.utils.Color;
 import com.cleanroommc.modularui.utils.NumberFormat;
@@ -15,8 +16,11 @@
 import net.minecraft.client.renderer.BufferBuilder;
 import net.minecraft.client.renderer.GlStateManager;
 import net.minecraft.client.renderer.RenderItem;
+import net.minecraft.client.renderer.entity.RenderManager;
 import net.minecraft.client.renderer.texture.TextureAtlasSprite;
 import net.minecraft.client.renderer.texture.TextureMap;
+import net.minecraft.entity.Entity;
+import net.minecraft.entity.EntityLivingBase;
 import net.minecraft.item.ItemStack;
 import net.minecraft.util.ResourceLocation;
 import net.minecraftforge.client.event.RenderTooltipEvent;
@@ -29,6 +33,7 @@
 import org.jetbrains.annotations.Nullable;
 
 import java.util.List;
+import java.util.function.Consumer;
 
 public class GuiDraw {
 
@@ -561,4 +566,89 @@ public static void drawTooltipBackground(ItemStack stack, List<String> lines, in
         // bottom accent border
         drawVerticalGradientRect(x - 3, y + height + 2, textWidth + 6, 1, borderColorEnd, borderColorEnd);
     }
+
+    /**
+     * Draws an entity. Note that this does NOT do any necessary setup for rendering the entity. Please see
+     * {@link #drawEntity(Entity, float, float, float, float, Consumer, Consumer)} for a full draw method.
+     *
+     * @param entity entity to draw.
+     * @see #drawEntity(Entity, float, float, float, float, Consumer, Consumer)
+     */
+    public static void drawEntityRaw(Entity entity) {
+        RenderManager rendermanager = Minecraft.getMinecraft().getRenderManager();
+        rendermanager.setPlayerViewY(180.0F);
+        rendermanager.setRenderShadow(false);
+        rendermanager.renderEntity(entity, 0.0D, 0.0D, 0.0D, 0.0F, 1.0F, false);
+        rendermanager.setRenderShadow(true);
+    }
+
+    /**
+     * A simple method to a draw an entity in a GUI. Using the consumers is not always ideal to modify and restore entity state. In those
+     * cases just copy and paste this method and put your code where the consumers would be called. The entity will be scaled so that it
+     * fits right in the given size when untransformed (default). When transforming during pre draw, you may need to manually correct the
+     * scale and offset.
+     *
+     * @param entity   entity to draw
+     * @param x        x pos
+     * @param y        y pos
+     * @param w        the width of the area where the entity should be drawn
+     * @param h        the height of the area where the entity should be drawn
+     * @param z        the z layer ({@link GuiContext#getCurrentDrawingZ()} if drawn in a MUI)
+     * @param preDraw  a function to call before rendering. Transform or modify the entity here.
+     * @param postDraw a function to call after rendering. Restore old entity state here if needed.
+     * @param <T>      type of the entity to render
+     */
+    public static <T extends Entity> void drawEntity(T entity, float x, float y, float w, float h, float z, @Nullable Consumer<T> preDraw, @Nullable Consumer<T> postDraw) {
+        GlStateManager.pushMatrix();
+        Platform.setupDrawEntity(entity, x, y, w, h, z);
+        if (preDraw != null) preDraw.accept(entity);
+        drawEntityRaw(entity);
+        if (postDraw != null) postDraw.accept(entity);
+        Platform.endDrawEntity();
+        GlStateManager.popMatrix();
+    }
+
+    /**
+     * Draws an entity which looks in the direction of the mouse like the player render in the player inventory does.
+     * The code was copied from
+     * {@link net.minecraft.client.gui.inventory.GuiInventory#drawEntityOnScreen(int, int, int, float, float, EntityLivingBase) GuiInventory.drawEntityOnScreen}.
+     *
+     * @param entity entity to draw
+     * @param x      x pos
+     * @param y      y pos
+     * @param w        the width of the area where the entity should be drawn
+     * @param h        the height of the area where the entity should be drawn
+     * @param z        the z layer ({@link GuiContext#getCurrentDrawingZ()} if drawn in a MUI)
+     * @param mouseX current x pos of the mouse
+     * @param mouseY current y pos of the mouse
+     */
+    public static void drawEntityLookingAtMouse(EntityLivingBase entity, float x, float y, float w, float h, float z, int mouseX, int mouseY) {
+        GlStateManager.pushMatrix();
+        Platform.setupDrawEntity(entity, x, y, w, h, z);
+
+        // pre draw
+        float f = entity.renderYawOffset;
+        float f1 = entity.rotationYaw;
+        float f2 = entity.rotationPitch;
+        float f3 = entity.prevRotationYawHead;
+        float f4 = entity.rotationYawHead;
+        GlStateManager.rotate(-((float) Math.atan(mouseY / 40.0F)) * 20.0F, 1.0F, 0.0F, 0.0F);
+        entity.renderYawOffset = (float) Math.atan(mouseX / 40.0F) * 20.0F;
+        entity.rotationYaw = (float) Math.atan(mouseX / 40.0F) * 40.0F;
+        entity.rotationPitch = -((float) Math.atan(mouseY / 40.0F)) * 20.0F;
+        entity.rotationYawHead = entity.rotationYaw;
+        entity.prevRotationYawHead = entity.rotationYaw;
+
+        drawEntityRaw(entity);
+
+        // post draw
+        entity.renderYawOffset = f;
+        entity.rotationYaw = f1;
+        entity.rotationPitch = f2;
+        entity.prevRotationYawHead = f3;
+        entity.rotationYawHead = f4;
+
+        Platform.endDrawEntity();
+        GlStateManager.popMatrix();
+    }
 }
diff --git a/src/main/java/com/cleanroommc/modularui/test/TestGuis.java b/src/main/java/com/cleanroommc/modularui/test/TestGuis.java
@@ -15,9 +15,12 @@
 import com.cleanroommc.modularui.screen.CustomModularScreen;
 import com.cleanroommc.modularui.screen.ModularPanel;
 import com.cleanroommc.modularui.screen.RichTooltip;
+import com.cleanroommc.modularui.screen.viewport.GuiContext;
 import com.cleanroommc.modularui.screen.viewport.ModularGuiContext;
+import com.cleanroommc.modularui.theme.WidgetTheme;
 import com.cleanroommc.modularui.utils.*;
 import com.cleanroommc.modularui.utils.fakeworld.ArraySchema;
+import com.cleanroommc.modularui.utils.fakeworld.FakeEntity;
 import com.cleanroommc.modularui.utils.fakeworld.ISchema;
 import com.cleanroommc.modularui.value.StringValue;
 import com.cleanroommc.modularui.widget.DraggableWidget;
@@ -34,8 +37,11 @@
 
 import com.cleanroommc.modularui.widgets.textfield.TextFieldWidget;
 
+import net.minecraft.client.Minecraft;
 import net.minecraft.client.renderer.GlStateManager;
 import net.minecraft.client.renderer.texture.TextureAtlasSprite;
+import net.minecraft.entity.Entity;
+import net.minecraft.entity.boss.EntityDragon;
 import net.minecraft.init.Blocks;
 import net.minecraft.init.Items;
 import net.minecraft.item.ItemStack;
@@ -54,7 +60,7 @@ public class TestGuis extends CustomModularScreen {
 
     @Override
     public @NotNull ModularPanel buildUI(ModularGuiContext context) {
-        return buildSearchTest(context);
+        return buildSpriteAndEntityUI(context);
     }
 
     public @NotNull ModularPanel buildAnimationUI(ModularGuiContext context) {
@@ -127,16 +133,19 @@ public class TestGuis extends CustomModularScreen {
                                 })));
     }
 
-    public @NotNull ModularPanel buildSpriteUI(ModularGuiContext context) {
+    public @NotNull ModularPanel buildSpriteAndEntityUI(ModularGuiContext context) {
         TextureAtlasSprite sprite = SpriteHelper.getSpriteOfBlockState(GameObjectHelper.getBlockState("minecraft", "command_block"), EnumFacing.UP);
         // SpriteHelper.getSpriteOfItem(new ItemStack(Items.DIAMOND));
+        Entity entity = FakeEntity.create(EntityDragon.class);
+        float period = 3000f;
         return ModularPanel.defaultPanel("main")
                 .size(150)
                 .child(new TextWidget(IKey.str("Test String")).scale(0.6f).horizontalCenter().top(7))
                 .child(new DraggableWidget<>()
                         .background(new SpriteDrawable(sprite))
                         .size(20)
-                        .center()
+                        .alignX(0.5f)
+                        .top(20)
                         .tooltipBuilder(tooltip -> {
                             tooltip.addLine(
                                     "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.  "
@@ -148,7 +157,19 @@ public class TestGuis extends CustomModularScreen {
                             tooltip.alignment(Alignment.Center);
                             tooltip.scale(0.5f);
                             tooltip.pos(RichTooltip.Pos.NEXT_TO_MOUSE);
-                        }));
+                        }))
+                .child(new IDrawable() {
+                    @Override
+                    public void draw(GuiContext context, int x, int y, int width, int height, WidgetTheme widgetTheme) {
+                        GuiDraw.drawEntity(entity, 0, 0, width, height, context.getCurrentDrawingZ(), e -> {
+                            float scale = 0.9f;
+                            GlStateManager.scale(scale, scale, scale);
+                            GlStateManager.translate(0, 7, 0);
+                            GlStateManager.rotate(35, 1, 0, 0);
+                            GlStateManager.rotate(360 * (Minecraft.getSystemTime() % period) / period, 0, 1, 0);
+                        }, null);
+                    }
+                }.asWidget().alignX(0.5f).bottom(10).size(100, 75));
     }
 
 
diff --git a/src/main/java/com/cleanroommc/modularui/utils/Platform.java b/src/main/java/com/cleanroommc/modularui/utils/Platform.java
@@ -1,13 +1,17 @@
 package com.cleanroommc.modularui.utils;
 
+import com.cleanroommc.modularui.screen.viewport.GuiContext;
+
 import net.minecraft.client.Minecraft;
 import net.minecraft.client.entity.EntityPlayerSP;
 import net.minecraft.client.renderer.BufferBuilder;
 import net.minecraft.client.renderer.GlStateManager;
+import net.minecraft.client.renderer.OpenGlHelper;
 import net.minecraft.client.renderer.RenderHelper;
 import net.minecraft.client.renderer.Tessellator;
 import net.minecraft.client.renderer.vertex.DefaultVertexFormats;
 import net.minecraft.client.settings.KeyBinding;
+import net.minecraft.entity.Entity;
 import net.minecraft.item.ItemStack;
 import net.minecraft.util.ResourceLocation;
 import net.minecraftforge.fml.relauncher.Side;
@@ -103,6 +107,46 @@ public static void setupDrawFont() {
         setupDrawTex();
     }
 
+    /**
+     * Sets up the gl state for rendering an entity. The entity will be scaled so that it fits right in the given size when untransformed.
+     *
+     * @param entity entity to set up drawing for
+     * @param x      x pos
+     * @param y      y pos
+     * @param w      the width of the area where the entity should be drawn
+     * @param h      the height of the area where the entity should be drawn
+     * @param z      the z layer ({@link GuiContext#getCurrentDrawingZ()} if drawn in a MUI)
+     */
+    public static void setupDrawEntity(Entity entity, float x, float y, float w, float h, float z) {
+        float size;
+        float scale;
+        if (h / entity.height < w / entity.width) {
+            size = entity.height;
+            scale = h / size;
+        } else {
+            size = entity.width;
+            scale = w / size;
+        }
+        GlStateManager.enableColorMaterial();
+        GlStateManager.enableDepth();
+        GlStateManager.translate(x + w / 2, y + h / 2, z + 50.0F);
+        GlStateManager.scale(-scale, scale, scale);
+        GlStateManager.translate(0, size / 2f, 0);
+        GlStateManager.rotate(180.0F, 0.0F, 0.0F, 1.0F);
+        GlStateManager.rotate(135.0F, 0.0F, 1.0F, 0.0F);
+        RenderHelper.enableStandardItemLighting();
+        GlStateManager.rotate(-135.0F, 0.0F, 1.0F, 0.0F);
+    }
+
+    public static void endDrawEntity() {
+        RenderHelper.disableStandardItemLighting();
+        GlStateManager.disableRescaleNormal();
+        GlStateManager.setActiveTexture(OpenGlHelper.lightmapTexUnit);
+        GlStateManager.disableTexture2D();
+        GlStateManager.setActiveTexture(OpenGlHelper.defaultTexUnit);
+        GlStateManager.disableDepth();
+    }
+
     /**
      * <a href="https://i.sstatic.net/sfQdh.jpg">Reference</a>
      */
diff --git a/src/main/java/com/cleanroommc/modularui/utils/fakeworld/FakeEntity.java b/src/main/java/com/cleanroommc/modularui/utils/fakeworld/FakeEntity.java
@@ -0,0 +1,24 @@
+package com.cleanroommc.modularui.utils.fakeworld;
+
+import net.minecraft.entity.Entity;
+import net.minecraft.world.World;
+import net.minecraftforge.fml.common.registry.EntityEntry;
+import net.minecraftforge.fml.common.registry.EntityRegistry;
+
+/**
+ * Utility class for creating entities for rendering in gui.
+ */
+public class FakeEntity {
+
+    private static final World entityWorld = new DummyWorld();
+
+    private FakeEntity() {}
+
+    public static <T extends Entity> T create(Class<T> entityClass) {
+        return (T) create(EntityRegistry.getEntry(entityClass));
+    }
+
+    public static Entity create(EntityEntry entry) {
+        return entry.newInstance(entityWorld);
+    }
+}
