moving clipping plane functionality to convenience class so that mods can use it as well

Mumfrey
1 parent 0a1da0c9
Showing 7 changed files with 202 additions and 102 deletions
java/client/com/mumfrey/liteloader/client/gui/GuiLiteLoaderPanel.java
java/client/com/mumfrey/liteloader/client/gui/GuiModListEntry.java
java/client/com/mumfrey/liteloader/client/gui/GuiPanel.java
java/client/com/mumfrey/liteloader/client/gui/GuiPanelConfigContainer.java
java/client/com/mumfrey/liteloader/client/gui/GuiPanelMods.java
java/client/com/mumfrey/liteloader/client/gui/GuiScrollPanel.java
java/client/com/mumfrey/liteloader/client/util/GLClippingPlanes.java
@@ -2,7 +2,6 @@ package com.mumfrey.liteloader.client.gui;
 import static org.lwjgl.opengl.GL11.*;
-import java.nio.DoubleBuffer;
 import java.util.ArrayList;
 import java.util.List;
@@ -16,7 +15,6 @@ import net.minecraft.client.resources.I18n;
 import net.minecraft.util.IIcon;
 import net.minecraft.util.ResourceLocation;
-import org.lwjgl.BufferUtils;
 import org.lwjgl.input.Keyboard;
 import org.lwjgl.input.Mouse;
@@ -55,13 +53,6 @@ public class GuiLiteLoaderPanel extends GuiScreen
 	static final int PANEL_BOTTOM    = 26;
 	private static final double TWEEN_RATE = 0.08;
-
-	/**
-	 * Used for clipping
-	 */
-	private static DoubleBuffer doubleBuffer = BufferUtils.createByteBuffer(64).asDoubleBuffer();
-	
-	private static int clippingPlaneFlags = 0;
 	private static boolean displayErrorToolTip = true;
@@ -770,79 +761,4 @@ public class GuiLiteLoaderPanel extends GuiScreen
 	{
 		glDrawTexturedRect(x, y, icon.getIconWidth(), icon.getIconHeight(), icon.getMinU(), icon.getMinV(), icon.getMaxU(), icon.getMaxV(), alpha);
 	}
-	
-	/**
-	 * Enable OpenGL clipping planes (uses planes 2, 3, 4 and 5)
-	 * 
-	 * @param xLeft Left edge clip or -1 to not use this plane
-	 * @param xRight Right edge clip or -1 to not use this plane
-	 * @param yTop Top edge clip or -1 to not use this plane
-	 * @param yBottom Bottom edge clip or -1 to not use this plane
-	 */
-	final static void glEnableClipping(int xLeft, int xRight, int yTop, int yBottom)
-	{
-		clippingPlaneFlags = 0;
-		
-		// Apply left edge clipping if specified
-		if (xLeft != -1)
-		{
-			doubleBuffer.clear();
-			doubleBuffer.put(1).put(0).put(0).put(-xLeft).flip();
-			glClipPlane(GL_CLIP_PLANE2, doubleBuffer);
-			glEnable(GL_CLIP_PLANE2);
-			clippingPlaneFlags |= GL_CLIP_PLANE2;
-		}
-		
-		// Apply right edge clipping if specified
-		if (xRight != -1)
-		{
-			doubleBuffer.clear();
-			doubleBuffer.put(-1).put(0).put(0).put(xRight).flip();
-			glClipPlane(GL_CLIP_PLANE3, doubleBuffer);
-			glEnable(GL_CLIP_PLANE3);
-			clippingPlaneFlags |= GL_CLIP_PLANE3;
-		}
-		
-		// Apply top edge clipping if specified
-		if (yTop != -1)
-		{
-			doubleBuffer.clear();
-			doubleBuffer.put(0).put(1).put(0).put(-yTop).flip();
-			glClipPlane(GL_CLIP_PLANE4, doubleBuffer);
-			glEnable(GL_CLIP_PLANE4);
-			clippingPlaneFlags |= GL_CLIP_PLANE4;
-		}
-		
-		// Apply bottom edge clipping if specified
-		if (yBottom != -1)
-		{
-			doubleBuffer.clear();
-			doubleBuffer.put(0).put(-1).put(0).put(yBottom).flip();
-			glClipPlane(GL_CLIP_PLANE5, doubleBuffer);
-			glEnable(GL_CLIP_PLANE5);
-			clippingPlaneFlags |= GL_CLIP_PLANE5;
-		}
-	}
-	
-	/**
-	 * Enable clipping planes which were previously enabled 
-	 */
-	final static void glEnableClipping()
-	{
-		if ((clippingPlaneFlags & GL_CLIP_PLANE2) == GL_CLIP_PLANE2) glEnable(GL_CLIP_PLANE2);
-		if ((clippingPlaneFlags & GL_CLIP_PLANE3) == GL_CLIP_PLANE3) glEnable(GL_CLIP_PLANE3);
-		if ((clippingPlaneFlags & GL_CLIP_PLANE4) == GL_CLIP_PLANE4) glEnable(GL_CLIP_PLANE4);
-		if ((clippingPlaneFlags & GL_CLIP_PLANE5) == GL_CLIP_PLANE5) glEnable(GL_CLIP_PLANE5);
-	}
-	
-	/**
-	 * Disable OpenGL clipping planes (uses planes 2, 3, 4 and 5)
-	 */
-	final static void glDisableClipping()
-	{
-		glDisable(GL_CLIP_PLANE5);
-		glDisable(GL_CLIP_PLANE4);
-		glDisable(GL_CLIP_PLANE3);
-		glDisable(GL_CLIP_PLANE2);
-	}
 }
 \ No newline at end of file
 package com.mumfrey.liteloader.client.gui;
+import static com.mumfrey.liteloader.client.util.GLClippingPlanes.*;
 import static org.lwjgl.opengl.GL11.*;
 import java.util.ArrayList;
@@ -273,9 +274,9 @@ public class GuiModListEntry extends Gui
 			String tooltipText = icon.getDisplayText();
 			if (tooltipText != null)
 			{
-				GuiLiteLoaderPanel.glDisableClipping();
+				glDisableClipping();
 				GuiLiteLoaderPanel.drawTooltip(this.fontRenderer, tooltipText, mouseX, mouseY, 4096, 4096, GuiModListEntry.WHITE, GuiModListEntry.BLEND_HALF & GuiModListEntry.BLACK);
-				GuiLiteLoaderPanel.glEnableClipping();
+				glEnableClipping();
 			}
 			if (icon instanceof IconClickable) this.mouseOverIcon = (IconClickable)icon;
@@ -323,7 +324,7 @@ public class GuiModListEntry extends Gui
 		this.mouseOverScrollBar = this.isMouseOver(mouseX, mouseY, xPosition + width - 5, yPos, 5, scrollHeight);
-		GuiLiteLoaderPanel.glEnableClipping(-1, -1, yPos, bottom - 3);
+		glEnableClipping(-1, -1, yPos, bottom - 3);
 		this.fontRenderer.drawSplitString(this.description, xPosition + 5, yPos - this.scrollBar.getValue(), width - 11, GuiModListEntry.DESCRIPTION_COLOUR);
 	}
@@ -207,15 +207,4 @@ public abstract class GuiPanel extends Gui
 		glAlphaFunc(GL_GREATER, 0.1F); 
 		glDisable(GL_BLEND);
 	}
-
-
-	protected static final void glEnableClipping(int xLeft, int xRight, int yTop, int yBottom)
-	{
-		GuiLiteLoaderPanel.glEnableClipping(xLeft, xRight, yTop, yBottom);
-	}
-	
-	protected static final void glDisableClipping()
-	{
-		GuiLiteLoaderPanel.glDisableClipping();
-	}
 }
 \ No newline at end of file
 package com.mumfrey.liteloader.client.gui;
+import static com.mumfrey.liteloader.client.util.GLClippingPlanes.*;
 import static org.lwjgl.opengl.GL11.*;
 import net.minecraft.client.Minecraft;
 import net.minecraft.client.gui.GuiButton;
 package com.mumfrey.liteloader.client.gui;
+import static com.mumfrey.liteloader.client.util.GLClippingPlanes.*;
 import static org.lwjgl.opengl.GL11.*;
 import java.util.ArrayList;
@@ -7,6 +8,10 @@ import java.util.List;
 import java.util.Map;
 import java.util.TreeMap;
+import net.minecraft.client.Minecraft;
+import net.minecraft.client.gui.GuiButton;
+import net.minecraft.client.resources.I18n;
+
 import org.lwjgl.input.Keyboard;
 import com.mumfrey.liteloader.LiteMod;
@@ -19,10 +24,6 @@ import com.mumfrey.liteloader.launch.LoaderEnvironment;
 import com.mumfrey.liteloader.modconfig.ConfigManager;
 import com.mumfrey.liteloader.modconfig.ConfigPanel;
-import net.minecraft.client.Minecraft;
-import net.minecraft.client.gui.GuiButton;
-import net.minecraft.client.resources.I18n;
-
 /**
  * Mods panel
  * 
 package com.mumfrey.liteloader.client.gui;
+import static com.mumfrey.liteloader.client.util.GLClippingPlanes.*;
 import static org.lwjgl.opengl.GL11.*;
 import net.minecraft.client.Minecraft;
 import net.minecraft.client.gui.GuiButton;
+package com.mumfrey.liteloader.client.util;
+
+import static org.lwjgl.opengl.GL11.*;
+
+import java.nio.DoubleBuffer;
+
+import org.lwjgl.BufferUtils;
+import org.lwjgl.util.Rectangle;
+
+/**
+ * OpenGL clipping plane convenience functions. We prefer to clip rectangular GUI regions in Minecraft using
+ * clipping rather than scissor because scissor is a nuisance to work with, primarily because it works in
+ * "window" (OpenGL window) coordinates and doesn't respect the current transformation matrix. Using clipping
+ * planes we can specify clipping edges in "Minecraft screen coordinates", can optionally clip on only one or
+ * two axes, and also don't need to worry about the current transform. 
+ * 
+ * @author Adam Mummery-Smith
+ */
+public final class GLClippingPlanes
+{
+	public enum Plane
+	{
+		LEFT(GL_CLIP_PLANE0),
+		RIGHT(GL_CLIP_PLANE1),
+		TOP(GL_CLIP_PLANE2),
+		BOTTOM(GL_CLIP_PLANE3);
+		
+		final int plane;
+		final int sign;
+		
+		private Plane(int plane)
+		{
+			this.plane = plane;
+			this.sign = (plane % 2 == 0) ? -1 : 1;
+		}
+	}
+	
+	private static final int STACK_DEPTH = 1;
+	private static final int STACK_FRAME_SIZE = 128;
+	
+	private static DoubleBuffer doubleBuffer = BufferUtils.createByteBuffer(STACK_FRAME_SIZE * STACK_DEPTH).asDoubleBuffer();
+	
+	private static int clippingPlaneFlags = 0;
+	
+	private static int totalClippingPlanes = glGetInteger(GL_MAX_CLIP_PLANES);
+	
+//	private static int frame = 0;
+	
+	static
+	{
+		for (int f = 0; f < STACK_DEPTH; f++)
+		{
+			// Clipping normals
+			GLClippingPlanes.doubleBuffer.put(1).put(0).put(0).put(0);
+			GLClippingPlanes.doubleBuffer.put(-1).put(0).put(0).put(0);
+			GLClippingPlanes.doubleBuffer.put(0).put(1).put(0).put(0);
+			GLClippingPlanes.doubleBuffer.put(0).put(-1).put(0).put(0);
+		}
+	}
+
+	private GLClippingPlanes() {}
+	
+	/**
+	 * Get the total number of available clipping planes on the platform
+	 */
+	public static int glGetTotalClippingPlanes()
+	{
+		return GLClippingPlanes.totalClippingPlanes;
+	}
+	
+	/**
+	 * Enable OpenGL clipping planes (uses planes 0, 1, 2 and 3)
+	 * 
+	 * @param left Left edge clip or -1 to not use this plane
+	 * @param right Right edge clip or -1 to not use this plane
+	 * @param top Top edge clip or -1 to not use this plane
+	 * @param bottom Bottom edge clip or -1 to not use this plane
+	 */
+	public static void glEnableClipping(int left, int right, int top, int bottom)
+	{
+		GLClippingPlanes.clippingPlaneFlags = 0;
+		
+		glEnableClipping(GL_CLIP_PLANE0, left, -1);
+		glEnableClipping(GL_CLIP_PLANE1, right, 1);
+		glEnableClipping(GL_CLIP_PLANE2, top, -1);
+		glEnableClipping(GL_CLIP_PLANE3, bottom, 1);
+	}
+
+	/**
+	 * Enable OpenGL clipping planes (uses planes 0, 1, 2 and 3)
+	 * 
+	 * @param rect Clipping rectangle
+	 */
+	public static void glEnableClipping(Rectangle rect)
+	{
+		GLClippingPlanes.clippingPlaneFlags = 0;
+		
+		glEnableClipping(GL_CLIP_PLANE0, rect.getX(), -1);
+		glEnableClipping(GL_CLIP_PLANE1, rect.getX() + rect.getWidth(), 1);
+		glEnableClipping(GL_CLIP_PLANE2, rect.getY(), -1);
+		glEnableClipping(GL_CLIP_PLANE3, rect.getY() + rect.getHeight(), 1);
+	}
+	
+	/**
+	 * Enable horizontal clipping planes (left and right) (uses planes 0, 1)
+	 * 
+	 * @param left Left edge clip or -1 to not use this plane
+	 * @param right Right edge clip or -1 to not use this plane
+	 */
+	public static void glEnableHorizontalClipping(int left, int right)
+	{
+		glEnableClipping(GL_CLIP_PLANE0, left, -1);
+		glEnableClipping(GL_CLIP_PLANE1, right, 1);
+	}
+	
+	/**
+	 * Enable vertical clipping planes (top and bottom) (uses planes 2, 3)
+	 * 
+	 * @param top Top edge clip or -1 to not use this plane
+	 * @param bottom Bottom edge clip or -1 to not use this plane
+	 */
+	public static void glEnableVerticalClipping(int top, int bottom)
+	{
+		glEnableClipping(GL_CLIP_PLANE2, top, -1);
+		glEnableClipping(GL_CLIP_PLANE3, bottom, 1);
+	}
+	
+	/**
+	 * @param plane
+	 * @param value
+	 */
+	public static void glEnableClipping(int plane, int value)
+	{
+		if (plane < GL_CLIP_PLANE0 || plane >= (GL_CLIP_PLANE0 + GLClippingPlanes.totalClippingPlanes))
+		{
+			throw new IllegalArgumentException("Invalid clipping plane enum specified GL_CLIP_PLANE" + (plane - GL_CLIP_PLANE0));
+		}
+		
+		glEnableClipping(plane, value, (plane % 2 == 0) ? -1 : 1); 
+	}
+	
+	/**
+	 * @param plane
+	 * @param value
+	 */
+	public static void glEnableClipping(Plane plane, int value)
+	{
+		glEnableClipping(plane.plane, value, plane.sign); 
+	}
+	
+	/**
+	 * Enable clipping on a particular axis
+	 * 
+	 * @param plane Clipping plane to enable
+	 * @param value Clipping plane position
+	 * @param sign Sign of the position
+	 */
+	private static void glEnableClipping(int plane, int value, int sign)
+	{
+		if (value == -1) return;
+		
+		int offset = (plane - GL_CLIP_PLANE0) << 2;
+		GLClippingPlanes.doubleBuffer.put(offset + 3, value * sign).position(offset);
+		GLClippingPlanes.clippingPlaneFlags |= plane;
+		
+		glClipPlane(plane, GLClippingPlanes.doubleBuffer);
+		glEnable(plane);
+	}
+	
+	/**
+	 * Enable clipping planes which were previously enabled 
+	 */
+	public static void glEnableClipping()
+	{
+		if ((GLClippingPlanes.clippingPlaneFlags & GL_CLIP_PLANE0) == GL_CLIP_PLANE0) glEnable(GL_CLIP_PLANE0);
+		if ((GLClippingPlanes.clippingPlaneFlags & GL_CLIP_PLANE1) == GL_CLIP_PLANE1) glEnable(GL_CLIP_PLANE1);
+		if ((GLClippingPlanes.clippingPlaneFlags & GL_CLIP_PLANE2) == GL_CLIP_PLANE2) glEnable(GL_CLIP_PLANE2);
+		if ((GLClippingPlanes.clippingPlaneFlags & GL_CLIP_PLANE3) == GL_CLIP_PLANE3) glEnable(GL_CLIP_PLANE3);
+	}
+	
+	/**
+	 * Disable OpenGL clipping planes (uses planes 2, 3, 4 and 5)
+	 */
+	public static void glDisableClipping()
+	{
+		glDisable(GL_CLIP_PLANE3);
+		glDisable(GL_CLIP_PLANE2);
+		glDisable(GL_CLIP_PLANE1);
+		glDisable(GL_CLIP_PLANE0);
+	}
+}