com.mapbox.turf

Class TurfConversion

java.lang.Object

com.mapbox.turf.TurfConversion

public final class TurfConversion
extends java.lang.Object

This 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

Method Summary

Modifier and Type	Method and Description
static double	convertLength(double distance, java.lang.String originalUnit) Converts a distance to the default units.
static double	convertLength(double distance, java.lang.String originalUnit, java.lang.String finalUnit) Converts a distance to a different unit specified.
static double	degreesToRadians(double degrees) Converts an angle in degrees to radians.
static double	lengthToDegrees(double distance, java.lang.String units) Convert a distance measurement (assuming a spherical Earth) from a real-world unit into degrees Valid units: miles, nauticalmiles, inches, yards, meters, metres, centimeters, kilometres, feet.
static double	lengthToRadians(double distance) Convert a distance measurement (assuming a spherical Earth) from a real-world unit into radians.
static double	lengthToRadians(double distance, java.lang.String units) Convert a distance measurement (assuming a spherical Earth) from a real-world unit into radians.
static double	radiansToDegrees(double radians) Converts an angle in radians to degrees.
static double	radiansToLength(double radians) Convert a distance measurement (assuming a spherical Earth) from radians to a more friendly unit.
static double	radiansToLength(double radians, java.lang.String units) Convert a distance measurement (assuming a spherical Earth) from radians to a more friendly unit.

Methods inherited from class java.lang.Object

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

Method Detail

lengthToDegrees

public static double lengthToDegrees(double distance,
                                     java.lang.String units)

Convert a distance measurement (assuming a spherical Earth) from a real-world unit into degrees Valid units: miles, nauticalmiles, inches, yards, meters, metres, centimeters, kilometres, feet.

Parameters:

distance - in real units

units - can be degrees, radians, miles, or kilometers inches, yards, metres, meters, kilometres, kilometers.

Returns:

a double value representing the distance in degrees

Since:

3.0.0

degreesToRadians

public static double degreesToRadians(double degrees)

Converts an angle in degrees to radians.

Parameters:

degrees - angle between 0 and 360 degrees

Returns:

angle in radians

Since:

3.1.0

radiansToDegrees

public static double radiansToDegrees(double radians)

Converts an angle in radians to degrees.

Parameters:

radians - angle in radians

Returns:

degrees between 0 and 360 degrees

Since:

3.0.0

radiansToLength

public static double radiansToLength(double radians)

Convert a distance measurement (assuming a spherical Earth) from radians to a more friendly unit. The units used here equals the default.

Parameters:

radians - a double using unit radian

Returns:

converted radian to distance value

Since:

1.2.0

radiansToLength

public static double radiansToLength(double radians,
                                     @NonNull
                                     java.lang.String units)

Convert a distance measurement (assuming a spherical Earth) from radians to a more friendly unit.

Parameters:

radians - a double using unit radian

units - pass in one of the units defined in TurfConstants.TurfUnitCriteria

Returns:

converted radian to distance value

Since:

1.2.0

lengthToRadians

public static double lengthToRadians(double distance)

Convert a distance measurement (assuming a spherical Earth) from a real-world unit into radians.

Parameters:

distance - double representing a distance value assuming the distance units is in kilometers

Returns:

converted distance to radians value

Since:

1.2.0

lengthToRadians

public static double lengthToRadians(double distance,
                                     @NonNull
                                     java.lang.String units)

Convert a distance measurement (assuming a spherical Earth) from a real-world unit into radians.

Parameters:

distance - double representing a distance value

units - pass in one of the units defined in TurfConstants.TurfUnitCriteria

Returns:

converted distance to radians value

Since:

1.2.0

convertLength

public static double convertLength(double distance,
                                   @NonNull
                                   java.lang.String originalUnit)

Converts a distance to the default units. Use convertLength(double, String, String) to specify a unit to convert to.

Parameters:

distance - double representing a distance value

originalUnit - of the distance, must be one of the units defined in TurfConstants.TurfUnitCriteria

Returns:

converted distance in the default unit

Since:

2.2.0

convertLength

public static double convertLength(double distance,
                                   @NonNull
                                   java.lang.String originalUnit,
                                   @Nullable
                                   java.lang.String finalUnit)

Converts a distance to a different unit specified.

Parameters:

distance - the distance to be converted

originalUnit - of the distance, must be one of the units defined in TurfConstants.TurfUnitCriteria

finalUnit - returned unit, TurfConstants.UNIT_DEFAULT if not specified

Returns:

the converted distance

Since:

2.2.0