cusack.hcg.events.graph

Class VertexMoveEvent

java.lang.Object

cusack.hcg.events.BaseEvent<S>

cusack.hcg.events.MultiVertexEvent<PuzzleInstance>

cusack.hcg.events.MultiVertexGraphEditEvent

cusack.hcg.events.SingleVertexGraphEditEvent

cusack.hcg.events.graph.VertexMoveEvent

All Implemented Interfaces:

Event<PuzzleInstance>, GraphEvent, MoveEvent, OneVertexEvent, RecordableEvent

public class VertexMoveEvent
extends SingleVertexGraphEditEvent
implements MoveEvent

Fired when a vertex is moved. This will be fired when a vertex is moved even just 1 pixel

Author:

Eric DePree, Modified by Chuck Cusack, Feb 2010

Field Summary

Fields inherited from interface cusack.hcg.events.graph.MoveEvent

SQUARE_OF_DISTANCE_THRESHOLD

Constructor Summary

Constructors

Constructor and Description
VertexMoveEvent(PuzzleInstance game)
VertexMoveEvent(PuzzleInstance game, Vertex vertex, java.awt.Point coords)

Method Summary

Modifier and Type	Method and Description
java.awt.Point	getChange()
java.lang.String	getDefaultBeforeActionComment()
java.lang.String	getDefaultBetweenActionComment()
java.lang.String	getDefaultIntroductoryComment()
java.lang.String	getEventName() Return the name of the event for printing.
java.awt.Point	getNewLocation()
Event<PuzzleInstance>	inverseEvent() This is the method that will be called by the public method getInverseEvent.
boolean	isSameEvent(Event arg)
void	takebackSideEffects() Implement anything special that has to be done after a move has been taken back.
void	updateNewLocations()

Methods inherited from class cusack.hcg.events.SingleVertexGraphEditEvent

getVertex, involvesMultipleVertices, involvesOneVertex, setVertex

Methods inherited from class cusack.hcg.events.MultiVertexGraphEditEvent

modifiedGraph

Methods inherited from class cusack.hcg.events.MultiVertexEvent

contains, containsAll, decodeData, getPrintableDetails, getVertex, getVertices, hasExactlyTheseVertices, performEvent, reallyDecodeData, size, vertsToString

Methods inherited from class cusack.hcg.events.BaseEvent

canUserGenerate, clearComments, encodeEvent, encodeEvents, equals, getAfterActionComment, getBeforeActionComment, getBetweenActionComment, getGame, getIntroductoryComment, getInverseEvent, getRealAfterActionComment, getRealBeforeActionComment, getRealBetweenActionComment, getRealIntroductoryComment, getTimeSinceFirstEvent, hashCode, isCreatedFromConstructor, modifiedPuzzle, performInverseEvent, performTakebackEvent, setAfterActionComment, setBeforeActionComment, setBetweenActionComment, setCreatedFromConstructor, setGame, setIntroductoryComment, setTimeSinceFirstEvent, toString, toStringWithoutTime

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VertexMoveEvent

public VertexMoveEvent(PuzzleInstance game)

VertexMoveEvent

public VertexMoveEvent(PuzzleInstance game,
                       Vertex vertex,
                       java.awt.Point coords)

Method Detail

updateNewLocations

public void updateNewLocations()

Specified by:

updateNewLocations in interface MoveEvent

getChange

public java.awt.Point getChange()

Returns:

the change

inverseEvent

public Event<PuzzleInstance> inverseEvent()

Description copied from class: BaseEvent

This is the method that will be called by the public method getInverseEvent. Although a bit weird, it is done this way because that method sets the time of the inverse event, so we want them to call that one. We don't want every class to have to remember to do that part.

Returns:

isSameEvent

public boolean isSameEvent(Event arg)

Specified by:

isSameEvent in interface Event<PuzzleInstance>

Overrides:

isSameEvent in class MultiVertexEvent<PuzzleInstance>

getNewLocation

public java.awt.Point getNewLocation()

getDefaultIntroductoryComment

public java.lang.String getDefaultIntroductoryComment()

Specified by:

getDefaultIntroductoryComment in interface Event<PuzzleInstance>

Specified by:

getDefaultIntroductoryComment in class BaseEvent<PuzzleInstance>

getDefaultBeforeActionComment

public java.lang.String getDefaultBeforeActionComment()

Specified by:

getDefaultBeforeActionComment in interface Event<PuzzleInstance>

Specified by:

getDefaultBeforeActionComment in class BaseEvent<PuzzleInstance>

getDefaultBetweenActionComment

public java.lang.String getDefaultBetweenActionComment()

Specified by:

getDefaultBetweenActionComment in interface Event<PuzzleInstance>

Specified by:

getDefaultBetweenActionComment in class BaseEvent<PuzzleInstance>

getEventName

public java.lang.String getEventName()

Description copied from class: BaseEvent

Return the name of the event for printing.

Specified by:

getEventName in class BaseEvent<PuzzleInstance>

Returns:

takebackSideEffects

public void takebackSideEffects()

Description copied from interface: Event

Implement anything special that has to be done after a move has been taken back. For instance, if it is a pebbling move, a vertex might need to be listed as uncovered, but that isn't a normal part of undoing a pebble move.

Specified by:

takebackSideEffects in interface Event<PuzzleInstance>

Overrides:

takebackSideEffects in class MultiVertexGraphEditEvent