cusack.hcg.games.pebble

Class PebbleInstance

java.lang.Object

java.util.Observable

cusack.hcg.model.PuzzleInstance

cusack.hcg.games.pebble.PebbleInstance

All Implemented Interfaces:

DrawableGraphProblem, java.util.Observer

Direct Known Subclasses:

PebbleMoveInstance, PebblePlaceInstance

public abstract class PebbleInstance
extends PuzzleInstance

This class extends the game instance class so that Pebble It specific information can be stored in this class that is necessary to play pebble it. This class is also necessary so that the game instance class stays separate enough to be generic to all different game types. This class also contains all the information about the vertices that is needed to play pebble it, such as the number of pebbles on each, whether or not a vertex is covered, etc.

Author:

Kevin?, modified by Charles Cusack, Oct 2009. Again drastically in Feb 2010, and again in April 2010.

Constructor Summary

Constructors

Constructor and Description
PebbleInstance()

Method Summary

Modifier and Type	Method and Description
void	addDoubleExtensionVertices() Adds 2n vertices and connects each vertex in the original graph to a path of length 2.
void	addExtensionVertices() Adds n vertices and connects each one to a vertex in the original graph.
boolean	addPebbles(Vertex vert, int toAdd) Do not use this or the next method in games unless you want the event to be recorded.
void	addToNumberOfPebblingMoves(int toAdd) Or subtract if you use a negative number.
boolean	areAllCovered()
boolean[]	areCovered()
void	clearPebbles()
void	clearPebbles(Vertex vert)
PuzzleInstance	copyPuzzleSoItHasInitialStateTheSameAsMyCurrentState() Copies the puzzle so that it has an initial state that is the same as this puzzle's current state.
java.lang.String	coveredVerticesWithNoPebblesToString()
void	efficientMovePebble(Vertex from, Vertex to) This is identical to movePebble but it does NOT do any checking to see that the move is actually valid.
void	efficientUndoPebbleMove(Vertex from, Vertex to)
VertexData	getDefaultVertexDataObject()
int	getNumberCoveredVertices() This method returns the total number of the vertices that are currently covered.
int	getNumberOfPebblingMoves()
int	getNumberPebbles() This method gets the total number of pebbles that are currently on the board.
int	getNumPebbles(Vertex v) This method returns the number of pebbles that are currently on a particular vertex.
java.lang.String	getProcessedSolution()
PebbleAlgorithmStates	getState()
boolean	isCovered(Vertex v) This method checks to see whether or not a vertex is covered or uncovered.
boolean	isEventForThisPuzzleType(Event<?> e) Return true iff this event is of type T.
boolean	isSolvable()
boolean	isUncertain()
boolean	isUnsolvable()
abstract boolean	isValidSource(Vertex v) This is used to determine if a vertex is valid in whatever game mode is implemented.
boolean	movePebble(Vertex from, Vertex to) This method causes a move pebble event to occur so that two pebbles are removed from the "from" vertex and one is added to the "to" vertex.
boolean	movePebbles(Vertex from, Vertex to, int numberToMove)
java.lang.String	pebblesToString() Since different games may want to convert pebble list to string, this is here.
void	recycle() This method causes a recycle event to occur which notifies the listeners of this class using a reset event.
boolean	removePebbles(Vertex vert, int toSubtract) Notice that this sets a vertex uncovered when it has no pebbles.
void	setCovered(java.lang.String vertexList) A space-separated list of the indices of the vertices to set covered.
void	setCovered(Vertex vertex) Adds a vertex to the covered set.
void	setNumberOfPebblingMoves(int numberOfPebblingMoves)
void	setNumPebbles(Vertex v, int num) This method sets the number of pebbles on a specific vertex
void	setPebbles(int[] config) Places new PebbleData on each vertex in the PebbleInstance according to the configuration given
void	setPebbles(java.lang.String pebbleList)
void	setState(PebbleAlgorithmStates state) This game is a bit odd.
void	setUncovered(Vertex vertex) Removes a vertex to the covered set.
boolean	tryItResultsAreBinding() Return true only if Try It mode, using the type from getTryItInstance, will produce a result that is AWLAYS valid for the puzzle type.
void	undoPebbleMove(Vertex from, Vertex to) This method causes an undo move event where the previous move is undone and two pebbles are added to the "from" vertex and one is removed from the "to" vertex.
void	undoPebbleMoves(Vertex from, Vertex to, int numMoved)
void	undoRecycle(java.lang.String pebbles) The assumption here is that you can't actually undo a recycle.
java.lang.String	uniqueIdentifier(Vertex v) Return a string that represents the data related to the given Vertex in a way that is different if the data is different.

Methods inherited from class cusack.hcg.model.PuzzleInstance

addDoppelganger, addGraph, addGraphWithData, addToSelected, addToSelected, addVertex, canRedo, canUndo, checkAndHandlePuzzleCompletion, clearAllSelections, clearHistory, clearTutorial, computeGlobalPoints, connectAllSelectedVertices, connectToSelected, convertMovesToTutorial, copyPuzzle, copyRequested, copySelected, createNewVertexForPuzzle, currentPuzzleDataToString, deleteSelected, disableHistory, disconnectFromSelected, disconnectSelected, doNotRecordGraphEvents, enableHistory, endGame, forceRedo, getAttemptName, getBasePoints, getCurrentAnnotation, getCurrentMoveOverview, getCurrentUndoableEvent, getData, getDescription, getDiameter, getDifficultyLevel, getEdgeDataClassName, getEditHelpClassName, getEditorClassName, getFamilyName, getFirstSelected, getFirstTimeBonus, getGameName, getGlobalBest, getGraph, getHelpClassName, getHighScoreBonus, getImprovementBonus, getInstanceClassName, getInterestingTutorialVertices, getMaximumXCoordinate, getMaximumYCoordinate, getMessage, getMinimumSelectedXCoordinate, getMinimumSelectedYCoordinate, getMinimumXCoordinate, getMinimumYCoordinate, getMode, getNumberOfEdges, getNumberOfMoves, getNumberOfVertices, getNumberSelected, getOldHighScore, getPersonalBest, getPlayClassName, getPuzzleID, getPuzzleInstanceName, getPuzzleName, getScore, getSelectedVertices, getSolution, getSolutionAsString, getSolutionID, getThemeClassName, getTimeTaken, getTopOfUndoStack, getTryItInstanceForUseOnPlayScreen, getTutorialData, getUserID, getVertexIndex, getVertices, getVisibility, getVisibleSources, goToNextEvent, grossHistoryDeleteLastEvent, grossHistoryGetLastAddedEvent, grossHistoryGetNextEvent, grossHistoryGetNextEventIndex, grossHistoryIsSaved, grossHistoryIteratorAtBeginning, grossHistoryIteratorAtEnd, grossHistoryNext, grossHistoryPrevious, grossHistorySetSaved, grossHistorySize, grossHistoryToBeginning, grossHistoryToEnd, initialPuzzleDataToString, isCurrentStateValidSolution, isFinishable, isInReplayOrEditTutorialMode, isLocked, isLowerScoreBetter, isPlayable, isSaved, isShowIndices, isSolutionRefinable, isSpecialCopyOK, isTutorial, isValidToTranslationSelection, isVisibleSource, makeCurrentStateInitialState, moveGraphEnded, moveSelectedVerticesEnded, moveStarted, pasteAndConnectCopyOfSelected, pasteCopyOfSelected, performEvents, performEvents, performTutorialEvents, reallySetLocked, recordGraphEvents, redo, removeFromSelected, removeFromSelected, resetVerticesToInitialLocations, restart, runAlgorithms, runuTryIt, selectAll, sendAlgorithmResult, sendMeaninglessEvent, setAttemptName, setData, setDefaultData, setDescription, setFinishable, setGlobalBest, setGraph, setInReplayOrEditTutorialMode, setLocked, setMessage, setMode, setPersonalBest, setPlayable, setPuzzle, setPuzzleID, setPuzzleName, setSaved, setShowIndices, setSolutionData, setSolutionID, setSolutionInformation, setUserID, setVisibleSources, startTimer, stopTimer, stringToPuzzleData, submit, toggleSelected, tutorialModeEnabled, undo, update, updateStateBasedOnAlgorithmResult, updateTimeTaken, usesAlgorithms

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

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

Constructor Detail

PebbleInstance

public PebbleInstance()

Method Detail

getNumberOfPebblingMoves

public int getNumberOfPebblingMoves()

setNumberOfPebblingMoves

public void setNumberOfPebblingMoves(int numberOfPebblingMoves)

addToNumberOfPebblingMoves

public void addToNumberOfPebblingMoves(int toAdd)

Or subtract if you use a negative number.

copyPuzzleSoItHasInitialStateTheSameAsMyCurrentState

public PuzzleInstance copyPuzzleSoItHasInitialStateTheSameAsMyCurrentState()

Description copied from class: PuzzleInstance

Copies the puzzle so that it has an initial state that is the same as this puzzle's current state.

Overrides:

copyPuzzleSoItHasInitialStateTheSameAsMyCurrentState in class PuzzleInstance

Returns:

the a copy of this puzzle.

isEventForThisPuzzleType

public boolean isEventForThisPuzzleType(Event<?> e)

Description copied from class: PuzzleInstance

Return true iff this event is of type T. Stupid method that is necessary because Java is dumb. One would like to ask 'if(x instanceof T)', but since Java throws away Generics at runtime, it doesn't know what T is, so you can't ask this. This is an important method because (I think) that this is the only thing that ensure the right sort of objects are placed on history and the wrong ones aren't. Since the UndoRedoHistory is not properly parameterized (don't get me started on how much I hate Generics in Java) I think this method is the only thing that makes sure that if an RecordableEvent calls its performEvent method, that the PuzzleInstance object passed in is the correct one (for instance, a PebbleInstance must be passed if movePebbles is called since otherwise the program will crash). This may only be used in one place, but it is still necessary. CAC, Feb 2010.

Specified by:

isEventForThisPuzzleType in class PuzzleInstance

Returns:

pebblesToString

public java.lang.String pebblesToString()

Since different games may want to convert pebble list to string, this is here.

Returns:

setPebbles

public void setPebbles(java.lang.String pebbleList)

setPebbles

public void setPebbles(int[] config)

Places new PebbleData on each vertex in the PebbleInstance according to the configuration given

Parameters:

pInstance - the game that you want to place new pebbles on

config - the number of pebbles to be placed on each vertex

coveredVerticesWithNoPebblesToString

public java.lang.String coveredVerticesWithNoPebblesToString()

setCovered

public void setCovered(java.lang.String vertexList)

A space-separated list of the indices of the vertices to set covered.

Parameters:

vertexList -

movePebble

public boolean movePebble(Vertex from,
                          Vertex to)

This method causes a move pebble event to occur so that two pebbles are removed from the "from" vertex and one is added to the "to" vertex. This method also causes a move event to be fired to all classes that are listening to this class.

Parameters:

from - The vertex from which the pebbles are being moved

to - The vertex to which the pebble is being moved

Returns:

Whether or not the move was successful

movePebbles

public boolean movePebbles(Vertex from,
                           Vertex to,
                           int numberToMove)

undoPebbleMove

public void undoPebbleMove(Vertex from,
                           Vertex to)

This method causes an undo move event where the previous move is undone and two pebbles are added to the "from" vertex and one is removed from the "to" vertex. This method doesn't (Yes it does...) fire any events to listeners. We are assuming the undo is legal--in other words, we do not check adjacency or that 'to' has at least one pebble. Bad us. Oh well. Sue us.

Parameters:

from - The vertex that the pebbles originally moved from

to - The vertex that the pebble was originally moved to

undoPebbleMoves

public void undoPebbleMoves(Vertex from,
                            Vertex to,
                            int numMoved)

undoRecycle

public void undoRecycle(java.lang.String pebbles)

The assumption here is that you can't actually undo a recycle. Therefore the only time this can be called is in tutorial mode or replay.

Parameters:

pebbles -

recycle

public void recycle()

This method causes a recycle event to occur which notifies the listeners of this class using a reset event.

addPebbles

public boolean addPebbles(Vertex vert,
                          int toAdd)

Do not use this or the next method in games unless you want the event to be recorded.

Parameters:

vert -

toSubtract -

Returns:

removePebbles

public boolean removePebbles(Vertex vert,
                             int toSubtract)

Notice that this sets a vertex uncovered when it has no pebbles. Because of this and the fired event, it should not be used by games which perform pebbling moves.

Parameters:

vert -

toSubtract -

Returns:

clearPebbles

public void clearPebbles(Vertex vert)

clearPebbles

public void clearPebbles()

efficientMovePebble

public void efficientMovePebble(Vertex from,
                                Vertex to)

This is identical to movePebble but it does NOT do any checking to see that the move is actually valid. It also does not deal with NetHistory events, etc.

Parameters:

from - The vertex that the pebbles are being moved from

to - The vertex that the pebble is being moved to

efficientUndoPebbleMove

public void efficientUndoPebbleMove(Vertex from,
                                    Vertex to)

getNumberCoveredVertices

public int getNumberCoveredVertices()

This method returns the total number of the vertices that are currently covered. This demonstrates the one weakness of the current method of storing covered. I still like it better than the old, though.

Returns:

int The number of covered vertices

setNumPebbles

public void setNumPebbles(Vertex v,
                          int num)

This method sets the number of pebbles on a specific vertex

Parameters:

v - The vertex that needs to be changed

num - The new number of pebbles

getNumPebbles

public int getNumPebbles(Vertex v)

This method returns the number of pebbles that are currently on a particular vertex.

Parameters:

v - The vertex that is being checked

Returns:

int The number of pebbles on the vertex

getNumberPebbles

public int getNumberPebbles()

This method gets the total number of pebbles that are currently on the board.

Returns:

int The total number of pebbles on the graph

isCovered

public boolean isCovered(Vertex v)

This method checks to see whether or not a vertex is covered or uncovered.

Parameters:

v - The vertex to be checked

Returns:

boolean true if the vertex is covered and false otherwise

areCovered

public boolean[] areCovered()

setCovered

public void setCovered(Vertex vertex)

Adds a vertex to the covered set. This is used when creating a new puzzle and you add a pebble to a vertex that previously did not have any.

Parameters:

vertex - The vertex to be covered

setUncovered

public void setUncovered(Vertex vertex)

Removes a vertex to the covered set. This is used when creating a new puzzle and you add a pebble to a vertex that previously did not have any.

Parameters:

vertex - The vertex to be covered

areAllCovered

public boolean areAllCovered()

isValidSource

public abstract boolean isValidSource(Vertex v)

This is used to determine if a vertex is valid in whatever game mode is implemented. e.g. for Rock It, a vertex has to have at least 2 pebbles. This is needed so that if a single vertex is highlighted, it can be appropriately handled.

tryItResultsAreBinding

public boolean tryItResultsAreBinding()

Description copied from class: PuzzleInstance

Return true only if Try It mode, using the type from getTryItInstance, will produce a result that is AWLAYS valid for the puzzle type. For instance, in Optimize it, valid is solvable, and if in Try It the player shows it is solvable, then it is correct. On the other hand Confound It is not binding because if you play it and don't find it solvable, that doesn't mean anything.

Specified by:

tryItResultsAreBinding in class PuzzleInstance

getProcessedSolution

public java.lang.String getProcessedSolution()

Specified by:

getProcessedSolution in class PuzzleInstance

getState

public PebbleAlgorithmStates getState()

isSolvable

public boolean isSolvable()

isUnsolvable

public boolean isUnsolvable()

isUncertain

public boolean isUncertain()

setState

public void setState(PebbleAlgorithmStates state)

This game is a bit odd. Since an external algorithm is used to determine whether or not it is solved, that algorithm has to tell it the answer. When the state is set, we need to notify listeners if it is unsolvable since that is the game completion criteria.

Parameters:

state - the current state of the game.

getDefaultVertexDataObject

public VertexData getDefaultVertexDataObject()

Specified by:

getDefaultVertexDataObject in class PuzzleInstance

uniqueIdentifier

public java.lang.String uniqueIdentifier(Vertex v)

Description copied from class: PuzzleInstance

Return a string that represents the data related to the given Vertex in a way that is different if the data is different. e.g. if the only data is number of pebbles, it can just return the number of pebbles as a string. If there is no real data, returning an empty string is acceptable.

Specified by:

uniqueIdentifier in class PuzzleInstance

Returns:

addExtensionVertices

public void addExtensionVertices()

Adds n vertices and connects each one to a vertex in the original graph. This is useful in 2PP algorithms.

addDoubleExtensionVertices

public void addDoubleExtensionVertices()

Adds 2n vertices and connects each vertex in the original graph to a path of length 2. This is useful in 2PP algorithms.