ARGeoTrackingConfiguration

Inherits: RefCounted < Object

Configuration for GPS-anchored geo tracking AR sessions.

Description

Configures a session for geo tracking, which combines visual localization with GPS to place content at real-world geographic coordinates. Use with ARSession.run_geo_tracking(). Call check_availability() to verify the current location supports geo tracking before starting. iOS 14+ only. On visionOS and macOS, is_supported() returns false.

Properties

String

detection_image_group_name

""

int

environment_texturing

0

bool

is_light_estimation_enabled

true

int

plane_detection_mask

0

bool

wants_hdr_environment_textures

false

Methods

void

check_availability(callback: Callable) static

bool

is_supported() static

bool

set_detection_image_group(groupName: String)

Property Descriptions

String detection_image_group_name = "" 🔗

  • void set_detection_image_group_name(value: String)

  • String get_detection_image_group_name()

The asset-catalog image group used for reference-image detection during geo tracking.

int environment_texturing = 0 🔗

  • void set_environment_texturing(value: int)

  • int get_environment_texturing()

Controls how environment probes are generated during geo tracking.

bool is_light_estimation_enabled = true 🔗

  • void set_is_light_estimation_enabled(value: bool)

  • bool get_is_light_estimation_enabled()

When enabled, ARKit produces ARLightEstimate data for geo-tracking frames.

int plane_detection_mask = 0 🔗

  • void set_plane_detection_mask(value: int)

  • int get_plane_detection_mask()

Bitmask of PlaneDetection values to detect while geo tracking.

bool wants_hdr_environment_textures = false 🔗

  • void set_wants_hdr_environment_textures(value: bool)

  • bool get_wants_hdr_environment_textures()

Requests HDR environment textures when environment texturing is enabled.

Method Descriptions

void check_availability(callback: Callable) static 🔗

Checks whether geo tracking is currently available at the user’s location. The callback receives a boolean result and an optional error message.

bool is_supported() static 🔗

Returns true when the current device supports geo tracking.

bool set_detection_image_group(groupName: String) 🔗

Loads a reference image group from the asset catalog and assigns it to detection_image_group_name. Returns true on success.