Package ch.sahits.game.openpatrician.engine.sea

Interface IPathConverter

public interface IPathConverter

Converts a list of point into a shape that can be used as path.

Author:

Andi Hotz, (c) Sahits GmbH, 2016 Created on Jan 05, 2016

Method Summary

Modifier and Type	Method	Description
long	calculateDuration(ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel, ch.sahits.game.openpatrician.clientserverinterface.service.PathInterpolator interpolator, double fraction)	Calculate the duration of the travel in milliseconds in real time for the specified fraction of the total distance
java.util.Optional<javafx.scene.shape.Path>	createPath(ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel, java.util.List<javafx.geometry.Point2D> pointedPath, double scale)	Create a path shape out of a list of points.
java.util.List<javafx.geometry.Point2D>	reduceLinePoints(java.util.List<javafx.geometry.Point2D> initialPoints)	Reduce the number of points that are needed to describe the path.

Method Detail

createPath

java.util.Optional<javafx.scene.shape.Path> createPath(ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel,
                                                       java.util.List<javafx.geometry.Point2D> pointedPath,
                                                       double scale)

Create a path shape out of a list of points. When the path is created the vessel will be added to the TravellingVessels container.

Parameters:

vessel - vessel that is traveling the path.

pointedPath - input points.

scale - scaling that is used on the path due to the sacle of the map.

Returns:

shape representing a path if the vessels owner is a human player. Otherwise the path is not needed.

reduceLinePoints

java.util.List<javafx.geometry.Point2D> reduceLinePoints(java.util.List<javafx.geometry.Point2D> initialPoints)

Reduce the number of points that are needed to describe the path.

Parameters:

initialPoints - list of initial points

Returns:

list of reduced points.

calculateDuration

long calculateDuration(ch.sahits.game.openpatrician.model.ship.INavigableVessel vessel,
                       ch.sahits.game.openpatrician.clientserverinterface.service.PathInterpolator interpolator,
                       double fraction)

Calculate the duration of the travel in milliseconds in real time for the specified fraction of the total distance

Parameters:

vessel - that is traveling

interpolator - used to hold the path information

fraction - value between [0,1]. 1 means that the whole distance is traveled.

Returns:

real time duration of the travel in milliseconds.