Class

OrbiterPosition.EdgeAlignment

Specifies how the Orbiter is aligned relative to its parent's layout boundary.

Source set: Android
public class EdgeAlignment private constructor(private val value: Int)

Specifies how the Orbiter is aligned relative to its parent's layout boundary.

Note: Calculates alignment based on the parent's rectangular layout bounds, not its visual shape or rounded corners. Use a custom offset in DpVolumeOffset to align with curved or non-rectangular contours.

Members

Companion

Source set: Android
public companion object

Properties

Outside

Source set: Android
public val Outside: EdgeAlignment = EdgeAlignment(0)

Positions the Orbiter fully outside the parent's layout boundary.

The orbiter does not overlap the parent panel's layout bounds. For example, a side rail will sit completely to the side of the parent.

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

Inside

Source set: Android
public val Inside: EdgeAlignment = EdgeAlignment(1)

Positions the Orbiter fully inside the parent's layout boundary.

The orbiter completely overlaps the parent panel's layout bounds, functioning as an overlay.

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

Center

Source set: Android
public val Center: EdgeAlignment = EdgeAlignment(2)

Centers the Orbiter directly on the parent's layout boundary line.

The boundary line bisects the orbiter, placing it half-inside and half-outside the parent.

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

Content updated: