Class: MapOwnAirplaneWithGhostIconLayer<M>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:61

A version of MapOwnAirplaneLayer which includes a ghost icon that is shown when the main airplane icon is out of the map viewport.

Extends

• MapOwnAirplaneLayer<M, MapOwnAirplaneWithGhostIconLayerProps<M>>

Type Parameters

Type Parameter	Default type
M extends MapOwnAirplaneLayerModules	MapOwnAirplaneLayerModules

Constructors

Constructor

new MapOwnAirplaneWithGhostIconLayer<M>(props): MapOwnAirplaneWithGhostIconLayer<M>

Defined in: src/sdk/components/FSComponent.ts:76

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	MapOwnAirplaneWithGhostIconLayerProps	The propertis of the component.

Returns

MapOwnAirplaneWithGhostIconLayer<M>

Inherited from

MapOwnAirplaneLayer.constructor

Properties

context?

optional context: [] = undefined

Defined in: src/sdk/components/FSComponent.ts:67

The context on this component, if any.

Inherited from

MapOwnAirplaneLayer.context

---

contextType?

readonly optional contextType: readonly [] = undefined

Defined in: src/sdk/components/FSComponent.ts:70

The type of context for this component, if any.

Inherited from

MapOwnAirplaneLayer.contextType

---

enableGhostIcon

protected readonly enableGhostIcon: Subscribable<boolean>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:83

---

ghostIconAnchor

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

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:90

---

ghostIconAnchorSub?

protected optional ghostIconAnchorSub: Subscription

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:99

---

ghostIconEnabledSub?

protected optional ghostIconEnabledSub: Subscription

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:97

---

ghostIconOffset

protected readonly ghostIconOffset: Float64Array<ArrayBufferLike>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:91

---

ghostIconSize

protected readonly ghostIconSize: Subscribable<number>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:89

---

ghostIconSizeSub?

protected optional ghostIconSizeSub: Subscription

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:98

---

ghostIconStyle

protected readonly ghostIconStyle: ObjectSubject<{ display: string; height: string; left: string; position: string; top: string; transform: string; transform-origin: string; width: string; }>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:67

---

ghostIconTransform

protected readonly ghostIconTransform: CssTransformChain<[CssTranslate3dTransform, CssRotateTransform]>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:78

---

ghostImageFilePath

protected readonly ghostImageFilePath: string | Subscribable<string>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:85

---

headingSub?

protected optional headingSub: Subscription

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:97

Inherited from

MapOwnAirplaneLayer.headingSub

---

iconAnchor

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

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:72

Inherited from

MapOwnAirplaneLayer.iconAnchor

---

iconAnchorSub?

protected optional iconAnchorSub: Subscription

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:101

Inherited from

MapOwnAirplaneLayer.iconAnchorSub

---

iconOffset

protected readonly iconOffset: Float64Array<ArrayBufferLike>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:74

Inherited from

MapOwnAirplaneLayer.iconOffset

---

iconSize

protected readonly iconSize: Subscribable<number>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:71

Inherited from

MapOwnAirplaneLayer.iconSize

---

iconSizeSub?

protected optional iconSizeSub: Subscription

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:100

Inherited from

MapOwnAirplaneLayer.iconSizeSub

---

iconTransform

protected readonly iconTransform: CssTransformChain<[CssTranslate3dTransform, CssRotateTransform]>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:81

Inherited from

MapOwnAirplaneLayer.iconTransform

---

imageFilePath

protected readonly imageFilePath: string | MappedSubscribable<string>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:53

Inherited from

MapOwnAirplaneLayer.imageFilePath

---

isGhostIconVisible

protected isGhostIconVisible: boolean = false

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:93

---

isGsAboveTrackThreshold

protected readonly isGsAboveTrackThreshold: MappedSubscribable<boolean>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:86

Inherited from

MapOwnAirplaneLayer.isGsAboveTrackThreshold

---

isInsideVisibilityBounds

protected isInsideVisibilityBounds: boolean = true

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:89

Inherited from

MapOwnAirplaneLayer.isInsideVisibilityBounds

---

needUpdateGhostIconVisibility

protected needUpdateGhostIconVisibility: boolean = true

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:95

---

needUpdatePositionRotation

protected needUpdatePositionRotation: boolean = false

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:93

Inherited from

MapOwnAirplaneLayer.needUpdatePositionRotation

---

needUpdateVisibility

protected needUpdateVisibility: boolean = false

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:92

Inherited from

MapOwnAirplaneLayer.needUpdateVisibility

---

orientationSub?

protected optional orientationSub: Subscription

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:102

Inherited from

MapOwnAirplaneLayer.orientationSub

---

ownAirplaneIconModule

protected readonly ownAirplaneIconModule: M["ownAirplaneIcon"]

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:69

Inherited from

MapOwnAirplaneLayer.ownAirplaneIconModule

---

ownAirplanePropsModule

protected readonly ownAirplanePropsModule: M["ownAirplaneProps"]

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:68

Inherited from

MapOwnAirplaneLayer.ownAirplanePropsModule

---

planeRotation

protected planeRotation: number = 0

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:90

Inherited from

MapOwnAirplaneLayer.planeRotation

---

positionSub?

protected optional positionSub: Subscription

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:96

Inherited from

MapOwnAirplaneLayer.positionSub

---

props

props: MapOwnAirplaneWithGhostIconLayerProps<M> & ComponentProps

Defined in: src/sdk/components/FSComponent.ts:64

The properties of the component.

Inherited from

MapOwnAirplaneLayer.props

---

showIcon

protected showIcon: boolean = true

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:88

Inherited from

MapOwnAirplaneLayer.showIcon

---

showSub?

protected optional showSub: Subscription

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:95

Inherited from

MapOwnAirplaneLayer.showSub

---

style

protected readonly style: ObjectSubject<{ display: string; height: string; left: string; position: string; top: string; transform: string; transform-origin: string; width: string; }>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:57

Inherited from

MapOwnAirplaneLayer.style

---

trackSub?

protected optional trackSub: Subscription

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:98

Inherited from

MapOwnAirplaneLayer.trackSub

---

trackThresholdSub?

protected optional trackThresholdSub: Subscription

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:99

Inherited from

MapOwnAirplaneLayer.trackThresholdSub

---

visibilityBounds

protected readonly visibilityBounds: Float64Array<ArrayBufferLike>

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:79

Bounds as [left, top, right, bottom], in pixels.

Inherited from

MapOwnAirplaneLayer.visibilityBounds

---

geoPointCache

protected readonly static geoPointCache: GeoPoint[]

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:63

---

vec2Cache

protected readonly static vec2Cache: Float64Array<ArrayBufferLike>[]

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:51

Inherited from

MapOwnAirplaneLayer.vec2Cache

---

vecCache

protected readonly static vecCache: Float64Array<ArrayBufferLike>[]

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:65

Methods

destroy()

destroy(): void

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:400

Destroys this component.

Returns

void

Overrides

MapOwnAirplaneLayer.destroy

---

getContext()

protected getContext(context): never

Defined in: src/sdk/components/FSComponent.ts:109

Gets a context data subscription from the context collection.

Parameters

Parameter	Type	Description
context	never	The context to get the subscription for.

Returns

never

The requested context.

Throws

An error if no data for the specified context type could be found.

Inherited from

MapOwnAirplaneLayer.getContext

---

isVisible()

isVisible(): boolean

Defined in: src/sdk/components/map/MapLayer.ts:38

Checks whether this layer is visible.

Returns

boolean

whether this layer is visible.

Inherited from

MapOwnAirplaneLayer.isVisible

---

onAfterRender()

onAfterRender(node): void

Defined in: src/sdk/components/FSComponent.ts:90

A callback that is called after the component is rendered.

Parameters

Parameter	Type	Description
node	VNode	The component's VNode.

Returns

void

Inherited from

MapOwnAirplaneLayer.onAfterRender

---

onAttached()

onAttached(): void

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:102

This method is called when this layer is attached to its parent map component.

Returns

void

Overrides

MapOwnAirplaneLayer.onAttached

---

onBeforeRender()

onBeforeRender(): void

Defined in: src/sdk/components/FSComponent.ts:83

A callback that is called before the component is rendered.

Returns

void

Inherited from

MapOwnAirplaneLayer.onBeforeRender

---

onDetached()

onDetached(): void

Defined in: src/sdk/components/map/MapLayer.ts:108

This method is called when this layer is detached from its parent map component.

Returns

void

Inherited from

MapOwnAirplaneLayer.onDetached

---

onGroundSpeedAboveThresholdChanged()

protected onGroundSpeedAboveThresholdChanged(value): void

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:175

Callback fired when the ground speed above threshold state changes

Parameters

Parameter	Type	Description
value	boolean	the new value

Returns

void

Inherited from

MapOwnAirplaneLayer.onGroundSpeedAboveThresholdChanged

---

onHeadingChanged()

protected onHeadingChanged(value): void

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:122

Callback fired when the airplane heading changes

Parameters

Parameter	Type	Description
value	number	the new value

Returns

void

Overrides

MapOwnAirplaneLayer.onHeadingChanged

---

onMapProjectionChanged()

onMapProjectionChanged(mapProjection, changeFlags): void

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:260

This method is called when the map projection changes.

Parameters

Parameter	Type	Description
mapProjection	MapProjection	this layer's map projection.
changeFlags	number	The types of changes made to the projection.

Returns

void

Inherited from

MapOwnAirplaneLayer.onMapProjectionChanged

---

onOrientationChanged()

protected onOrientationChanged(value): void

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:136

Callback fired when the orientation mode changes

Parameters

Parameter	Type	Description
value	MapOwnAirplaneIconOrientation	the new value

Returns

void

Overrides

MapOwnAirplaneLayer.onOrientationChanged

---

onSleep()

onSleep(): void

Defined in: src/sdk/components/map/MapLayer.ts:81

This method is called when this layer's parent map is put to sleep.

Returns

void

Inherited from

MapOwnAirplaneLayer.onSleep

---

onTrackChanged()

protected onTrackChanged(value): void

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:129

Callback fired when the airplane track changes

Parameters

Parameter	Type	Description
value	number	the new value

Returns

void

Overrides

MapOwnAirplaneLayer.onTrackChanged

---

onUpdated()

onUpdated(time, elapsed): void

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:144

This method is called once every map update cycle.

Parameters

Parameter	Type	Description
time	number	The current time as a UNIX timestamp.
elapsed	number	The elapsed time, in milliseconds, since the last update.

Returns

void

Overrides

MapOwnAirplaneLayer.onUpdated

---

onVisibilityChanged()

onVisibilityChanged(isVisible): void

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:106

This method is called when this layer's visibility changes.

Parameters

Parameter	Type	Description
isVisible	boolean	Whether the layer is now visible.

Returns

void

Inherited from

MapOwnAirplaneLayer.onVisibilityChanged

---

onWake()

onWake(): void

Defined in: src/sdk/components/map/MapLayer.ts:74

This method is called when this layer's parent map is woken.

Returns

void

Inherited from

MapOwnAirplaneLayer.onWake

---

render()

render(): VNode

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:408

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

MapOwnAirplaneLayer.render

---

setVisible()

setVisible(val): void

Defined in: src/sdk/components/map/MapLayer.ts:46

Sets this layer's visibility.

Parameters

Parameter	Type	Description
val	boolean	Whether this layer should be visible.

Returns

void

Inherited from

MapOwnAirplaneLayer.setVisible

---

updateGhostIconOffset()

protected updateGhostIconOffset(): void

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:183

Updates the ghost icon's offset from the projected position of the airplane.

Returns

void

---

updateGhostIconPositionRotation()

protected updateGhostIconPositionRotation(): void

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:207

Updates the position and rotation of the ghost icon

Returns

void

---

updateGhostIconVisibility()

protected updateGhostIconVisibility(): void

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:193

Updates the ghost icon's visibility

Returns

void

---

updateIconPositionRotation()

protected updateIconPositionRotation(): void

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:198

Updates the airplane icon's projected position and rotation.

Returns

void

Overrides

MapOwnAirplaneLayer.updateIconPositionRotation

---

updateIconVisibility()

protected updateIconVisibility(): void

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:284

Updates the airplane icon's visibility.

Returns

void

Inherited from

MapOwnAirplaneLayer.updateIconVisibility

---

updateOffset()

protected updateOffset(): void

Defined in: src/sdk/components/map/layers/MapOwnAirplaneLayer.tsx:216

Updates the icon's offset from the projected position of the airplane.

Returns

void

Inherited from

MapOwnAirplaneLayer.updateOffset

---

updateVisibilityBounds()

protected updateVisibilityBounds(): void

Defined in: src/sdk/components/map/layers/MapOwnAirplaneWithGhostIconLayer.tsx:157

Updates the boundaries within the map's projected window that define a region such that if the airplane's projected position falls outside of it, the icon is not visible and therefore does not need to be updated.

Returns

void

Overrides

MapOwnAirplaneLayer.updateVisibilityBounds