Interface: HorizonSyntheticVisionLayerProps
Defined in: src/sdk/components/horizon/layers/HorizonSyntheticVisionLayer.tsx:38
Component props for HorizonSyntheticVisionLayer.
Extends
Properties
bingDelay?
optionalbingDelay:number
Defined in: src/sdk/components/horizon/layers/HorizonSyntheticVisionLayer.tsx:43
The amount of time, in milliseconds, to delay binding the layer's Bing instance. Defaults to 0.
bingId
bingId:
string
Defined in: src/sdk/components/horizon/layers/HorizonSyntheticVisionLayer.tsx:40
The string ID to assign to the layer's bound Bing instance.
bingSkipUnbindOnDestroy?
optionalbingSkipUnbindOnDestroy:boolean
Defined in: src/sdk/components/horizon/layers/HorizonSyntheticVisionLayer.tsx:46
Whether to skip unbinding the layer's bound Bing instance when the layer is destroyed. Defaults to false.
cameraAltitudeReference?
optionalcameraAltitudeReference:Ellipsoid|Geoid|Subscribable<Ellipsoid|Geoid>
Defined in: src/sdk/components/horizon/layers/HorizonSyntheticVisionLayer.tsx:91
The reference to use when defining the altitude for the camera of the layer's underlying Bing instance. Ignored if
cameraPositionMode is not HorizonSyntheticVisionCameraParamMode.Custom. Defaults to
SimAltitudeReference.Geoid.
cameraOffset?
optionalcameraOffset:Readonly<Omit<Float64Array<ArrayBufferLike>,"set"|"sort"|"copyWithin">> |Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>,"set"|"sort"|"copyWithin">>>
Defined in: src/sdk/components/horizon/layers/HorizonSyntheticVisionLayer.tsx:136
The offset to set for the camera of the layer's underlying Bing instance, as [x, y, z] in meters in the camera's
coordinate system. The positive z axis points in the forward direction of the camera, the positive x
axis points in the upward direction, and the positive y axis points to the right. Ignored if cameraOffsetMode is
not HorizonSyntheticVisionCameraParamMode.Custom.
cameraOffsetMode?
optionalcameraOffsetMode:HorizonSyntheticVisionCameraParamMode|Subscribable<HorizonSyntheticVisionCameraParamMode>
Defined in: src/sdk/components/horizon/layers/HorizonSyntheticVisionLayer.tsx:128
The mode used to control the offset of the camera of the layer's underlying Bing instance. If
HorizonSyntheticVisionCameraParamMode.Auto is used, then the offset of the camera will be set to the
camera offset of the layer's projection. If HorizonSyntheticVisionCameraParamMode.Custom is
used, then the offset will be set using the cameraOffset prop. If cameraOffset is not defined, then
HorizonSyntheticVisionCameraParamMode.Custom will behave like
HorizonSyntheticVisionCameraParamMode.Default. Defaults to
HorizonSyntheticVisionCameraParamMode.Default.
cameraPosition?
optionalcameraPosition:Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>,"set"|"sort"|"copyWithin">>>
Defined in: src/sdk/components/horizon/layers/HorizonSyntheticVisionLayer.tsx:84
The position to set for the camera of the layer's underlying Bing instance, as
[longitude (degrees), latitude (degrees), altitude (meters)]. Ignored if cameraPositionMode is not
HorizonSyntheticVisionCameraParamMode.Custom.
cameraPositionMode?
optionalcameraPositionMode:HorizonSyntheticVisionCameraParamMode|Subscribable<HorizonSyntheticVisionCameraParamMode>
Defined in: src/sdk/components/horizon/layers/HorizonSyntheticVisionLayer.tsx:77
The mode used to control the position of the camera of the layer's underlying Bing instance. If
HorizonSyntheticVisionCameraParamMode.Auto is used, then the position of the camera will be set to the
position and altitude of the layer's projection (note that this does not include the projection's camera
offset). If HorizonSyntheticVisionCameraParamMode.Custom is used, then the position will be set using the
cameraPosition and cameraAltitudeReference props. If cameraPosition is not defined, then
HorizonSyntheticVisionCameraParamMode.Custom will behave like
HorizonSyntheticVisionCameraParamMode.Default. Defaults to
HorizonSyntheticVisionCameraParamMode.Default.
cameraRotation?
optionalcameraRotation:Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>,"set"|"sort"|"copyWithin">>>
Defined in: src/sdk/components/horizon/layers/HorizonSyntheticVisionLayer.tsx:110
The rotation to set for the camera of the layer's underlying Bing instance, as
[pitch, roll, heading] in degrees. The sign conventions for pitch and roll are the same as those used by the
layer's horizon projection: positive pitch up and positive roll to the right. Ignored if cameraRotationMode is
not HorizonSyntheticVisionCameraParamMode.Custom.
cameraRotationMode?
optionalcameraRotationMode:HorizonSyntheticVisionCameraParamMode|Subscribable<HorizonSyntheticVisionCameraParamMode>
Defined in: src/sdk/components/horizon/layers/HorizonSyntheticVisionLayer.tsx:102
The mode used to control the rotation of the camera of the layer's underlying Bing instance. If
HorizonSyntheticVisionCameraParamMode.Auto is used, then the rotation of the camera will be set to the
pitch, roll, and heading of the layer's projection. If HorizonSyntheticVisionCameraParamMode.Custom is
used, then the rotation will be set using the cameraRotation and cameraRotationReference props. If
cameraRotation is not defined, then HorizonSyntheticVisionCameraParamMode.Custom will behave like
HorizonSyntheticVisionCameraParamMode.Default. Defaults to
HorizonSyntheticVisionCameraParamMode.Default.
cameraRotationReference?
optionalcameraRotationReference:BingCameraRotationReference|Subscribable<BingCameraRotationReference>
Defined in: src/sdk/components/horizon/layers/HorizonSyntheticVisionLayer.tsx:117
The reference to use when defining the rotation for the camera of the layer's underlying Bing instance. Ignored if
cameraRotationMode is not HorizonSyntheticVisionCameraParamMode.Custom. Defaults to
BingCameraRotationReference.World.
children?
optionalchildren:DisplayChildren[]
Defined in: src/sdk/components/FSComponent.ts:122
The children of the display component.
Inherited from
class?
optionalclass:string|ToggleableClassNameRecord|SubscribableSet<string>
Defined in: src/sdk/components/horizon/layers/HorizonSyntheticVisionLayer.tsx:139
CSS class(es) to apply to the layer's root element.
earthColors?
optionalearthColors:SubscribableArray<number>
Defined in: src/sdk/components/horizon/layers/HorizonSyntheticVisionLayer.tsx:53
The earth colors for the Bing component. Index 0 defines the water color, and indexes 1 to the end of the array
define the terrain colors. Each color should be expressed as R + G * 256 + B * 256^2. If not defined, all colors
default to black.
earthColorsElevationRange?
optionalearthColorsElevationRange:Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>,"set"|"sort"|"copyWithin">>>
Defined in: src/sdk/components/horizon/layers/HorizonSyntheticVisionLayer.tsx:62
The elevation range over which to assign the earth terrain colors, as [minimum, maximum] in feet. The terrain
colors are assigned at regular intervals over the entire elevation range, starting with the first terrain color at
the minimum elevation and ending with the last terrain color at the maximum elevation. Terrain below and above the
minimum and maximum elevation are assigned the first and last terrain colors, respectively. Defaults to
[0, 30000].
projection
projection:
HorizonProjection
Defined in: src/sdk/components/horizon/HorizonLayer.ts:10
The layer's horizon projection.
Inherited from
ref?
optionalref:NodeReference<any>
Defined in: src/sdk/components/FSComponent.ts:125
A reference to the display component.
Inherited from
skyColor
skyColor:
Subscribable<number>
Defined in: src/sdk/components/horizon/layers/HorizonSyntheticVisionLayer.tsx:65
The sky color for the component. The color should be expressed as R + G * 256 + B * 256^2.
updateFreq?
optionalupdateFreq:Subscribable<number>
Defined in: src/sdk/components/horizon/HorizonLayer.ts:17
A subscribable which provides the maximum update frequency of the layer, in hertz. Note that the actual update frequency will not exceed the update frequency of the layer's parent map. If not defined, the frequency will default to that of the layer's parent map.