org.vizzini.ui.game.boardgame
Interface IGridBoard3DUISwing

All Superinterfaces:

IEnvironmentUI, IGridBoardUI, IGridBoardUISwing, IListener, IScoreListener, IStateListener

All Known Implementing Classes:

AbstractGridBoardUISwing, DefaultGridBoard3DUISwing, DefaultGridBoardUISwing, GridBoard3DUISwing, GridBoardUISwing

public interface IGridBoard3DUISwing
extends IGridBoardUISwing

Defines methods required by grid board 3D environment user interfaces in the game framework.

Since:

v0.2

Version:

v0.3

Author:

Jeffrey M. Thompson

Field Summary

static String

ARRANGEMENT_PROPERTY Arrangement property.

Method Summary

JMenu	createArrangementUI() Create an arrangement user interface widget.
Arrangement	getArrangement() Return the board arrangement.
double	getMagnify() Return the magnification.
Markings	getMarkings() Return the board markings.
void	setArrangement(Arrangement arrangement) Set the board arrangement.
void	setMagnify(double magnify) Set the magnification.
void	setMarkings(Markings markings, Color firstColor, Color secondColor) Set the board markings by adjusting their colors.

Methods inherited from interface org.vizzini.ui.game.boardgame.IGridBoardUISwing

add, clearCurrentHighlight, clearHighlights, clearLastMoveHighlight, clearSelectionHighlight, getBoardColor, getCurrentColor, getCurrentHighlightWidth, getFirstColor, getGridLineColor, getLabelColor, getLastMoveColor, getLastMoveHighlightWidth, getPositionForPoint, getSecondColor, getSelectionColor, getSelectionHighlightWidth, highlightCurrentPosition, highlightLastMovePosition, highlightSelectedPosition, isLabelPainted, remove, setBoardColor, setCurrentColor, setCurrentHighlightWidth, setFirstColor, setGridLineColor, setLabelColor, setLabelPainted, setLastMoveColor, setLastMoveHighlightWidth, setSecondColor, setSelectionColor, setSelectionHighlightWidth

Methods inherited from interface org.vizzini.ui.game.IEnvironmentUI

assignAgentListeners, configure, getEnvironment, isAudioOn, removeAgentListeners, reset, setAudioOn, setEnvironment

Methods inherited from interface org.vizzini.game.event.IStateListener

stateChange

Methods inherited from interface org.vizzini.game.event.IScoreListener

scoreChange

Field Detail

ARRANGEMENT_PROPERTY

static final String ARRANGEMENT_PROPERTY

Arrangement property.

See Also:

Constant Field Values

Method Detail

createArrangementUI

JMenu createArrangementUI()

Create an arrangement user interface widget.

Since:

v0.3

getArrangement

Arrangement getArrangement()

Return the board arrangement.

Returns:

UPRIGHT, CANT, SLANT, or SKEW.

Since:

v0.2

getMagnify

double getMagnify()

Return the magnification.

Since:

v0.3

getMarkings

Markings getMarkings()

Return the board markings.

Returns:

VARYING or CONSTANT.

Since:

v0.3

setArrangement

void setArrangement(Arrangement arrangement)

Set the board arrangement.

Parameters:

arrangement - The board arrangement, UPRIGHT, CANT, SLANT, or SKEW.

Since:

v0.2

setMagnify

void setMagnify(double magnify)

Set the magnification.

Parameters:

magnify - The new magnification.

Since:

v0.3

setMarkings

void setMarkings(Markings markings,
                 Color firstColor,
                 Color secondColor)

Set the board markings by adjusting their colors.

Parameters:

markings - The board markings, VARYING or CONSTANT.

firstColor - The color at 0,0.

secondColor - The other color.

Since:

v0.3