EdgeOffset

class EdgeOffset

Represents the offset of an orbiter from the main panel.

Summary

Public companion functions
`EdgeOffset`	`@Composable inner(offset: Dp)` Creates an `EdgeOffset` representing an offset from the inner edge of an orbiter.
`EdgeOffset`	`@Composable outer(offset: Dp)` Creates an `EdgeOffset` representing an offset from the outer edge of an orbiter.
`EdgeOffset`	`@Composable overlap(offset: Dp)` Creates an `EdgeOffset` representing an overlap of an orbiter into the main panel relative to the inner edge of the orbiter.

Public functions
`EdgeOffset`	`copy(amount: Float, type: OrbiterOffsetType)`
`open operator Boolean`	`equals(other: Any?)`
`open Int`	`hashCode()`
`open String`	`toString()`

Public properties
`Float`	`amount` the magnitude of the offset in pixels.
`OrbiterOffsetType`	`type` the type of offset (`OrbiterOffsetType.OuterEdge` or `OrbiterOffsetType.InnerEdge`).

Public companion functions

inner

@Composable
fun inner(offset: Dp): EdgeOffset

Creates an EdgeOffset representing an offset from the inner edge of an orbiter.

An offset that represents the offset of an orbiter from the main panel relative to the inner edge of the orbiter. In inner edge alignment, the inner edge of the orbiter will be offset distance away from the edge of the main panel.

Parameters
`offset: Dp`	the offset value in `Dp`.

Returns
`EdgeOffset`	an `EdgeOffset` with the specified offset and type `OrbiterOffsetType.InnerEdge`.

outer

@Composable
fun outer(offset: Dp): EdgeOffset

Creates an EdgeOffset representing an offset from the outer edge of an orbiter.

An offset that represents the offset of an orbiter from the main panel relative to the outer edge of the orbiter. In outer edge alignment, the outer edge of the orbiter will be offset distance away from the edge of the main panel.

Parameters
`offset: Dp`	the offset value in `Dp`.

Returns
`EdgeOffset`	an `EdgeOffset` with the specified offset and type `OrbiterOffsetType.OuterEdge`.

overlap

@Composable
fun overlap(offset: Dp): EdgeOffset

Creates an EdgeOffset representing an overlap of an orbiter into the main panel relative to the inner edge of the orbiter.

In overlap alignment, the inner edge of the orbiter will be offset distance inset into the edge of the main panel.

Parameters
`offset: Dp`	the amount of overlap, specified in `Dp`.

Returns
`EdgeOffset`	an `EdgeOffset` with the `offset`'s pixel value and `OrbiterOffsetType.InnerEdge`.

Public functions

copy

fun copy(amount: Float = this.amount, type: OrbiterOffsetType = this.type): EdgeOffset

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

amount

Added in 1.0.0-alpha01

val amount: Float

the magnitude of the offset in pixels.

type

Added in 1.0.0-alpha01

val type: OrbiterOffsetType

the type of offset (OrbiterOffsetType.OuterEdge or OrbiterOffsetType.InnerEdge).