api_quantity/com.tomtom.tools.android.api.quantity/Angle

Angle

@Serializable

data class Angle : Quantity<Angle, Angle.Unit>

A quantity describing an angle. (For example, 90 degrees.)

Types

object Companion

enum Unit : Enum<Angle.Unit>

The unit of an angle's value.

Functions

open override fun abs(): Angle

Returns a new instance with the value from this as absolute value.

open operator override fun compareTo(other: Angle): Int

open operator override fun div(divisor: Double): Angle

open operator override fun div(divisor: Int): Angle

Returns a new instance with the value from this divided by divisor.

fun inDegrees(): Double

Expresses the angle's value in degrees.

fun inRadians(): Double

Expresses the angle's value in radians.

fun inWholeDegrees(): Long

Expresses the angle's value in degrees rounded down.

fun inWholeRadians(): Long

Expresses the angle's value in radians rounded down.

open operator override fun minus(other: Angle): Angle

Returns a new instance that has other's value subtracted from this.

open operator override fun plus(other: Angle): Angle

Returns a new instance with a value equal to the sum of values from this and other.

open operator override fun times(factor: Double): Angle

open operator override fun times(factor: Int): Angle

Returns a new instance with the value from this multiplied by factor.

open override fun toDouble(unit: Angle.Unit): Double

Expresses the value of this under the given unit as a Double.

open override fun toLong(unit: Angle.Unit): Long

Expresses the value of this under the given unit as a Long.

open override fun toString(unit: Angle.Unit, decimals: Int, suffixMode: Quantity.SuffixMode, decimalsMode: Quantity.DecimalsMode): String

Returns a string representation for the value from this with the given unit. Depending on decimalsMode, it will show either exactly or at most decimals amount of decimals after the separator. The unit will be suffixed depending on suffixMode.

open operator override fun unaryMinus(): Angle

Returns a new instance with the value from this as negative.