From be707a89fe253b2e026f68f4fe8d1992bb4a6370 Mon Sep 17 00:00:00 2001 From: tterrag1098 Date: Wed, 22 Apr 2015 21:47:44 -0400 Subject: [PATCH] Clean up CTM documentation and move to API --- eclipseFormat.xml | 2 +- .../{client/render => api/client}/CTM.java | 185 ++++++++++-------- .../chisel/carving/CarvableHelper.java | 2 +- .../chisel/client/render/RenderBlocksCTM.java | 3 +- .../client/render/RenderBlocksCTMNoLight.java | 2 + .../client/render/RenderBlocksColumn.java | 2 + .../render/SubmapManagerFakeController.java | 3 +- .../chisel/config/Configurations.java | 6 +- 8 files changed, 114 insertions(+), 91 deletions(-) rename src/main/java/com/cricketcraft/chisel/{client/render => api/client}/CTM.java (63%) diff --git a/eclipseFormat.xml b/eclipseFormat.xml index 0c657bc6..9c789066 100644 --- a/eclipseFormat.xml +++ b/eclipseFormat.xml @@ -64,7 +64,7 @@ - + diff --git a/src/main/java/com/cricketcraft/chisel/client/render/CTM.java b/src/main/java/com/cricketcraft/chisel/api/client/CTM.java similarity index 63% rename from src/main/java/com/cricketcraft/chisel/client/render/CTM.java rename to src/main/java/com/cricketcraft/chisel/api/client/CTM.java index fba44f1b..32567289 100644 --- a/src/main/java/com/cricketcraft/chisel/client/render/CTM.java +++ b/src/main/java/com/cricketcraft/chisel/api/client/CTM.java @@ -1,4 +1,4 @@ -package com.cricketcraft.chisel.client.render; +package com.cricketcraft.chisel.api.client; import gnu.trove.map.TIntObjectMap; import gnu.trove.map.hash.TIntObjectHashMap; @@ -10,19 +10,17 @@ import net.minecraft.world.IBlockAccess; import net.minecraftforge.common.util.ForgeDirection; import com.cricketcraft.chisel.api.IFacade; -import com.cricketcraft.chisel.config.Configurations; import com.google.common.collect.Maps; -import static com.cricketcraft.chisel.client.render.CTM.Dir.*; -import static net.minecraftforge.common.util.ForgeDirection.*; +import static com.cricketcraft.chisel.api.client.Dir.*; +// @formatter:off /** - * @formatter:off * The CTM renderer will draw the block's FACE using by assembling 4 quadrants from the 5 available block * textures. The normal Texture.png is the blocks "unconnected" texture, and is used when CTM is disabled or the block * has nothing to connect to. This texture has all of the outside corner quadrants The texture-ctm.png contains the * rest of the quadrants. - * + * 

  * ┌─────────────────┐ ┌────────────────────────────────┐
  * │ texture.png     │ │ texture-ctm.png                │
  * │ ╔══════╤══════╗ │ │  ──────┼────── ║ ─────┼───── ║ │
@@ -40,9 +38,9 @@ import static net.minecraftforge.common.util.ForgeDirection.*;
  *                     │ │ 12   │ 13   ││ 14   │ 15   │ │
  *                     │ ═══════╧═══════╗ ─────┼───── ╔ │
  *                     └────────────────────────────────┘
- *
+ *
* combining { 18, 13, 9, 16 }, we can generate a texture connected to the right! - * + * 

  * ╔══════╤═══════
  * ║      │      │
  * ║ 16   │ 9    │
@@ -50,10 +48,10 @@ import static net.minecraftforge.common.util.ForgeDirection.*;
  * ║      │      │
  * ║ 18   │ 13   │
  * ╚══════╧═══════
- *
+ *
* * combining { 18, 13, 11, 2 }, we can generate a texture, in the shape of an L (connected to the right, and up - * + * 

  * ║ ─────┼───── ╚
  * ║      │      │
  * ║ 2    │ 11   │
@@ -61,86 +59,23 @@ import static net.minecraftforge.common.util.ForgeDirection.*;
  * ║      │      │
  * ║ 18   │ 13   │
  * ╚══════╧═══════
- *
+ *
* * HAVE FUN! * -CptRageToaster- */ +// @formatter:on public class CTM { - public enum Dir { - - TOP(UP), - TOP_RIGHT(UP, EAST), - RIGHT(EAST), - BOTTOM_RIGHT(DOWN, EAST), - BOTTOM(DOWN), - BOTTOM_LEFT(DOWN, WEST), - LEFT(WEST), - TOP_LEFT(UP, WEST); - // @formatter:on - - private static final ForgeDirection NORMAL = SOUTH; - private static final Dir[] VALUES = values(); - - private ForgeDirection[] dirs; - - private Dir(ForgeDirection... dirs) { - this.dirs = dirs; - } - - private boolean isConnected(CTM inst, IBlockAccess world, int x, int y, int z, int sideIdx, Block block, int meta) { - ForgeDirection side = getOrientation(sideIdx); - ForgeDirection[] dirs = getNormalizedDirs(side); - for (ForgeDirection dir : dirs) { - x += dir.offsetX; - y += dir.offsetY; - z += dir.offsetZ; - } - return inst.isConnected(world, x, y, z, side, block, meta); - } - - private ForgeDirection[] getNormalizedDirs(ForgeDirection normal) { - if (normal == NORMAL) { - return dirs; - } else if (normal == NORMAL.getOpposite()) { - // If this is the opposite direction of the default normal, we - // need to mirror the dirs - // A mirror version does not affect y+ and y- so we ignore those - ForgeDirection[] ret = new ForgeDirection[dirs.length]; - for (int i = 0; i < ret.length; i++) { - ret[i] = dirs[i].offsetY != 0 ? dirs[i] : dirs[i].getOpposite(); - } - return ret; - } else { - ForgeDirection axis = null; - // Next, we need different a different rotation axis depending - // on if this is up/down or not - if (normal.offsetY == 0) { - // If it is not up/down, pick either the left or right-hand - // rotation - axis = normal == NORMAL.getRotation(UP) ? UP : DOWN; - } else { - // If it is up/down, pick either the up or down rotation. - axis = normal == UP ? NORMAL.getRotation(DOWN) : NORMAL.getRotation(UP); - } - ForgeDirection[] ret = new ForgeDirection[dirs.length]; - // Finally apply all the rotations - for (int i = 0; i < ret.length; i++) { - ret[i] = dirs[i].getRotation(axis); - } - return ret; - } - } - } - /** Some hardcoded offset values for the different corner indeces */ private int[] submapOffsets = { 4, 5, 1, 0 }; private TIntObjectMap submapMap = new TIntObjectHashMap(); private static EnumMap connectionMap = Maps.newEnumMap(Dir.class); - - public boolean disableObscuredFaceCheck = false; - + /** For use via the Chisel 2 config only, altering this could cause unintended behavior */ + public static boolean disableObscuredFaceCheckConfig = false; + + public Boolean disableObscuredFaceCheck = null; + private CTM() { for (Dir dir : Dir.VALUES) { connectionMap.put(dir, false); @@ -151,11 +86,16 @@ public class CTM { submapMap.put(2, new Dir[] { TOP, RIGHT, TOP_RIGHT }); submapMap.put(3, new Dir[] { TOP, LEFT, TOP_LEFT }); } - + public static CTM getInstance() { return new CTM(); } + /** + * @return The indeces of the typical 4x4 submap to use for the given face at the given location. + * + * Indeces are in counter-clockwise order starting at bottom right. + */ public int[] getSubmapIndices(IBlockAccess world, int x, int y, int z, int side) { int[] ret = new int[] { 18, 19, 17, 16 }; @@ -177,9 +117,7 @@ public class CTM { } /** - * Builds the connection map and stores it in this class. The - * {@link #connected(Dir)}, {@link #connectedAnd(Dir...)}, and - * {@link #connectedOr(Dir...)} methods can be used to access it. + * Builds the connection map and stores it in this CTM instance. The {@link #connected(Dir)}, {@link #connectedAnd(Dir...)}, and {@link #connectedOr(Dir...)} methods can be used to access it. */ public void buildConnectionMap(IBlockAccess world, int x, int y, int z, int side, Block block, int meta) { for (Dir dir : Dir.VALUES) { @@ -204,10 +142,20 @@ public class CTM { } } + /** + * @param dir + * The direction to check connection in. + * @return True if the cached connectionMap holds a connection in this {@link Dir direction}. + */ public boolean connected(Dir dir) { return connectionMap.get(dir); } + /** + * @param dirs + * The directions to check connection in. + * @return True if the cached connectionMap holds a connection in all the given {@link Dir directions}. + */ public boolean connectedAnd(Dir... dirs) { for (Dir dir : dirs) { if (!connected(dir)) { @@ -217,6 +165,11 @@ public class CTM { return true; } + /** + * @param dirs + * The directions to check connection in. + * @return True if the cached connectionMap holds a connection in one of the given {@link Dir directions}. + */ private boolean connectedOr(Dir... dirs) { for (Dir dir : dirs) { if (connected(dir)) { @@ -226,18 +179,56 @@ public class CTM { return false; } + /** + * A simple check for if the given block can connect to the given direction on the given side. + * + * @param world + * @param x + * The x coordinate of the block to check against. This is not the position of your block. + * @param y + * The y coordinate of the block to check against. This is not the position of your block. + * @param z + * The z coordinate of the block to check against. This is not the position of your block. + * @param side + * The side of the block to check for connection status. This is not the direction to check in. + * @param block + * The block to check against for connection. + * @param meta + * The metadata to check against for connection. + * @return True if the given block can connect to the given location on the given side. + */ public boolean isConnected(IBlockAccess world, int x, int y, int z, int side, Block block, int meta) { ForgeDirection dir = ForgeDirection.VALID_DIRECTIONS[side]; return isConnected(world, x, y, z, dir, block, meta); } + /** + * A simple check for if the given block can connect to the given direction on the given side. + * + * @param world + * @param x + * The x coordinate of the block to check against. This is not the position of your block. + * @param y + * The y coordinate of the block to check against. This is not the position of your block. + * @param z + * The z coordinate of the block to check against. This is not the position of your block. + * @param dir + * The {@link ForgeDirection side} of the block to check for connection status. This is not the direction to check in. + * @param block + * The block to check against for connection. + * @param meta + * The metadata to check against for connection. + * @return True if the given block can connect to the given location on the given side. + */ public boolean isConnected(IBlockAccess world, int x, int y, int z, ForgeDirection dir, Block block, int meta) { int x2 = x + dir.offsetX; int y2 = y + dir.offsetY; int z2 = z + dir.offsetZ; + boolean disableObscured = disableObscuredFaceCheck == null ? disableObscuredFaceCheckConfig : disableObscuredFaceCheck; + Block con = getBlockOrFacade(world, x, y, z, dir.ordinal()); - Block obscuring = disableObscuredFaceCheck ? null : getBlockOrFacade(world, x2, y2, z2, dir.ordinal()); + Block obscuring = disableObscured ? null : getBlockOrFacade(world, x2, y2, z2, dir.ordinal()); // no block or a bad API user if (con == null) { @@ -252,11 +243,22 @@ public class CTM { } // check that we aren't already connected outwards from this side - ret &= !(obscuring.equals(block) && getBlockOrFacadeMetadata(world, x2, y2, z2, dir.ordinal()) == meta && Configurations.connectInsideCTM); + ret &= !(obscuring.equals(block) && getBlockOrFacadeMetadata(world, x2, y2, z2, dir.ordinal()) == meta); return ret; } + /** + * A utility method to access metadata from both the world and {@link IFacade} blocks in the world. + * + * @param world + * @param x + * @param y + * @param z + * @param side + * The side to check for. -1 for unknown. + * @return The metadata at this position in the world, or inside an {@link IFacade} block. + */ public int getBlockOrFacadeMetadata(IBlockAccess world, int x, int y, int z, int side) { Block blk = world.getBlock(x, y, z); if (blk instanceof IFacade) { @@ -265,6 +267,17 @@ public class CTM { return world.getBlockMetadata(x, y, z); } + /** + * A utility method to access a block from both the world and {@link IFacade} blocks in the world. + * + * @param world + * @param x + * @param y + * @param z + * @param side + * The side to check for. -1 for unknown. + * @return The block at this position in the world, or inside an {@link IFacade} block. + */ public Block getBlockOrFacade(IBlockAccess world, int x, int y, int z, int side) { Block blk = world.getBlock(x, y, z); if (blk instanceof IFacade) { diff --git a/src/main/java/com/cricketcraft/chisel/carving/CarvableHelper.java b/src/main/java/com/cricketcraft/chisel/carving/CarvableHelper.java index 87419c0f..581aa14d 100644 --- a/src/main/java/com/cricketcraft/chisel/carving/CarvableHelper.java +++ b/src/main/java/com/cricketcraft/chisel/carving/CarvableHelper.java @@ -16,7 +16,7 @@ import net.minecraftforge.oredict.OreDictionary; import org.apache.commons.lang3.ArrayUtils; import com.cricketcraft.chisel.Chisel; -import com.cricketcraft.chisel.client.render.CTM; +import com.cricketcraft.chisel.api.client.CTM; import com.cricketcraft.chisel.client.render.TextureSubmap; import com.cricketcraft.chisel.compat.FMPIntegration; import com.cricketcraft.chisel.item.ItemCarvable; diff --git a/src/main/java/com/cricketcraft/chisel/client/render/RenderBlocksCTM.java b/src/main/java/com/cricketcraft/chisel/client/render/RenderBlocksCTM.java index cedab2c0..b5b6ad3b 100644 --- a/src/main/java/com/cricketcraft/chisel/client/render/RenderBlocksCTM.java +++ b/src/main/java/com/cricketcraft/chisel/client/render/RenderBlocksCTM.java @@ -1,10 +1,11 @@ package com.cricketcraft.chisel.client.render; +import com.cricketcraft.chisel.api.client.CTM; + import net.minecraft.block.Block; import net.minecraft.client.renderer.RenderBlocks; import net.minecraft.client.renderer.Tessellator; import net.minecraft.util.IIcon; - import static com.cricketcraft.chisel.client.render.RenderBlocksCTM.Vert.*; import static com.cricketcraft.chisel.client.render.RenderBlocksCTM.SubSide.*; import static com.cricketcraft.chisel.client.render.RenderBlocksCTM.Vert.Y_HALF_X; diff --git a/src/main/java/com/cricketcraft/chisel/client/render/RenderBlocksCTMNoLight.java b/src/main/java/com/cricketcraft/chisel/client/render/RenderBlocksCTMNoLight.java index 541fe27c..03970684 100644 --- a/src/main/java/com/cricketcraft/chisel/client/render/RenderBlocksCTMNoLight.java +++ b/src/main/java/com/cricketcraft/chisel/client/render/RenderBlocksCTMNoLight.java @@ -1,5 +1,7 @@ package com.cricketcraft.chisel.client.render; +import com.cricketcraft.chisel.api.client.CTM; + import net.minecraft.block.Block; import net.minecraft.client.renderer.RenderBlocks; import net.minecraft.client.renderer.Tessellator; diff --git a/src/main/java/com/cricketcraft/chisel/client/render/RenderBlocksColumn.java b/src/main/java/com/cricketcraft/chisel/client/render/RenderBlocksColumn.java index 4e2874f8..ca04bfb0 100644 --- a/src/main/java/com/cricketcraft/chisel/client/render/RenderBlocksColumn.java +++ b/src/main/java/com/cricketcraft/chisel/client/render/RenderBlocksColumn.java @@ -1,5 +1,7 @@ package com.cricketcraft.chisel.client.render; +import com.cricketcraft.chisel.api.client.CTM; + import net.minecraft.block.Block; import net.minecraft.client.renderer.RenderBlocks; import net.minecraft.util.IIcon; diff --git a/src/main/java/com/cricketcraft/chisel/client/render/SubmapManagerFakeController.java b/src/main/java/com/cricketcraft/chisel/client/render/SubmapManagerFakeController.java index 8dbf9f7e..d0c485e4 100644 --- a/src/main/java/com/cricketcraft/chisel/client/render/SubmapManagerFakeController.java +++ b/src/main/java/com/cricketcraft/chisel/client/render/SubmapManagerFakeController.java @@ -5,10 +5,11 @@ import net.minecraft.client.renderer.texture.IIconRegister; import net.minecraft.util.IIcon; import net.minecraft.world.IBlockAccess; +import com.cricketcraft.chisel.api.client.CTM; import com.cricketcraft.chisel.carving.CarvableHelper.ISubmapManager; import com.cricketcraft.chisel.init.ChiselBlocks; -import static com.cricketcraft.chisel.client.render.CTM.Dir.*; +import static com.cricketcraft.chisel.api.client.Dir.*; public class SubmapManagerFakeController implements ISubmapManager { diff --git a/src/main/java/com/cricketcraft/chisel/config/Configurations.java b/src/main/java/com/cricketcraft/chisel/config/Configurations.java index 5e5e6c6a..ea05b6d1 100644 --- a/src/main/java/com/cricketcraft/chisel/config/Configurations.java +++ b/src/main/java/com/cricketcraft/chisel/config/Configurations.java @@ -2,8 +2,11 @@ package com.cricketcraft.chisel.config; import com.cricketcraft.chisel.Chisel; import com.cricketcraft.chisel.Features; +import com.cricketcraft.chisel.api.client.CTM; + import net.minecraft.item.ItemDye; import net.minecraftforge.common.config.Configuration; + import org.apache.commons.lang3.StringUtils; import java.util.Locale; @@ -85,7 +88,8 @@ public class Configurations { particlesTickrate = config.get(category, "particleTickrate", 1, "Particle tick rate. Greater value = less particles.").getInt(1); oldPillars = config.get(category, "pillarOldGraphics", false, "Use old pillar textures").getBoolean(false); disableCTM = !config.get(category, "connectedTextures", true, "Enable connected textures").getBoolean(true); - connectInsideCTM = !config.get(category, "connectInsideCTM", false, "Choose whether the inside corner is disconnected on a CTM block - http://imgur.com/eUywLZ4").getBoolean(false); + CTM.disableObscuredFaceCheckConfig = connectInsideCTM = !config.get(category, "connectInsideCTM", false, + "Choose whether the inside corner is disconnected on a CTM block - http://imgur.com/eUywLZ4").getBoolean(false); fancy = config.get(category, "fancyLeaves", true, "Enable fancy textures").getBoolean(true); blockDescriptions = config.get(category, "tooltipsUseBlockDescriptions", true, "Make variations of blocks have the same name, and use the description in tooltip to distinguish them.") .getBoolean(true);