# OrbiterPosition

Artifact: [androidx.xr.compose:compose](https://developer.android.com/jetpack/androidx/releases/xr-compose) [View Source](https://cs.android.com/search?q=file:androidx/xr/compose/spatial/Orbiter.kt+class:androidx.xr.compose.spatial.OrbiterPosition) Added in [1.0.0-beta02](https://developer.android.com/jetpack/androidx/releases/xr-compose#1.0.0-beta02)


```
sealed class OrbiterPosition
```

<br />

Known direct subclasses [OrbiterPosition.BottomCenter](https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.BottomCenter), [OrbiterPosition.BottomEnd](https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.BottomEnd), [OrbiterPosition.BottomLeft](https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.BottomLeft), [OrbiterPosition.BottomRight](https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.BottomRight), [OrbiterPosition.BottomStart](https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.BottomStart), [OrbiterPosition.CenterEnd](https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.CenterEnd), [OrbiterPosition.CenterLeft](https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.CenterLeft), [OrbiterPosition.CenterRight](https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.CenterRight), [OrbiterPosition.CenterStart](https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.CenterStart), [OrbiterPosition.Center](https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.Center), [OrbiterPosition.TopCenter](https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.TopCenter), [OrbiterPosition.TopEnd](https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.TopEnd), [OrbiterPosition.TopLeft](https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.TopLeft), [OrbiterPosition.TopRight](https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.TopRight), [OrbiterPosition.TopStart](https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.TopStart)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.BottomCenter` | Bottom-Center edge alignment. |
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.BottomEnd` | Bottom-End edge alignment. |
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.BottomLeft` | Bottom-Left absolute edge alignment. |
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.BottomRight` | Bottom-Right absolute edge alignment. |
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.BottomStart` | Bottom-Start edge alignment. |
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.CenterEnd` | Center-End edge alignment. |
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.CenterLeft` | Center-Left absolute edge alignment. |
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.CenterRight` | Center-Right absolute edge alignment. |
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.CenterStart` | Center-Start edge alignment. |
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.Center` | Center of the parent (non-edge). |
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.TopCenter` | Top-Center edge alignment. |
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.TopEnd` | Top-End edge alignment. |
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.TopLeft` | Top-Left absolute edge alignment. |
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.TopRight` | Top-Right absolute edge alignment. |
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.TopStart` | Top-Start edge alignment. |

*** ** * ** ***

Represents the position of an `https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/Orbiter.composable#Orbiter(androidx.xr.compose.spatial.ContentEdge.Horizontal,androidx.compose.ui.unit.Dp,androidx.xr.compose.spatial.OrbiterOffsetType,androidx.compose.ui.Alignment.Horizontal,androidx.xr.compose.subspace.layout.SpatialShape,androidx.compose.ui.unit.Dp,kotlin.Boolean,kotlin.Function0)` in relation to the parent, defined by its alignment, edge alignment, and offset. The edge alignment can be configured for both vertical bounds (i.e., the top or bottom edges of a panel) and horizontal bounds (i.e., the start or end sides of the panel) depending on the specified alignment.

TopStart horizontalEdgeAlignment = EdgeAlignment.Outside and verticalEdgeAlignment = EdgeAlignment.Outside, Left-to-Right (LTR):

```kotlin
+---+
| Orbiter |
+---+---+
          |                        |
          |                        |
          |      SpatialPanel      |
          |                        |
          |                        |
          +---+
```

TopStart horizontalEdgeAlignment = EdgeAlignment.Outside, verticalEdgeAlignment = EdgeAlignment.Inside, Left-to-Right (LTR):

```kotlin
+---+---+
| Orbiter |                        |
+---+                        |
          |      SpatialPanel      |
          |                        |
          |                        |
          +---+
```

TopStart horizontalEdgeAlignment = EdgeAlignment.Inside, verticalEdgeAlignment = EdgeAlignment.Outside, Left-to-Right (LTR):

```kotlin
    +---+
    | Orbiter |
    +---+---+
    |                        |
    |      SpatialPanel      |
    |                        |
    |                        |
    +---+
```

TopStart horizontalEdgeAlignment = EdgeAlignment.Inside and verticalEdgeAlignment = EdgeAlignment.Inside, Left-to-Right (LTR):

```kotlin
+---+---+
| Orbiter |              |
+---+              |
|      SpatialPanel      |
|                        |
|                        |
+---+
```

TopStart horizontalEdgeAlignment = EdgeAlignment.Center and verticalEdgeAlignment = EdgeAlignment.Center, Left-to-Right (LTR):

```kotlin
+---+
| Orbiter |---+
+---+                  |
    |                        |
    |      SpatialPanel      |
    |                        |
    |                        |
    +---+
```

BottomCenter verticalEdgeAlignment = EdgeAlignment.Center:

```kotlin
+---+
|                        |
|                        |
|      SpatialPanel      |
|                        |
|      +---+       |
+---| Orbiter |---+
       +---+
```

## Summary

| ### Nested types |
|---|
| `class https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.BottomCenter : https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition` Bottom-Center edge alignment. |
| `class https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.BottomEnd : https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition` Bottom-End edge alignment. |
| `class https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.BottomLeft : https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition` Bottom-Left absolute edge alignment. |
| `class https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.BottomRight : https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition` Bottom-Right absolute edge alignment. |
| `class https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.BottomStart : https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition` Bottom-Start edge alignment. |
| `class https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.Center : https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition` Center of the parent (non-edge). |
| `class https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.CenterEnd : https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition` Center-End edge alignment. |
| `class https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.CenterLeft : https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition` Center-Left absolute edge alignment. |
| `class https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.CenterRight : https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition` Center-Right absolute edge alignment. |
| `class https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.CenterStart : https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition` Center-Start edge alignment. |
| `value class https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.EdgeAlignment` Specifies how the `https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/Orbiter.composable#Orbiter(androidx.xr.compose.spatial.ContentEdge.Horizontal,androidx.compose.ui.unit.Dp,androidx.xr.compose.spatial.OrbiterOffsetType,androidx.compose.ui.Alignment.Horizontal,androidx.xr.compose.subspace.layout.SpatialShape,androidx.compose.ui.unit.Dp,kotlin.Boolean,kotlin.Function0)` is aligned relative to its parent's layout boundary. |
| `class https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.TopCenter : https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition` Top-Center edge alignment. |
| `class https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.TopEnd : https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition` Top-End edge alignment. |
| `class https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.TopLeft : https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition` Top-Left absolute edge alignment. |
| `class https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.TopRight : https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition` Top-Right absolute edge alignment. |
| `class https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition.TopStart : https://developer.android.com/reference/kotlin/androidx/xr/compose/spatial/OrbiterPosition` Top-Start edge alignment. |