com.mapbox.services.api.utils.turf

Class TurfHelpers

java.lang.Object

com.mapbox.services.api.utils.turf.TurfHelpers

public class TurfHelpers
extends java.lang.Object

This TurfHelpers class is made up of methods that take in an object, convert it, and then return the object in the desired units or object.

Since:

1.2.0

See Also:

Turfjs documentation

Constructor Summary

Constructors

Constructor and Description
TurfHelpers()

Method Summary

Modifier and Type	Method and Description
static double	convertDistance(double distance, java.lang.String originalUnit) Converts a distance to the requested unit.
static double	convertDistance(double distance, java.lang.String originalUnit, java.lang.String finalUnit) Converts a distance to the requested unit.
static double	distanceToRadians(double distance) Convert distance to radians.
static double	distanceToRadians(double distance, java.lang.String units) Convert distance to radians.
static double	radiansToDistance(double radians) Convert radians to distance.
static double	radiansToDistance(double radians, java.lang.String units) Convert radians to distance.

Methods inherited from class java.lang.Object

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

Constructor Detail

TurfHelpers

public TurfHelpers()

Method Detail

radiansToDistance

public static double radiansToDistance(double radians)
                                throws TurfException

Convert radians to distance. The units used here equals the default.

Parameters:

radians - Double representing a radian value.

Returns:

Converted radian to distance value.

Throws:

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

Since:

1.2.0

radiansToDistance

public static double radiansToDistance(double radians,
                                       java.lang.String units)
                                throws TurfException

Convert radians to distance.

Parameters:

radians - Double representing a radian value.

units - Pass in the units you'd like to use.

Returns:

Converted radian to distance value.

Throws:

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

Since:

1.2.0

distanceToRadians

public static double distanceToRadians(double distance)
                                throws TurfException

Convert distance to radians. The units used here equals the default.

Parameters:

distance - Double representing a distance value.

Returns:

Converted distance to radians value.

Throws:

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

Since:

1.2.0

distanceToRadians

public static double distanceToRadians(double distance,
                                       java.lang.String units)
                                throws TurfException

Convert distance to radians.

Parameters:

distance - Double representing a distance value.

units - Pass in the units you'd like to use.

Returns:

Converted distance to radians value.

Throws:

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

Since:

1.2.0

convertDistance

public static double convertDistance(double distance,
                                     java.lang.String originalUnit)

Converts a distance to the requested unit. Valid units: miles, nauticalmiles, inches, yards, meters, metres, kilometers, centimeters, feet

Parameters:

distance - the distance to be converted

originalUnit - of the distance

Returns:

the converted distance

Since:

2.2.0

convertDistance

public static double convertDistance(double distance,
                                     java.lang.String originalUnit,
                                     java.lang.String finalUnit)

Converts a distance to the requested unit. Valid units: miles, nauticalmiles, inches, yards, meters, metres, kilometers, centimeters, feet

Parameters:

distance - the distance to be converted

originalUnit - of the distance

finalUnit - returned unit, TurfConstants.UNIT_DEFAULT if not specified.

Returns:

the converted distance

Since:

2.2.0