net.sf.gridarta.action.exportmap.PendingInfo Class Reference

Preliminary layout information for a map. More...

Collaboration diagram for net.sf.gridarta.action.exportmap.PendingInfo:

Public Member Functions
int	getX (final int width)
	Returns the x coordinate of the next map. More...
int	getY (final int height)
	Returns the y coordinate of the next map. More...
	PendingInfo (@NotNull final Direction direction, final int x, final int y)
	Creates a new instance. More...

Private Attributes
final Direction	direction
	The direction from which the map was discovered. More...
final int	x
	The x coordinate of the border between the previous and the next map. More...
final int	y
	The y coordinate of the border between the previous and the next map. More...

Detailed Description

Preliminary layout information for a map.

Definition at line 28 of file PendingInfo.java.

Constructor & Destructor Documentation

PendingInfo()

net.sf.gridarta.action.exportmap.PendingInfo.PendingInfo	(	@NotNull final Direction	direction,
		final int	x,
		final int	y
	)

Creates a new instance.

Parameters

direction	the direction from which the map was discovered; may be NORTH , EAST , SOUTH , WEST , or UP
x	the x coordinate of the border between the previous and the next map.
y	the y coordinate of the border between the previous and the next map.

Definition at line 57 of file PendingInfo.java.

References net.sf.gridarta.action.exportmap.PendingInfo.direction, net.sf.gridarta.action.exportmap.PendingInfo.x, and net.sf.gridarta.action.exportmap.PendingInfo.y.

Member Function Documentation

getX()

int net.sf.gridarta.action.exportmap.PendingInfo.getX

(

final int

width

)

Returns the x coordinate of the next map.

Parameters

width

the width of the previous map

Returns

the x coordinate of the next map

Definition at line 85 of file PendingInfo.java.

References net.sf.gridarta.action.exportmap.PendingInfo.direction, and net.sf.gridarta.action.exportmap.PendingInfo.x.

getY()

int net.sf.gridarta.action.exportmap.PendingInfo.getY

(

final int

height

)

Returns the y coordinate of the next map.

Parameters

height

the height of the previous map

Returns

the y coordinate of the next map

Definition at line 111 of file PendingInfo.java.

References net.sf.gridarta.action.exportmap.PendingInfo.direction, and net.sf.gridarta.action.exportmap.PendingInfo.y.

Member Data Documentation

direction

final Direction net.sf.gridarta.action.exportmap.PendingInfo.direction

private

The direction from which the map was discovered.

May be one of

NORTH 

,

EAST 

,

SOUTH 

,

WEST 

, or

UP 

. The value

UP 

is used for the initial map.

Definition at line 36 of file PendingInfo.java.

Referenced by net.sf.gridarta.action.exportmap.PendingInfo.getX(), net.sf.gridarta.action.exportmap.PendingInfo.getY(), and net.sf.gridarta.action.exportmap.PendingInfo.PendingInfo().

x

final int net.sf.gridarta.action.exportmap.PendingInfo.x

private

The x coordinate of the border between the previous and the next map.

Definition at line 41 of file PendingInfo.java.

Referenced by net.sf.gridarta.action.exportmap.PendingInfo.getX(), and net.sf.gridarta.action.exportmap.PendingInfo.PendingInfo().

y

final int net.sf.gridarta.action.exportmap.PendingInfo.y

private

The y coordinate of the border between the previous and the next map.

Definition at line 46 of file PendingInfo.java.

Referenced by net.sf.gridarta.action.exportmap.PendingInfo.getY(), and net.sf.gridarta.action.exportmap.PendingInfo.PendingInfo().

---

The documentation for this class was generated from the following file:

• src/gridarta/src/main/java/net/sf/gridarta/action/exportmap/PendingInfo.java