cusack.hcg.games.lights

Class LightsInstance

java.lang.Object

java.util.Observable

cusack.hcg.model.PuzzleInstance

cusack.hcg.games.lights.LightsInstance

All Implemented Interfaces:

DrawableGraphProblem, java.util.Observer

Direct Known Subclasses:

LightsOutInstance

public class LightsInstance
extends PuzzleInstance

Author:

Cusack, June 1, 2010

Constructor Summary

Constructors

Constructor and Description
LightsInstance()
LightsInstance(LightsInstance g)

Method Summary

Modifier and Type	Method and Description
PuzzleInstance	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.
VertexData	getDefaultVertexDataObject()
int	getNumberColors()
java.lang.String	getProcessedSolution() Probably not used.
int	getScore() Return the current score of the active game.
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	isEventForThisPuzzleType(Event<?> e) Return true iff this event is of type T.
boolean	isSolutionRefinable() For optimization problems, for instance, this will return true.
int	lightDown(Vertex v)
void	lightDownNeigborhood(Vertex v)
int	lightUp(Vertex v)
void	lightUpNeigborhood(Vertex v)
void	setNumberColors(int numberColors)
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.
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.
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.model.PuzzleInstance

addDoppelganger, addGraph, addGraphWithData, addToSelected, addToSelected, addVertex, canRedo, canUndo, checkAndHandlePuzzleCompletion, clearAllSelections, clearHistory, clearTutorial, computeGlobalPoints, connectAllSelectedVertices, connectToSelected, convertMovesToTutorial, copyPuzzleSoItHasInitialStateTheSameAsMyCurrentState, 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, setSolutionInformation, setUserID, setVisibleSources, startTimer, stopTimer, stringToPuzzleData, submit, toggleSelected, tutorialModeEnabled, undo, update, 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

LightsInstance

public LightsInstance()

LightsInstance

public LightsInstance(LightsInstance g)

Method Detail

copyPuzzle

public PuzzleInstance 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:

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:

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:

getNumberColors

public int getNumberColors()

setNumberColors

public void setNumberColors(int numberColors)

lightDownNeigborhood

public void lightDownNeigborhood(Vertex v)

lightUpNeigborhood

public void lightUpNeigborhood(Vertex v)

lightUp

public int lightUp(Vertex v)

lightDown

public int lightDown(Vertex v)

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.

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()

Probably not used. For now, we'll just return the solution data.

Specified by:

getProcessedSolution in class PuzzleInstance

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: