SpatialPanel

Functions summary

Unit
@Composable
@SubspaceComposable
SpatialPanel(
    modifier: SubspaceModifier,
    shape: SpatialShape,
    dragPolicy: DragPolicy?,
    resizePolicy: ResizePolicy?,
    interactionPolicy: InteractionPolicy?,
    content: @Composable @UiComposable () -> Unit
)

Creates a SpatialPanel representing a 2D plane in 3D space in which an application can fill content.

Functions

SpatialPanel

@Composable
@SubspaceComposable
fun SpatialPanel(
    modifier: SubspaceModifier = SubspaceModifier,
    shape: SpatialShape = SpatialPanelDefaults.shape,
    dragPolicy: DragPolicy? = null,
    resizePolicy: ResizePolicy? = null,
    interactionPolicy: InteractionPolicy? = null,
    content: @Composable @UiComposable () -> Unit
): Unit

Creates a SpatialPanel representing a 2D plane in 3D space in which an application can fill content.

Parameters
modifier: SubspaceModifier = SubspaceModifier

SubspaceModifiers to apply to the SpatialPanel.

shape: SpatialShape = SpatialPanelDefaults.shape

The shape of this Spatial Panel.

dragPolicy: DragPolicy? = null

An optional DragPolicy that defines the motion behavior of the SpatialPanel. This can be either a MovePolicy for free movement or an AnchorPolicy for anchoring to real-world surfaces. If a policy is provided, draggable UI controls will be shown, allowing the user to manipulate the panel in 3D space. If null, no motion behavior is applied.

resizePolicy: ResizePolicy? = null

An optional ResizePolicy that defines the resizing behavior of this SpatialPanel. If a policy is provided, resize UI controls will be shown, allowing the user to resize the element in 3D space. If null, no resize behavior is applied to the element.

interactionPolicy: InteractionPolicy? = null

An optional InteractionPolicy that can be set to detect 3D input events. Setting this will not intercept 2D input events and is intended to provide additional spatial input information.

content: @Composable @UiComposable () -> Unit

The composable content to render within the SpatialPanel.