shared.model.map.handlers

Class HexHandler

java.lang.Object

shared.model.map.handlers.HexHandler

All Implemented Interfaces:

java.io.Serializable

public class HexHandler
extends java.lang.Object
implements java.io.Serializable

Stores and manages the hexes contained in a map.

Author:

Jonathan Sadler

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.Integer,Hex>	hexes
private static int	MAX_SIZE
private static long	serialVersionUID
private static int	Y_SHIFT

Constructor Summary

Constructors

Constructor and Description
HexHandler() Creates a HexHandler object.

Method Summary

Modifier and Type	Method and Description
void	AddHex(Hex hex) Adds a hex object to the handler.
boolean	ContainsHex(Coordinate point) Determines if a hex is contained at the location.
boolean	equals(java.lang.Object obj)
java.util.Iterator<Hex>	GetAllHexes() Gets all the hexes in the map.
static Coordinate	GetBottomLeft(Coordinate point)
static Coordinate	GetBottomRight(Coordinate point)
Hex	GetHex(Coordinate point) Gets the hex at the given coordinate.
private int	GetKey(Coordinate point)
private int	GetKey(Hex hex)
static Coordinate	GetLeft(Coordinate point)
static Coordinate	GetRight(Coordinate point)
static Coordinate	GetTopLeft(Coordinate point)
static Coordinate	GetTopRight(Coordinate point)
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

MAX_SIZE

private static final int MAX_SIZE

See Also:

Constant Field Values

Y_SHIFT

private static final int Y_SHIFT

See Also:

Constant Field Values

hexes

private java.util.Map<java.lang.Integer,Hex> hexes

Constructor Detail

HexHandler

public HexHandler()

Creates a HexHandler object.

Method Detail

AddHex

public void AddHex(Hex hex)
            throws MapException

Adds a hex object to the handler.

Parameters:

hex - The hex to add.

Throws:

MapException - Thrown if attempting to add to many hexes or duplicate hexes.

ContainsHex

public boolean ContainsHex(Coordinate point)

Determines if a hex is contained at the location.

Parameters:

x - The coordinate of the hex.

Returns:

True if yes, else false.

GetHex

public Hex GetHex(Coordinate point)
           throws MapException

Gets the hex at the given coordinate.

Parameters:

x - The coordinate of the hex.

Returns:

The assocaited hex.

Throws:

MapException

GetAllHexes

public java.util.Iterator<Hex> GetAllHexes()

Gets all the hexes in the map.

Returns:

A iterator to all the hexes.

GetTopLeft

public static Coordinate GetTopLeft(Coordinate point)

GetTopRight

public static Coordinate GetTopRight(Coordinate point)

GetRight

public static Coordinate GetRight(Coordinate point)

GetBottomRight

public static Coordinate GetBottomRight(Coordinate point)

GetBottomLeft

public static Coordinate GetBottomLeft(Coordinate point)

GetLeft

public static Coordinate GetLeft(Coordinate point)

GetKey

private int GetKey(Hex hex)

GetKey

private int GetKey(Coordinate point)

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