Navigation/com.amarcolini.joos.geometry/Angle

Angle

@Serializable(with = AngleSerializer::class)
data class Angle @JvmOverloads constructor(val value: Double = 0.0, val units: AngleUnit) : Comparable<Angle>

Class for representing angles.

Constructors

Link copied to clipboard
@JvmOverloads
constructor(value: Double = 0.0, units: AngleUnit)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
@get:JvmName(name = "degrees")
val degrees: Double

The measure of this angle in degrees.

Link copied to clipboard
@get:JvmName(name = "radians")
val radians: Double

The measure of this angle in radians.

Link copied to clipboard
Link copied to clipboard
@JvmField
val value: Double = 0.0

Functions

Link copied to clipboard
fun abs(): Angle

Returns the absolute value of this angle.

Link copied to clipboard
infix fun angleTo(other: Angle): Angle

Returns the shortest angle that can be added to this angle to get other (e.g., 10° angleTo 360° = -10°).

Link copied to clipboard
fun coerceIn(min: Angle, max: Angle): Angle

Ensures that this angle lies in the specified range min..max.

Link copied to clipboard
open operator override fun compareTo(other: Angle): Int

Returns 1 if this angle is greater than other, 0 if they are equal, and -1 if this angle is less than other.

Link copied to clipboard
fun cos(): Double

Returns the cosine of this angle.

Link copied to clipboard
operator fun div(other: Angle): Double

Divides two angles.

operator fun div(scalar: Double): Angle

Divides this angle by a scalar.

Link copied to clipboard
infix fun epsilonEquals(other: Angle): Boolean

Returns whether two angles are approximately equal (within EPSILON), but angles which point in the same direction are considered equal as well (e.g., 0° = 360° = 720°).

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
fun getValue(units: AngleUnit): Double
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
operator fun minus(other: Angle): Angle

Subtracts two angles.

Link copied to clipboard
fun norm(): Angle

Returns this angle clamped to [0, 2pi] in radians, or [0, 360] in degrees.

Link copied to clipboard
fun normDelta(): Angle

Returns this angle clamped to [-pi, pi] in radians, or [-180, 180] in degrees.

Link copied to clipboard
operator fun plus(other: Angle): Angle

Adds two angles.

Link copied to clipboard
fun sin(): Double

Returns the sine of this angle.

Link copied to clipboard
infix fun strictEpsilonEquals(other: Angle): Boolean

Returns whether two angles are approximately equal (within EPSILON).

Link copied to clipboard
fun tan(): Double

Returns the tangent of this angle.

Link copied to clipboard
operator fun times(scalar: Double): Angle

Multiplies this angle by a scalar.

Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
operator fun unaryMinus(): Angle

Returns the negative of this angle.

Link copied to clipboard
fun vec(): Vector2d

Returns the vector representation of this angle.