com.mapbox.services.api.utils.turf

Class TurfJoins

java.lang.Object

com.mapbox.services.api.utils.turf.TurfJoins

public class TurfJoins
extends java.lang.Object

Class contains methods that can determine if points lie within a polygon or not.

Since:

1.3.0

See Also:

Turf documentation

Constructor Summary

Constructors

Constructor and Description
TurfJoins()

Method Summary

Modifier and Type	Method and Description
static boolean	inside(com.mapbox.services.commons.geojson.Point point, com.mapbox.services.commons.geojson.MultiPolygon polygon) Takes a Point and a MultiPolygon and determines if the point resides inside the polygon.
static boolean	inside(com.mapbox.services.commons.geojson.Point point, com.mapbox.services.commons.geojson.Polygon polygon) Takes a Point and a Polygon and determines if the point resides inside the polygon.
static boolean	inside(com.mapbox.services.commons.models.Position point, java.util.List<com.mapbox.services.commons.models.Position> polygon) Takes a Position and a List of Positions making up a polygon and determines if the point resides inside the polygon.

Methods inherited from class java.lang.Object

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

Constructor Detail

TurfJoins

public TurfJoins()

Method Detail

inside

public static boolean inside(com.mapbox.services.commons.models.Position point,
                             java.util.List<com.mapbox.services.commons.models.Position> polygon)
                      throws TurfException

Takes a Position and a List of Positions making up a polygon and determines if the point resides inside the polygon. The polygon can be convex or concave. The function accounts for holes.

Parameters:

point - input position.

polygon - input list of positions making up the polygon.

Returns:

True if the Point is inside the Polygon; false if the Point is not inside the Polygon.

Throws:

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

Since:

1.3.0

See Also:

Turf Inside documentation

inside

public static boolean inside(com.mapbox.services.commons.geojson.Point point,
                             com.mapbox.services.commons.geojson.Polygon polygon)
                      throws TurfException

Takes a Point and a Polygon and determines if the point resides inside the polygon. The polygon can be convex or concave. The function accounts for holes.

Parameters:

point - input point.

polygon - input polygon.

Returns:

True if the Point is inside the Polygon; false if the Point is not inside the Polygon.

Throws:

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

Since:

1.3.0

See Also:

Turf Inside documentation

inside

public static boolean inside(com.mapbox.services.commons.geojson.Point point,
                             com.mapbox.services.commons.geojson.MultiPolygon polygon)
                      throws TurfException

Takes a Point and a MultiPolygon and determines if the point resides inside the polygon. The polygon can be convex or concave. The function accounts for holes.

Parameters:

point - input point.

polygon - input multipolygon.

Returns:

True if the Point is inside the MultiPolygon; false if the Point is not inside the MultiPolygon.

Throws:

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

Since:

1.3.0

See Also:

Turf Inside documentation