Class: WaypointDisplayBuilder
Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:11
A class that builds a configuration for the waypoint display.
Extended by
Constructors
Constructor
new WaypointDisplayBuilder(
iconFactory
,labelFactory
,waypointRenderer
):WaypointDisplayBuilder
Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:23
Creates an instance of the WaypointDisplayBuilder.
Parameters
Parameter | Type | Description |
---|---|---|
iconFactory | MapSystemIconFactory | The icon factory to use with this builder. |
labelFactory | MapSystemLabelFactory | The label factory to use with this builder. |
waypointRenderer | MapSystemWaypointsRenderer | The waypoint renderer to use with this builder. |
Returns
WaypointDisplayBuilder
Properties
facilityWaypointCache
protected
facilityWaypointCache:undefined
|FacilityWaypointCache
Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:15
iconFactory
protected
readonly
iconFactory:MapSystemIconFactory
Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:23
The icon factory to use with this builder.
isCenterTarget
protected
isCenterTarget:boolean
=false
Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:14
labelFactory
protected
readonly
labelFactory:MapSystemLabelFactory
Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:23
The label factory to use with this builder.
roleGroup
protected
roleGroup:string
=MapSystemWaypointRoles.Normal
Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:13
waypointRenderer
protected
readonly
waypointRenderer:MapSystemWaypointsRenderer
Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:24
The waypoint renderer to use with this builder.
Methods
addDefaultIcon()
addDefaultIcon<
T
>(role
,config
):this
Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:44
Adds a default icon configuration to the waypoint display system, if no other configuration is found.
Type Parameters
Type Parameter |
---|
T extends Waypoint |
Parameters
Parameter | Type | Description |
---|---|---|
role | string | number | The role to add this waypoint display config for. |
config | (waypoint ) => MapWaypointIcon <T > | The waypoint icon factory to add as a configuration. |
Returns
this
The modified builder.
addDefaultLabel()
addDefaultLabel<
T
>(role
,config
):this
Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:67
Adds a label configuration to the waypoint display system.
Type Parameters
Type Parameter |
---|
T extends Waypoint |
Parameters
Parameter | Type | Description |
---|---|---|
role | string | number | The role to add this waypoint display config for. |
config | (waypoint ) => MapCullableLocationTextLabel | The waypoint label factory to add as a configuration. |
Returns
this
The modified builder.
addIcon()
addIcon<
T
>(role
,type
,config
):this
Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:33
Adds a icon configuration to the waypoint display system.
Type Parameters
Type Parameter |
---|
T extends Waypoint |
Parameters
Parameter | Type | Description |
---|---|---|
role | string | number | The role to add this waypoint display config for. |
type | string | The type of waypoint to add an icon for. |
config | (waypoint ) => MapWaypointIcon <T > | The waypoint icon factory to add as a configuration. |
Returns
this
The modified builder.
addLabel()
addLabel<
T
>(role
,type
,config
):this
Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:56
Adds a label configuration to the waypoint display system.
Type Parameters
Type Parameter |
---|
T extends Waypoint |
Parameters
Parameter | Type | Description |
---|---|---|
role | string | number | The role to add this waypoint display config for. |
type | string | The type of waypoint to add an label for. |
config | (waypoint ) => MapCullableLocationTextLabel | The waypoint label factory to add as a configuration. |
Returns
this
The modified builder.
getIsCenterTarget()
getIsCenterTarget():
boolean
Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:138
Gets if the waypoint search is using the map target with offset as the search center.
Returns
boolean
True if the search center is the map target, false if it is the map center.
getRoleId()
getRoleId(
role
):number
Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:109
Gets the ID of a role in the waypoint display system.
Parameters
Parameter | Type | Description |
---|---|---|
role | string | The name of the role to get the ID for. |
Returns
number
The ID of the role.
Throws
An error if an invalid role name is supplied.
getWaypointCache()
getWaypointCache():
undefined
|FacilityWaypointCache
Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:156
Gets the currently set facility waypoint cache.
Returns
undefined
| FacilityWaypointCache
The currently set facility waypoint cache.
registerRole()
registerRole(
name
):this
Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:97
Registers a waypoint display role for use with the flight plan rendering system.
Parameters
Parameter | Type | Description |
---|---|---|
name | string | The name of the role to register. |
Returns
this
The modified builder.
withSearchCenter()
withSearchCenter(
center
):this
Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:124
Configures the center for waypoint searches for this display.
Parameters
Parameter | Type | Description |
---|---|---|
center | "center" | "target" | If center, then waypoint searches will use the map center. If target, waypoint searches will use the map target with offset. |
Returns
this
The modified builder.
withWaypointCache()
withWaypointCache(
cache
):this
Defined in: src/sdk/components/mapsystem/WaypointDisplayBuilder.ts:147
Configures the facility waypoint cache to use with the waypoint display.
Parameters
Parameter | Type | Description |
---|---|---|
cache | undefined | FacilityWaypointCache | The facility waypoint cache to use, or undefined to use the default. |
Returns
this
The modified builder.