HorizonOptions

data class HorizonOptions(val elementTypes: List<HorizonElementType>, val mainPathSearchOptions: MainPathSearchOptions, val subPathSearchOptions: List<SubPathSearchOptions> = listOf(), val numberOfPaths: Int = DEFAULT_NUMBER_OF_PATHS)

Horizon options. For information on how to manage horizon options see HorizonEngine.registerHorizonOptions and HorizonEngine.unregisterHorizonOptions. Horizon options define the extent of the paths in the horizon and the map attributes to be collected for these paths. A set of horizon options consists of the following:

  1. the set of horizon element types the client is interested in,

  2. the path search options for the main path (the path that the user is currently on, extending along the most likely trajectory),

  3. the path search options for the sub-paths (any horizon path that is not the main path),

  4. the maximum number of paths the client can receive.

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

Parameters

elementTypes

Types of horizon element of interest.

mainPathSearchOptions

Search options for the main path.

subPathSearchOptions

Search options for sub-path levels. The container element at index i encodes search options for path level i + 1. The horizon is extended to the deepest sub-path level, as specified by the search options for sub-path levels.

numberOfPaths

Maximum number of paths the client can receive. The default value is DEFAULT_NUMBER_OF_PATHS.

Throws

Constructors

Link copied to clipboard
constructor(elementTypes: List<HorizonElementType>, mainPathSearchOptions: MainPathSearchOptions, subPathSearchOptions: List<SubPathSearchOptions> = listOf(), numberOfPaths: Int = DEFAULT_NUMBER_OF_PATHS)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard