Abstract Class: AbstractMapWaypointIcon<T>

Defined in: src/sdk/components/map/MapWaypointIcon.ts:90

An abstract implementation of MapWaypointIcon which supports an arbitrary anchor point and offset.

Extended by

• MapWaypointImageIcon
• MapWaypointSpriteIcon
• MapWaypointHighlightIcon
• MapFixInfoWaypointIcon
• MapAirportIcon
• MapDynamicWaypointImageIcon

Type Parameters

Type Parameter
T extends MapWaypoint

Implements

• MapWaypointIcon<T>

Constructors

Constructor

new AbstractMapWaypointIcon<T>(waypoint, priority, size, options?): AbstractMapWaypointIcon<T>

Defined in: src/sdk/components/map/MapWaypointIcon.ts:131

Creates a new instance of AbstractMapWaypointIcon.

Parameters

Parameter	Type	Description
waypoint	T	The waypoint associated with this icon.
priority	number | Subscribable<number>	The render priority of this icon, or a subscribable which provides it. Icons with higher priorities should be rendered above those with lower priorities.
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

AbstractMapWaypointIcon<T>

Properties

anchor

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

Defined in: src/sdk/components/map/MapWaypointIcon.ts:103

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.

---

drawData

protected readonly drawData: object

Defined in: src/sdk/components/map/MapWaypointIcon.ts:117

size

size: Float64Array<ArrayBufferLike>

topLeft

topLeft: Float64Array<ArrayBufferLike>

waypointProjectedPos

waypointProjectedPos: Float64Array<ArrayBufferLike>

---

offset

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

Defined in: src/sdk/components/map/MapWaypointIcon.ts:106

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

---

onDraw

readonly onDraw: ReadonlySubEvent<AbstractMapWaypointIcon<T>, AbstractMapWaypointIconDrawData>

Defined in: src/sdk/components/map/MapWaypointIcon.ts:115

An event that notifies subscribers when this icon is drawn (when draw() is called). The sender of the event is this icon. The event data describes the draw operation that triggered the event.

The data object passed to event handlers is only guaranteed to be valid at the moment the handler is called. If a handler needs to retain the data past this moment, then it is recommended that a copy of the data be made.

---

priority

readonly priority: Subscribable<number>

Defined in: src/sdk/components/map/MapWaypointIcon.ts:94

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

Implementation of

MapWaypointIcon.priority

---

size

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

Defined in: src/sdk/components/map/MapWaypointIcon.ts:97

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

---

waypoint

readonly waypoint: T

Defined in: src/sdk/components/map/MapWaypointIcon.ts:132

The waypoint associated with this icon.

Implementation of

MapWaypointIcon.waypoint

---

tempVec2

protected readonly static tempVec2: Float64Array<ArrayBufferLike>

Defined in: src/sdk/components/map/MapWaypointIcon.ts:91

Methods

draw()

draw(context, mapProjection): void

Defined in: src/sdk/components/map/MapWaypointIcon.ts:156

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

Implementation of

MapWaypointIcon.draw

---

drawIconAt()

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

Defined in: src/sdk/components/map/MapWaypointIcon.ts:181

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

---

getLastDrawData()

getLastDrawData(): AbstractMapWaypointIconDrawData

Defined in: src/sdk/components/map/MapWaypointIcon.ts:151

Gets data describing this icon's last executed drawing operation (the last time that draw() was called). If the icon has not been drawn yet, then the data will report NaN values.

Returns

AbstractMapWaypointIconDrawData

Data describing this icon's last executed drawing operation. The returned data object passed is only guaranteed to be valid at the moment it is returned. If you need to retain the data past this moment, then it is recommended that a copy of the data be made.