Class: NearestLodBoundarySearchSession

Defined in: src/sdk/navigation/NearestLodBoundarySearchSession.ts:20

A nearest search session for boundaries (airspaces) in the form of LodBoundary objects.

Constructors

Constructor

new NearestLodBoundarySearchSession(cache, session, frameBudget): NearestLodBoundarySearchSession

Defined in: src/sdk/navigation/NearestLodBoundarySearchSession.ts:28

Constructor.

Parameters

Parameter	Type	Description
cache	LodBoundaryCache	The boundary cache this search session uses.
session	NearestBoundarySearchSession	The nearest boundary facility search session this search session uses.
frameBudget	number	The maximum amount of time allotted per frame to retrieve and process LodBoundary objects, in milliseconds.

Returns

NearestLodBoundarySearchSession

Properties

frameBudget

readonly frameBudget: number

Defined in: src/sdk/navigation/NearestLodBoundarySearchSession.ts:31

The maximum amount of time allotted per frame to retrieve and process LodBoundary objects, in milliseconds.

Methods

searchNearest()

searchNearest(lat, lon, radius, maxItems): Promise<NearestLodBoundarySearchResults>

Defined in: src/sdk/navigation/NearestLodBoundarySearchSession.ts:43

Searches for the nearest boundaries around a specified location.

Parameters

Parameter	Type	Description
lat	number	The latitude of the search center, in degrees.
lon	number	The longitude of the search center, in degrees.
radius	number	The radius of the search, in meters.
maxItems	number	The maximum number of items for which to search.

Returns

Promise<NearestLodBoundarySearchResults>

The nearest search results.

---

setFilter()

setFilter(classMask): void

Defined in: src/sdk/navigation/NearestLodBoundarySearchSession.ts:63

Sets this session's boundary class filter. The new filter takes effect with the next search executed in this session.

Parameters

Parameter	Type	Description
classMask	number	A bitmask defining the boundary classes to include in the search (0: exclude, 1: include). The bit index for each boundary class is equal to the value of the corresponding BoundaryType enum.

Returns

void