CentralBody

Members

depthTestAgainstTerrain :Boolean

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.

Default Value:

• false

ellipsoid :Ellipsoid

Gets an ellipsoid describing the shape of this central body.

enableLighting :Boolean

Enable lighting the globe with the sun as a light source.

Default Value:

• false

imageryLayers :ImageryLayerCollection

Gets the collection of image layers that will be rendered on this central body.

lightingFadeInDistance :Number

The distance where lighting resumes. This only takes effect when enableLighting is true.

Default Value:

• 9000000.0

lightingFadeOutDistance :Number

The distance where everything becomes lit. This only takes effect when enableLighting is true.

Default Value:

• 6500000.0

maximumScreenSpaceError :Number

The maximum screen-space error used to drive level-of-detail refinement. Higher values will provide better performance but lower visual quality.

Default Value:

• 2

northPoleColor :Cartesian3

Determines the color of the north pole. If the day tile provider imagery does not extend over the north pole, it will be filled with this color before applying lighting.

Default Value:

• Cartesian3(2.0 / 255.0, 6.0 / 255.0, 18.0 / 255.0)

oceanNormalMapUrl :String

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.

Default Value:

• buildModuleUrl('Assets/Textures/waterNormalsSmall.jpg')

show :Boolean

Determines if the central body will be shown.

Default Value:

• true

southPoleColor :Cartesian3

Determines the color of the south pole. If the day tile provider imagery does not extend over the south pole, it will be filled with this color before applying lighting.

Default Value:

• Cartesian3(1.0, 1.0, 1.0)

terrainProvider :TerrainProvider

The terrain provider providing surface geometry for this central body.

tileCacheSize :Number

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.

Default Value:

• 100

Methods

destroy

Destroys the WebGL resources held by this object. Destroying an object allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this object.

Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.

Throws:

DeveloperError : This object was destroyed, i.e., destroy() was called.

Returns:

Example

centralBody = centralBody && centralBody.destroy();

See:

• CentralBody#isDestroyed

isDestroyed

Returns true if this object was destroyed; otherwise, false.

If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.

Returns:

Boolean True if this object was destroyed; otherwise, false.

See:

• CentralBody#destroy