cusack.hcg.gui

Class NewTheme<S extends PuzzleInstance>

java.lang.Object

cusack.hcg.gui.NewTheme<S>

Direct Known Subclasses:

GraphTheme, LightsTheme, MultiDesignsTheme, PebbleTheme, PortalLordTheme, PowerGraphTheme, WeightedTheme

public abstract class NewTheme<S extends PuzzleInstance>
extends java.lang.Object

Default Theme for drawing the graph and game configuration pieces. Not only does the class have default drawing methods, but it also deals with loading and storing advanced themes.

Author:

Eric DePree, Updated by Chuck Cusack, January 2010., Updated by Jeff Largent, July 2010.

Constructor Summary

Constructors

Constructor and Description
NewTheme()

Method Summary

Modifier and Type	Method and Description
void	draw(java.awt.Graphics g, S game, int width, int height, double scale)
abstract void	drawAnimation(java.awt.Graphics g, S game) Defines how the Theme subclass should handle animation.
void	drawBWVertex(java.awt.Graphics2D g, S game, Vertex v, java.awt.Point where)
void	drawNormalVertex(java.awt.Graphics2D g, S game, Vertex v) Draws a vertex in its normal state using the overridden drawVertex method.
void	drawSelectedVertex(java.awt.Graphics2D g, S game, Vertex v) Draws a vertex in its selected state using the overridden drawVertex method.
void	drawTargetVertex(java.awt.Graphics2D g, S game, Vertex v) Draws a vertex in its targeted state using the overridden drawVertex method.
abstract void	drawVertex(java.awt.Graphics2D g, S game, Vertex v) Dictates how a vertex should be drawn.
static int	getAnimationFrame()
abstract int[]	getAnimationStage(Vertex v, S game) Return a number or set of numbers that identifies what stage of drawing animation this vertex is at.
abstract int	getBoundingHeight() Defines the height of the box used to determine the clickable area of a vertex.
abstract int	getBoundingWidth() Defines the width of the box used to determine the clickable area of a vertex.
float	getBrightnessFactor() Returns the brightness factor drawing target vertices using the default drawTargetVertex method.
abstract int	getDrawingHeight() Defines the width of the drawable area of a vertex.
abstract int	getDrawingWidth() Defines the width of the drawable area of a vertex.
abstract java.awt.Color	getEdgeColor(S game, Vertex a, Vertex b) Defines the color used for drawing edges.
abstract int	getNumberAnimatingFrames()
static NewTheme<?>	getTheme(java.lang.String theme_name)
abstract java.lang.String	getThemeName()
abstract java.awt.Point	getVertexCenter() Defines the intended center point, relative to the origin (0, 0), on the image created by drawVertex.
java.util.ArrayList<Vertex>	getVerticesSortedByY(java.util.ArrayList<Vertex> vertsToSort) This method returns a list of all the vertices in the current graph.
boolean	isAnimatingConfig()
boolean	isBlinkEdges()
boolean	isDrawCurvyEdges()
void	setAnimatingConfig(boolean animatingConfig)
static void	setAnimationFrame(int animationFrame)
void	setBlinkEdges(boolean blinkEdges)
void	setDrawCurvyEdges(boolean drawCurvyEdges)
abstract void	setupMoveAnimation(DoubleVertexEvent<?> event) Assumes the event is a
void	tick()
void	tickIt() A convenience method to allow subclasses of Theme to override tick() while still retaining the basic animation advancing functionality.

Methods inherited from class java.lang.Object

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

Constructor Detail

NewTheme

public NewTheme()

Method Detail

getTheme

public static NewTheme<?> getTheme(java.lang.String theme_name)

getThemeName

public abstract java.lang.String getThemeName()

getBoundingWidth

public abstract int getBoundingWidth()

Defines the width of the box used to determine the clickable area of a vertex.

Returns:

the width of the bounding box

getBoundingHeight

public abstract int getBoundingHeight()

Defines the height of the box used to determine the clickable area of a vertex.

Returns:

the height of the bounding box

getDrawingWidth

public abstract int getDrawingWidth()

Defines the width of the drawable area of a vertex. This height is used as a parameter in creating the BufferedImage that contains a vertex's image, so it is important that nothing in drawVertex exceeds this height as it will be clipped.

Returns:

the height of the drawing box

getDrawingHeight

public abstract int getDrawingHeight()

Defines the width of the drawable area of a vertex. This width is used as a parameter in creating the BufferedImage that contains a vertex's image, so it is important that nothing in drawVertex exceeds this width as it will be clipped.

Returns:

the width of the drawing box

getVertexCenter

public abstract java.awt.Point getVertexCenter()

Defines the intended center point, relative to the origin (0, 0), on the image created by drawVertex. When drawn on a graph, a vertex will be centered over the intersection of its edges based on this point.

Returns:

the Point at the center of a vertex

setupMoveAnimation

public abstract void setupMoveAnimation(DoubleVertexEvent<?> event)

Assumes the event is a

Parameters:

event -

getNumberAnimatingFrames

public abstract int getNumberAnimatingFrames()

drawVertex

public abstract void drawVertex(java.awt.Graphics2D g,
                                S game,
                                Vertex v)

Dictates how a vertex should be drawn. The Theme methods drawNormalVertex, drawSelectedVertex, and drawTargetVertex all use this method to determine how to display vertices. As such, this method must draw everything relative to the origin (0, 0) as opposed to the vertex's coordinates. Also, everything drawn must fit within the area defined by the getDrawingWidth and getDrawingHeight methods.

Parameters:

g - The graphics object to draw on

game - The PuzzleInstance subclass containing game data

v - The vertex to be drawn

getEdgeColor

public abstract java.awt.Color getEdgeColor(S game,
                                            Vertex a,
                                            Vertex b)

Defines the color used for drawing edges. This includes both the default edge color and any other color the game should render based on the state of the game or the connected vertices.

Parameters:

game - The PuzzleInstance subclass containing game data

a - The first vertex connected by an edge

b - The second vertex connected by this edge

Returns:

the edge Color

drawAnimation

public abstract void drawAnimation(java.awt.Graphics g,
                                   S game)

Defines how the Theme subclass should handle animation. This pertains to anything outside the scope of drawing vertices or edges-- those are handled by the other vertex and edge draw methods (e.g. moving pebbles from one vertex to another).

Parameters:

g -

game -

getAnimationStage

public abstract int[] getAnimationStage(Vertex v,
                                        S game)

Return a number or set of numbers that identifies what stage of drawing animation this vertex is at. This is used as part of an identifier to cache images. The values of this should be used by the drawVertex method to determine which image from a strip should be used, etc.

Parameters:

game - TODO

tickIt

public void tickIt()

A convenience method to allow subclasses of Theme to override tick() while still retaining the basic animation advancing functionality.

tick

public void tick()

drawNormalVertex

public void drawNormalVertex(java.awt.Graphics2D g,
                             S game,
                             Vertex v)

Draws a vertex in its normal state using the overridden drawVertex method.

Parameters:

g - The graphics object to draw on

game - The PuzzleInstance subclass containing game data

v - The vertex to be drawn

drawTargetVertex

public void drawTargetVertex(java.awt.Graphics2D g,
                             S game,
                             Vertex v)

Draws a vertex in its targeted state using the overridden drawVertex method. By default, it animates the vertex glowing from dark to light and back again.

Parameters:

g - The graphics object to draw on

game - The PuzzleInstance subclass containing game data

v - The vertex to be drawn

drawBWVertex

public void drawBWVertex(java.awt.Graphics2D g,
                         S game,
                         Vertex v,
                         java.awt.Point where)

drawSelectedVertex

public void drawSelectedVertex(java.awt.Graphics2D g,
                               S game,
                               Vertex v)

Draws a vertex in its selected state using the overridden drawVertex method. By default, it draws the vertex surrounded by the yellow selected reticle.

Parameters:

g - The graphics object to draw on

game - The PuzzleInstance subclass containing game data

v - The vertex to be drawn

getBrightnessFactor

public float getBrightnessFactor()

Returns the brightness factor drawing target vertices using the default drawTargetVertex method. Can be overridden by subclasses to adjusted the brightness of the glow to the desired level.

Returns:

a float representing by how much target vertices' rgb values should be scaled.

draw

public void draw(java.awt.Graphics g,
                 S game,
                 int width,
                 int height,
                 double scale)

getVerticesSortedByY

public java.util.ArrayList<Vertex> getVerticesSortedByY(java.util.ArrayList<Vertex> vertsToSort)

This method returns a list of all the vertices in the current graph.

Returns:

A list of all the vertices in this graph

isDrawCurvyEdges

public boolean isDrawCurvyEdges()

setDrawCurvyEdges

public void setDrawCurvyEdges(boolean drawCurvyEdges)

isBlinkEdges

public boolean isBlinkEdges()

setBlinkEdges

public void setBlinkEdges(boolean blinkEdges)

getAnimationFrame

public static int getAnimationFrame()

setAnimationFrame

public static void setAnimationFrame(int animationFrame)

isAnimatingConfig

public boolean isAnimatingConfig()

Returns:

the animatingConfig

setAnimatingConfig

public void setAnimatingConfig(boolean animatingConfig)