generateHorizon

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

Provides horizon data for the given location, based on a list of previously 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 result data consisting of one horizon snapshot and vehicle position and set of horizon options. Provided that the registerHorizonOptions was previously called to register each set of horizon options. If a specific set of options was not previously registered, neither the horizon snapshot data nor the vehicle position is generated for that set. If none of the sets of options was previously registered, the function returns an empty list.

Parameters

options

List of previously registered sets of options.

navigationSnapshot

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