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

Package-level declarations

Types

ControllerHapticConfiguration

@Stable

class ControllerHapticConfiguration(val hover: HandControllerHapticType = HandControllerHapticType.Hover, val press: HandControllerHapticType = HandControllerHapticType.Press, val step: HandControllerHapticType = HandControllerHapticType.Step, val none: HandControllerHapticType = HandControllerHapticType.None)

Hand controller haptic configuration, provide

enum HandController : Enum<HandController>

Hand controller type in Pico OS, provide

HandControllerHapticType

@Stable

class HandControllerHapticType(level: Int, frequency: Int, duration: Int)

Hand controller haptic type that provides default haptic types:

enum LengthUnit : Enum<LengthUnit>

The type of physical lengthUnit.

LocalPhysicalLengthConverter

object LocalPhysicalLengthConverter

The LocalPhysicalLengthConverter for convert between physicalLength and Dp.

enum Material : Enum<Material>

Material in PICO design system is made up of two colors with blend mode.

PhysicalLengthConverter

interface PhysicalLengthConverter : Density

Interface for converting length between physical lengthUnit and Dp.

enum ScaledType : Enum<ScaledType>

The type of Scale.

SpatialAudioEffectConfiguration

@Stable

class SpatialAudioEffectConfiguration(val opClickEffect: SpatialSoundEffect = SpatialSoundEffect.OpClick, val opDragBeginEffect: SpatialSoundEffect = SpatialSoundEffect.OpDragBegin, val opDragEndEffect: SpatialSoundEffect = SpatialSoundEffect.OpDragEnd, val opDragScaleEffect: SpatialSoundEffect = SpatialSoundEffect.OpDragScale, val opCloseEffect: SpatialSoundEffect = SpatialSoundEffect.OpClose, val opLongPressEffect: SpatialSoundEffect = SpatialSoundEffect.OpLongPress, val stateSelectEffect: SpatialSoundEffect = SpatialSoundEffect.StateSelected, val stateUnselectEffect: SpatialSoundEffect = SpatialSoundEffect.StateUnselected, val stateOnEffect: SpatialSoundEffect = SpatialSoundEffect.StateOn, val stateOffEffect: SpatialSoundEffect = SpatialSoundEffect.StateOff, val stateSuccessEffect: SpatialSoundEffect = SpatialSoundEffect.StateSuccess, val stateFailureEffect: SpatialSoundEffect = SpatialSoundEffect.StateFailure)

Configuration for SpatialAudioEffectPlayer. Provide default sound effect for each operation.

SpatialAudioEffectPlayer

interface SpatialAudioEffectPlayer

Player for spatial audio effects. We provide the default implementation. Callers should use LocalAudioEffectPlayer to get the instance.

SpatialHandControllerHaptic

interface SpatialHandControllerHaptic

Hand controller haptic interface that provides haptic feedback when the user interacts with a hand controller, such as press, hover, and step.

SpatialSoundEffect

enum SpatialSoundEffect : Enum<SpatialSoundEffect>

Spatial sound effects. Current supported effects in PICO OS.

StageImmersionListener

interface StageImmersionListener

The StageImmersionListener listens to the immersion level of a progressive Stage.

StageImmersionManager

interface StageImmersionManager

The StageImmersionManager is responsible for providing and listening to the immersion level of a progressive Stage.

StageUpperLimbRenderModelManager

interface StageUpperLimbRenderModelManager

Manager for the upper limb render mode of a stage.

enum ViewPoint : Enum<ViewPoint>

The ViewPoint enum.

VolumeViewPointListener

interface VolumeViewPointListener

The VolumeViewPointListener interface.

VolumeViewPointManager

interface VolumeViewPointManager

The interface of volume View Point. When you register a VolumeViewPointListener to the VolumeViewPointManager, the VolumeViewPointListener will be called when the viewpoint of the container changes.

Properties

Centimeter2Meter

const val Centimeter2Meter: Float = 0.01f

Centimeter to meter.

@Stable

@get:Composable

val Double.centimeters: Dp

Double centimeters that are equivalent in Dp.

@Stable

@get:Composable

val Float.centimeters: Dp

Float centimeters that are equivalent in Dp.

@Stable

@get:Composable

val Int.centimeters: Dp

Int centimeters that are equivalent in Dp.

centimeters2Meters

@Stable

val Float.centimeters2Meters: Float

Converts size from centimeters to meters.

centimetersToDp

@Stable

@get:Composable

val Float.centimetersToDp: Dp

Converts centimeters to Dp.

LocalControllerHapticConfiguration

val LocalControllerHapticConfiguration: ProvidableCompositionLocal<ControllerHapticConfiguration>

Local hand controller haptic configuration.

LocalHandControllerHaptic

val LocalHandControllerHaptic: ProvidableCompositionLocal<SpatialHandControllerHaptic>

The CompositionLocal containing the current SpatialHandControllerHaptic.

LocalIsMaterialBackgroundEnabled

val LocalIsMaterialBackgroundEnabled: ProvidableCompositionLocal<Boolean>

Whether the Window (e.g WindowContainer's main window , dialog , popup) has a material background.

LocalSpatialAudioEffectConfiguration

val LocalSpatialAudioEffectConfiguration: ProvidableCompositionLocal<SpatialAudioEffectConfiguration>

Local composition value for SpatialAudioEffectConfiguration.

LocalSpatialContainerStateManager

val LocalSpatialContainerStateManager: ProvidableCompositionLocal<SpatialContainerStateManager>

The CompositionLocal containing the SpatialContainerStateManagerImpl of current SpatialContainer.

LocalSpatialContainerStateOwner

val LocalSpatialContainerStateOwner: ProvidableCompositionLocal<SpatialContainerStateOwner>

The CompositionLocal containing the current SpatialContainerStateOwner.

LocalStageImmersionManager

val LocalStageImmersionManager: ProvidableCompositionLocal<StageImmersionManager>

The CompositionLocal containing the current StageProgressiveImmersion.

LocalStageUpperLimbRenderModelManager

val LocalStageUpperLimbRenderModelManager: ProvidableCompositionLocal<StageUpperLimbRenderModelManager>

The CompositionLocal containing the current StageUpperLimbRenderModelManager.

LocalVolumeViewPointManager

val LocalVolumeViewPointManager: ProvidableCompositionLocal<VolumeViewPointManager>

The CompositionLocal containing the current LocalSpatialViewPointManager.

@Stable

@get:Composable

val Double.meters: Dp

Double meters that are equivalent in Dp.

@Stable

@get:Composable

val Float.meters: Dp

Float meters that are equivalent in Dp.

@Stable

@get:Composable

val Int.meters: Dp

Integer meters that are equivalent in Dp.

meters2Centimeters

@Stable

val Float.meters2Centimeters: Float

Converts size from meters to centimeters.

@Stable

@get:Composable

val Float.metersToDp: Dp

Converts meters to Dp.

@Stable

@get:Composable

val Dp.toCentimeters: Float

Converts Dp to centimeters.

@Stable

@get:Composable

val Dp.toMeters: Float

Converts Dp to meters.

Functions

convertFromMeters

fun Float.convertFromMeters(toUnit: LengthUnit): Float

Converts to the LengthUnit value from a LengthUnit.Meters value.

convertToMeters

fun Float.convertToMeters(fromUnit: LengthUnit): Float

Converts to a LengthUnit.Meters value from the LengthUnit value.

ProvidePhysicalLengthConverter

@Composable

fun ProvidePhysicalLengthConverter(scaledType: ScaledType, content: @Composable () -> Unit)

ProvidePhysicalLengthConverter binds values to LocalPhysicalLengthConverter's Reading the LocalPhysicalLengthConverter using LocalPhysicalLengthConverter.current

SpatialLocalsForPreview

@Composable

fun SpatialLocalsForPreview(content: @Composable () -> Unit)

A helper to provides some default impl of PICO OS specific CompositionLocal for @Preview functions DO NOT USE THIS FUNCTION IN PRODUCTION.

toHandController

fun InteractionKindExtra.toHandController(): HandController

Converts this InteractionKindExtra to the corresponding HandController.