api/dev.s7a.strata.geometry/DoubleOffset

DoubleOffset

data class DoubleOffset(val x: Double, val y: Double)(source)

An immutable finite two-dimensional coordinate or displacement.

The value owns no external resources and is safe to share between threads. Arithmetic creates another validated value and fails when a result is not finite.

Throws

IllegalArgumentException

when either component is not finite.

Constructors

DoubleOffset

constructor(x: Double, y: Double)

Types

Companion

object Companion

Common coordinate constants.

Properties

val x: Double

horizontal coordinate or displacement.

val y: Double

vertical coordinate or displacement.

Functions

minus

operator fun minus(other: DoubleOffset): DoubleOffset

Subtracts a finite displacement.

plus

operator fun plus(other: DoubleOffset): DoubleOffset

Adds a finite displacement.