arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar

Package-level declarations

Types

class ArCoreAuthorizationException : Exception

Indicates an error with the authorization of ArCore on Google Cloud. This may be because:

class ArCoreResourceExhaustedException : Exception

Indicates that the application has exhausted the quota allotted to the ARCore API on the given Google Cloud project. The developer should request additional quota for the ARCore API for their project from the Google Cloud Console.

FlyoverSceneViewProxy

class FlyoverSceneViewProxy

Used to perform operations on a FlyoverSceneView.

FlyoverSceneViewScope

class FlyoverSceneViewScope

The receiver class of the FlyoverSceneView content lambda.

FlyoverSceneViewStatus

sealed class FlyoverSceneViewStatus

Represents the initialization status of a FlyoverSceneView.

TableTopSceneViewProxy

@Stable

class TableTopSceneViewProxy

Used to perform operations on a TableTopSceneView.

TableTopSceneViewScope

class TableTopSceneViewScope

The receiver class of the TableTopSceneView content lambda.

TableTopSceneViewStatus

sealed class TableTopSceneViewStatus

Represents the initialization status of a TableTopSceneView.

WorldScaleCalibrationViewColorScheme

@Immutable

data class WorldScaleCalibrationViewColorScheme

A class that holds the color scheme for the WorldScaleSceneViewScope.CalibrationView.

WorldScaleCalibrationViewDefaults

object WorldScaleCalibrationViewDefaults

Object holding the default theming for the WorldScaleSceneViewScope.CalibrationView.

WorldScaleCalibrationViewTypography

@Immutable

data class WorldScaleCalibrationViewTypography

A class that holds the typography for the WorldScaleSceneViewScope.CalibrationView.

WorldScaleSceneViewProxy

@Stable

class WorldScaleSceneViewProxy

Used to perform operations on a WorldScaleSceneView.

WorldScaleSceneViewScope

class WorldScaleSceneViewScope

The receiver class of the WorldScaleSceneView content lambda.

WorldScaleSceneViewStatus

sealed class WorldScaleSceneViewStatus

Represents the initialization status of a WorldScaleSceneView.

WorldScaleTrackingMode

sealed class WorldScaleTrackingMode

Defines how the position and orientation of a device are determined and how the WorldScaleSceneView's camera is synchronized with that position and orientation.

WorldScaleVpsAvailability

sealed class WorldScaleVpsAvailability

Represents the availability of Google's Virtual Positioning Service at a specific location.

Functions

FlyoverSceneView

@Composable

fun FlyoverSceneView(arcGISScene: ArcGISScene, flyoverSceneViewProxy: FlyoverSceneViewProxy, translationFactor: Double, modifier: Modifier = Modifier, onInitializationStatusChanged: (FlyoverSceneViewStatus) -> Unit? = null, onViewpointChangedForCenterAndScale: (Viewpoint) -> Unit? = null, onViewpointChangedForBoundingGeometry: (Viewpoint) -> Unit? = null, graphicsOverlays: List<GraphicsOverlay> = remember { emptyList() }, viewLabelProperties: ViewLabelProperties = remember { ViewLabelProperties() }, selectionProperties: SelectionProperties = remember { SelectionProperties() }, isAttributionBarVisible: Boolean = true, onAttributionTextChanged: (String) -> Unit? = null, onAttributionBarLayoutChanged: (AttributionBarLayoutChangeEvent) -> Unit? = null, analysisOverlays: List<AnalysisOverlay> = remember { emptyList() }, imageOverlays: List<ImageOverlay> = remember { emptyList() }, atmosphereEffect: AtmosphereEffect = AtmosphereEffect.Realistic, timeExtent: TimeExtent? = null, onTimeExtentChanged: (TimeExtent?) -> Unit? = null, spaceEffect: SpaceEffect = SpaceEffect.Stars, sunTime: Instant = SceneViewDefaults.DefaultSunTime, sunLighting: LightingMode = LightingMode.NoLight, ambientLightColor: Color = SceneViewDefaults.DefaultAmbientLightColor, onNavigationChanged: (isNavigating: Boolean) -> Unit? = null, onSpatialReferenceChanged: (spatialReference: SpatialReference?) -> Unit? = null, onLayerViewStateChanged: (GeoView.GeoViewLayerViewStateChanged) -> Unit? = null, onInteractingChanged: (isInteracting: Boolean) -> Unit? = null, onCurrentViewpointCameraChanged: (camera: Camera) -> Unit? = null, onRotate: (RotationChangeEvent) -> Unit? = null, onScale: (ScaleChangeEvent) -> Unit? = null, onUp: (UpEvent) -> Unit? = null, onDown: (DownEvent) -> Unit? = null, onSingleTapConfirmed: (SingleTapConfirmedEvent) -> Unit? = null, onDoubleTap: (DoubleTapEvent) -> Unit? = null, onLongPress: (LongPressEvent) -> Unit? = null, onTwoPointerTap: (TwoPointerTapEvent) -> Unit? = null, onPan: (PanChangeEvent) -> Unit? = null, content: @Composable FlyoverSceneViewScope.() -> Unit? = null)

A scene view that provides an augmented reality fly over experience.

rememberFlyoverSceneViewProxy

@Composable

fun rememberFlyoverSceneViewProxy(location: Point, heading: Double): FlyoverSceneViewProxy

Create and remember a FlyoverSceneViewProxy.

rememberFlyoverSceneViewStatus

@Composable

fun rememberFlyoverSceneViewStatus(): MutableState<FlyoverSceneViewStatus>

Remembers a MutableState of FlyoverSceneViewStatus that can be used to track the initialization status of a FlyoverSceneView. The initial value of the MutableState is FlyoverSceneViewStatus.Initializing.

rememberTableTopSceneViewStatus

@Composable

fun rememberTableTopSceneViewStatus(): MutableState<TableTopSceneViewStatus>

Remembers a MutableState of TableTopSceneViewStatus that can be used to track the initialization status of a TableTopSceneView. The initial value of the MutableState is TableTopSceneViewStatus.Initializing.

rememberWorldScaleSceneViewStatus

@Composable

fun rememberWorldScaleSceneViewStatus(): MutableState<WorldScaleSceneViewStatus>

Remembers a MutableState of WorldScaleSceneViewStatus that can be used to track the initialization status of a WorldScaleSceneView. The initial value of the MutableState is WorldScaleSceneViewStatus.Initializing.

TableTopSceneView

@Composable

fun TableTopSceneView(arcGISScene: ArcGISScene, arcGISSceneAnchor: Point, translationFactor: Double, modifier: Modifier = Modifier, clippingDistance: Double? = null, onInitializationStatusChanged: (TableTopSceneViewStatus) -> Unit? = null, requestCameraPermissionAutomatically: Boolean = true, onViewpointChangedForCenterAndScale: (Viewpoint) -> Unit? = null, onViewpointChangedForBoundingGeometry: (Viewpoint) -> Unit? = null, graphicsOverlays: List<GraphicsOverlay> = remember { emptyList() }, tableTopSceneViewProxy: TableTopSceneViewProxy = remember { TableTopSceneViewProxy() }, viewLabelProperties: ViewLabelProperties = remember { ViewLabelProperties() }, selectionProperties: SelectionProperties = remember { SelectionProperties() }, isAttributionBarVisible: Boolean = true, onAttributionTextChanged: (String) -> Unit? = null, onAttributionBarLayoutChanged: (AttributionBarLayoutChangeEvent) -> Unit? = null, analysisOverlays: List<AnalysisOverlay> = remember { emptyList() }, imageOverlays: List<ImageOverlay> = remember { emptyList() }, timeExtent: TimeExtent? = null, onTimeExtentChanged: (TimeExtent?) -> Unit? = null, sunTime: Instant = SceneViewDefaults.DefaultSunTime, sunLighting: LightingMode = LightingMode.NoLight, ambientLightColor: Color = SceneViewDefaults.DefaultAmbientLightColor, onNavigationChanged: (isNavigating: Boolean) -> Unit? = null, onSpatialReferenceChanged: (spatialReference: SpatialReference?) -> Unit? = null, onLayerViewStateChanged: (GeoView.GeoViewLayerViewStateChanged) -> Unit? = null, onInteractingChanged: (isInteracting: Boolean) -> Unit? = null, onCurrentViewpointCameraChanged: (camera: Camera) -> Unit? = null, onRotate: (RotationChangeEvent) -> Unit? = null, onScale: (ScaleChangeEvent) -> Unit? = null, onUp: (UpEvent) -> Unit? = null, onDown: (DownEvent) -> Unit? = null, onSingleTapConfirmed: (SingleTapConfirmedEvent) -> Unit? = null, onDoubleTap: (DoubleTapEvent) -> Unit? = null, onLongPress: (LongPressEvent) -> Unit? = null, onTwoPointerTap: (TwoPointerTapEvent) -> Unit? = null, onPan: (PanChangeEvent) -> Unit? = null, content: @Composable TableTopSceneViewScope.() -> Unit? = null)

A scene view that provides an augmented reality table top experience.

WorldScaleSceneView

@Composable

fun WorldScaleSceneView(arcGISScene: ArcGISScene, modifier: Modifier = Modifier, worldScaleTrackingMode: WorldScaleTrackingMode = remember { WorldScaleTrackingMode.World() }, clippingDistance: Double? = null, onInitializationStatusChanged: (WorldScaleSceneViewStatus) -> Unit? = null, onTrackingErrorChanged: (Throwable?) -> Unit? = null, onViewpointChangedForCenterAndScale: (Viewpoint) -> Unit? = null, onViewpointChangedForBoundingGeometry: (Viewpoint) -> Unit? = null, graphicsOverlays: List<GraphicsOverlay> = remember { emptyList() }, worldScaleSceneViewProxy: WorldScaleSceneViewProxy = remember { WorldScaleSceneViewProxy() }, viewLabelProperties: ViewLabelProperties = remember { ViewLabelProperties() }, selectionProperties: SelectionProperties = remember { SelectionProperties() }, isAttributionBarVisible: Boolean = true, onAttributionTextChanged: (String) -> Unit? = null, onAttributionBarLayoutChanged: (AttributionBarLayoutChangeEvent) -> Unit? = null, analysisOverlays: List<AnalysisOverlay> = remember { emptyList() }, imageOverlays: List<ImageOverlay> = remember { emptyList() }, timeExtent: TimeExtent? = null, onTimeExtentChanged: (TimeExtent?) -> Unit? = null, sunTime: Instant = SceneViewDefaults.DefaultSunTime, sunLighting: LightingMode = LightingMode.NoLight, ambientLightColor: Color = SceneViewDefaults.DefaultAmbientLightColor, onNavigationChanged: (isNavigating: Boolean) -> Unit? = null, onSpatialReferenceChanged: (spatialReference: SpatialReference?) -> Unit? = null, onLayerViewStateChanged: (GeoView.GeoViewLayerViewStateChanged) -> Unit? = null, onInteractingChanged: (isInteracting: Boolean) -> Unit? = null, onCurrentViewpointCameraChanged: (camera: Camera) -> Unit? = null, onRotate: (RotationChangeEvent) -> Unit? = null, onScale: (ScaleChangeEvent) -> Unit? = null, onUp: (UpEvent) -> Unit? = null, onDown: (DownEvent) -> Unit? = null, onSingleTapConfirmed: (SingleTapConfirmedEvent) -> Unit? = null, onDoubleTap: (DoubleTapEvent) -> Unit? = null, onLongPress: (LongPressEvent) -> Unit? = null, onTwoPointerTap: (TwoPointerTapEvent) -> Unit? = null, onPan: (PanChangeEvent) -> Unit? = null, content: @Composable WorldScaleSceneViewScope.() -> Unit? = null)

A scene view that provides a world-scale augmented reality experience.