Package gui

Class GUI

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

gui.GUI

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class GUI
extends JFrame

An instance is a GUI for the game. Run this
file as a Java application to test the project.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JFrame

JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow, Window.Type

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	animating	Whether the GUI is doing an animation
protected DiverSprite	diver	The panel for updating and drawing the diver
static int	FRAMES_PER_MOVE	Frame rate of game (fps) and frames a single move takes
static int	FRAMES_PER_SECOND	Frame rate of game (fps) and frames a single move takes
static final double	GAME_HEIGHT_PROP	Width and height of the game portion (proportion of total)
static final double	GAME_WIDTH_PROP	Width and height of the game portion (proportion of total)
protected MazePanel	mazePanel	The panel for generating and drawing the maze
protected OptionsPanel	options	The panel for showing stats / displaying options
static int	SCREEN_HEIGHT	Width and height of the entire screen
static int	SCREEN_WIDTH	Width and height of the entire screen

Fields inherited from class javax.swing.JFrame

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
GUI(Sewers sewers, int diverRow, int diverCol, long seed, GameState gs)	Constructor: a new display for sewer system with the diver at (diverRow, diverCol) using random number seed seed and overseen by GameState gs.

Method Summary

Modifier and Type	Method	Description
void	displayError(String e)	Display error e to the player.
void	finishAnimating()
BufferedImage	getCoinIcon(Node n)	Return an icon for the coins on tile n, or null if no coins.
BufferedImage	getIcon(Tile.TileType tileType)	Return an image representing tile type.
MazePanel	getMazePanel()	Return the MazePanel associated with this GUI.
OptionsPanel	getOptionsPanel()	Return the OptionsPanel associated with this GUI.
boolean	isAnimating()
void	moveTo(Node dest)	Move the diver on the GUI to destination dest, and block until the diver has completed the move.
void	selectNode(Node n)	Select node n on the GUI. This displays information on that node's panel on the screen.
void	setLighting(boolean light)	Set the sewer system to be all light or all dark, depending on light.
void	startAnimating()
void	updateBonus(double bonus)	Update the bonus multiplier as displayed by the GUI by bonus
void	updateCoins(int coins, int score)	Update the number of coins picked up as displayed on the GUI.
void	updateSewer(Sewers c, int numStepsToGo)	What is the specification?
void	updateStepsToGo(int stepsLeft)	Update the steps remaining as displayed on the GUI to stepsLeft.

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Details

SCREEN_WIDTH

public static int SCREEN_WIDTH

Width and height of the entire screen

SCREEN_HEIGHT

public static int SCREEN_HEIGHT

Width and height of the entire screen

GAME_WIDTH_PROP

public static final double GAME_WIDTH_PROP

Width and height of the game portion (proportion of total)

See Also:

• Constant Field Values

GAME_HEIGHT_PROP

public static final double GAME_HEIGHT_PROP

Width and height of the game portion (proportion of total)

See Also:

• Constant Field Values

FRAMES_PER_SECOND

public static int FRAMES_PER_SECOND

Frame rate of game (fps) and frames a single move takes

FRAMES_PER_MOVE

public static int FRAMES_PER_MOVE

Frame rate of game (fps) and frames a single move takes

mazePanel

protected MazePanel mazePanel

The panel for generating and drawing the maze

diver

protected DiverSprite diver

The panel for updating and drawing the diver

options

protected OptionsPanel options

The panel for showing stats / displaying options

animating

protected boolean animating

Whether the GUI is doing an animation

Constructor Details

GUI

public GUI(Sewers sewers,
 int diverRow,
 int diverCol,
 long seed,
 GameState gs)

Constructor: a new display for sewer system with the diver at
(diverRow, diverCol) using random number seed seed and overseen by GameState gs.

Method Details

getMazePanel

public MazePanel getMazePanel()

Return the MazePanel associated with this GUI.

getOptionsPanel

public OptionsPanel getOptionsPanel()

Return the OptionsPanel associated with this GUI.

moveTo

public void moveTo(Node dest)

Move the diver on the GUI to destination dest, and block until the diver has completed the move. Requires: dest is adjacent to the diver's current location

updateBonus

public void updateBonus(double bonus)

Update the bonus multiplier as displayed by the GUI by bonus

updateCoins

public void updateCoins(int coins,
 int score)

Update the number of coins picked up as displayed on the GUI.

Parameters:

coins - the number of coins to be displayed

score - the player's current score

updateStepsToGo

public void updateStepsToGo(int stepsLeft)

Update the steps remaining as displayed on the GUI to stepsLeft.

updateSewer

public void updateSewer(Sewers c,
 int numStepsToGo)

What is the specification?

setLighting

public void setLighting(boolean light)

Set the sewer system to be all light or all dark, depending on light.

getIcon

public BufferedImage getIcon(Tile.TileType tileType)

Return an image representing tile type.

getCoinIcon

public BufferedImage getCoinIcon(Node n)

Return an icon for the coins on tile n, or null if no coins.

selectNode

public void selectNode(Node n)

Select node n on the GUI.
This displays information on that node's panel on the screen.

displayError

public void displayError(String e)

Display error e to the player.

startAnimating

public void startAnimating()

isAnimating

public boolean isAnimating()

finishAnimating

public void finishAnimating()