Skip to main content

Class: MapTodIcon

Defined in: workingtitle-instruments-wt21/shared/Map/MapTod.ts:53

A VNAV waypoint icon.

Extends

Constructors

Constructor

new MapTodIcon(waypoint, priority, size, options?): MapTodIcon

Defined in: workingtitle-instruments-wt21/shared/Map/MapTod.ts:62

Constructor.

Parameters

ParameterTypeDescription
waypointVNavWaypointThe waypoint associated with this icon.
prioritynumberThe render priority of this icon. Icons with higher priorities should be rendered above those with lower priorities.
sizeReadonlyFloat64ArrayThe size of this icon, as [width, height] in pixels.
options?AbstractMapWaypointIconOptionsOptions with which to initialize this icon.

Returns

MapTodIcon

Overrides

MapWaypointImageIcon.constructor

Properties

anchor

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

Defined in: 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.

Inherited from

MapWaypointImageIcon.anchor


drawData

protected readonly drawData: object

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

size

size: Float64Array<ArrayBufferLike>

topLeft

topLeft: Float64Array<ArrayBufferLike>

waypointProjectedPos

waypointProjectedPos: Float64Array<ArrayBufferLike>

Inherited from

MapWaypointImageIcon.drawData


img

protected readonly img: HTMLImageElement

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

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:106

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

Inherited from

MapWaypointImageIcon.offset


onDraw

readonly onDraw: ReadonlySubEvent<MapTodIcon, AbstractMapWaypointIconDrawData>

Defined in: 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.

Inherited from

MapWaypointImageIcon.onDraw


priority

readonly priority: Subscribable<number>

Defined in: 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.

Inherited from

MapWaypointImageIcon.priority


size

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

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

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

Inherited from

MapWaypointImageIcon.size


waypoint

readonly waypoint: VNavWaypoint

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

The waypoint associated with this icon.

Inherited from

MapWaypointImageIcon.waypoint


tempVec2

protected readonly static tempVec2: Float64Array<ArrayBufferLike>

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

Inherited from

MapWaypointImageIcon.tempVec2

Methods

draw()

draw(context, mapProjection): void

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

Renders this icon to a canvas.

Parameters

ParameterTypeDescription
contextCanvasRenderingContext2DThe canvas 2D rendering context to which to render.
mapProjectionMapProjectionThe projection to use for rendering.

Returns

void

Inherited from

MapWaypointImageIcon.draw


drawIconAt()

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

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

Draws the icon at the specified position.

Parameters

ParameterTypeDescription
contextCanvasRenderingContext2DThe canvas rendering context to use.
mapProjectionMapProjectionThe map projection to use.
leftnumberThe x-coordinate of the left edge of the icon.
topnumberThe y-coordinate of the top edge of the icon.

Returns

void

Inherited from

MapWaypointImageIcon.drawIconAt


getLastDrawData()

getLastDrawData(): AbstractMapWaypointIconDrawData

Defined in: 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.

Inherited from

MapWaypointImageIcon.getLastDrawData