ch.sahits.game.openpatrician.model.map

Interface IMap

All Known Implementing Classes:

GameMap

public interface IMap

Interface defining the map that defines the game plan

Author:

Andi Hotz, (c) Sahits GmbH, 2011 Created on Sep 9, 2011

Method Summary

Modifier and Type	Method and Description
void	add(ICity city) Add a new city.
Optional<ICity>	findCity(javafx.geometry.Point2D location) Find the city at the given coordinates.
ICity	findCity(String cityName) Find a city by its name.
List<ICity>	getCities() Retrieve an unmodifiable list of all the cities in the map
List<ICity>	getCities(IPlayer player) Retrieve an unmodifiable list of all the cities in the map also including the once only visible to the player.
List<javafx.geometry.Point2D>	getCityCoordinates() Retrieve a list of all coordinates of the cities.
javafx.geometry.Dimension2D	getDimension() Retrieve the map dimensions
List<IFutureTowns>	getFutureTowns()
List<ILandBridge>	getLandbridges()
String	getMapBWImagePath() Retrieve the path for the black and white variant of the map.
String	getMapImagePath() Retrieve the path for the map image without the cities added.
int	getNumberCities() Retrieve the number of cities that are on the map.
double	getNumberOfPixelPerKilometer() Retrieve the scale of the map by providing a number to convert one kilometer into a number of pixels.
List<PirateNest>	getPirateNests()
com.google.common.collect.Multimap<IPlayer,ICity>	getTownsInFounding() Retrieve the cities that are currently being founded by players.
Set<ITradeRoute>	getTradeRoutes() Retrieve the trade routes defined for this map.

Method Detail

getNumberCities

int getNumberCities()

Retrieve the number of cities that are on the map.

Returns:

getCities

List<ICity> getCities()

Retrieve an unmodifiable list of all the cities in the map

Returns:

getCities

List<ICity> getCities(IPlayer player)

Retrieve an unmodifiable list of all the cities in the map also including the once only visible to the player.

Returns:

findCity

ICity findCity(String cityName)

Find a city by its name.

Parameters:

cityName -

Returns:

getDimension

javafx.geometry.Dimension2D getDimension()

Retrieve the map dimensions

Returns:

dimesion

getMapImagePath

String getMapImagePath()

Retrieve the path for the map image without the cities added.

Returns:

getMapBWImagePath

String getMapBWImagePath()

Retrieve the path for the black and white variant of the map.

Returns:

getFutureTowns

List<IFutureTowns> getFutureTowns()

getLandbridges

List<ILandBridge> getLandbridges()

getPirateNests

List<PirateNest> getPirateNests()

getNumberOfPixelPerKilometer

double getNumberOfPixelPerKilometer()

Retrieve the scale of the map by providing a number to convert one kilometer into a number of pixels.

Returns:

findCity

Optional<ICity> findCity(javafx.geometry.Point2D location)

Find the city at the given coordinates.

Parameters:

location - of the supposed city.

Returns:

instance of the city or null if at the coordinates there is no city.

getCityCoordinates

List<javafx.geometry.Point2D> getCityCoordinates()

Retrieve a list of all coordinates of the cities.

Returns:

getTownsInFounding

com.google.common.collect.Multimap<IPlayer,ICity> getTownsInFounding()

Retrieve the cities that are currently being founded by players.

Returns:

add

void add(ICity city)

Add a new city.

Parameters:

city -

getTradeRoutes

Set<ITradeRoute> getTradeRoutes()

Retrieve the trade routes defined for this map.

Returns: