shared.locations

Class VertexLocation

java.lang.Object

shared.locations.VertexLocation

public class VertexLocation
extends java.lang.Object

Represents the location of a vertex on a hex map

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
VertexLocation(HexLocation hexLoc, VertexDirection dir)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
VertexDirection	getDir()
HexLocation	getHexLoc()
VertexLocation	getNormalizedLocation() Returns a canonical (i.e., unique) value for this vertex location.
int	hashCode()
private void	setDir(VertexDirection direction)
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 VertexDirection dir

Constructor Detail

VertexLocation

public VertexLocation(HexLocation hexLoc,
                      VertexDirection dir)

Method Detail

getHexLoc

public HexLocation getHexLoc()

setHexLoc

private void setHexLoc(HexLocation hexLoc)

getDir

public VertexDirection getDir()

setDir

private void setDir(VertexDirection direction)

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

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

Returns:

Normalized vertex location