CentralBody

CentralBody

new CentralBody

DOC_TBA

Parameters:
Name Type Argument Default Description
ellipsoid Ellipsoid <optional>
Ellipsoid.WGS84 Determines the size and shape of the central body.

Members

logoOffset :Cartesian2

The offset, relative to the bottom left corner of the viewport, where the logo for terrain and imagery providers will be drawn.

morphTime :Number

The current morph transition time between 2D/Columbus View and 3D, with 0.0 being 2D or Columbus View and 1.0 being 3D.
Default Value:
  • 1.0

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.

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.

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:

getEllipsoid

Gets an ellipsoid describing the shape of this central body.

Returns:

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:

<static> prototype.getImageryLayers

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

Returns: