units/org.maplibre.spatialk.units.extensions

Package-level declarations

Kotlin DSL extensions for ergonomic unit construction and conversion, including extension properties on numeric types (e.g., 5.meters, 45.degrees) and utilities for collections and trigonometry.

Properties

acres

val Double.acres: Area

val Int.acres: Area

Creates an Area from a scalar value in acres.

arcMinutes

val Double.arcMinutes: Rotation

val Int.arcMinutes: Rotation

Creates a Rotation from a scalar value in arc minutes.

arcSeconds

val Double.arcSeconds: Rotation

val Int.arcSeconds: Rotation

Creates a Rotation from a scalar value in arc seconds.

ares

val Double.ares: Area

val Int.ares: Area

Creates an Area from a scalar value in ares.

cables

val Double.cables: Length

val Int.cables: Length

Creates a Length from a scalar value in cables.

centiares

val Double.centiares: Area

val Int.centiares: Area

Creates an Area from a scalar value in centiares.

centimeters

val Double.centimeters: Length

val Int.centimeters: Length

Creates a Length from a scalar value in centimeters.

chains

val Double.chains: Length

val Int.chains: Length

Creates a Length from a scalar value in chains.

decares

val Double.decares: Area

val Int.decares: Area

Creates an Area from a scalar value in decares.

deciares

val Double.deciares: Area

val Int.deciares: Area

Creates an Area from a scalar value in deciares.

degrees

val Double.degrees: Rotation

val Int.degrees: Rotation

Creates a Rotation from a scalar value in degrees.

earthDegrees

val Double.earthDegrees: Length

val Int.earthDegrees: Length

Creates a Length from a scalar value in earth degrees.

earthMinutes

val Double.earthMinutes: Length

val Int.earthMinutes: Length

Creates a Length from a scalar value in earth minutes.

earthRadians

val Double.earthRadians: Length

val Int.earthRadians: Length

Creates a Length from a scalar value in earth radians.

earthSeconds

val Double.earthSeconds: Length

val Int.earthSeconds: Length

Creates a Length from a scalar value in earth seconds.

fathoms

val Double.fathoms: Length

val Int.fathoms: Length

Creates a Length from a scalar value in fathoms.

feet

val Double.feet: Length

val Int.feet: Length

Creates a Length from a scalar value in feet.

furlongs

val Double.furlongs: Length

val Int.furlongs: Length

Creates a Length from a scalar value in furlongs.

gradians

val Double.gradians: Rotation

val Int.gradians: Rotation

Creates a Rotation from a scalar value in gradians.

hectares

val Double.hectares: Area

val Int.hectares: Area

Creates an Area from a scalar value in hectares.

inAcres

val Area.inAcres: Double

Returns this Area as a scalar value in acres.

inArcMinutes

val Rotation.inArcMinutes: Double

Returns this Rotation as a scalar value in arc minutes.

inArcSeconds

val Rotation.inArcSeconds: Double

Returns this Rotation as a scalar value in arc seconds.

inAres

val Area.inAres: Double

Returns this Area as a scalar value in ares.

inCables

val Length.inCables: Double

Returns this Length as a scalar value in cables.

inCentiares

val Area.inCentiares: Double

Returns this Area as a scalar value in centiares.

inCentimeters

val Length.inCentimeters: Double

Returns this Length as a scalar value in centimeters.

inChains

val Length.inChains: Double

Returns this Length as a scalar value in chains.

inches

val Double.inches: Length

val Int.inches: Length

Creates a Length from a scalar value in inches.

inDecares

val Area.inDecares: Double

Returns this Area as a scalar value in decares.

inDeciares

val Area.inDeciares: Double

Returns this Area as a scalar value in deciares.

inDegrees

val Rotation.inDegrees: Double

Returns this Rotation as a scalar value in degrees.

inEarthDegrees

val Length.inEarthDegrees: Double

Returns this Length as a scalar value in earth degrees.

inEarthMinutes

val Length.inEarthMinutes: Double

Returns this Length as a scalar value in earth minutes.

inEarthRadians

val Length.inEarthRadians: Double

Returns this Length as a scalar value in earth radians.

inEarthSeconds

val Length.inEarthSeconds: Double

Returns this Length as a scalar value in earth seconds.

inFathoms

val Length.inFathoms: Double

Returns this Length as a scalar value in fathoms.

inFeet

val Length.inFeet: Double

Returns this Length as a scalar value in feet.

inFurlongs

val Length.inFurlongs: Double

Returns this Length as a scalar value in furlongs.

inGradians

val Rotation.inGradians: Double

Returns this Rotation as a scalar value in gradians.

inHectares

val Area.inHectares: Double

Returns this Area as a scalar value in hectares.

inInches

val Length.inInches: Double

Returns this Length as a scalar value in inches.

inKilometers

val Length.inKilometers: Double

Returns this Length as a scalar value in kilometers.

inLeagues

val Length.inLeagues: Double

Returns this Length as a scalar value in leagues.

inLinks

val Length.inLinks: Double

Returns this Length as a scalar value in links.

inMeters

val Length.inMeters: Double

Returns this Length as a scalar value in meters.

inMiles

val Length.inMiles: Double

Returns this Length as a scalar value in miles.

inMillimeters

val Length.inMillimeters: Double

Returns this Length as a scalar value in millimeters.

inNauticalMiles

val Length.inNauticalMiles: Double

Returns this Length as a scalar value in nautical miles.

inRadians

val Rotation.inRadians: Double

Returns this Rotation as a scalar value in radians.

inRods

val Length.inRods: Double

Returns this Length as a scalar value in rods.

inSquareCentimeters

val Area.inSquareCentimeters: Double

Returns this Area as a scalar value in square centimeters.

inSquareFeet

val Area.inSquareFeet: Double

Returns this Area as a scalar value in square feet.

inSquareInches

val Area.inSquareInches: Double

Returns this Area as a scalar value in square inches.

inSquareKilometers

val Area.inSquareKilometers: Double

Returns this Area as a scalar value in square kilometers.

inSquareMeters

val Area.inSquareMeters: Double

Returns this Area as a scalar value in square meters.

inSquareMiles

val Area.inSquareMiles: Double

Returns this Area as a scalar value in square miles.

inSquareMillimeters

val Area.inSquareMillimeters: Double

Returns this Area as a scalar value in square millimeters.

inSquareRods

val Area.inSquareRods: Double

Returns this Area as a scalar value in square rods.

inSquareYards

val Area.inSquareYards: Double

Returns this Area as a scalar value in square yards.

inYards

val Length.inYards: Double

Returns this Length as a scalar value in yards.

kilometers

val Double.kilometers: Length

val Int.kilometers: Length

Creates a Length from a scalar value in kilometers.

leagues

val Double.leagues: Length

val Int.leagues: Length

Creates a Length from a scalar value in leagues.

links

val Double.links: Length

val Int.links: Length

Creates a Length from a scalar value in links.

meters

val Double.meters: Length

val Int.meters: Length

Creates a Length from a scalar value in meters.

miles

val Double.miles: Length

val Int.miles: Length

Creates a Length from a scalar value in miles.

millimeters

val Double.millimeters: Length

val Int.millimeters: Length

Creates a Length from a scalar value in millimeters.

nauticalMiles

val Double.nauticalMiles: Length

val Int.nauticalMiles: Length

Creates a Length from a scalar value in nautical miles.

radians

val Double.radians: Rotation

val Int.radians: Rotation

Creates a Rotation from a scalar value in radians.

rods

val Double.rods: Length

val Int.rods: Length

Creates a Length from a scalar value in rods.

squareCentimeters

val Double.squareCentimeters: Area

val Int.squareCentimeters: Area

Creates an Area from a scalar value in square centimeters.

squareFeet

val Double.squareFeet: Area

val Int.squareFeet: Area

Creates an Area from a scalar value in square feet.

squareInches

val Double.squareInches: Area

val Int.squareInches: Area

Creates an Area from a scalar value in square inches.

squareKilometers

val Double.squareKilometers: Area

val Int.squareKilometers: Area

Creates an Area from a scalar value in square kilometers.

squareMeters

val Double.squareMeters: Area

val Int.squareMeters: Area

Creates an Area from a scalar value in square meters.

squareMiles

val Double.squareMiles: Area

val Int.squareMiles: Area

Creates an Area from a scalar value in square miles.

squareMillimeters

val Double.squareMillimeters: Area

val Int.squareMillimeters: Area

Creates an Area from a scalar value in square millimeters.

squareRods

val Double.squareRods: Area

val Int.squareRods: Area

Creates an Area from a scalar value in square rods.

squareYards

val Double.squareYards: Area

val Int.squareYards: Area

Creates an Area from a scalar value in square yards.

yards

val Double.yards: Length

val Int.yards: Length

Creates a Length from a scalar value in yards.

Functions

acos

fun acos(x: Double): Rotation

Returns the arccosine as a Rotation.

asin

fun asin(x: Double): Rotation

Returns the arcsine as a Rotation.

atan

fun atan(x: Double): Rotation

Returns the arctangent as a Rotation.

atan2

fun atan2(y: Double, x: Double): Rotation

Returns the two-argument arctangent as a Rotation.

convert

fun Double.convert(from: AreaUnit, to: AreaUnit): Double

Convert a value from one AreaUnit to another.

fun Double.convert(from: LengthUnit, to: LengthUnit): Double

Convert a value from one LengthUnit to another.

fun Double.convert(from: RotationUnit, to: RotationUnit): Double

Convert a value from one RotationUnit to another.

cos

fun cos(x: Rotation): Double

Returns the cosine of this Rotation.

sin

fun sin(x: Rotation): Double

Returns the sine of this Rotation.

sum

@JvmName(name = "sumArea")

fun Iterable<Area>.sum(): Area

Calculates the sum of all Area values in this collection.

@JvmName(name = "sumLength")

fun Iterable<Length>.sum(): Length

Calculates the sum of all Length values in this collection.

@JvmName(name = "sumRotation")

fun Iterable<Rotation>.sum(): Rotation

Calculates the sum of all Rotation values in this collection.

sumOf

@JvmName(name = "sumOfArea")

inline fun <T> Iterable<T>.sumOf(selector: (T) -> Area): Area

Calculates the sum of Area values produced by selector for each element.

@JvmName(name = "sumOfLength")

inline fun <T> Iterable<T>.sumOf(selector: (T) -> Length): Length

Calculates the sum of Length values produced by selector for each element.

@JvmName(name = "sumOfRotation")

inline fun <T> Iterable<T>.sumOf(selector: (T) -> Rotation): Rotation

Calculates the sum of Rotation values produced by selector for each element.

tan

fun tan(x: Rotation): Double

Returns the tangent of this Rotation.

times

operator fun Double.times(other: Area): Area

Multiplies a scalar by an Area.

operator fun Double.times(other: Length): Length

Multiplies a scalar by a Length.

operator fun Double.times(other: Rotation): Rotation

Multiplies a scalar by a Rotation.

toArea

fun Double.toArea(unit: AreaUnit): Area

Converts this scalar to an Area in the specified unit.

toLength

fun Double.toLength(unit: LengthUnit): Length

Converts this scalar to a Length in the specified unit.

toRotation

fun Double.toRotation(unit: RotationUnit): Rotation

Converts this scalar to a Rotation in the specified unit.