Class: SynVisComponent

Defined in: src/sdk/components/synvis/SynVisComponent.tsx:64

A synthetic vision display.

Extends

• DisplayComponent<SynVisProps>

Constructors

Constructor

new SynVisComponent(props): SynVisComponent

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	SynVisProps	The propertis of the component.

Returns

SynVisComponent

Inherited from

DisplayComponent.constructor

Properties

_isAwake

protected _isAwake: boolean = true

Defined in: src/sdk/components/synvis/SynVisComponent.tsx:68

---

bingRef

protected readonly bingRef: NodeReference<BingComponent>

Defined in: src/sdk/components/synvis/SynVisComponent.tsx:65

---

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

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

DisplayComponent.contextType

---

isRendered

protected isRendered: boolean = false

Defined in: src/sdk/components/synvis/SynVisComponent.tsx:67

---

props

props: SynVisProps & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

Defined in: src/sdk/components/synvis/SynVisComponent.tsx:172

Destroys this component.

Returns

void

Overrides

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

DisplayComponent.getContext

---

isAwake()

isAwake(): boolean

Defined in: src/sdk/components/synvis/SynVisComponent.tsx:90

Checks whether this display is awake.

Returns

boolean

whether this display is awake.

---

isBound()

isBound(): boolean

Defined in: src/sdk/components/synvis/SynVisComponent.tsx:98

Checks whether this display is bound to a Bing map instance.

Returns

boolean

whether this display is bound to a Bing map instance.

---

onAfterRender()

onAfterRender(): void

Defined in: src/sdk/components/synvis/SynVisComponent.tsx:78

A callback that is called after the component is rendered.

Returns

void

Overrides

DisplayComponent.onAfterRender

---

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

DisplayComponent.onBeforeRender

---

onBingBound()

protected onBingBound(): void

Defined in: src/sdk/components/synvis/SynVisComponent.tsx:73

A callback which is called when the Bing component is bound.

Returns

void

---

render()

render(): VNode

Defined in: src/sdk/components/synvis/SynVisComponent.tsx:152

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render

---

set3DMapCameraTransform()

set3DMapCameraTransform(pos, altitudeRef, offset, rotation, rotationRef): void

Defined in: src/sdk/components/synvis/SynVisComponent.tsx:139

Sets this display's camera transform parameters.

Parameters

Parameter	Type	Description
pos	LatLongAlt | null	The camera's nominal position. If null, then the nominal position will sync to the aircraft's position.
altitudeRef	Ellipsoid | Geoid | null	The altitude reference to use for the camera's nominal position. If null, then the default reference (SimAltitudeReference.Geoid) is used. Ignored if pos is null.
offset	Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | null	The camera's offset from its nominal position, as [x, y, z] in meters in the camera's reference frame after rotation is applied. The positive x axis points to the left. The positive y axis points upward. The positive z axis points forward. If null, then no offset is applied.
rotation	PitchBankHeading | null	The camera's rotation, whose reference frame depends on the value of rotationRef. If null, then the rotation will sync to the aircraft's attitude.
rotationRef	BingCameraRotationReference | null	The reference frame for the camera rotation. If null, then the default reference (BingCameraRotationReference.World) is used. Ignored if rotation is null.

Returns

void

---

sleep()

sleep(): void

Defined in: src/sdk/components/synvis/SynVisComponent.tsx:118

Puts this display to sleep. While asleep, this display cannot make changes to the Bing instance to which it is bound.

Returns

void

---

wake()

wake(): void

Defined in: src/sdk/components/synvis/SynVisComponent.tsx:106

Wakes this display. Upon awakening, this display will synchronize its state to the Bing instance to which it is bound.

Returns

void