Class: Planet

Constructor

new Planet(optionsopt)

Parameters:

Name Type Attributes Default Description

options

IPlanetParams

{}

Planet configuration parameters.

Properties

Name	Type	Attributes	Default	Description
`name`	string	<optional>		Planet name.
`ellipsoid`	Ellipsoid	<optional>	wgs84	Planet ellipsoid.
`minAltitude`	number	<optional>		Minimum camera altitude above terrain.
`maxAltitude`	number	<optional>		Maximum camera altitude above terrain.
`frustums`	Array.<Array.<number>>	<optional>		Planet camera frustum configuration.
`maxGridSize`	number	<optional>	256	Maximum terrain segment grid size.
`maxLoadingRequests`	number	<optional>	12	Maximum concurrent tile loading requests.
`maxNodesCount`	number	<optional>	400	Maximum number of created quadtree nodes.
`maxEqualZoomAltitude`	number	<optional>	15000000.0	Max altitude where visible segments keep the same zoom.
`minEqualZoomAltitude`	number	<optional>	10000.0	Min altitude where visible segments keep the same zoom.
`minEqualZoomCameraSlope`	number	<optional>	0.8	Min camera slope for equal-zoom segment strategy.
`quadTreeStrategyPrototype`	function	<optional>	EarthQuadTreeStrategy	Quadtree strategy class.
`nightTextureSrc`	string \| null	<optional>		Night lights texture URL (`null` disables texture loading).
`specularTextureSrc`	string \| null	<optional>		Water/specular mask texture URL (`null` disables texture loading).
`atmosphereEnabled`	boolean	<optional>	false	Enables atmosphere rendering.
`transitionOpacityEnabled`	boolean	<optional>		Enables terrain transition opacity blending.
`atmosphereParameters`	IAtmosphereParams	<optional>		Atmosphere model parameters.
`minDistanceBeforeMemClear`	number	<optional>		Camera travel distance threshold before automatic memory cleanup.
`vectorTileSize`	number	<optional>		Vector tile texture size for vector layer baking.
`transparentBackground`	boolean	<optional>	false	Enables transparent renderer background.
`nearPlaneStrategy`	INearPlaneStrategy	<optional>		Near-plane strategy implementation.
`shadeMode`	number \| string	<optional>	0.5	Terrain shading mode: `0\|none\|unlit`, `0.5\|phong`, `1\|pbr`.
`reverseDepth`	boolean	<optional>	true	Enables reverse-Z depth for the default planet camera in perspective mode.

Source: scene/Planet.ts, line 110

Fires:

event:draw - Triggered before globe frame begins to render.
event:layeradd - Triggered when a layer is added to the planet.
event:baselayerchange - Triggered when the base layer changes.
event:layerremove - Triggered when a layer is removed from the planet.
event:layervisibilitychange - Triggered when layer visibility changes.
event:rendercompleted - Triggered when all data is loaded.
event:terraincompleted - Triggered when terrain data is loaded.
event:layerloadend - Triggered when layer data finishes loading.

Extends

Scene

Members

atmosphereControl

Returns atmosphere control instance bound to the planet.

Source: scene/Planet.ts, line 915

atmosphereEnabled

Enables or disables atmosphere rendering and related programs.

Source: scene/Planet.ts, line 599

atmosphereEnabled

Returns atmosphere activity flag.

Source: scene/Planet.ts, line 611

atmosphereMaxMinOpacity

Gets atmosphere opacity range [max, min].

Source: scene/Planet.ts, line 578

atmosphereMaxOpacity

Sets maximum atmosphere opacity.

Source: scene/Planet.ts, line 542

atmosphereMaxOpacity

Gets maximum atmosphere opacity.

Source: scene/Planet.ts, line 551

atmosphereMinOpacity

Sets minimum atmosphere opacity.

Source: scene/Planet.ts, line 560

atmosphereMinOpacity

Gets minimum atmosphere opacity.

Source: scene/Planet.ts, line 569

layers

Returns current layers snapshot.

Source: scene/Planet.ts, line 678

maxGridSize

Returns max segment grid size used by the quadtree.

Source: scene/Planet.ts, line 513

normalMapCreator

Returns normal-map generator used by the planet.

Source: scene/Planet.ts, line 669

shadeMode

Returns active terrain shade mode.

Source: scene/Planet.ts, line 620

shadeMode

Sets terrain shade mode.

Source: scene/Planet.ts, line 629

sun

Returns Sun control instance if attached to the renderer.

Source: scene/Planet.ts, line 687

sunPos

Returns current sun world position.

Source: scene/Planet.ts, line 696

terrainReady

Returns true if current terrain data set is loaded

Source: scene/Planet.ts, line 505

Methods

(protected) _applyAttribution()

Apply to render list of layer attributions

Source: scene/Planet.ts, line 1280

(protected) _clear()

Clear current node.

Overrides: Scene#_clear
Source: scene/Scene.ts, line 190

_clearLayerMaterial(layer)

Clears material resources related to a layer in quadtree segments.

Parameters:

Name	Type	Description
`layer`	Layer	Material layer.

Source: scene/Planet.ts, line 778

_onLayerVisibilityChanged(layer)

Dispatch layer visibility changing event.

Parameters:

Name	Type	Description
`layer`	Layer	Changed layer.

Source: scene/Planet.ts, line 749

_renderingOpaqueScreenNodes()

Drawing nodes

Source: scene/Planet.ts, line 1715

(protected) _sortLayers()

Sort visible layer - preparing for rendering.

Source: scene/Planet.ts, line 1296

addControl(control)

Add the given control to the renderer of the planet scene.

Parameters:

Name	Type	Description
`control`	Control	Control.

Source: scene/Planet.ts, line 705

addControls(cArr)

Add the given controls array to the renderer of the planet.

Parameters:

Name	Type	Description
`cArr`	Array.<Control>	Control array.

Source: scene/Planet.ts, line 715

addEntityCollection(entityCollection, isHiddenopt) → {Scene}

Adds entity collection.

Parameters:

Name	Type	Attributes	Description
`entityCollection`	EntityCollection		Entity collection.
`isHidden`	boolean	<optional>	If it's true that this collection has specific rendering.

Overrides: Scene#addEntityCollection
Source: scene/Scene.ts, line 200

Returns:

Type:: Scene

addLayer(layer)

Adds layer to the planet.

Parameters:

Name	Type	Description
`layer`	Layer	Layer object.

Source: scene/Planet.ts, line 740

addLayers(layers)

Adds the given layers array to the planet.

Parameters:

Name	Type	Description
`layers`	Array.<Layer>	Layers array.

Source: scene/Planet.ts, line 758

addNode()

Adds node to the current hierarchy.

Overrides: Scene#addNode
Source: scene/Scene.ts, line 111

assign(renderer)

Assign render node with renderer.

Parameters:

Name	Type	Description
`renderer`	Renderer	Render node's renderer.

Overrides: Scene#assign
Source: scene/Scene.ts, line 127

createDefaultTextures(param0, param1)

Creates default textures first for the North Pole and whole globe and second for the South Pole.

Parameters:

Name	Type	Description
`param0`	IDefaultTextureParams	Default texture params for the first texture.
`param1`	IDefaultTextureParams	Default texture params for the second texture.

Source: scene/Planet.ts, line 1190

destroy()

Destroy planet.

Overrides: Scene#destroy
Source: scene/Planet.ts, line 2388

draw()

Calls render frame node's callback. Used in renderer.

Overrides: Scene#draw
Source: scene/Scene.ts, line 266

drawPickingEntityCollections(ec)

Draw entity collections picking frame.

Parameters:

Name	Type	Description
`ec`	Array.<EntityCollection>	Entity collection array.

Overrides: Scene#drawPickingEntityCollections
Source: scene/Scene.ts, line 377

flyCartesian(cartesian, params)

Fly camera to the point.

Parameters:

Name	Type	Description
`cartesian`	Vec3	Fly cartesian coordinates.
`params`	IPlanetFlyCartesianParams	Flight parameters.

Source: scene/Planet.ts, line 2274

flyExtent(extent, heightopt, params)

Fly active camera to the view extent.

Parameters:

Name	Type	Attributes	Description
`extent`	Extent		Geographical extent.
`height`	Number	<optional>	Height on the end of the flight route.
`params`	IPlanetFlyCartesianParams		Flight parameters.

Source: scene/Planet.ts, line 2263

flyLonLat(lonlat, params)

Fly camera to the geodetic position.

Parameters:

Name	Type	Description
`lonlat`	LonLat	Fly geographical coordinates.
`params`	IPlanetFlyCartesianParams	Flight parameters.

Source: scene/Planet.ts, line 2284

getCartesianFromMouseTerrain() → {Vec3|undefined}

Returns mouse position cartesian coordinates on the current terrain.

Source: scene/Planet.ts, line 2082

Returns:

Type:: Vec3 | undefined

getCartesianFromPixelEllipsoid(px) → {Vec3|undefined}

Project screen coordinates to the planet ellipsoid.

Parameters:

Name	Type	Description
`px`	Vec2 \| IBaseInputState	Screen coordinates.

Source: scene/Planet.ts, line 2058

Returns:

Cartesian coordinates.

Type:: Vec3 | undefined

getCartesianFromPixelTerrain(px) → {Vec3|undefined}

Returns screen coordinates cartesian coordinates on the current terrain. position or null if input coordinates is outside the planet.

Parameters:

Name	Type	Description
`px`	Vec2 \| IBaseInputState	Pixel screen 2d coordinates.

Source: scene/Planet.ts, line 2096

Returns:

Type:: Vec3 | undefined

getDistanceFromPixel(px) → {number}

Returns distance from active (screen) camera to the planet terrain by screen coordinates.

Parameters:

Name	Type	Description
`px`	Vec2 \| IBaseInputState	Screen coordinates.

Source: scene/Planet.ts, line 2173

Returns:

Type:: number

getDistanceFromPixelEllipsoid(px) → {number|undefined}

Returns distance from an active (screen) camera to the planet ellipsoid.

Parameters:

Name	Type	Description
`px`	Vec2 \| IBaseInputState	Screen coordinates.

Source: scene/Planet.ts, line 2157

Returns:

Type:: number | undefined

getEntityTerrainPoint(entity, res) → {Vec3|undefined}

Finds terrain point under an entity in currently rendered segments.

Parameters:

Name	Type	Description
`entity`	Entity	Entity to test.
`res`	Vec3	Output vector for terrain point.

Source: scene/Planet.ts, line 2325

Returns:

Terrain point if found.

Type:: Vec3 | undefined

getExtent() → {Extent}

Gets current camera view extent.

Source: scene/Planet.ts, line 2206

Returns:

Type:: Extent

getFrameRotation(cartesian) → {Quat}

Returns local frame rotation for a cartesian point.

Parameters:

Name	Type	Description
`cartesian`	Vec3	Cartesian point.

Source: scene/Planet.ts, line 532

Returns:

Rotation from world frame to local frame.

Type:: Quat

(async) getHeightAboveELL(lonLat) → {Promise.<number>}

Returns terrain height above ellipsoid at the given coordinates.

Parameters:

Name	Type	Description
`lonLat`	LonLat	Geodetic coordinates.

Source: scene/Planet.ts, line 2360

Returns:

Height above ellipsoid.

Type:: Promise.<number>

(async) getHeightDefault(lonLat) → {Promise.<number>}

Returns terrain height at the given coordinates in default terrain datum.

Parameters:

Name	Type	Description
`lonLat`	LonLat	Geodetic coordinates.

Source: scene/Planet.ts, line 2342

Returns:

Height value.

Type:: Promise.<number>

getHeightFactor() → {number}

Gets elevation scale.

Source: scene/Planet.ts, line 841

Returns:

Terrain elevation scale

Type:: number

getLayerByName(name) → {Layer|undefined}

Returns a layer by name.

Parameters:

Name	Type	Description
`name`	string	Layer name.

Source: scene/Planet.ts, line 726

Returns:

Type:: Layer | undefined

getLonLatFromPixelEllipsoid(px) → {LonLat|undefined}

Project screen coordinates to the planet ellipsoid.

Parameters:

Name	Type	Description
`px`	Vec2	Screen coordinates.

Source: scene/Planet.ts, line 2069

Returns:

Geodetic coordinates.

Type:: LonLat | undefined

getLonLatFromPixelTerrain(px) → {LonLat|undefined}

Returns geodetic coordinates on the current terrain planet by its screen coordinates. position or null if input coordinates is outside the planet.

Parameters:

Name	Type	Description
`px`	Vec2 \| IBaseInputState	Pixel screen 2d coordinates.

Source: scene/Planet.ts, line 2120

Returns:

Type:: LonLat | undefined

getNorthFrameRotation(cartesian) → {Quat}

Returns local north frame rotation for a cartesian point.

Parameters:

Name	Type	Description
`cartesian`	Vec3	Cartesian point.

Source: scene/Planet.ts, line 522

Returns:

Rotation from world frame to local north frame.

Type:: Quat

getPixelFromCartesian(coords) → {Vec2}

Project cartesian coordinates to screen space.

Parameters:

Name	Type	Description
`coords`	Vec3	Cartesian coordinates.

Source: scene/Planet.ts, line 2134

Returns:

Screen coordinates.

Type:: Vec2

getPixelFromLonLat(lonlat) → {Vec2|undefined}

Project geodetic coordinates to screen space.

Parameters:

Name	Type	Description
`lonlat`	LonLat	Geodetic coordinates.

Source: scene/Planet.ts, line 2144

Returns:

Screen coordinates.

Type:: Vec2 | undefined

getRayIntersectionEllipsoid(ray) → {Vec3|undefined}

Returns ray vector hit ellipsoid coordinates. If the ray doesn't hit ellipsoid it returns 'undefined'.

Parameters:

Name	Type	Description
`ray`	Ray	Ray.

Source: scene/Planet.ts, line 2047

Returns:

Type:: Vec3 | undefined

getViewExtent() → {Extent}

Returns currently cached quadtree view extent.

Source: scene/Planet.ts, line 2243

Returns:

Cached view extent.

Type:: Extent

init()

Initializes render resources, workers, shaders, and layer state.

Source: scene/Planet.ts, line 1010

initAtmosphereShader(atmosParamsopt)

Reinitializes terrain forward/deferred shaders for atmosphere mode.

Parameters:

Name	Type	Attributes	Description
`atmosParams`	AtmosphereParameters	<optional>	Optional atmosphere shader parameters.

Source: scene/Planet.ts, line 899

initLayers()

Reattaches already registered layers to apply initialization logic.

Source: scene/Planet.ts, line 1167

isActive() → {Boolean}

Gets render node activity.

Overrides: Scene#isActive
Source: scene/Scene.ts, line 274

Returns:

Type:: Boolean

lockQuadTree()

Pauses quadtree render-node collection and disables camera terrain collision checks.

Source: scene/Planet.ts, line 1461

memClear()

Starts clear memory thread.

Source: scene/Planet.ts, line 2022

onremove()

Handles node detachment and frees runtime terrain data.

Source: scene/Planet.ts, line 2378

preDraw()

Calls render frame node's callback. Used in renderer.

Overrides: Scene#preDraw
Source: scene/Scene.ts, line 266

preFrame()

Render node callback.

Source: scene/Planet.ts, line 1416

removeEntityCollection(entityCollection)

Removes entity collection.

Parameters:

Name	Type	Description
`entityCollection`	EntityCollection	Entity collection for remove.

Overrides: Scene#removeEntityCollection
Source: scene/Scene.ts, line 225

removeLayer(layer)

Removes the given layer from the planet.

Parameters:

Name	Type	Description
`layer`	Layer	Layer to remove.

Source: scene/Planet.ts, line 769

renderDepthFramebuffer(cam, quadTreeStrategy)

Renders terrain depth and frustum id into the depth framebuffer.

Parameters:

Name	Type	Description
`cam`	PlanetCamera	Camera used for rendering.
`quadTreeStrategy`	QuadTreeStrategy	Quadtree strategy with rendered node lists.

Source: scene/Planet.ts, line 1951

setActive(isActive)

Rendering activation.

Parameters:

Name	Type	Description
`isActive`	boolean	Activation flag.

Overrides: Scene#setActive
Source: scene/Scene.ts, line 283

setBaseLayer(layer)

Sets base layer coverage to the planet.

Parameters:

Name	Type	Description
`layer`	Layer	Layer object.

Source: scene/Planet.ts, line 787

setDrawMode(mode)

Sets draw mode

Parameters:

Name	Type	Description
`mode`	Number	Draw mode, such as gl.TRIANGLES, gl.TRIANGLE_STRIP, gl.LINES etc.

Overrides: Scene#setDrawMode
Source: scene/Scene.ts, line 307

setHeightFactor(factor)

Sets elevation scale. 1.0 is default.

Parameters:

Name	Type	Description
`factor`	number	Elevation scale.

Source: scene/Planet.ts, line 828

setLodSize(currentLodSize, minLodSizeopt, maxLodSizeopt)

Sets LOD thresholds for quadtree terrain rendering. Proxy to QuadTreeStrategy.setLodSize.

Parameters:

Name	Type	Attributes	Description
`currentLodSize`	number		Current LOD size target.
`minLodSize`	number	<optional>	Minimum LOD size.
`maxLodSize`	number	<optional>	Maximum LOD size.

Source: scene/Planet.ts, line 850

setTerrain(terrain)

Sets terrain provider

Parameters:

Name	Type	Description
`terrain`	EmptyTerrain	Terrain provider.

Source: scene/Planet.ts, line 862

stopFlying()

Stop current flight.

Source: scene/Planet.ts, line 2294

unlockQuadTree()

Resumes quadtree render-node collection and enables camera terrain collision checks.

Source: scene/Planet.ts, line 1474

updateAttributionsList()

Updates attribution lists

Source: scene/Planet.ts, line 1211

updateBillboardsTexCoords()

Refreshes billboard texture coordinates for all visible entity collections.

Source: scene/Planet.ts, line 2302

updateVisibleLayers()

Schedules visible layers list refresh for the next frame.

Source: scene/Planet.ts, line 1228

viewExtent(extent)

Sets camera to the planet geographical extent.

Parameters:

Name	Type	Description
`extent`	Extent	Geographical extent.

Source: scene/Planet.ts, line 2183

viewExtentArr(extentArr)

Fits camera position for the view extent.

Parameters:

Name	Type	Description
`extentArr`	Array.<number>	Geographical extent array, (exactly 4 entries) where index 0 - southwest longitude, 1 - latitude southwest, 2 - longitude northeast, 3 - latitude northeast.

Source: scene/Planet.ts, line 2196

viewLonLat(lonlat, lookLonLatopt, upopt)

Sets camera to the planet geographical position.

Parameters:

Name	Type	Attributes	Description
`lonlat`	LonLat		Camera position.
`lookLonLat`	LonLat	<optional>	Viewpoint.
`up`	Vec3	<optional>	Camera up vector.

Source: scene/Planet.ts, line 2252