com.mapbox.services.api.utils.turf

Class TurfMisc

java.lang.Object

com.mapbox.services.api.utils.turf.TurfMisc

public class TurfMisc
extends java.lang.Object

Class contains all the miscellaneous methods that Turf can perform.

Since:

1.2.0

See Also:

Turf documentation

Constructor Summary

Constructors

Constructor and Description
TurfMisc()

Method Summary

Modifier and Type	Method and Description
static com.mapbox.services.commons.geojson.LineString	lineSlice(com.mapbox.services.commons.geojson.Point startPt, com.mapbox.services.commons.geojson.Point stopPt, com.mapbox.services.commons.geojson.Feature line) Takes a line, a start Point, and a stop point and returns the line in between those points.
static com.mapbox.services.commons.geojson.LineString	lineSlice(com.mapbox.services.commons.geojson.Point startPt, com.mapbox.services.commons.geojson.Point stopPt, com.mapbox.services.commons.geojson.LineString line) Takes a line, a start Point, and a stop point and returns the line in between those points.
static com.mapbox.services.commons.geojson.Feature	pointOnLine(com.mapbox.services.commons.geojson.Point pt, java.util.List<com.mapbox.services.commons.models.Position> coords) Takes a Point and a LineString and calculates the closest Point on the LineString.

Methods inherited from class java.lang.Object

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

Constructor Detail

TurfMisc

public TurfMisc()

Method Detail

lineSlice

public static com.mapbox.services.commons.geojson.LineString lineSlice(com.mapbox.services.commons.geojson.Point startPt,
                                                                       com.mapbox.services.commons.geojson.Point stopPt,
                                                                       com.mapbox.services.commons.geojson.Feature line)
                                                                throws TurfException

Takes a line, a start Point, and a stop point and returns the line in between those points.

Parameters:

startPt - Starting point.

stopPt - Stopping point.

line - Line to slice.

Returns:

Sliced line.

Throws:

TurfException - signals that a Turf exception of some sort has occurred.

Since:

1.2.0

See Also:

Turf Line slice documentation

lineSlice

public static com.mapbox.services.commons.geojson.LineString lineSlice(com.mapbox.services.commons.geojson.Point startPt,
                                                                       com.mapbox.services.commons.geojson.Point stopPt,
                                                                       com.mapbox.services.commons.geojson.LineString line)
                                                                throws TurfException

Takes a line, a start Point, and a stop point and returns the line in between those points.

Parameters:

startPt - Starting point.

stopPt - Stopping point.

line - Line to slice.

Returns:

Sliced line.

Throws:

TurfException - signals that a Turf exception of some sort has occurred.

Since:

1.2.0

See Also:

Turf Line slice documentation

pointOnLine

public static com.mapbox.services.commons.geojson.Feature pointOnLine(com.mapbox.services.commons.geojson.Point pt,
                                                                      java.util.List<com.mapbox.services.commons.models.Position> coords)
                                                               throws TurfException

Takes a Point and a LineString and calculates the closest Point on the LineString.

Parameters:

pt - point to snap from

coords - line to snap to

Returns:

closest point on the line to point

Throws:

TurfException - signals that a Turf exception of some sort has occurred.

Since:

1.3.0