Class: ActiveWaypointIcon

Defined in: workingtitle-instruments-epic2/shared/Map/ActiveWaypoint.ts:6

An active map flightplan waypoint icon that can be set to flash.

Extends

• MapWaypointImageIcon<Waypoint>

Constructors

Constructor

new ActiveWaypointIcon(waypoint, priority, img, size, options?): ActiveWaypointIcon

Defined in: sdk/components/map/MapWaypointIcon.ts:147

Constructor.

Parameters

Parameter	Type	Description
waypoint	Waypoint	The waypoint associated with this icon.
priority	number | Subscribable<number>	The render priority of this icon. Icons with higher priorities should be rendered above those with lower priorities.
img	HTMLImageElement	This icon's image.
size	Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">>>	The size of this icon, as [width, height] in pixels, or a subscribable which provides it.
options?	AbstractMapWaypointIconOptions	Options with which to initialize this icon.

Returns

ActiveWaypointIcon

Inherited from

MapWaypointImageIcon.constructor

Properties

anchor

readonly anchor: Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">>>

Defined in: sdk/components/map/MapWaypointIcon.ts:86

The anchor point of this icon, expressed relative to its width and height. [0, 0] is the top-left corner, and [1, 1] is the bottom-right corner.

Inherited from

MapWaypointImageIcon.anchor

---

img

protected readonly img: HTMLImageElement

Defined in: sdk/components/map/MapWaypointIcon.ts:150

This icon's image.

Inherited from

MapWaypointImageIcon.img

---

offset

readonly offset: Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">>>

Defined in: sdk/components/map/MapWaypointIcon.ts:89

The offset of this icon from the projected position of its associated waypoint, as [x, y] in pixels.

Inherited from

MapWaypointImageIcon.offset

---

priority

readonly priority: Subscribable<number>

Defined in: sdk/components/map/MapWaypointIcon.ts:77

The render priority of this icon. Icons with higher priorities will be rendered on top of icons with lower priorities.

Inherited from

MapWaypointImageIcon.priority

---

size

readonly size: Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">>>

Defined in: sdk/components/map/MapWaypointIcon.ts:80

The size of this icon, as [width, height] in pixels.

Inherited from

MapWaypointImageIcon.size

---

waypoint

readonly waypoint: Waypoint

Defined in: sdk/components/map/MapWaypointIcon.ts:100

The waypoint associated with this icon.

Inherited from

MapWaypointImageIcon.waypoint

---

tempVec2

protected readonly static tempVec2: Float64Array<ArrayBuffer>

Defined in: sdk/components/map/MapWaypointIcon.ts:74

Inherited from

MapWaypointImageIcon.tempVec2

Methods

draw()

draw(context, mapProjection): void

Defined in: sdk/components/map/MapWaypointIcon.ts:113

Renders this icon to a canvas.

Parameters

Parameter	Type	Description
context	CanvasRenderingContext2D	The canvas 2D rendering context to which to render.
mapProjection	MapProjection	The projection to use for rendering.

Returns

void

Inherited from

MapWaypointImageIcon.draw

---

drawIconAt()

drawIconAt(context, mapProjection, left, top): void

Defined in: workingtitle-instruments-epic2/shared/Map/ActiveWaypoint.ts:18

Draws the icon at the specified position.

Parameters

Parameter	Type	Description
context	CanvasRenderingContext2D	The canvas rendering context to use.
mapProjection	MapProjection	The map projection to use.
left	number	The x-coordinate of the left edge of the icon.
top	number	The y-coordinate of the top edge of the icon.

Returns

void

Overrides

MapWaypointImageIcon.drawIconAt

---

setDisplayed()

setDisplayed(isDisplayed): void

Defined in: workingtitle-instruments-epic2/shared/Map/ActiveWaypoint.ts:13

Sets whether or not the icon is displayed.

Parameters

Parameter	Type	Description
isDisplayed	boolean	Whether or not the icon is displayed.

Returns

void