quantity/com.tomtom.quantity/Angle

Angle

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

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

Important: This is a Public Preview API. It may be changed or removed at any time.

Types

Companion

object Companion

Unit

abstract class Unit : UnitBase

The unit of an angle's value.

Functions

abs

open override fun abs(): Angle

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

compareTo

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

div

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.

format

open override fun format(unit: Angle.Unit): Quantity.FormattedQuantity

Returns a FormattedQuantity representation of the value from this with the given unit.

inDegrees

fun inDegrees(): Double

Expresses the angle's value in degrees.

inRadians

fun inRadians(): Double

Expresses the angle's value in radians.

inWholeDegrees

fun inWholeDegrees(): Long

Expresses the angle's value in degrees.

inWholeRadians

fun inWholeRadians(): Long

Expresses the angle's value in radians.

minus

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

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

plus

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.

times

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.

toDouble

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

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

toLong

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

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

unaryMinus

open operator override fun unaryMinus(): Angle

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