Class: MapWaypointRenderer<W>
A renderer that draws waypoints to a map. For the renderer to draw a waypoint, the waypoint must first be registered with the renderer. Waypoints may be registered under multiple render roles. Each render role is represented as a bit flag. During each render cycle, a specific role is chosen for each waypoint by a selector function. Once the role is chosen, the waypoint will be rendered in that role.
Type parameters
| Name | Type |
|---|---|
W | extends MapWaypoint = MapWaypoint |
Hierarchy
MapWaypointRenderer
Constructors
constructor
• new MapWaypointRenderer<W>(textManager, selectRoleToRender?): MapWaypointRenderer<W>
Constructor.
Type parameters
| Name | Type |
|---|---|
W | extends MapWaypoint = MapWaypoint |
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
textManager | MapCullableTextLabelManager | undefined | The text manager to use for waypoint labels. |
selectRoleToRender | MapWaypointRenderRoleSelector<W> | MapWaypointRenderer.DEFAULT_RENDER_ROLE_SELECTOR | A function which selects roles under which to render waypoints. Defaults to MapWaypointRenderer.DEFAULT_RENDER_ROLE_SELECTOR. |
Returns
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:141
Properties
onWaypointAdded
• Readonly onWaypointAdded: SubEvent<any, W>
An event to subscribe to, fired when waypoints are added to the renderer.
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:128
onWaypointRemoved
• Readonly onWaypointRemoved: SubEvent<any, W>
An event to subscribe to, fired when waypoints are removed from the render.
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:133
registered
• Protected Readonly registered: Map<string, MapWaypointRendererEntry<W>>
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:116
roleDefinitions
• Protected Readonly roleDefinitions: Map<number, MapWaypointRenderRoleDef<W>>
This renderer's render role definitions. Waypoints assigned to be rendered under a role or combination of roles with no definition will not be rendered.
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:123
selectRoleToRender
• Protected Readonly selectRoleToRender: MapWaypointRenderRoleSelector<W> = MapWaypointRenderer.DEFAULT_RENDER_ROLE_SELECTOR
A function which selects roles under which to render waypoints. Defaults to MapWaypointRenderer.DEFAULT_RENDER_ROLE_SELECTOR.
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:143
textManager
• Protected Readonly textManager: MapCullableTextLabelManager
The text manager to use for waypoint labels.
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:142
toCleanUp
• Protected Readonly toCleanUp: Set<MapWaypointRendererEntry<W>>
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:117
NULL_ROLE_DEF
▪ Static Protected Readonly NULL_ROLE_DEF: Object
A null render role definition. Icons rendered under this role are never visible.
Type declaration
| Name | Type |
|---|---|
canvasContext | null |
iconFactory | null |
labelFactory | null |
visibilityHandler | () => boolean |
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:73
Methods
addRenderRole
▸ addRenderRole(role, def?): boolean
Adds a render role to this renderer. If the role has already been added to this renderer, this method does nothing.
Parameters
| Name | Type | Description |
|---|---|---|
role | number | The render role to add. |
def? | MapWaypointRenderRoleDef<W> | The render role's definition. If undefined, the new role will be assigned a default definition with no defined rendering context, icon, or label factories, and a visibility handler which always returns true. |
Returns
boolean
Whether the render role was successfully added.
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:164
clearRenderRoles
▸ clearRenderRoles(): void
Removes all render roles from this renderer.
Returns
void
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:205
deregister
▸ deregister(waypoint, role, sourceId): void
Removes a registration for a waypoint for a specific role or roles. Once all of a waypoint's registrations for a role are removed, it will no longer be rendered in that role the next this renderer's update() method is called.
Parameters
| Name | Type | Description |
|---|---|---|
waypoint | W | The waypoint to deregister. |
role | number | The role(s) from which the waypoint should be deregistered. |
sourceId | string | The unique string ID for the source of the registration to remove. |
Returns
void
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:334
getNearestWaypoint
▸ getNearestWaypoint<T>(pos, first?): undefined | T
Gets the nearest waypoint currently registered in the renderer.
Type parameters
| Name | Type |
|---|---|
T | extends MapWaypoint = W |
Parameters
| Name | Type | Description |
|---|---|---|
pos | LatLonInterface | The position to get the closest waypoint to. |
first? | (waypoint: W) => boolean | A predicate that will search the list of closest waypoints for a match, and return the first one found. |
Returns
undefined | T
The nearest waypoint, or undefined if none found.
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:405
getRenderRoleDefinition
▸ getRenderRoleDefinition(role): undefined | Readonly<MapWaypointRenderRoleDef<W>>
Gets the definition for a render role.
Parameters
| Name | Type | Description |
|---|---|---|
role | number | A render role. |
Returns
undefined | Readonly<MapWaypointRenderRoleDef<W>>
The definition for the specified render role, or undefined if no such role has been added to this renderer.
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:189
hasRenderRole
▸ hasRenderRole(role): boolean
Checks whether a render role has been added to this renderer.
Parameters
| Name | Type | Description |
|---|---|---|
role | number | The render role to check. |
Returns
boolean
Whether the render role has been added to this renderer.
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:152
isRegistered
▸ isRegistered(waypoint, role?): boolean
Checks if a waypoint is registered with this renderer. A role or roles can be optionally specified such that the method will only return true if the waypoint is registered under those specific roles.
Parameters
| Name | Type | Description |
|---|---|---|
waypoint | W | A waypoint. |
role? | number | The specific role(s) to check. |
Returns
boolean
whether the waypoint is registered with this renderer.
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:288
register
▸ register(waypoint, role, sourceId): void
Registers a waypoint with this renderer under a specific role or roles. Registered waypoints will be drawn as appropriate the next time this renderer's update() method is called. Registering a waypoint under a role under which it is already registered has no effect unless the source of the registration is different.
Parameters
| Name | Type | Description |
|---|---|---|
waypoint | W | The waypoint to register. |
role | number | The role(s) under which the waypoint should be registered. |
sourceId | string | A unique string ID for the source of the registration. |
Returns
void
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:312
removeRenderRole
▸ removeRenderRole(role): boolean
Removes a render role from this renderer.
Parameters
| Name | Type | Description |
|---|---|---|
role | number | The render role to remove. |
Returns
boolean
Whether the render role was successfully removed.
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:179
renderRoles
▸ renderRoles(): IterableIterator<number>
Gets an iterable of render roles added to this renderer. The iterable will return the roles in the order in which they were added.
Returns
IterableIterator<number>
An iterable of render roles added to this renderer.
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:198
setCanvasContext
▸ setCanvasContext(role, context): boolean
Sets the canvas rendering context for a render role. If the render role has not been added to this renderer, this method does nothing.
Parameters
| Name | Type | Description |
|---|---|---|
role | number | A render role. |
context | CanvasRenderingContext2D | A canvas 2D rendering context. |
Returns
boolean
Whether the context was set.
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:252
setIconFactory
▸ setIconFactory(role, factory): boolean
Sets the factory to use to create waypoint icons for a render role. If the render role has not been added to this renderer, this method does nothing.
Parameters
| Name | Type | Description |
|---|---|---|
role | number | A render role. |
factory | MapWaypointRendererIconFactory<W> | A waypoint icon factory. |
Returns
boolean
Whether the factory was set.
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:216
setLabelFactory
▸ setLabelFactory(role, factory): boolean
Sets the factory to use to create waypoint labels for a render role. If the render role has not been added to this renderer, this method does nothing.
Parameters
| Name | Type | Description |
|---|---|---|
role | number | A render role. |
factory | MapWaypointRendererLabelFactory<W> | A waypoint label factory. |
Returns
boolean
Whether the factory was set.
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:234
setVisibilityHandler
▸ setVisibilityHandler(role, handler): boolean
Sets the handler that determines if a waypoint should visible for a render role. If the render role has not been added to this renderer, this method does nothing.
Parameters
| Name | Type | Description |
|---|---|---|
role | number | A render role. |
handler | (waypoint: W) => boolean | A function that determines if a waypoint should be visible. |
Returns
boolean
Whether the handler was set.
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:270
update
▸ update(mapProjection): void
Redraws waypoints registered with this renderer.
Parameters
| Name | Type | Description |
|---|---|---|
mapProjection | MapProjection | The map projection to use. |
Returns
void
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:364
DEFAULT_RENDER_ROLE_SELECTOR
▸ DEFAULT_RENDER_ROLE_SELECTOR<T>(entry, roleDefinitions): number
The default render role selector. For each waypoint entry, iterates through all possible render roles in the order they were originally added to the renderer and selects the first role under which the entry is registered and is visible.
Type parameters
| Name | Type |
|---|---|
T | extends MapWaypoint |
Parameters
| Name | Type | Description |
|---|---|---|
entry | MapWaypointRendererEntry<T> | A waypoint entry. |
roleDefinitions | ReadonlyMap<number, Readonly<MapWaypointRenderRoleDef<T>>> | A map from all possible render roles to their definitions. |
Returns
number
The role under which the waypoint entry should be rendered, or 0 if the entry should not be rendered under any role.
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:102
ENTRY_SORT_FUNC
▸ ENTRY_SORT_FUNC(a, b): number
Sorts waypoint entries such that those with icons of higher priority are sorted after those with icons of lower priority.
Parameters
| Name | Type | Description |
|---|---|---|
a | MapWaypointRendererEntry<any> | The first waypoint entry to sort. |
b | MapWaypointRendererEntry<any> | The second waypoint entry to sort. |
Returns
number
A negative number if the first entry is to be sorted before the second, a positive number if the second entry is to be sorted before the first, and zero if the entries' relative sorting order does not matter.
Defined in
src/sdk/components/map/MapWaypointRenderer.ts:88