ch.sahits.game.openpatrician.model.util

Class CityUtilities

java.lang.Object

ch.sahits.game.openpatrician.model.util.CityUtilities

public class CityUtilities
extends Object

Utility class to privide services around the cities.

Author:

Andi Hotz, (c) Sahits GmbH, 2013 Created on Jan 27, 2013

Field Summary

Fields

Modifier and Type	Field and Description
private IMap	map
private com.google.common.collect.Range<Double>	range
private Random	rnd

Constructor Summary

Constructors

Constructor and Description
CityUtilities()

Method Summary

Methods

Modifier and Type	Method and Description
private double	calculateDistance(javafx.geometry.Point2D p1, javafx.geometry.Point2D p2)
private boolean	checkCities(ICity startCity, List<ICity> exclude) Check if there is a city that can be choosen
com.google.common.base.Optional<ICity>	findNearbyCity(ICity startCity, double radiusFactor, int max, List<ICity> exclude) Find a city nearby.
ICity	findNearbyCityRepeated(ICity startCity, double radiusFactor, int max, List<ICity> exclude) Find a nearby city.
ICity	findNearestCity(javafx.geometry.Point2D p) Find the nearest city to a point
ICity	findRandomCity(ICity excludedCity) Find a random city that is not the excluded city.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

map

@Autowired
private IMap map

rnd

@Autowired
private Random rnd

range

private final com.google.common.collect.Range<Double> range

Constructor Detail

CityUtilities

public CityUtilities()

Method Detail

findNearbyCity

public com.google.common.base.Optional<ICity> findNearbyCity(ICity startCity,
                                                    double radiusFactor,
                                                    int max,
                                                    List<ICity> exclude)

Find a city nearby. The search is limited by a factor (0,1]. Based on the max dimension of the map the radius is calculated with this factor. Repeated calls with the same arguments are not guaranteed to deliver the same result

Parameters:

startCity - city where to start

radiusFactor - factor for the radius calculation

max - maximal dimension of the map

exclude - potentially empty list of cities, that should be excluded from the search

Returns:

Optional city within the radius.

findNearbyCityRepeated

public ICity findNearbyCityRepeated(ICity startCity,
                           double radiusFactor,
                           int max,
                           List<ICity> exclude)

Find a nearby city. If the radius is chosen to small the radius is increased successively. This method is guaranteed to deliver a result if there is a city that can be chosen.

Parameters:

startCity - city where to start

radiusFactor - factor for the radius calculation

max - maximal dimension of the map

exclude - potentially empty list of cities, that should be excluded from the search

Returns:

Optional city within the radius.

See Also:

findNearbyCity(ICity, double, int, List)

checkCities

private boolean checkCities(ICity startCity,
                  List<ICity> exclude)

Check if there is a city that can be choosen

Parameters:

startCity -

exclude -

Returns:

findNearestCity

public ICity findNearestCity(javafx.geometry.Point2D p)

Find the nearest city to a point

Parameters:

p -

Returns:

findRandomCity

public ICity findRandomCity(ICity excludedCity)

Find a random city that is not the excluded city.

Parameters:

excludedCity - city that cannot be chosen.

Returns:

calculateDistance

private double calculateDistance(javafx.geometry.Point2D p1,
                       javafx.geometry.Point2D p2)