com.mapbox.services.commons.utils

Class PolylineUtils

java.lang.Object

com.mapbox.services.commons.utils.PolylineUtils

public class PolylineUtils
extends java.lang.Object

Polyline utils class contains method that can decode/encode a polyline, simplify a line, and more.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
PolylineUtils()

Method Summary

Modifier and Type	Method and Description
static java.util.List<Position>	decode(java.lang.String encodedPath, int precision) Decodes an encoded path string into a sequence of Positions.
static java.lang.String	encode(java.util.List<Position> path, int precision) Encodes a sequence of Positions into an encoded path string.
static Position[]	simplify(Position[] points) Reduces the number of points in a polyline while retaining its shape, giving a performance boost when processing it and also reducing visual noise
static Position[]	simplify(Position[] points, boolean highestQuality) Reduces the number of points in a polyline while retaining its shape, giving a performance boost when processing it and also reducing visual noise.
static Position[]	simplify(Position[] points, double tolerance) Reduces the number of points in a polyline while retaining its shape, giving a performance boost when processing it and also reducing visual noise.
static Position[]	simplify(Position[] points, double tolerance, boolean highestQuality) Reduces the number of points in a polyline while retaining its shape, giving a performance boost when processing it and also reducing visual noise.

Methods inherited from class java.lang.Object

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

Constructor Detail

PolylineUtils

public PolylineUtils()

Method Detail

decode

public static java.util.List<Position> decode(java.lang.String encodedPath,
                                              int precision)

Decodes an encoded path string into a sequence of Positions.

Parameters:

encodedPath - String representing a path string.

precision - OSRMv4 uses 6, OSRMv5 and Google uses 5.

Returns:

List of Position making up the line.

Since:

1.0.0

See Also:

Part of algorithm came from this source, Part of algorithm came from this source.

encode

public static java.lang.String encode(java.util.List<Position> path,
                                      int precision)

Encodes a sequence of Positions into an encoded path string.

Parameters:

path - List of Position making up the line.

precision - OSRMv4 uses 6, OSRMv5 and Google uses 5.

Returns:

String representing a path string.

Since:

1.0.0

simplify

public static Position[] simplify(Position[] points)

Reduces the number of points in a polyline while retaining its shape, giving a performance boost when processing it and also reducing visual noise

Parameters:

points - an array of points

Returns:

an array of simplified points

Since:

1.2.0

See Also:

JavaScript implementation

simplify

public static Position[] simplify(Position[] points,
                                  double tolerance)

Reduces the number of points in a polyline while retaining its shape, giving a performance boost when processing it and also reducing visual noise.

Parameters:

points - an array of points

tolerance - affects the amount of simplification (in the same metric as the point coordinates)

Returns:

an array of simplified points

Since:

1.2.0

See Also:

JavaScript implementation

simplify

public static Position[] simplify(Position[] points,
                                  boolean highestQuality)

Reduces the number of points in a polyline while retaining its shape, giving a performance boost when processing it and also reducing visual noise.

Parameters:

points - an array of points

highestQuality - excludes distance-based preprocessing step which leads to highest quality simplification

Returns:

an array of simplified points

Since:

1.2.0

See Also:

JavaScript implementation

simplify

public static Position[] simplify(Position[] points,
                                  double tolerance,
                                  boolean highestQuality)

Reduces the number of points in a polyline while retaining its shape, giving a performance boost when processing it and also reducing visual noise.

Parameters:

points - an array of points

tolerance - affects the amount of simplification (in the same metric as the point coordinates)

highestQuality - excludes distance-based preprocessing step which leads to highest quality simplification

Returns:

an array of simplified points

Since:

1.2.0

See Also:

JavaScript implementation