Skip to main content

Class: ArtificialHorizon

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2/PFD/Components/Horizon/ArtificialHorizon.tsx:46

A PFD artificial horizon. Renders sky and ground boxes.

Extends​

Constructors​

Constructor​

new ArtificialHorizon(props): ArtificialHorizon

Defined in: sdk/components/FSComponent.ts:73

Creates an instance of a DisplayComponent.

Parameters​

ParameterTypeDescription
propsArtificalHorizonPropsThe propertis of the component.

Returns​

ArtificialHorizon

Inherited from​

HorizonSharedCanvasSubLayer<ArtificalHorizonProps>.constructor

Properties​

context?​

optional context: [] = undefined

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

The context on this component, if any.

Inherited from​

HorizonSharedCanvasSubLayer.context


contextType?​

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from​

HorizonSharedCanvasSubLayer.contextType


props​

props: ArtificalHorizonProps & ComponentProps

Defined in: sdk/components/FSComponent.ts:61

The properties of the component.

Inherited from​

HorizonSharedCanvasSubLayer.props


CLAMP_PITCH_MAX​

readonly static CLAMP_PITCH_MAX: 25 = 25

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2/PFD/Components/Horizon/ArtificialHorizon.tsx:47


CLAMP_PITCH_MIN​

readonly static CLAMP_PITCH_MIN: -10.8 = -10.8

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2/PFD/Components/Horizon/ArtificialHorizon.tsx:48

Accessors​

display​

Get Signature​

get protected display(): HorizonSharedCanvasInstance

Defined in: sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:174

This sublayer's shared canvas instance.

Throws​

Error if this sublayer is not attached.

Returns​

HorizonSharedCanvasInstance

Inherited from​

HorizonSharedCanvasSubLayer.display


projection​

Get Signature​

get protected projection(): HorizonProjection

Defined in: sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:161

This sublayer's horizon projection.

Throws​

Error if this sublayer is not attached.

Returns​

HorizonProjection

Inherited from​

HorizonSharedCanvasSubLayer.projection

Methods​

attach()​

attach(projection, display): void

Defined in: sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:203

Attaches this sublayer to a parent layer.

Parameters​

ParameterTypeDescription
projectionHorizonProjectionThe horizon projection used by this sublayer.
displayHorizonSharedCanvasInstanceThe canvas instance shared by this sublayer.

Returns​

void

Inherited from​

HorizonSharedCanvasSubLayer.attach


destroy()​

destroy(): void

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2/PFD/Components/Horizon/ArtificialHorizon.tsx:200

Returns​

void

Inherit Doc​

Overrides​

HorizonSharedCanvasSubLayer.destroy


getContext()​

protected getContext(context): never

Defined in: sdk/components/FSComponent.ts:106

Gets a context data subscription from the context collection.

Parameters​

ParameterTypeDescription
contextneverThe 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​

HorizonSharedCanvasSubLayer.getContext


isAttached()​

protected isAttached(): boolean

Defined in: sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:186

Checks whether this sublayer is attached to a parent layer.

Returns​

boolean

Whether this sublayer is attached to a parent layer.

Inherited from​

HorizonSharedCanvasSubLayer.isAttached


isVisible()​

protected isVisible(): boolean

Defined in: sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:194

Checks whether this sublayer is visible.

Returns​

boolean

Whether this sublayer is visible.

Inherited from​

HorizonSharedCanvasSubLayer.isVisible


onAfterRender()​

onAfterRender(node): void

Defined in: sdk/components/FSComponent.ts:87

A callback that is called after the component is rendered.

Parameters​

ParameterTypeDescription
nodeVNodeThe component's VNode.

Returns​

void

Inherited from​

HorizonSharedCanvasSubLayer.onAfterRender


onAttached()​

onAttached(): void

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2/PFD/Components/Horizon/ArtificialHorizon.tsx:72

Returns​

void

Inherit Doc​

Overrides​

HorizonSharedCanvasSubLayer.onAttached


onBeforeRender()​

onBeforeRender(): void

Defined in: sdk/components/FSComponent.ts:80

A callback that is called before the component is rendered.

Returns​

void

Inherited from​

HorizonSharedCanvasSubLayer.onBeforeRender


onProjectionChanged()​

onProjectionChanged(projection, changeFlags): void

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2/PFD/Components/Horizon/ArtificialHorizon.tsx:82

Parameters​

ParameterType
projectionHorizonProjection
changeFlagsnumber

Returns​

void

Inherit Doc​

Overrides​

HorizonSharedCanvasSubLayer.onProjectionChanged


onSleep()​

onSleep(): void

Defined in: sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:255

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

Returns​

void

Inherited from​

HorizonSharedCanvasSubLayer.onSleep


onUpdated()​

onUpdated(): void

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2/PFD/Components/Horizon/ArtificialHorizon.tsx:94

Returns​

void

Inherit Doc​

Overrides​

HorizonSharedCanvasSubLayer.onUpdated


onVisibilityChanged()​

protected onVisibilityChanged(isVisible): void

Defined in: sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:234

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

Parameters​

ParameterTypeDescription
isVisiblebooleanWhether the layer is now visible.

Returns​

void

Inherited from​

HorizonSharedCanvasSubLayer.onVisibilityChanged


onWake()​

onWake(): void

Defined in: sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:248

This method is called when this sublayer's parent layer is awakened.

Returns​

void

Inherited from​

HorizonSharedCanvasSubLayer.onWake


render()​

render(): null | VNode

Defined in: sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:293

Returns​

null | VNode

Inherit Doc​

Inherited from​

HorizonSharedCanvasSubLayer.render


setVisible()​

setVisible(val): void

Defined in: sdk/components/horizon/layers/HorizonSharedCanvasLayer.tsx:218

Sets this sublayer's visibility.

Parameters​

ParameterTypeDescription
valbooleanWhether this sublayer should be visible.

Returns​

void

Inherited from​

HorizonSharedCanvasSubLayer.setVisible


shouldInvalidate()​

shouldInvalidate(): boolean

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2/PFD/Components/Horizon/ArtificialHorizon.tsx:89

Returns​

boolean

Inherit Doc​

Overrides​

HorizonSharedCanvasSubLayer.shouldInvalidate