Orbiter

Functions summary

Unit
@Composable
@ComposableOpenTarget(index = -1)
Orbiter(
    position: OrbiterPosition,
    shape: SpatialShape,
    content: @Composable @UiComposable () -> Unit
)

A composable that creates an orbiter along the edge or center of a parent spatial component.

Functions

@Composable
@ComposableOpenTarget(index = -1)
fun Orbiter(
    position: OrbiterPosition,
    shape: SpatialShape = OrbiterDefaults.Shape,
    content: @Composable @UiComposable () -> Unit
): Unit

A composable that creates an orbiter along the edge or center of a parent spatial component.

Orbiters are floating elements that are typically used to control the content within spatial panels and other entities that they're anchored to. They allow the content to have more space and give users quick access to features like navigation without obstructing the main content.

Sizing constraints depend on where the orbiter is declared:

import androidx.compose.foundation.background
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.size
import androidx.compose.material3.Text
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.unit.dp
import androidx.compose.ui.unit.sp
import androidx.xr.compose.spatial.Orbiter
import androidx.xr.compose.spatial.OrbiterDefaults
import androidx.xr.compose.spatial.OrbiterPosition
import androidx.xr.compose.spatial.OrbiterPosition.EdgeAlignment
import androidx.xr.compose.subspace.SpatialPanel
import androidx.xr.compose.subspace.layout.SubspaceModifier
import androidx.xr.compose.subspace.layout.height
import androidx.xr.compose.subspace.layout.width
import androidx.xr.compose.unit.DpVolumeOffset

SpatialPanel(SubspaceModifier.width(400.dp).height(300.dp)) {
    // Place a horizontal bar orbiter at the bottom-center edge of the panel.
    Orbiter(
        position =
            OrbiterPosition.BottomCenter(
                offset = DpVolumeOffset(x = 0.dp, y = 0.dp, z = OrbiterDefaults.Elevation),
                verticalEdgeAlignment = EdgeAlignment.Center,
            )
    ) {
        Box(
            modifier = Modifier.size(200.dp, 64.dp).background(Color.DarkGray),
            contentAlignment = Alignment.Center,
        ) {
            Text("Bottom Bar", color = Color.White, fontSize = 18.sp)
        }
    }
}
import androidx.compose.foundation.background
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.size
import androidx.compose.material3.Text
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.unit.dp
import androidx.compose.ui.unit.sp
import androidx.xr.compose.spatial.Orbiter
import androidx.xr.compose.spatial.OrbiterDefaults
import androidx.xr.compose.spatial.OrbiterPosition
import androidx.xr.compose.spatial.OrbiterPosition.EdgeAlignment
import androidx.xr.compose.subspace.SpatialPanel
import androidx.xr.compose.subspace.layout.SubspaceModifier
import androidx.xr.compose.subspace.layout.height
import androidx.xr.compose.subspace.layout.width
import androidx.xr.compose.unit.DpVolumeOffset

SpatialPanel(SubspaceModifier.width(400.dp).height(300.dp)) {
    // Place the orbiter at the top-start corner: horizontally aligned inside the left edge,
    // but vertically sitting completely above (outside) the top edge.
    Orbiter(
        position =
            OrbiterPosition.TopStart(
                offset = DpVolumeOffset(x = 0.dp, y = 0.dp, z = OrbiterDefaults.Elevation),
                horizontalEdgeAlignment = EdgeAlignment.Inside,
                verticalEdgeAlignment = EdgeAlignment.Outside,
            )
    ) {
        Box(
            modifier = Modifier.size(200.dp, 64.dp).background(Color.DarkGray),
            contentAlignment = Alignment.Center,
        ) {
            Text("Top Rail", color = Color.White, fontSize = 18.sp)
        }
    }
}
import androidx.compose.foundation.background
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.size
import androidx.compose.material3.Text
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.unit.dp
import androidx.compose.ui.unit.sp
import androidx.xr.compose.spatial.Orbiter
import androidx.xr.compose.spatial.OrbiterDefaults
import androidx.xr.compose.spatial.OrbiterPosition
import androidx.xr.compose.spatial.OrbiterPosition.EdgeAlignment
import androidx.xr.compose.subspace.SpatialPanel
import androidx.xr.compose.subspace.layout.SubspaceModifier
import androidx.xr.compose.subspace.layout.height
import androidx.xr.compose.subspace.layout.width
import androidx.xr.compose.unit.DpVolumeOffset

SpatialPanel(SubspaceModifier.width(400.dp).height(300.dp)) {
    // Place the orbiter at the top-start corner: horizontally sitting completely to the side
    // (outside) of the left edge, but vertically aligned inside the top boundary.
    Orbiter(
        position =
            OrbiterPosition.TopStart(
                offset = DpVolumeOffset(x = 0.dp, y = 0.dp, z = OrbiterDefaults.Elevation),
                horizontalEdgeAlignment = EdgeAlignment.Outside,
                verticalEdgeAlignment = EdgeAlignment.Inside,
            )
    ) {
        Box(
            modifier = Modifier.size(64.dp, 200.dp).background(Color.DarkGray),
            contentAlignment = Alignment.Center,
        ) {
            Text("Rail", color = Color.White, fontSize = 18.sp)
        }
    }
}
Parameters
position: OrbiterPosition

position of the orbiter relative to the parent spatial component, defined by its alignment, edge alignment, and offset

shape: SpatialShape = OrbiterDefaults.Shape

shape of the orbiter when rendered in 3D space

content: @Composable @UiComposable () -> Unit

content to display inside the orbiter