Class

OrbiterAlignment

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

Source set: Android
@Deprecated(message = "Use OrbiterPosition instead.", replaceWith = ReplaceWith("OrbiterPosition"))
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.

TopStart OrbiterEdgeOffsetType.None LTR Visual representation:

+---------+
| Orbiter | -----------------+
+---------+                  |
|                        |
|      SpatialPanel      |
|                        |
|                        |
+------------------------+

BottomCenter OrbiterEdgeOffsetType.OuterEdge Visual representation:

+------------------------+
|                        |
|                        |
|      SpatialPanel      |
|                        |
|                        |
+------+----------+------+
| Orbiter  |
+----------+

Members

Center

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

Center of the parent (non-edge).

Parameters
offset manual offset applied to the orbiter after the edgeOffsetType's offset is applied. This offset will automatically adjust the horizontal offset according to the layout direction: when the layout direction is LTR, positive x offsets will move the content to the right and when the layout direction is RTL, positive x offsets will move the content to the left.

TopStart

Source set: Android
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.

Parameters
edgeOffsetType boundary offset behavior relative to the parent bounds
offset manual offset applied to the orbiter after the edgeOffsetType's offset is applied. This offset will automatically adjust the horizontal offset according to the layout direction: when the layout direction is LTR, positive x offsets will move the content to the right and when the layout direction is RTL, positive x offsets will move the content to the left.

TopCenter

Source set: Android
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.

Parameters
edgeOffsetType boundary offset behavior relative to the parent bounds
offset manual offset applied to the orbiter after the edgeOffsetType's offset is applied. This offset will automatically adjust the horizontal offset according to the layout direction: when the layout direction is LTR, positive x offsets will move the content to the right and when the layout direction is RTL, positive x offsets will move the content to the left.

TopEnd

Source set: Android
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.

Parameters
edgeOffsetType boundary offset behavior relative to the parent bounds
offset manual offset applied to the orbiter after the edgeOffsetType's offset is applied. This offset will automatically adjust the horizontal offset according to the layout direction: when the layout direction is LTR, positive x offsets will move the content to the right and when the layout direction is RTL, positive x offsets will move the content to the left.

CenterStart

Source set: Android
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.

Parameters
edgeOffsetType boundary offset behavior relative to the parent bounds
offset manual offset applied to the orbiter after the edgeOffsetType's offset is applied. This offset will automatically adjust the horizontal offset according to the layout direction: when the layout direction is LTR, positive x offsets will move the content to the right and when the layout direction is RTL, positive x offsets will move the content to the left.

CenterEnd

Source set: Android
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.

Parameters
edgeOffsetType boundary offset behavior relative to the parent bounds
offset manual offset applied to the orbiter after the edgeOffsetType's offset is applied. This offset will automatically adjust the horizontal offset according to the layout direction: when the layout direction is LTR, positive x offsets will move the content to the right and when the layout direction is RTL, positive x offsets will move the content to the left.

BottomStart

Source set: Android
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.

Parameters
edgeOffsetType boundary offset behavior relative to the parent bounds
offset manual offset applied to the orbiter after the edgeOffsetType's offset is applied. This offset will automatically adjust the horizontal offset according to the layout direction: when the layout direction is LTR, positive x offsets will move the content to the right and when the layout direction is RTL, positive x offsets will move the content to the left.

BottomCenter

Source set: Android
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.

Parameters
edgeOffsetType boundary offset behavior relative to the parent bounds
offset manual offset applied to the orbiter after the edgeOffsetType's offset is applied. This offset will automatically adjust the horizontal offset according to the layout direction: when the layout direction is LTR, positive x offsets will move the content to the right and when the layout direction is RTL, positive x offsets will move the content to the left.

BottomEnd

Source set: Android
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.

Parameters
edgeOffsetType boundary offset behavior relative to the parent bounds
offset manual offset applied to the orbiter after the edgeOffsetType's offset is applied. This offset will automatically adjust the horizontal offset according to the layout direction: when the layout direction is LTR, positive x offsets will move the content to the right and when the layout direction is RTL, positive x offsets will move the content to the left.

TopLeft

Source set: Android
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.

Parameters
edgeOffsetType boundary offset behavior relative to the parent bounds
offset manual offset applied to the orbiter after the edgeOffsetType's offset is applied without considering layout direction

TopRight

Source set: Android
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.

Parameters
edgeOffsetType boundary offset behavior relative to the parent bounds
offset manual offset applied to the orbiter after the edgeOffsetType's offset is applied without considering layout direction

CenterLeft

Source set: Android
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.

Parameters
edgeOffsetType boundary offset behavior relative to the parent bounds
offset manual offset applied to the orbiter after the edgeOffsetType's offset is applied without considering layout direction

CenterRight

Source set: Android
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.

Parameters
edgeOffsetType boundary offset behavior relative to the parent bounds
offset manual offset applied to the orbiter after the edgeOffsetType's offset is applied without considering layout direction

BottomLeft

Source set: Android
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.

Parameters
edgeOffsetType boundary offset behavior relative to the parent bounds
offset manual offset applied to the orbiter after the edgeOffsetType's offset is applied without considering layout direction

BottomRight

Source set: Android
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.

Parameters
edgeOffsetType boundary offset behavior relative to the parent bounds
offset manual offset applied to the orbiter after the edgeOffsetType's offset is applied without considering layout direction

Content updated: