com.scvngr.levelup.core.util

Class DistanceUtil

java.lang.Object

com.scvngr.levelup.core.util.DistanceUtil

@LevelUpApi(contract=INTERNAL)
public final class DistanceUtil
extends Object

Utilities to convert distances to other units.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DistanceUtil.DistanceUnit Common distance units.

Method Summary

Modifier and Type	Method and Description
static float	convertDistance(float distanceInMeters, DistanceUtil.DistanceUnit desiredUnit) Converts a distance in meters to the desired unit.
static float	roundDistance(float distance) Rounds the distance to the upper 0.5.

Methods inherited from class java.lang.Object

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

Method Detail

convertDistance

public static float convertDistance(float distanceInMeters,
                                    DistanceUtil.DistanceUnit desiredUnit)

Converts a distance in meters to the desired unit.

Parameters:

distanceInMeters - the input distance, in meters.

desiredUnit - the unit to return.

Returns:

the distance in meters converted to the desired unit.

roundDistance

public static float roundDistance(float distance)

Rounds the distance to the upper 0.5. E.g. 0.6 will return 1.0 and 0.3 will return 0.5.

Parameters:

distance - input distance.

Returns:

the distance, rounded to the upper 0.5.