client.map

Interface IMapController

All Superinterfaces:

IController

All Known Implementing Classes:

MapController

public interface IMapController
extends IController

Interface for the map controller

Method Summary

Modifier and Type	Method and Description
void	AddMapObserver(MapObserver listener)
void	CancelMove()
boolean	CanPlaceCity(Coordinate point, CatanColor color) This method is called whenever the user is trying to place a city on the map.
boolean	CanPlaceRoad(Coordinate p1, Coordinate p2, CatanColor color) This method is called whenever the user is trying to place a road on the map.
boolean	CanPlaceRobber(Coordinate point) This method is called whenever the user is trying to place the robber on the map.
boolean	CanPlaceSettlement(Coordinate point, CatanColor color) This method is called whenever the user is trying to place a settlement on the map.
DropObject	GetDropObject()
java.util.Iterator<Edge>	GetEdges() Gets all the edges in the map.
java.util.Iterator<Hex>	GetHexes() Gets all the hexes in the map.
IMapModel	GetModel()
java.util.Iterator<java.util.Map.Entry<java.lang.Integer,java.util.List<Hex>>>	GetPips() Gets all the pips in the map.
java.util.Iterator<java.util.Map.Entry<Edge,Hex>>	GetPorts() Gets all the ports on the map.
Hex	GetRobberPlacement() Gets the location of the robber.
java.util.Iterator<Vertex>	GetVertices() Gets all the vertices in the map.
boolean	IsRobberInitialized()
void	MouseClick()
void	MouseMove(java.awt.geom.Point2D worldPoint)
void	PlaceCity(Coordinate point)
void	PlaceRoad(Coordinate p1, Coordinate p2)
void	PlaceRobber(Coordinate point)
void	PlaceSettlement(Coordinate point)

Methods inherited from interface client.base.IController

getView

Method Detail

CanPlaceRoad

boolean CanPlaceRoad(Coordinate p1,
                     Coordinate p2,
                     CatanColor color)

This method is called whenever the user is trying to place a road on the map. It is called by the view for each "mouse move" event. The returned value tells the view whether or not to allow the road to be placed at the specified location.

Parameters:

p1 - The beginning of the road piece

p2 - The end of the road piece (it's the end of the road, get it? Never mind...)

color - The color of the road being placed

Returns:

true if the road can be placed at edgeLoc, false otherwise

CanPlaceSettlement

boolean CanPlaceSettlement(Coordinate point,
                           CatanColor color)

This method is called whenever the user is trying to place a settlement on the map. It is called by the view for each "mouse move" event. The returned value tells the view whether or not to allow the settlement to be placed at the specified location.

Parameters:

point - the location of the vertex

color - the color of the piece being placed

Returns:

true if the settlement can be placed at vertLoc, false otherwise

CanPlaceCity

boolean CanPlaceCity(Coordinate point,
                     CatanColor color)

This method is called whenever the user is trying to place a city on the map. It is called by the view for each "mouse move" event. The returned value tells the view whether or not to allow the city to be placed at the specified location.

Parameters:

point - the location of the vertex

color - the color of the piece being placed

Returns:

true if the city can be placed at vertLoc, false otherwise

CanPlaceRobber

boolean CanPlaceRobber(Coordinate point)

This method is called whenever the user is trying to place the robber on the map. It is called by the view for each "mouse move" event. The returned value tells the view whether or not to allow the robber to be placed at the specified location.

Parameters:

point - the coordinate of the hex

Returns:

true if the robber can be placed at hexLoc, false otherwise

GetHexes

java.util.Iterator<Hex> GetHexes()

Gets all the hexes in the map.

Returns:

All the hexes.

GetEdges

java.util.Iterator<Edge> GetEdges()

Gets all the edges in the map.

Returns:

All the edges.

GetVertices

java.util.Iterator<Vertex> GetVertices()

Gets all the vertices in the map.

Returns:

All the vertices.

GetPorts

java.util.Iterator<java.util.Map.Entry<Edge,Hex>> GetPorts()

Gets all the ports on the map.

Returns:

All the ports.

GetPips

java.util.Iterator<java.util.Map.Entry<java.lang.Integer,java.util.List<Hex>>> GetPips()

Gets all the pips in the map.

Returns:

All the pips.

GetRobberPlacement

Hex GetRobberPlacement()
                throws MapException

Gets the location of the robber.

Returns:

The hex of the robber.

Throws:

MapException

IsRobberInitialized

boolean IsRobberInitialized()

GetDropObject

DropObject GetDropObject()

PlaceRoad

void PlaceRoad(Coordinate p1,
               Coordinate p2)

PlaceSettlement

void PlaceSettlement(Coordinate point)

PlaceCity

void PlaceCity(Coordinate point)

PlaceRobber

void PlaceRobber(Coordinate point)

CancelMove

void CancelMove()

MouseMove

void MouseMove(java.awt.geom.Point2D worldPoint)

MouseClick

void MouseClick()

GetModel

IMapModel GetModel()

AddMapObserver

void AddMapObserver(MapObserver listener)