jurpe.dungeon.rpgmap
Interface ILogicalMap

All Known Implementing Classes:
MapView, RpgMap

public interface ILogicalMap

Interface for RPG maps. Known subclasses: Map and MapView

See Also:
RpgMap, MapView

Method Summary
 RpgMapPoint getBottomRight()
          Get bottom right coordinates, relative to RpgMap, of viewport
 Cell getCell(HexPoint hexPoint)
          Get RpgMapCell at RpgMapCoordinates XY
 short getHeight()
          Viewport height
 RpgMapPoint getTopLeft()
          Get top left coordinates, relative to RpgMap, of viewport
 short getWidth()
          Viewport width
 boolean isInside(RpgMapPoint position)
          Get RpgMapCell at RpgMapCoordinates XY
 MapIterator iterator()
          Iterator
 

Method Detail

getCell

Cell getCell(HexPoint hexPoint)
Get RpgMapCell at RpgMapCoordinates XY

Parameters:
hexPoint - RpgMapPoint View relative point
Returns:
RpgMapCell Cell in RpgMap

isInside

boolean isInside(RpgMapPoint position)
Get RpgMapCell at RpgMapCoordinates XY

Parameters:
position - RpgMapPoint View relative point
Returns:
RpgMapCell Cell in RpgMap

getWidth

short getWidth()
Viewport width

Returns:
Viewport width

getHeight

short getHeight()
Viewport height

Returns:
Viewport height

getTopLeft

RpgMapPoint getTopLeft()
Get top left coordinates, relative to RpgMap, of viewport

Returns:
top left coordinates, relative to RpgMap, of viewport

getBottomRight

RpgMapPoint getBottomRight()
Get bottom right coordinates, relative to RpgMap, of viewport

Returns:
bottom right coordinates, relative to RpgMap, of viewport

iterator

MapIterator iterator()
Iterator

Returns:
RpgMapIterator

Jurpe - Java Universal Role Playing Engine - http://jurpe.sourceforge.net