Globe
The globe rendered in the scene, including its terrain (Globe.terrainProvider) and imagery layers (Globe.imageryLayers). Access the globe using Scene.globe.
See also
Properties
The brightness shift to apply to the atmosphere. Defaults to 0.0 (no shift). A brightness shift of -1.0 is complete darkness, which will let space show through.
The hue shift to apply to the atmosphere. Defaults to 0.0 (no shift). A hue shift of 1.0 indicates a complete rotation of the hues available.
The intensity of the light that is used for computing the ground atmosphere color.
The anisotropy of the medium to consider for Mie scattering.
The Mie scattering coefficient used in the atmospheric scattering equations for the ground atmosphere.
The Mie scale height used in the atmospheric scattering equations for the ground atmosphere, in meters.
The Rayleigh scattering coefficient used in the atmospheric scattering equations for the ground atmosphere.
The Rayleigh scale height used in the atmospheric scattering equations for the ground atmosphere, in meters.
The saturation shift to apply to the atmosphere. Defaults to 0.0 (no shift). A saturation shift of -1.0 is monochrome.
Whether to cull back-facing terrain. Back faces are not culled when the camera is underground or translucency is enabled.
A property specifying a Rectangle used to limit globe rendering to a cartographic area. Defaults to the maximum extent of cartographic coordinates.
A property specifying a ClippingPlaneCollection used to selectively disable rendering on the outside of each plane.
A property specifying a ClippingPolygonCollection used to selectively disable rendering inside or outside a list of polygons.
True if primitives such as billboards, polylines, labels, etc. should be depth-tested against the terrain surface, or false if such primitives should always be drawn on top of terrain unless they're on the opposite side of the globe. The disadvantage of depth testing primitives against terrain is that slight numerical noise or terrain level-of-detail switched can sometimes make a primitive that should be on the surface disappear underneath it.
Enable dynamic lighting effects on atmosphere and fog. This only takes effect when enableLighting is true.
Whether dynamic atmosphere lighting uses the sun direction instead of the scene's light direction. This only takes effect when enableLighting and dynamicAtmosphereLighting are true.
Determines the size and shape of the globe. Default value - Ellipsoid.default
Enable lighting the globe with the scene's light source.
The color to use to highlight terrain fill tiles. If undefined, fill tiles are not highlighted at all. The alpha value is used to alpha blend with the tile's actual color. Because terrain fill tiles do not represent the actual terrain surface, it may be useful in some applications to indicate visually that they are not to be trusted.
Gets the collection of image layers that will be rendered on this globe.
Gets an event that's raised when an imagery layer is added, shown, hidden, moved, or removed.
A multiplier to adjust terrain lambert lighting. This number is multiplied by the result of czm_getLambertDiffuse in GlobeFS.glsl. This only takes effect when enableLighting is true.
The distance where lighting resumes. This only takes effect when enableLighting or showGroundAtmosphere is true.
The distance where everything becomes lit. This only takes effect when enableLighting or showGroundAtmosphere is true.
Gets or sets the number of loading descendant tiles that is considered "too many". If a tile has too many loading descendants, that tile will be loaded and rendered before any of its descendants are loaded and rendered. This means more feedback for the user that something is happening at the cost of a longer overall load time. Setting this to 0 will cause each tile level to be loaded successively, significantly increasing load time. Setting it to a large number (e.g. 1000) will minimize the number of tiles that are loaded but tend to make detail appear all at once after a long wait.
The maximum screen-space error used to drive level-of-detail refinement. Higher values will provide better performance but lower visual quality.
The distance where the darkness of night from the ground atmosphere fades in to an unlit ground atmosphere. This only takes effect when showGroundAtmosphere, enableLighting, and dynamicAtmosphereLighting are true.
The distance where the darkness of night from the ground atmosphere fades out to a lit ground atmosphere. This only takes effect when showGroundAtmosphere, enableLighting, and dynamicAtmosphereLighting are true.
The normal map to use for rendering waves in the ocean. Setting this property will only have an effect if the configured terrain provider includes a water mask.
Gets or sets a value indicating whether the ancestors of rendered tiles should be preloaded. Setting this to true optimizes the zoom-out experience and provides more detail in newly-exposed areas when panning. The down side is that it requires loading more tiles.
Gets or sets a value indicating whether the siblings of rendered tiles should be preloaded. Setting this to true causes tiles with the same parent as a rendered tile to be loaded, even if they are culled. Setting this to true may provide a better panning experience at the cost of loading more tiles.
Determines whether the globe casts or receives shadows from light sources. Setting the globe to cast shadows may impact performance since the terrain is rendered again from the light's perspective. Currently only terrain that is in view casts shadows. By default the globe does not cast shadows.
Enable the ground atmosphere, which is drawn over the globe when viewed from a distance between lightingFadeInDistance and lightingFadeOutDistance.
Whether to show terrain skirts. Terrain skirts are geometry extending downwards from a tile's edges used to hide seams between neighboring tiles. Skirts are always hidden when the camera is underground or translucency is enabled.
True if an animated wave effect should be shown in areas of the globe covered by water; otherwise, false. This property is ignored if the terrainProvider does not provide a water mask.
The terrain provider providing surface geometry for this globe.
Gets an event that's raised when the terrain provider is changed
The size of the terrain tile cache, expressed as a number of tiles. Any additional tiles beyond this number will be freed, as long as they aren't needed for rendering this frame. A larger number will consume more memory but will show detail faster when, for example, zooming out and then back in.
Gets an event that's raised when the length of the tile load queue has changed since the last render frame. When the load queue is empty, all terrain and imagery for the current view have been loaded. The event passes the new length of the tile load queue.
Returns true when the tile load queue is empty, false otherwise. When the load queue is empty, all terrain and imagery for the current view have been loaded.
Properties for controlling globe translucency.
The color to render the back side of the globe when the camera is underground or the globe is translucent, blended with the globe color based on the camera's distance.
Gets or sets the near and far distance for blending Globe.undergroundColor with the globe color. The alpha will interpolate between the NearFarScalar.nearValue and NearFarScalar.farValue while the camera distance falls within the lower and upper bounds of the specified NearFarScalar.near and NearFarScalar.far. Outside of these ranges the alpha remains clamped to the nearest bound. If undefined, the underground color will not be blended with the globe color.
Determines the darkness of the vertex shadow. This only takes effect when enableLighting is true.
Functions
Get the height of the surface at a given cartographic.
Returns true if this object was destroyed; otherwise, false.
Find an intersection between a ray and the globe surface that was rendered. The ray must be given in world coordinates.