Package-level declarations

Types

Link copied to clipboard
enum LengthUnit : Enum<LengthUnit>

the type of physical lengthUnit

Link copied to clipboard

The LocalPhysicalLengthConverter for convert between physicalLength and Dp

Link copied to clipboard
enum Material : Enum<Material>

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

Link copied to clipboard

Interface for converting length between physical lengthUnit and Dp

Link copied to clipboard
enum ScaledType : Enum<ScaledType>

the type of Scale

Link copied to clipboard

Player for spatial audio effects. we will provider the default implementation. callers should use LocalAudioEffectPlayer to get the instance.

Link copied to clipboard

Spatial sound effects. Current supported effects in PICO OS

Link copied to clipboard

The StageImmersionListener is responsible for listening the immersion level of a progressive Stage.

Link copied to clipboard

The StageImmersionManager is responsible for provider and listen the immersion level of a progressive Stage.

Link copied to clipboard

Manager for upper limb render model of stage.

Link copied to clipboard
enum ViewPoint : Enum<ViewPoint>

The ViewPoint enum.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
const val Centimeter2Meter: Float = 0.01f

centimeter to meter

Link copied to clipboard
@Stable
@get:Composable
val Double.centimeters: Dp

Double centimeters that equivalent in Dp

@Stable
@get:Composable
val Float.centimeters: Dp

Float centimeters that equivalent in Dp

@Stable
@get:Composable
val Int.centimeters: Dp

Int centimeters that equivalent in Dp

Link copied to clipboard
@Stable
val Float.centimeters2Meters: Float

Convert size from centimeters to meters

Link copied to clipboard
val LocalIsMaterialBackgroundEnabled: ProvidableCompositionLocal<Boolean>

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

Link copied to clipboard

The CompositionLocal containing the current SpatialContainerStateOwner.

Link copied to clipboard
val LocalStageImmersionManager: ProvidableCompositionLocal<StageImmersionManager>

The CompositionLocal containing the current StageProgressiveImmersion.

Link copied to clipboard

The CompositionLocal containing the current StageUpperLimbRenderModelManager.

Link copied to clipboard
val LocalVolumeViewPointManager: ProvidableCompositionLocal<VolumeViewPointManager>

The CompositionLocal containing the current LocalSpatialViewPointManager.

Link copied to clipboard
@Stable
@get:Composable
val Double.meters: Dp

Double meters that equivalent in Dp

@Stable
@get:Composable
val Float.meters: Dp

Float meters that equivalent in Dp

@Stable
@get:Composable
val Int.meters: Dp

Integer meters that equivalent in Dp

Link copied to clipboard
@Stable
val Float.meters2Centimeters: Float

Convert size from meters to centimeters

Functions

Link copied to clipboard
fun Float.convertFromMeters(toUnit: LengthUnit): Float

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

Link copied to clipboard
fun Float.convertToMeters(fromUnit: LengthUnit): Float

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

Link copied to clipboard
Link copied to clipboard
@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.