OrbiterAlignment

public sealed class OrbiterAlignment private constructor(
    internal val alignment: SpatialAlignment,
    internal val edgeOffsetType: OrbiterEdgeOffsetType,
    internal val offset: DpVolumeOffset,
)

Represents the alignment and offset configuration for an Orbiter in relation to the parent.

Members

Center

public class Center(
        offset: DpVolumeOffset = DpVolumeOffset(0.dp, 0.dp, OrbiterDefaults.Elevation)
    ) : OrbiterAlignment(SpatialAlignment.Center, OrbiterEdgeOffsetType.None, offset)

The center of the parent (non-edge).

TopStart

public class TopStart(
        edgeOffsetType: OrbiterEdgeOffsetType = OrbiterEdgeOffsetType.OuterEdge,
        offset: DpVolumeOffset = DpVolumeOffset(0.dp, 0.dp, OrbiterDefaults.Elevation),
    ) : OrbiterAlignment(SpatialAlignment.TopStart, edgeOffsetType, offset)

Top-Start edge alignment.

TopCenter

public class TopCenter(
        edgeOffsetType: OrbiterEdgeOffsetType = OrbiterEdgeOffsetType.OuterEdge,
        offset: DpVolumeOffset = DpVolumeOffset(0.dp, 0.dp, OrbiterDefaults.Elevation),
    ) : OrbiterAlignment(SpatialAlignment.TopCenter, edgeOffsetType, offset)

Top-Center edge alignment.

TopEnd

public class TopEnd(
        edgeOffsetType: OrbiterEdgeOffsetType = OrbiterEdgeOffsetType.OuterEdge,
        offset: DpVolumeOffset = DpVolumeOffset(0.dp, 0.dp, OrbiterDefaults.Elevation),
    ) : OrbiterAlignment(SpatialAlignment.TopEnd, edgeOffsetType, offset)

Top-End edge alignment.

CenterStart

public class CenterStart(
        edgeOffsetType: OrbiterEdgeOffsetType = OrbiterEdgeOffsetType.OuterEdge,
        offset: DpVolumeOffset = DpVolumeOffset(0.dp, 0.dp, OrbiterDefaults.Elevation),
    ) : OrbiterAlignment(SpatialAlignment.CenterStart, edgeOffsetType, offset)

Center-Start edge alignment.

CenterEnd

public class CenterEnd(
        edgeOffsetType: OrbiterEdgeOffsetType = OrbiterEdgeOffsetType.OuterEdge,
        offset: DpVolumeOffset = DpVolumeOffset(0.dp, 0.dp, OrbiterDefaults.Elevation),
    ) : OrbiterAlignment(SpatialAlignment.CenterEnd, edgeOffsetType, offset)

Center-End edge alignment.

BottomStart

public class BottomStart(
        edgeOffsetType: OrbiterEdgeOffsetType = OrbiterEdgeOffsetType.OuterEdge,
        offset: DpVolumeOffset = DpVolumeOffset(0.dp, 0.dp, OrbiterDefaults.Elevation),
    ) : OrbiterAlignment(SpatialAlignment.BottomStart, edgeOffsetType, offset)

Bottom-Start edge alignment.

BottomCenter

public class BottomCenter(
        edgeOffsetType: OrbiterEdgeOffsetType = OrbiterEdgeOffsetType.OuterEdge,
        offset: DpVolumeOffset = DpVolumeOffset(0.dp, 0.dp, OrbiterDefaults.Elevation),
    ) : OrbiterAlignment(SpatialAlignment.BottomCenter, edgeOffsetType, offset)

Bottom-Center edge alignment.

BottomEnd

public class BottomEnd(
        edgeOffsetType: OrbiterEdgeOffsetType = OrbiterEdgeOffsetType.OuterEdge,
        offset: DpVolumeOffset = DpVolumeOffset(0.dp, 0.dp, OrbiterDefaults.Elevation),
    ) : OrbiterAlignment(SpatialAlignment.BottomEnd, edgeOffsetType, offset)

Bottom-End edge alignment.

TopLeft

public class TopLeft(
        edgeOffsetType: OrbiterEdgeOffsetType = OrbiterEdgeOffsetType.OuterEdge,
        offset: DpVolumeOffset = DpVolumeOffset(0.dp, 0.dp, OrbiterDefaults.Elevation),
    ) : OrbiterAlignment(SpatialAbsoluteAlignment.TopLeft, edgeOffsetType, offset)

Top-Left absolute edge alignment.

TopRight

public class TopRight(
        edgeOffsetType: OrbiterEdgeOffsetType = OrbiterEdgeOffsetType.OuterEdge,
        offset: DpVolumeOffset = DpVolumeOffset(0.dp, 0.dp, OrbiterDefaults.Elevation),
    ) : OrbiterAlignment(SpatialAbsoluteAlignment.TopRight, edgeOffsetType, offset)

Top-Right absolute edge alignment.

CenterLeft

public class CenterLeft(
        edgeOffsetType: OrbiterEdgeOffsetType = OrbiterEdgeOffsetType.OuterEdge,
        offset: DpVolumeOffset = DpVolumeOffset(0.dp, 0.dp, OrbiterDefaults.Elevation),
    ) : OrbiterAlignment(SpatialAbsoluteAlignment.CenterLeft, edgeOffsetType, offset)

Center-Left absolute edge alignment.

CenterRight

public class CenterRight(
        edgeOffsetType: OrbiterEdgeOffsetType = OrbiterEdgeOffsetType.OuterEdge,
        offset: DpVolumeOffset = DpVolumeOffset(0.dp, 0.dp, OrbiterDefaults.Elevation),
    ) : OrbiterAlignment(SpatialAbsoluteAlignment.CenterRight, edgeOffsetType, offset)

Center-Right absolute edge alignment.

BottomLeft

public class BottomLeft(
        edgeOffsetType: OrbiterEdgeOffsetType = OrbiterEdgeOffsetType.OuterEdge,
        offset: DpVolumeOffset = DpVolumeOffset(0.dp, 0.dp, OrbiterDefaults.Elevation),
    ) : OrbiterAlignment(SpatialAbsoluteAlignment.BottomLeft, edgeOffsetType, offset)

Bottom-Left absolute edge alignment.

BottomRight

public class BottomRight(
        edgeOffsetType: OrbiterEdgeOffsetType = OrbiterEdgeOffsetType.OuterEdge,
        offset: DpVolumeOffset = DpVolumeOffset(0.dp, 0.dp, OrbiterDefaults.Elevation),
    ) : OrbiterAlignment(SpatialAbsoluteAlignment.BottomRight, edgeOffsetType, offset)

Bottom-Right absolute edge alignment.