From 308febfed0e678bca446869d36d6a3eae110d660 Mon Sep 17 00:00:00 2001 From: OrderedSet Date: Sat, 21 Nov 2026 22:55:27 -0800 Subject: [PATCH] Cleanup and add explicit axis enum --- .../codechicken/nei/WorldOverlayRenderer.java | 6 +- .../nei/moboverlay/MobOverlayDisplayList.java | 30 +++---- .../nei/moboverlay/MobOverlayFace.java | 5 +- .../nei/moboverlay/MobOverlayScan.java | 81 +++++++++++-------- .../nei/moboverlay/MobOverlayStyle.java | 18 ++--- 5 files changed, 76 insertions(+), 64 deletions(-) diff --git a/src/main/java/codechicken/nei/WorldOverlayRenderer.java b/src/main/java/codechicken/nei/WorldOverlayRenderer.java index 02a67659..37523886 100644 --- a/src/main/java/codechicken/nei/WorldOverlayRenderer.java +++ b/src/main/java/codechicken/nei/WorldOverlayRenderer.java @@ -85,8 +85,8 @@ public class WorldOverlayRenderer implements IKeyStateTracker { } /** - * The model view matrix is relative to ({@code intOffsetX}, {@code intOffsetY}, {@code intOffsetZ}), the camera - * position cast to {@code int}. + * The model view matrix is relative to ({@code intOffsetX}, {@code intOffsetY}, {@code intOffsetZ}). The offsets + * are the camera position cast to {@code int}. */ private static void renderMobSpawnOverlay(Entity entity, int intOffsetX, int intOffsetY, int intOffsetZ) { if (mobOverlay == 0) { @@ -171,7 +171,7 @@ public class WorldOverlayRenderer implements IKeyStateTracker { GL11.glBlendFunc(GL11.GL_SRC_ALPHA, GL11.GL_ONE_MINUS_SRC_ALPHA); GL11.glDisable(GL11.GL_LIGHTING); GL11.glLineWidth(1.5F); - // the outline of `MobOverlayStyle.CONNECTED` lies in the plane of the tint. With depth writes on, the depth + // the outline of `MobOverlayStyle.CONNECTED` lies in the plane of the tint. When depth writes are on, the depth // test discards most of the outline GL11.glDepthMask(false); } diff --git a/src/main/java/codechicken/nei/moboverlay/MobOverlayDisplayList.java b/src/main/java/codechicken/nei/moboverlay/MobOverlayDisplayList.java index 4a522c41..cba9b4a4 100644 --- a/src/main/java/codechicken/nei/moboverlay/MobOverlayDisplayList.java +++ b/src/main/java/codechicken/nei/moboverlay/MobOverlayDisplayList.java @@ -7,8 +7,8 @@ import net.minecraft.client.renderer.GLAllocation; import org.lwjgl.opengl.GL11; /** - * The mob spawn overlay quads, in one GL display list for each chunk column of the box of a {@link MobOverlayScan}. A - * compile rebuilds only the lists whose {@link MobOverlayScan#readChunkVersion} changed. + * {@code MobOverlayDisplayList} compiles the overlay quads of each chunk column of a {@link MobOverlayScan} box into + * one GL display list. A compile rebuilds only the lists whose {@link MobOverlayScan#readChunkVersion} changed. */ public final class MobOverlayDisplayList { @@ -54,10 +54,10 @@ public final class MobOverlayDisplayList { } /** - * Start the list of chunk column ({@code chunkX}, {@code chunkZ}), with quad positions relative to block ({@code - * chunkX * 16}, {@link MobOverlayScan#getMinY}, {@code chunkZ * 16}). + * Start the list of chunk column ({@code chunkX}, {@code chunkZ}). The quad positions in the list are relative to + * block ({@code chunkX * 16}, {@link MobOverlayScan#getMinY}, {@code chunkZ * 16}). * - * @return false, with no list started, when the chunk column's list is current + * @return false when the chunk column's list is current. {@code beginChunk} doesn't start a list then */ public boolean beginChunk(MobOverlayScan scan, int chunkX, int chunkZ) { final int chunk = scan.findChunk(chunkX, chunkZ); @@ -103,16 +103,6 @@ public final class MobOverlayDisplayList { GL11.glPopMatrix(); } - public void delete() { - if (firstListId == NO_LIST) return; - - GLAllocation.deleteDisplayLists(firstListId); - firstListId = NO_LIST; - parentListId = NO_LIST; - chunkSpan = 0; - Arrays.fill(isCompiled, false); - } - private void resize(int newChunkSpan) { delete(); chunkSpan = newChunkSpan; @@ -123,4 +113,14 @@ public final class MobOverlayDisplayList { hasFaces = new boolean[chunkCount]; compiledChunkVersion = new int[chunkCount]; } + + public void delete() { + if (firstListId == NO_LIST) return; + + GLAllocation.deleteDisplayLists(firstListId); + firstListId = NO_LIST; + parentListId = NO_LIST; + chunkSpan = 0; + Arrays.fill(isCompiled, false); + } } diff --git a/src/main/java/codechicken/nei/moboverlay/MobOverlayFace.java b/src/main/java/codechicken/nei/moboverlay/MobOverlayFace.java index 030140b7..739c1adb 100644 --- a/src/main/java/codechicken/nei/moboverlay/MobOverlayFace.java +++ b/src/main/java/codechicken/nei/moboverlay/MobOverlayFace.java @@ -2,7 +2,7 @@ package codechicken.nei.moboverlay; import net.minecraft.client.renderer.Tessellator; -/** Vertex builder for one block's top face in the mob spawn overlay. */ +/** {@code MobOverlayFace} adds the vertices of the mark on one block's top face to {@link Tessellator#instance}. */ public final class MobOverlayFace { public static final byte OUTSIDE_SCAN = -2; @@ -36,7 +36,7 @@ public final class MobOverlayFace { public boolean isJoined(int offsetX, int offsetZ) { final byte neighbourMode = neighbourModes[indexNeighbour(offsetX, offsetZ)]; - // no outline along the edge of the scan + // `MobOverlayStyle.CONNECTED` doesn't outline the edge of the scan return neighbourMode == neighbourModes[indexNeighbour(0, 0)] || neighbourMode == OUTSIDE_SCAN; } @@ -67,7 +67,6 @@ public final class MobOverlayFace { addTexturedVertex(1, 0); } - /** @param offsetX 0 at the west edge, 1 at the east edge */ public void addVertex(double offsetX, double offsetZ) { Tessellator.instance.addVertex(x + offsetX, y, z + offsetZ); } diff --git a/src/main/java/codechicken/nei/moboverlay/MobOverlayScan.java b/src/main/java/codechicken/nei/moboverlay/MobOverlayScan.java index df2060f3..5de42b3e 100644 --- a/src/main/java/codechicken/nei/moboverlay/MobOverlayScan.java +++ b/src/main/java/codechicken/nei/moboverlay/MobOverlayScan.java @@ -18,11 +18,13 @@ import net.minecraft.world.chunk.Chunk; import codechicken.lib.math.MathHelper; /** - * Spawn modes, and the tops of flat blocks such as carpets, in a box around the player. The spawn modes are from - * {@link Column#getSpawnMode}: 0 for no spawns, 1 for night only and 2 for any time. The box moves with the player once - * the player is a few blocks from the box's centre, and {@link #update} scans only the blocks that enter the box. - * {@link #update} rescans the column of a block or light change on the next tick. On each tick, {@link #update} also - * rescans a slice of the columns, for changes with no block update, such as a boat that moves into the box. + * {@code MobOverlayScan} reads the spawn mode and the cover top of each block in a box around the player. The cover top + * is the top of a flat block such as a carpet. A spawn mode is 0 when monsters can't spawn on the block, + * {@link #NIGHT_ONLY} when monsters spawn only at night and 2 when monsters spawn at any time. The box moves with the + * player once the player is a few blocks from the box's centre, and {@link #update} scans only the blocks that enter + * the box. {@link #update} rescans the column of a block or light change on the next tick. {@link #update} also rescans + * a slice of the columns on each tick. A change that doesn't cause a block update, such as a boat that moves into the + * box, shows when the slice rescan reaches the change's column. */ public final class MobOverlayScan { @@ -56,15 +58,16 @@ public final class MobOverlayScan { private int minX; private int minY; private int minZ; - // the slice rescan of `update()` continues from this column, numbered `(x - minX) * span + (z - minZ)` private int nextRescanColumn; private int modesVersion; private int chunkSpan; + // indexed by `findChunk()`. The version of a chunk column changes when a cell in or beside the chunk column + // changes, and when an edge of the box moves into, out of, within or across the chunk column. A full scan and a + // vertical move change the version of every chunk column private int[] chunkVersions = new int[0]; private int chunkVersionCount; private boolean hasModes; private long scannedTick; - // world of `modes`, with `changeListener` added private World scannedWorld; public void clear() { @@ -120,7 +123,6 @@ public final class MobOverlayScan { if (isChanged) modesVersion++; } - /** The version changes when a spawn mode or the top of a flat block changes, or the box moves. */ public int getModesVersion() { return modesVersion; } @@ -165,18 +167,16 @@ public final class MobOverlayScan { return (minZ + span - 1) >> CHUNK_SHIFT; } - /** The version changes when a cell in or beside the chunk column changes, and when the box moves. */ public int readChunkVersion(int chunkX, int chunkZ) { return chunkVersions[findChunk(chunkX, chunkZ)]; } - /** {@code i} and {@code j} are from 0 to {@link #getSpan}, and {@code k} is from 0 to {@link #getHeight}. */ public byte readSpawnMode(int i, int k, int j) { return extractSpawnMode(modes[findCell(minX + i, minY + k, minZ + j)]); } /** - * Copy the cells of column ({@code i}, {@code j}) to {@code columnCells}, from the bottom of the box to the top. + * Copy the cells of column ({@code i}, {@code j}) to {@code columnCells} in order from the bottom of the box up. */ public void readColumn(int i, int j, byte[] columnCells) { final int columnStart = findColumn(minX + i, minZ + j) * height; @@ -190,8 +190,8 @@ public final class MobOverlayScan { } /** - * Height of the overlay above the bottom of the block, so that a flat block such as a carpet does not cover the - * overlay. + * Return the height of the overlay above the bottom of the block. The overlay is above the top of a flat block such + * as a carpet. */ public static double computeOverlayYOffset(byte cell) { final double OVERLAY_GAP = 0.02; @@ -238,7 +238,7 @@ public final class MobOverlayScan { final int offsetX = centreX - radius - minX; if (Math.abs(offsetX) > RECENTRE_DISTANCE) { final int enteringX = offsetX > 0 ? minX + span : minX + offsetX; - markMovedEdgeChunks(minX, offsetX, true); + markMovedEdgeChunks(minX, offsetX, Axis.X); minX += offsetX; for (int x = enteringX; x < enteringX + Math.abs(offsetX); x++) { for (int z = minZ; z < minZ + span; z++) { @@ -251,7 +251,7 @@ public final class MobOverlayScan { final int offsetZ = centreZ - radius - minZ; if (Math.abs(offsetZ) > RECENTRE_DISTANCE) { final int enteringZ = offsetZ > 0 ? minZ + span : minZ + offsetZ; - markMovedEdgeChunks(minZ, offsetZ, false); + markMovedEdgeChunks(minZ, offsetZ, Axis.Z); minZ += offsetZ; for (int x = minX; x < minX + span; x++) { for (int z = enteringZ; z < enteringZ + Math.abs(offsetZ); z++) { @@ -322,26 +322,37 @@ public final class MobOverlayScan { } /** - * No outline is drawn between an edge cell of the box and a cell outside the box, so a move changes the outlines of - * the edge cells. + * A move changes the connected outlines of the edge cells on the trailing and the leading side of the box. + * {@link MobOverlayFace#isJoined} doesn't outline a cell's side toward the outside of the box. */ - private void markMovedEdgeChunks(int oldMin, int offset, boolean isAlongX) { + private void markMovedEdgeChunks(int oldMin, int offset, Axis moveAxis) { final int lowFrom = Math.min(oldMin, oldMin + offset); final int lowTo = Math.max(oldMin, oldMin + offset); - final int highFrom = lowFrom + span - 1; - final int highTo = lowTo + span - 1; - if (isAlongX) { - markChunks(lowFrom, lowTo, minZ, minZ + span - 1); - markChunks(highFrom, highTo, minZ, minZ + span - 1); - } else { - markChunks(minX, minX + span - 1, lowFrom, lowTo); - markChunks(minX, minX + span - 1, highFrom, highTo); - } + markStripChunks(lowFrom, lowTo, moveAxis); + markStripChunks(lowFrom + span - 1, lowTo + span - 1, moveAxis); } - private void markChunks(int fromX, int toX, int fromZ, int toZ) { - for (int chunkX = fromX >> CHUNK_SHIFT; chunkX <= toX >> CHUNK_SHIFT; chunkX++) { - for (int chunkZ = fromZ >> CHUNK_SHIFT; chunkZ <= toZ >> CHUNK_SHIFT; chunkZ++) { + /** + * Mark the chunk columns of blocks {@code from} to {@code to} along the move. The marked chunk columns span the box + * across the move. + */ + private void markStripChunks(int from, int to, Axis moveAxis) { + final int acrossMin = switch (moveAxis) { + case X -> minZ; + case Z -> minX; + }; + final int minAcrossChunk = acrossMin >> CHUNK_SHIFT; + final int maxAcrossChunk = (acrossMin + span - 1) >> CHUNK_SHIFT; + for (int alongChunk = from >> CHUNK_SHIFT; alongChunk <= to >> CHUNK_SHIFT; alongChunk++) { + for (int acrossChunk = minAcrossChunk; acrossChunk <= maxAcrossChunk; acrossChunk++) { + final int chunkX = switch (moveAxis) { + case X -> alongChunk; + case Z -> acrossChunk; + }; + final int chunkZ = switch (moveAxis) { + case X -> acrossChunk; + case Z -> alongChunk; + }; markChunk(chunkX, chunkZ); } } @@ -411,7 +422,6 @@ public final class MobOverlayScan { return isChanged; } - /** The spawn mode of the block at height {@code y} in this column. */ private byte getSpawnMode(int y) { if (y >= chunk.worldObj.getHeight()) { return 0; @@ -445,8 +455,8 @@ public final class MobOverlayScan { } /** - * The top of the block at height {@code y}, in fractions of a block with {@link MobOverlayScan#COVER_TOP_STEPS} - * as the denominator, or 0 for a tall block. + * Return the top of the block at height {@code y} in units of 1 / {@link MobOverlayScan#COVER_TOP_STEPS} block. + * Return 0 for a tall block. */ private int readCoverTop(int y) { final double MAX_COVER_TOP = 0.25; @@ -524,4 +534,9 @@ public final class MobOverlayScan { hasDirtyColumns = true; } } + + private enum Axis { + X, + Z + } } diff --git a/src/main/java/codechicken/nei/moboverlay/MobOverlayStyle.java b/src/main/java/codechicken/nei/moboverlay/MobOverlayStyle.java index 10117175..62eeb00a 100644 --- a/src/main/java/codechicken/nei/moboverlay/MobOverlayStyle.java +++ b/src/main/java/codechicken/nei/moboverlay/MobOverlayStyle.java @@ -27,9 +27,7 @@ public enum MobOverlayStyle { } }, - /** - * A light tint, with a stronger outline around each area of one spawn mode, like a connected texture. - */ + /** A light tint and a stronger connected-texture outline around each area of one spawn mode. */ CONNECTED(GL11.GL_QUADS) { @Override @@ -39,7 +37,8 @@ public enum MobOverlayStyle { face.applyColor(Colouring.OVERLAY, MARK_ALPHA); for (int offsetX = -1; offsetX <= 1; offsetX++) { for (int offsetZ = -1; offsetZ <= 1; offsetZ++) { - // a corner cell is drawn when either edge next to the corner is outlined, and on an inside corner + // a corner cell is drawn when either edge next to the corner is outlined or when the corner is an + // inside corner final boolean isOutline = !(face.isJoined(offsetX, offsetZ) && face.isJoined(offsetX, 0) && face.isJoined(0, offsetZ)); if (isOutline) face.addCell(offsetX, offsetZ, OUTLINE_WIDTH); @@ -48,7 +47,7 @@ public enum MobOverlayStyle { } }, - /** A small square in the middle of the block, with no tint. */ + /** A small square in the middle of an untinted block. */ SQUARE(GL11.GL_QUADS) { @Override @@ -62,7 +61,7 @@ public enum MobOverlayStyle { } }, - /** The pufferfish sticker. */ + /** A pufferfish sticker on the block. */ PUFFERFISH("pufferfish", Colouring.STICKER) { @Override @@ -102,7 +101,6 @@ public enum MobOverlayStyle { return DEFAULT; } - /** @return the {@link #formatName} of every style, separated by commas */ public static String formatAllNames() { final StringJoiner names = new StringJoiner(", "); for (MobOverlayStyle style : values()) { @@ -119,7 +117,7 @@ public enum MobOverlayStyle { return switch (this) { case CONNECTED -> TINT_ALPHA; case SQUARE -> MARK_ALPHA; - // opaque lines for X, and the alpha of the PNG for PUFFERFISH + // the lines of X are opaque, and the alpha of PUFFERFISH comes from the PNG case X, PUFFERFISH -> 1.0F; }; } @@ -127,9 +125,9 @@ public enum MobOverlayStyle { public abstract void addVertices(MobOverlayFace face); public enum Colouring { - /** Yellow where mobs spawn only at night, red where mobs spawn at any time. */ + /** Yellow marks where mobs spawn only at night and red marks where mobs spawn at any time. */ OVERLAY, - /** The texture's colours, tinted red where mobs spawn at any time. */ + /** Texture colours with a red tint where mobs spawn at any time. */ STICKER } }