HorizonEngine

Defines the interface to the horizon engine. The horizon engine generates virtual horizon data based on the previously registered horizon options. These options define the length and the map data collected for the horizon paths. The client of the horizon engine can register multiple sets of horizon options. The client can also request the engine provide horizon data for all or some of the option sets. The client of the engine can also update the horizon options by registering a new set of options or unregistering a previously registered set.

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

Functions

Link copied to clipboard
abstract fun close()
Link copied to clipboard
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.

Link copied to clipboard
abstract fun registerHorizonOptions(options: HorizonOptions)

Registers a set of horizon options. These options define the extent of the paths on the horizon and the map attributes that are collected about these paths.

Link copied to clipboard

Unregisters a previously registered set of horizon options. If the options set was not previously registered, the engine will report a warning and return immediately.