cusack.hcg.games.pebble.reachit

Class ReachItInstance

java.lang.Object

java.util.Observable

cusack.hcg.model.PuzzleInstance

cusack.hcg.games.pebble.PebbleInstance

cusack.hcg.games.pebble.PebbleMoveInstance

cusack.hcg.games.pebble.reachit.ReachItInstance

All Implemented Interfaces:

DrawableGraphProblem, java.util.Observer

public class ReachItInstance
extends PebbleMoveInstance

Author:

modified by Chuck Cusack, March, 2010.

Constructor Summary

Constructors

Constructor and Description
ReachItInstance()

Method Summary

Modifier and Type	Method and Description
ReachItInstance	copyPuzzle() Make a copy of this object, but not exactly! IMPORTANT: This copy should make a copy so that the copy's initial settings are set to this objects current settings.
int	getScore() Return the current score of the active game.
Vertex	getTargetVertex()
PuzzleInstance	getTryItInstanceForUseOnPlayScreen() What kind of puzzle should the TryIt button produce? Return null if Try it is not applicable
boolean	isCurrentStateValidSolution() Each instance needs to determine when the solution is valid.
boolean	isSolutionRefinable() For optimization problems, for instance, this will return true.
boolean	isValidSource(Vertex v) This is used to determine if a vertex is valid in whatever game mode is implemented.
void	setSolutionInformation(Solution solution) This method sets the solution data, such as the time taken by the user, and the previous score set by the user during their last play through.
void	setTargetVertex(Vertex targetVertex)
void	update(java.util.Observable o, java.lang.Object arg)
void	updateCovered()
void	updateStateBasedOnAlgorithmResult(java.lang.String algorithmResult) Updates the algorithm's state based on the algorithm result.
boolean	usesAlgorithms() If the game related to this problem requires running algorithms, this should return true.

Methods inherited from class cusack.hcg.games.pebble.PebbleInstance

addDoubleExtensionVertices, addExtensionVertices, addPebbles, addToNumberOfPebblingMoves, areAllCovered, areCovered, clearPebbles, clearPebbles, copyPuzzleSoItHasInitialStateTheSameAsMyCurrentState, coveredVerticesWithNoPebblesToString, efficientMovePebble, efficientUndoPebbleMove, getDefaultVertexDataObject, getNumberCoveredVertices, getNumberOfPebblingMoves, getNumberPebbles, getNumPebbles, getProcessedSolution, getState, isCovered, isEventForThisPuzzleType, isSolvable, isUncertain, isUnsolvable, movePebble, movePebbles, pebblesToString, recycle, removePebbles, setCovered, setCovered, setNumberOfPebblingMoves, setNumPebbles, setPebbles, setPebbles, setState, setUncovered, tryItResultsAreBinding, undoPebbleMove, undoPebbleMoves, undoRecycle, uniqueIdentifier

Methods inherited from class cusack.hcg.model.PuzzleInstance

addDoppelganger, addGraph, addGraphWithData, addToSelected, addToSelected, addVertex, canRedo, canUndo, checkAndHandlePuzzleCompletion, clearAllSelections, clearHistory, clearTutorial, computeGlobalPoints, connectAllSelectedVertices, connectToSelected, convertMovesToTutorial, 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, getSelectedVertices, getSolution, getSolutionAsString, getSolutionID, getThemeClassName, getTimeTaken, getTopOfUndoStack, getTutorialData, getUserID, getVertexIndex, getVertices, getVisibility, getVisibleSources, goToNextEvent, grossHistoryDeleteLastEvent, grossHistoryGetLastAddedEvent, grossHistoryGetNextEvent, grossHistoryGetNextEventIndex, grossHistoryIsSaved, grossHistoryIteratorAtBeginning, grossHistoryIteratorAtEnd, grossHistoryNext, grossHistoryPrevious, grossHistorySetSaved, grossHistorySize, grossHistoryToBeginning, grossHistoryToEnd, initialPuzzleDataToString, isFinishable, isInReplayOrEditTutorialMode, isLocked, isLowerScoreBetter, isPlayable, isSaved, isShowIndices, 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, setUserID, setVisibleSources, startTimer, stopTimer, stringToPuzzleData, submit, toggleSelected, tutorialModeEnabled, undo, updateTimeTaken

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

ReachItInstance

public ReachItInstance()

Method Detail

update

public void update(java.util.Observable o,
                   java.lang.Object arg)

Specified by:

update in interface java.util.Observer

Overrides:

update in class PuzzleInstance

updateCovered

public void updateCovered()

isValidSource

public boolean isValidSource(Vertex v)

Description copied from class: PebbleInstance

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.

Specified by:

isValidSource in class PebbleInstance

copyPuzzle

public ReachItInstance copyPuzzle()

Description copied from class: PuzzleInstance

Make a copy of this object, but not exactly! IMPORTANT: This copy should make a copy so that the copy's initial settings are set to this objects current settings. This can probably just call the copy constructor defined in the subclass. This method should simply call the copy constructor for the puzzle.

Specified by:

copyPuzzle in class PuzzleInstance

Returns:

getTargetVertex

public Vertex getTargetVertex()

setTargetVertex

public void setTargetVertex(Vertex targetVertex)

getScore

public int getScore()

Description copied from class: PuzzleInstance

Return the current score of the active game. For many games this will simply be: return getNumberMoves(); For others it will be something else.

Specified by:

getScore in class PuzzleInstance

Returns:

isSolutionRefinable

public boolean isSolutionRefinable()

Description copied from class: PuzzleInstance

For optimization problems, for instance, this will return true. For decision problems, this will generally return false.

Specified by:

isSolutionRefinable in class PuzzleInstance

Returns:

true if the solution can be defined.

usesAlgorithms

public boolean usesAlgorithms()

Description copied from class: PuzzleInstance

If the game related to this problem requires running algorithms, this should return true. In addition there must be a class in the game package called FooAlgorithmRunner.

Specified by:

usesAlgorithms in class PuzzleInstance

Returns:

true if this problem requires running algorithms.

isCurrentStateValidSolution

public boolean isCurrentStateValidSolution()

Description copied from class: PuzzleInstance

Each instance needs to determine when the solution is valid.

Specified by:

isCurrentStateValidSolution in class PuzzleInstance

Returns:

true if the current state is a valid solution.

updateStateBasedOnAlgorithmResult

public void updateStateBasedOnAlgorithmResult(java.lang.String algorithmResult)

Description copied from class: PuzzleInstance

Updates the algorithm's state based on the algorithm result. (This is mostly for Confound It and Optimize It, but it may be useful for other things.)

Specified by:

updateStateBasedOnAlgorithmResult in class PuzzleInstance

Parameters:

algorithmResult - a boolean that describes the result of the algorithm.

getTryItInstanceForUseOnPlayScreen

public PuzzleInstance getTryItInstanceForUseOnPlayScreen()

Description copied from class: PuzzleInstance

What kind of puzzle should the TryIt button produce? Return null if Try it is not applicable

Specified by:

getTryItInstanceForUseOnPlayScreen in class PuzzleInstance

Returns:

a subclass of PuzzleInstance that the TryIt button should produce.

setSolutionInformation

public void setSolutionInformation(Solution solution)

Description copied from class: PuzzleInstance

This method sets the solution data, such as the time taken by the user, and the previous score set by the user during their last play through.

Overrides:

setSolutionInformation in class PuzzleInstance

Parameters:

solution - The database class that holds the necessary information