com.lukflug.panelstudio.mc8fabric

Class GLInterface

java.lang.Object

com.lukflug.panelstudio.mc8fabric.GLInterface

All Implemented Interfaces:

IInterface

Direct Known Subclasses:

MinecraftGUI.GUIInterface

public abstract class GLInterface
extends java.lang.Object
implements IInterface

Implementation of IInterface for OpenGL in Minecraft.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	clipX Boolean indicating whether to clip in the horizontal direction.

Fields inherited from interface com.lukflug.panelstudio.base.IInterface

ALT, CTRL, LBUTTON, RBUTTON, SHIFT, SUPER

Constructor Summary

Constructors

Constructor and Description
GLInterface(boolean clipX) Constructor.

Method Summary

Modifier and Type	Method and Description
void	begin(boolean matrix) Set OpenGL to the state used by the rendering methods.
void	drawImage(java.awt.Rectangle r, int rotation, boolean parity, int image, java.awt.Color color) Draw an image.
void	drawLine(java.awt.Point a, java.awt.Point b, java.awt.Color c1, java.awt.Color c2) Draw a line on the screen.
void	drawRect(java.awt.Rectangle r, java.awt.Color c1, java.awt.Color c2, java.awt.Color c3, java.awt.Color c4) Draw the outline of an axis-aligned rectangle on the screen.
void	drawString(java.awt.Point pos, int height, java.lang.String s, java.awt.Color c) Draw a string on the screen.
void	end(boolean matrix) Restore OpenGL to the state expected by Minecraft.
void	fillRect(java.awt.Rectangle r, java.awt.Color c1, java.awt.Color c2, java.awt.Color c3, java.awt.Color c4) Draw an axis-aligned rectangle on the screen.
void	fillTriangle(java.awt.Point pos1, java.awt.Point pos2, java.awt.Point pos3, java.awt.Color c1, java.awt.Color c2, java.awt.Color c3) Draw a triangle on the screen.
int	getFontWidth(int height, java.lang.String s) Get the font width of a string being rendered by IInterface.drawString(Point, int, String, Color)
boolean	getModifier(int modifier) Method to query a keyboard modifier.
protected abstract java.lang.String	getResourcePrefix() Get the Minecraft resource location string.
protected double	getScreenHeight() Get the current screen height.
protected double	getScreenWidth() Get the current screen width.
java.awt.Dimension	getWindowSize() Get size of display.
protected abstract float	getZLevel() Get the z-coordinate to render everything.
java.awt.Point	guiToScreen(java.awt.Point p) Utility function to convert PanelStudio GUI coordinates to screen pixel coordinates.
int	loadImage(java.lang.String name) Load an image into memory and return a number that may be used to draw that image.
void	restore() Restore the clipping to the previous state.
protected void	scissor(java.awt.Rectangle r) Utility function to set clipping rectangle.
java.awt.Point	screenToGui(java.awt.Point p) Utility function to convert screen pixel coordinates to PanelStudio GUI coordinates.
void	window(java.awt.Rectangle r) Clip all rendering on screen outside the intersection of the specified rectangle and the current clipping rectangle.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.lukflug.panelstudio.base.IInterface

drawImage, getButton, getMouse, getTime

Field Detail

clipX

protected boolean clipX

Boolean indicating whether to clip in the horizontal direction.

Constructor Detail

GLInterface

public GLInterface(boolean clipX)

Constructor.

Parameters:

clipX - whether to clip in the horizontal direction

Method Detail

getModifier

public boolean getModifier(int modifier)

Description copied from interface: IInterface

Method to query a keyboard modifier. May be called by any GUI-related method.

Specified by:

getModifier in interface IInterface

Parameters:

modifier - the ID of the modifier

Returns:

true if the keyboard modifier key is down

See Also:

IInterface.SHIFT, IInterface.CTRL, IInterface.ALT, IInterface.SUPER

getWindowSize

public java.awt.Dimension getWindowSize()

Description copied from interface: IInterface

Get size of display.

Specified by:

getWindowSize in interface IInterface

Returns:

the display size

drawString

public void drawString(java.awt.Point pos,
                       int height,
                       java.lang.String s,
                       java.awt.Color c)

Description copied from interface: IInterface

Draw a string on the screen. May only be called in a GUI rendering method.

Specified by:

drawString in interface IInterface

Parameters:

pos - the position of the string on the screen

height - the height of the font

s - the string to be displayed

c - the color of the string to be displayed

getFontWidth

public int getFontWidth(int height,
                        java.lang.String s)

Description copied from interface: IInterface

Get the font width of a string being rendered by IInterface.drawString(Point, int, String, Color)

Specified by:

getFontWidth in interface IInterface

Parameters:

height - the height of the string

s - the string to be considered

Returns:

the font width

fillTriangle

public void fillTriangle(java.awt.Point pos1,
                         java.awt.Point pos2,
                         java.awt.Point pos3,
                         java.awt.Color c1,
                         java.awt.Color c2,
                         java.awt.Color c3)

Description copied from interface: IInterface

Draw a triangle on the screen. The color of the triangle should ideally be smoothly interpolated. May only be called in a GUI rendering method.

Specified by:

fillTriangle in interface IInterface

Parameters:

pos1 - the first corner of the triangle

pos2 - the second corner of the triangle

pos3 - the third corner of the triangle

c1 - the color at the first corner

c2 - the color at the second corner

c3 - the color at the third corner

drawLine

public void drawLine(java.awt.Point a,
                     java.awt.Point b,
                     java.awt.Color c1,
                     java.awt.Color c2)

Description copied from interface: IInterface

Draw a line on the screen. The color of the line should ideally be smoothly interpolated. May only be called in a GUI rendering method.

Specified by:

drawLine in interface IInterface

Parameters:

a - the start of the line

b - the end of the line

c1 - the color at the start of the line

c2 - the color at the end of the line

fillRect

public void fillRect(java.awt.Rectangle r,
                     java.awt.Color c1,
                     java.awt.Color c2,
                     java.awt.Color c3,
                     java.awt.Color c4)

Description copied from interface: IInterface

Draw an axis-aligned rectangle on the screen. The color of the rectangle should ideally be smoothly interpolated. May only be called in a GUI rendering method.

Specified by:

fillRect in interface IInterface

Parameters:

r - the rectangle to be rendered

c1 - the color at the top-left corner of the rectangle

c2 - the color at the top-right corner of the rectangle

c3 - the color at the bottom-right corner of the rectangle

c4 - the color at the bottom-left corner of the rectangle

drawRect

public void drawRect(java.awt.Rectangle r,
                     java.awt.Color c1,
                     java.awt.Color c2,
                     java.awt.Color c3,
                     java.awt.Color c4)

Description copied from interface: IInterface

Draw the outline of an axis-aligned rectangle on the screen. The color of the rectangle should ideally be smoothly interpolated. May only be called in a GUI rendering method.

Specified by:

drawRect in interface IInterface

Parameters:

r - the rectangle to be rendered

c1 - the color at the top-left corner of the rectangle

c2 - the color at the top-right corner of the rectangle

c3 - the color at the bottom-right corner of the rectangle

c4 - the color at the bottom-left corner of the rectangle

loadImage

public int loadImage(java.lang.String name)

Description copied from interface: IInterface

Load an image into memory and return a number that may be used to draw that image. Should only be called during initialization. The name string should ideally be the filename of the image, not including the path, since the implementation of this interface must ideally provide the directory in which the images are located.

Specified by:

loadImage in interface IInterface

Parameters:

name - a string indicating the location of the image to be loaded

Returns:

a number identifying the image

See Also:

IInterface.drawImage(Rectangle, int, boolean, int), IInterface.drawImage(Rectangle, int, boolean, int, Color)

drawImage

public void drawImage(java.awt.Rectangle r,
                      int rotation,
                      boolean parity,
                      int image,
                      java.awt.Color color)

Description copied from interface: IInterface

Draw an image.

Specified by:

drawImage in interface IInterface

Parameters:

r - the rectangle specifying the position of the image

rotation - the rotation of the image in units of 90 degrees counter-clockwise

parity - if true, will flip the image around the vertical axis

image - the number identifying the image

color - the color to modulate the image by

See Also:

IInterface.loadImage(String)

scissor

protected void scissor(java.awt.Rectangle r)

Utility function to set clipping rectangle.

Parameters:

r - the clipping rectangle

window

public void window(java.awt.Rectangle r)

Description copied from interface: IInterface

Clip all rendering on screen outside the intersection of the specified rectangle and the current clipping rectangle. May only be called in a GUI rendering method. The calling method should restore clipping by calling IInterface.restore() after rendering.

Specified by:

window in interface IInterface

Parameters:

r - the clipping rectangle

See Also:

IInterface.restore()

restore

public void restore()

Description copied from interface: IInterface

Restore the clipping to the previous state.

Specified by:

restore in interface IInterface

See Also:

IInterface.window(Rectangle)

screenToGui

public java.awt.Point screenToGui(java.awt.Point p)

Utility function to convert screen pixel coordinates to PanelStudio GUI coordinates.

Parameters:

p - the screen coordinates

Returns:

the corresponding GUI coordinates

guiToScreen

public java.awt.Point guiToScreen(java.awt.Point p)

Utility function to convert PanelStudio GUI coordinates to screen pixel coordinates.

Parameters:

p - the GUI coordinates

Returns:

the corresponding screen coordinates

getScreenWidth

protected double getScreenWidth()

Get the current screen width.

Returns:

the screen width

getScreenHeight

protected double getScreenHeight()

Get the current screen height.

Returns:

the screen height

begin

public void begin(boolean matrix)

Set OpenGL to the state used by the rendering methods. Should be called before rendering.

Parameters:

matrix - whether to set up the modelview matrix

end

public void end(boolean matrix)

Restore OpenGL to the state expected by Minecraft. Should be called after rendering.

Parameters:

matrix - whether to restore the modelview matrix

getZLevel

protected abstract float getZLevel()

Get the z-coordinate to render everything.

Returns:

the z-level

getResourcePrefix

protected abstract java.lang.String getResourcePrefix()

Get the Minecraft resource location string.

Returns:

the resource prefix