org.flexgen.map
Class MapTileEdgePosition

java.lang.Object
  org.flexgen.map.MapTileEdgePosition

public class MapTileEdgePosition
extends java.lang.Object

Class representing the positions of the four edges on a map tile.

Field Summary

static MapTileEdgePosition	BOTTOM Position of the bottom edge of the map tile.
static MapTileEdgePosition	LEFT Position of the left edge of the map tile.
static MapTileEdgePosition	RIGHT Position of the right edge of the map tile.
static MapTileEdgePosition	TOP Position of the top edge of the map tile.

Method Summary

boolean	equals(java.lang.Object obj) Determines whether or not this map tile edge position is equal to another map tile edge position.
static MapTileEdgePosition	get(int index) Get the map tile edge position that corresponds with the specified index.
int	getIndex() Get the index of the map tile edge position.
int	hashCode() Returns a hash code value for the object.
java.lang.String	toString() Get the string representation of this object.

Methods inherited from class java.lang.Object

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

Field Detail

TOP

public static final MapTileEdgePosition TOP

Position of the top edge of the map tile.

RIGHT

public static final MapTileEdgePosition RIGHT

Position of the right edge of the map tile.

BOTTOM

public static final MapTileEdgePosition BOTTOM

Position of the bottom edge of the map tile.

LEFT

public static final MapTileEdgePosition LEFT

Position of the left edge of the map tile.

Method Detail

get

public static MapTileEdgePosition get(int index)

Get the map tile edge position that corresponds with the specified index.

Parameters:

index - Index of the map tile edge position to get.

Returns:

The map tile edge position that corresponds with the specified index.

getIndex

public int getIndex()

Get the index of the map tile edge position. Used when looking up a specific map tile edge in an array containing all of the map tile edges of a map tile.

Returns:

The index of the map tile edge position.

toString

public java.lang.String toString()

Get the string representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

The string representation of this object.

equals

public boolean equals(java.lang.Object obj)

Determines whether or not this map tile edge position is equal to another map tile edge position.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The map tile edge position against which to compare this map tile edge position.

Returns:

True if the two map tile edge positions are equal, false otherwise.

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class java.lang.Object

Returns:

A hash code value for this object.