generateHorizon

abstract fun generateHorizon(options: List<HorizonOptions>, navigationSnapshot: NavigationSnapshot): List<HorizonResult>

Provides horizon data for the given location, based on a list of registered sets of horizon options.

Important: This is a Public Preview API. It may be changed or removed at any time.

Return

List of horizon results generated for the specified sets of horizon options. The list contains a separate horizon result for each set of options. A horizon result consists of the corresponding set of options, a horizon snapshot and a horizon position. If a specific set of options was not previously registered, no horizon result is generated for that set of options. If none of the sets of options was previously registered, the function returns an empty list.

Parameters

options

List of previously registered sets of horizon options.

navigationSnapshot

Snapshot of the current navigation session. The required location information is extracted from this navigation snapshot.

Throws

if failed to generate horizon data.