Class: MapDynamicWaypointImageIcon<T>

Defined in: workingtitle-instruments-epic2/shared/Map/MapDynamicWaypointIcon.ts:7

A waypoint icon with an image as the icon's graphic source. With support for showing a different icon based on the map range setting.

Extends

• AbstractMapWaypointIcon<T>

Type Parameters

Type Parameter
T extends MapWaypoint

Constructors

Constructor

new MapDynamicWaypointImageIcon<T>(waypoint, priority, img, dot_img, size, minRange, currentRange, options?): MapDynamicWaypointImageIcon<T>

Defined in: workingtitle-instruments-epic2/shared/Map/MapDynamicWaypointIcon.ts:20

Constructor.

Parameters

Parameter	Type	Description
waypoint	T	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.
dot_img	HTMLImageElement	This icon's image for the dot.
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.
minRange	number	The range from which to show the dot instead of the image.
currentRange	Subscribable<number>	The current range setting of the map.
options?	AbstractMapWaypointIconOptions	Options with which to initialize this icon.

Returns

MapDynamicWaypointImageIcon<T>

Overrides

AbstractMapWaypointIcon.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

AbstractMapWaypointIcon.anchor

---

currentRange

protected readonly currentRange: Subscribable<number>

Defined in: workingtitle-instruments-epic2/shared/Map/MapDynamicWaypointIcon.ts:27

The current range setting of the map.

---

dot_img

protected readonly dot_img: HTMLImageElement

Defined in: workingtitle-instruments-epic2/shared/Map/MapDynamicWaypointIcon.ts:24

This icon's image for the dot.

---

img

protected readonly img: HTMLImageElement

Defined in: workingtitle-instruments-epic2/shared/Map/MapDynamicWaypointIcon.ts:23

This icon's image.

---

minRange

protected readonly minRange: number

Defined in: workingtitle-instruments-epic2/shared/Map/MapDynamicWaypointIcon.ts:26

The range from which to show the dot instead of the image.

---

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

AbstractMapWaypointIcon.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

AbstractMapWaypointIcon.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

AbstractMapWaypointIcon.size

---

waypoint

readonly waypoint: T

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

The waypoint associated with this icon.

Inherited from

AbstractMapWaypointIcon.waypoint

---

tempVec2

protected readonly static tempVec2: Float64Array<ArrayBuffer>

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

Inherited from

AbstractMapWaypointIcon.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

AbstractMapWaypointIcon.draw

---

drawIconAt()

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

Defined in: workingtitle-instruments-epic2/shared/Map/MapDynamicWaypointIcon.ts:34

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

AbstractMapWaypointIcon.drawIconAt