Globe
Globe can operate the globe of the scene.
All properties are applied to single globe of the scene.
Note: Following code is not recommended as occur extra rendering steps:
<Viewer> <Scene> <Globe> <Camera> <Entity /> </Camera> </Globe> </Scene></Viewer>Globe component’s role is just changing fields of Viewer#scene#globe, so following code is recommended.
<Viewer> <Scene /> <Globe /> <Camera /> <Entity /></Viewer>For details, refer to “Component location” chapter in Guide.
Availability
Section titled “Availability”Globe can be mounted insideViewer or CesiumWidget components. It can not be mounted more than once for each Viewer or CesiumWidget.
Properties
Section titled “Properties”Cesium properties
Section titled “Cesium properties”| Property | Type | Description |
|---|---|---|
| show | boolean | |
| material | Material | undefined | |
| shadows | ShadowMode | |
| maximumScreenSpaceError | number | |
| clippingPlanes | ClippingPlaneCollection | |
| clippingPolygons | ClippingPolygonCollection | |
| backFaceCulling | boolean | |
| atmosphereBrightnessShift | number | |
| atmosphereHueShift | number | |
| atmosphereSaturationShift | number | |
| baseColor | Color | |
| depthTestAgainstTerrain | boolean | |
| enableLighting | boolean | |
| lightingFadeInDistance | number | |
| lightingFadeOutDistance | number | |
| nightFadeInDistance | number | |
| nightFadeOutDistance | number | |
| oceanNormalMapUrl | string | |
| showGroundAtmosphere | boolean | |
| showWaterEffect | boolean | |
| tileCacheSize | number | |
| loadingDescendantLimit | number | |
| preloadAncestors | boolean | |
| preloadSiblings | boolean | |
| fillHighlightColor | Color | |
| dynamicAtmosphereLighting | boolean | |
| dynamicAtmosphereLightingFromSun | boolean | |
| showSkirts | boolean | |
| cartographicLimitRectangle | Rectangle | |
| translucency | GlobeTranslucency | |
| undergroundColor | Color | |
| undergroundColorAlphaByDistance | NearFarScalar | |
| lambertDiffuseMultiplier | number | |
| atmosphereLightIntensity | number | |
| atmosphereRayleighCoefficient | Cartesian3 | |
| atmosphereMieCoefficient | Cartesian3 | |
| atmosphereRayleighScaleHeight | number | |
| atmosphereMieScaleHeight | number | |
| atmosphereMieAnisotropy | number | |
| vertexShadowDarkness | number |
Cesium read-only properties
Section titled “Cesium read-only properties”N/A
Cesium events
Section titled “Cesium events”| Property | Type | Description |
|---|---|---|
| onImageryLayersUpdate | (() => void) | undefined | |
| onTerrainProviderChange | ((terrainProvider: TerrainProvider) => void) | undefined | |
| onTileLoadProgress | ((currentLoadQueueLength: number) => void) | undefined |
Other properties
Section titled “Other properties”| Property | Type | Description |
|---|---|---|
| terrainProvider | TerrainProvider | Promise<TerrainProvider> | undefined |