DpOffset

A two-dimensional offset using Dp for units.

To create a DpOffset, call the top-level function that accepts an x/y pair of coordinates:

val offset = DpOffset(x, y)

The primary constructor of DpOffset is intended to be used with the packedValue property to allow storing offsets in arrays or collections of primitives without boxing.

Summary

Nested types

Public companion properties
DpOffset

Represents an offset whose x and y are unspecified.
Cmn
DpOffset

A DpOffset with 0 DP x and 0 DP y values.
Cmn

Public constructors
DpOffset(packedValue: Long)
Cmn

Public functions
DpOffset
copy(x: Dp, y: Dp)

Returns a copy of this DpOffset instance optionally overriding the x or y parameter
Cmn
operator DpOffset
minus(other: DpOffset)

Subtract a DpOffset from another one.
Cmn
operator DpOffset
plus(other: DpOffset)

Add a DpOffset to another one.
Cmn
open String
Cmn

Public properties
Long

Long value encoding the x and y components of the DpOffset.
Cmn
Dp

The horizontal aspect of the offset in Dp
Cmn
Dp

The vertical aspect of the offset in Dp
Cmn

Extension functions
inline DpOffset

If this DpOffset isSpecified then this is returned, otherwise block is executed and its result is returned.
Cmn

Extension properties
Boolean

false when this is DpOffset.Unspecified.
Cmn
Boolean

true when this is DpOffset.Unspecified.
Cmn

Public companion properties

Unspecified

Cmn
Added in 1.1.0
val Unspecified: DpOffset

Represents an offset whose x and y are unspecified. This is usually a replacement for null when a primitive value is desired. Access to x or y on an unspecified offset is not allowed.

Zero

Cmn
Added in 1.0.0
val Zero: DpOffset

A DpOffset with 0 DP x and 0 DP y values.

Public constructors

DpOffset

Cmn
Added in 1.8.0-alpha01
DpOffset(packedValue: Long)
Parameters
packedValue: Long

Long value encoding the x and y components of the DpOffset. Encoded values can be obtained by using the packedValue property of existing DpOffset instances.

Public functions

copy

Cmn 
fun copy(x: Dp = this.x, y: Dp = this.y): DpOffset

Returns a copy of this DpOffset instance optionally overriding the x or y parameter

minus

Cmn 
operator fun minus(other: DpOffset): DpOffset

Subtract a DpOffset from another one.

plus

Cmn 
operator fun plus(other: DpOffset): DpOffset

Add a DpOffset to another one.

toString

Cmn 
open fun toString(): String

Public properties

packedValue

Cmn
Added in 1.8.0-alpha01
val packedValue: Long

Long value encoding the x and y components of the DpOffset. Encoded values can be obtained by using the packedValue property of existing DpOffset instances.

x

Cmn
Added in 1.2.0
val x: Dp

The horizontal aspect of the offset in Dp

y

Cmn
Added in 1.2.0
val y: Dp

The vertical aspect of the offset in Dp

Extension functions

takeOrElse

Cmn 
inline fun DpOffset.takeOrElse(block: () -> DpOffset): DpOffset

If this DpOffset isSpecified then this is returned, otherwise block is executed and its result is returned.

Extension properties

isSpecified

Cmn 
val DpOffset.isSpecified: Boolean

false when this is DpOffset.Unspecified.

isUnspecified

Cmn 
val DpOffset.isUnspecified: Boolean

true when this is DpOffset.Unspecified.