Compose - Foundation/com.mapbox.navigation.compose.foundation.model

Package-level declarations

Types

Link copied to clipboard
class Distance : Comparable<Distance>

Represents a finite distance.

Link copied to clipboard
enum DistanceUnit : Enum<DistanceUnit>

Specifies the Distance unit.

Link copied to clipboard
class Speed : Comparable<Speed>

Represents a finite speed of a vehicle.

Link copied to clipboard
enum SpeedUnit : Enum<SpeedUnit>

Specifies the Speed unit.

Link copied to clipboard
sealed interface SystemOfMeasurement

Represents a system of measurement (e.g., Metric or Imperial) and provides utility functions to work with scaled DistanceUnits appropriate for the system.

Functions

Link copied to clipboard
fun Distance.roundedValue(unit: DistanceUnit, decimals: Int): Number

Converts receiving Distance to given unit and rounds to exact decimals. Returns are either long or double, depending on whether the resulting value has a fractional component.

fun Speed.roundedValue(unit: SpeedUnit, decimals: Int): Number

Converts the current Speed to the specified unit and rounds it to the specified number of decimals.

Link copied to clipboard
fun Distance.roundToIncrement(unit: DistanceUnit, roundingIncrement: Int): Distance

Returns receiving Distance rounded to roundingIncrement in given unit.

Link copied to clipboard
fun Distance.unitForLocale(locale: Locale): DistanceUnit

Determines the appropriate DistanceUnit for a given Distance based on the locale.