onyxsdk-baselite/com.onyx.android.sdk.base.data/Size

Size

data class Size(var width: Int = 0, var height: Int = 0)(source)

Mutable pixel dimensions used by the recovered SDK APIs.

A dimension is considered empty when either value is zero or negative. The default instance is therefore empty.

Constructors

constructor(width: Int = 0, height: Int = 0)

Types

object Companion

Factory and conversion helpers for Size.

Properties

var height: Int

vertical dimension in pixels

horizontal dimension in pixels

Functions

fun equals(w: Int, h: Int): Boolean

Returns whether this instance has exactly the supplied w and h dimensions.

fun getOrElse(defaultValue: () -> Size): Size

Returns this non-empty instance, or a value produced by defaultValue when it is empty.

fun isEmpty(): Boolean

Returns true when width or height is not positive.

fun isVertical(): Boolean

Returns true when the height is greater than the width.

fun key(): String

Returns a stable text key containing the current dimensions.

fun ratioPageSize(maxPageSize: Size): RectF

Returns a rectangle whose dimensions fit within maxPageSize without changing orientation or aspect ratio. Sizes that already fit are returned at their original dimensions.

fun setHeight(height: Int): Size

Sets height and returns this mutable instance for call chaining.

fun setWidth(width: Int): Size

Sets width and returns this mutable instance for call chaining.

fun toRect(): Rect

Returns an integer rectangle from the origin to this size.

fun toRectF(): RectF

Returns a floating-point rectangle from the origin to this size.