WemapPositioningSDK VPS ARCore/com.getwemap.sdk.positioning.wemapvpsarcore/VpsARCoreLocationSource

VpsARCoreLocationSource

class VpsARCoreLocationSource : LocationSource, CameraCaptureProvider, ConveyingDetector, AttitudeSource, NavigationManagerInterceptor

A LocationSource providing indoor positioning based on Wemap's VPS (Visual Positioning System) and ARCore.

This is the @MainThread public facade. It owns the ARCore binding + GL frame plumbing and the VpsBrain thread, and delegates all positioning orchestration to a brain-confined VpsEngine (the Android counterpart of iOS's VPSEngine), re-exposing the engine's result flows. See § VPS brain — single-thread confinement.

Constructors

VpsARCoreLocationSource

constructor(context: Context, session: CoreSession, vpsConfig: VpsConfig = VpsConfig())

Creates a VPS location source bound to the given session.

Types

object Companion

DegradedPositioningReason

enum DegradedPositioningReason : Enum<VpsARCoreLocationSource.DegradedPositioningReason>

Describes why VPS positioning is currently degraded.

NotPositioningReason

enum NotPositioningReason : Enum<VpsARCoreLocationSource.NotPositioningReason>

The reason why the system is not currently positioning the user.

enum ScanStatus : Enum<VpsARCoreLocationSource.ScanStatus>

Describes whether a VPS scan is currently in progress.

sealed class State

Describes the current quality of the VPS positioning.

Properties

open override val attitudes: Flow<Attitude>

backgroundScanStatus

val backgroundScanStatus: VpsARCoreLocationSource.ScanStatus

The current background scan status.

backgroundScanStatuses

val backgroundScanStatuses: StateFlow<VpsARCoreLocationSource.ScanStatus>

Emits the background scan status whenever it changes.

cameraTrackingStates

val cameraTrackingStates: Flow<CameraTrackingState>

Emits the ARCore camera tracking state each time it changes.

open override val coordinates: Flow<Coordinate>

open override val errors: Flow<Throwable>

open override var isStarted: Boolean

var itinerary: Itinerary?

The navigation itinerary used by the location source.

val scanStatus: VpsARCoreLocationSource.ScanStatus

The current foreground scan status.

val scanStatuses: StateFlow<VpsARCoreLocationSource.ScanStatus>

Emits the foreground scan status whenever it changes.

val state: VpsARCoreLocationSource.State

The current positioning state.

val states: StateFlow<VpsARCoreLocationSource.State>

Emits the positioning State whenever it changes (including its reason).

supportsAttitude

open override val supportsAttitude: Boolean = true

userLocalizationUpdates

val userLocalizationUpdates: Flow<UserLocalizationUpdate>

Emits a UserLocalizationUpdate each time the source successfully localizes the user.

Functions

open override fun bind(context: Context, surfaceView: SurfaceView)

Binds the camera preview to this location source.

open override fun deinit()

distanceToVpsCoverageFrom

suspend fun distanceToVpsCoverageFrom(coordinate: Coordinate): Double

Calculates the distance to the nearest point of VPS coverage from the provided coordinate.

forceUpdatePosition

fun ~~forceUpdatePosition~~(coordinate: Coordinate, attitude: Attitude? = null): Boolean

Forces a manual update of the geo-reference used by the pose estimator.

isVpsAvailableAt

suspend fun isVpsAvailableAt(coordinate: Coordinate): Boolean

Checks if the provided coordinate is inside the VPS-covered area.

@RequiresPermission(value = "android.permission.CAMERA")

open override fun start()

fun startScan()

Starts a foreground VPS scan of the environment.

open override fun stop()

Stops the ongoing foreground VPS scan.

open override fun unbind()