ui:platform/com.pico.spatial.ui.platform.containers

Package-level declarations

Types

OpenStageResult

sealed class OpenStageResult

The result of openStage.

SpatialContainerScope

interface SpatialContainerScope

Interface defining the scope of a spatial container, such as a WindowContainer or Stage.

SpatialContainerStateManager

interface SpatialContainerStateManager

Provides the SpatialContainer's states by State.

SpatialNavigator

interface SpatialNavigator

Navigator for spatial container.

interface StageScope : SpatialContainerScope

Interface representing the scope of a Stage, which extends the SpatialContainerScope.

enum StageStyle : Enum<StageStyle>

Stage's styles.

UpperLimbRenderModeChangeListener

interface UpperLimbRenderModeChangeListener

Listener for upper limb render mode change events.

WindowContainerParamsUpdater

interface WindowContainerParamsUpdater

Provides functionality to update and retrieve the mutable parameters of a WindowContainer.

WindowContainerScope

interface WindowContainerScope : SpatialContainerScope, WindowContainerConstraintsScope

Interface representing the scope of a WindowContainer, which extends the SpatialContainerScope and WindowContainerConstraintsScope.

Properties

LocalSpatialNavigator

val LocalSpatialNavigator: ProvidableCompositionLocal<SpatialNavigator>

LocalSpatialNavigator.

LocalWindowContainerParamsUpdater

val LocalWindowContainerParamsUpdater: ProvidableCompositionLocal<WindowContainerParamsUpdater>

LocalWindowContainerParamsUpdater.

Functions

suspend fun closeStage()

Closes the current Stage opened by the app.

closeWindowContainer

fun Context.closeWindowContainer(id: String, tag: String? = null)

Closes a WindowContainer by id and optional tag.

minimizeWindowContainer

fun Context.minimizeWindowContainer(id: String, tag: String? = null): Boolean

Minimizes a WindowContainer by id and optional tag. This can only be used when there is a stage open.

suspend fun Context.openStage(id: String, style: StageStyle? = null, bundle: Bundle? = null, upperLimbRenderMode: UpperLimbRenderMode? = null): OpenStageResult

Opens a Stage by id.

openWindowContainer

fun Context.openWindowContainer(id: String, tag: String? = null, bundle: Bundle? = null)

Opens a WindowContainer by id and optional tag.

restoreWindowContainer

fun Context.restoreWindowContainer(id: String, tag: String? = null): Boolean

Restores a WindowContainer by id and optional tag. This can only be used when there is a stage open.