shared.locations

Class EdgeLocation

java.lang.Object

shared.locations.EdgeLocation

public class EdgeLocation
extends java.lang.Object

Represents the location of an edge on a hex map

Field Summary

Fields

Modifier and Type	Field and Description
private EdgeDirection	dir
private HexLocation	hexLoc

Constructor Summary

Constructors

Constructor and Description
EdgeLocation(HexLocation hexLoc, EdgeDirection dir)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
EdgeDirection	getDir()
HexLocation	getHexLoc()
EdgeLocation	getNormalizedLocation() Returns a canonical (i.e., unique) value for this edge location.
int	hashCode()
private void	setDir(EdgeDirection dir)
private void	setHexLoc(HexLocation hexLoc)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

hexLoc

private HexLocation hexLoc

dir

private EdgeDirection dir

Constructor Detail

EdgeLocation

public EdgeLocation(HexLocation hexLoc,
                    EdgeDirection dir)

Method Detail

getHexLoc

public HexLocation getHexLoc()

setHexLoc

private void setHexLoc(HexLocation hexLoc)

getDir

public EdgeDirection getDir()

setDir

private void setDir(EdgeDirection dir)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getNormalizedLocation

public EdgeLocation getNormalizedLocation()

Returns a canonical (i.e., unique) value for this edge location. Since each edge has two different locations on a map, this method converts a hex location to a single canonical form. This is useful for using hex locations as map keys.

Returns:

Normalized hex location