WorldScaleSceneViewProps

WorldScaleSceneViewProps = ArSceneViewProps & object

Defined in: packages/expo-arcgis-toolkit/src/WorldScaleSceneView.tsx:20

Type Declaration

calibrationButtonAlignment?

optional calibrationButtonAlignment?: CalibrationButtonAlignment

Where the calibration button sits.

Default

'bottom'

Platform

ios

calibrationViewHidden?

optional calibrationViewHidden?: boolean

Hides the Toolkit’s calibration view, which lets the user adjust heading and elevation.

Default

false

Platform

ios

clippingDistance?

optional clippingDistance?: number

Clips the scene to this many meters around the camera; none when unset.

onCalibratingChange?

optional onCalibratingChange?: (isCalibrating) => void

Called when the user starts or stops calibrating.

Parameters

isCalibrating

boolean

Returns

void

Platform

ios

onInitializationStatusChange?

optional onInitializationStatusChange?: (status) => void

Called as initialization goes: initializing, initialized, or failed.

Parameters

status

ArInitializationStatus

Returns

void

Platform

android — the Swift Toolkit reports no status.

onTrackingErrorChange?

optional onTrackingErrorChange?: (error) => void

Called when tracking fails, with the error, and with null once it recovers.

Parameters

error

string | null

Returns

void

Platform

android

trackingMode?

optional trackingMode?: "worldTracking" | "geoTracking" | "preferGeoTracking"

How ARKit tracks the world (the Swift Toolkit’s AppleWorldTracking.Mode):

• worldTracking: the device’s location and compass;
• geoTracking: Apple’s geo tracking, where it is available;
• preferGeoTracking: geo tracking where it is available, world tracking elsewhere.

Default

'worldTracking'

Platform

ios — on Android, see worldScaleTrackingMode.

worldScaleTrackingMode?

optional worldScaleTrackingMode?: "world" | "geospatial"

How ARCore tracks the world (the Kotlin Toolkit’s WorldScaleTrackingMode):

• world: the device’s location and compass;
• geospatial: Google’s Geospatial API, where Street View covers the area. It needs a Google Cloud API key with the ARCore API: the config plugin’s ar.arcoreApiKey.

Default

'world'

Platform

android — on iOS, see trackingMode.