Class: Planet

Constructor

new Planet()

Parameters:

Name	Type	Attributes	Default	Description
`options.name`	string	<optional>	"Earth"	Planet name(Earth by default)
`options.ellipsoid`	Ellipsoid	<optional>		Planet ellipsoid(WGS84 by default)
`options.maxGridSize`	Number	<optional>	128	Segment maximal grid size
`options.maxEqualZoomAltitude`	Number	<optional>	15000000.0	Maximal altitude since segments on the screen become the same zoom level
`options.minEqualZoomAltitude`	Number	<optional>	10000.0	Minimal altitude since segments on the screen become the same zoom level
`options.minEqualZoomCameraSlope`	Number	<optional>	0.8	Minimal camera slope above te globe where segments on the screen become the same zoom level

Source: scene/Planet.ts, line 98

Fires:

EventsHandler#event:draw
EventsHandler#event:layeradd
EventsHandler#event:baselayerchange
EventsHandler#event:layerremove
EventsHandler#event:layervisibilitychange
EventsHandler#event:geoimageadd

Extends

RenderNode

Members

terrainReady

Returns true if current terrain data set is loaded

Source: scene/Planet.ts, line 597

Methods

(protected) _applyAttribution()

Apply to render list of layer attributions

Source: scene/Planet.ts, line 1202

(protected) _clear()

Clear current node.

Overrides: RenderNode#_clear
Source: scene/BaseNode.ts, line 100

_clearLayerMaterial(layer)

Parameters:

Name	Type	Description
`layer`	Layer	Material layer.

Source: scene/Planet.ts, line 764

(protected) _collectRenderNodes()

Collects visible quad nodes.

Source: scene/Planet.ts, line 1302

_onLayerVisibilityChanged(layer)

Dispatch layer visibility changing event.

Parameters:

Name	Type	Description
`layer`	Layer	Changed layer.

Source: scene/Planet.ts, line 735

_renderingScreenNodes()

Drawing nodes

Source: scene/Planet.ts, line 1686

(protected) _sortLayers()

Sort visible layer - preparing for rendering.

Source: scene/Planet.ts, line 1218

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 681

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 702

addEntityCollection(entityCollection, isHiddenopt) → {RenderNode}

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: RenderNode#addEntityCollection
Source: scene/RenderNode.ts, line 152

Returns:

Type:: RenderNode

addLayer(layer)

Adds layer to the planet.

Parameters:

Name	Type	Description
`layer`	Layer	Layer object.

Source: scene/Planet.ts, line 726

addLayers(layers)

Adds the given layers array to the planet.

Parameters:

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

Source: scene/Planet.ts, line 744

addLight(light) → {RenderNode}

Adds point light source.

Parameters:

Name	Type	Description
`light`	LightSource	Light source.

Overrides: RenderNode#addLight
Source: scene/RenderNode.ts, line 173

Returns:

Type:: RenderNode

addNode()

Adds node to the current hierarchy.

Overrides: RenderNode#addNode
Source: scene/RenderNode.ts, line 90

assign(renderer)

Assign render node with renderer.

Parameters:

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

Overrides: RenderNode#assign
Source: scene/RenderNode.ts, line 100

createDefaultTextures()

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

Source: scene/Planet.ts, line 1116

destroy()

Destroy node.

Overrides: RenderNode#destroy
Source: scene/BaseNode.ts, line 79

drawNode()

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

Overrides: RenderNode#drawNode
Source: scene/RenderNode.ts, line 213

drawPickingEntityCollections(ec)

Draw entity collections picking frame.

Parameters:

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

Overrides: RenderNode#drawPickingEntityCollections
Source: scene/RenderNode.ts, line 349

flyCartesian(cartesian, lookopt, upopt, amplopt, completeCallbackopt, startCallbackopt, frameCallbackopt)

Fly camera to the point.

Parameters:

Name	Type	Attributes	Description
`cartesian`	Vec3		Point coordinates.
`look`	Vec3	<optional>	Camera "look at" point.
`up`	Vec3	<optional>	Camera UP vector on the end of a flying.
`ampl`	Number	<optional>	Altitude amplitude factor.
`completeCallback`	function	<optional>	Call the function in the end of flight
`startCallback`	function	<optional>	Call the function in the beginning
`frameCallback`	function	<optional>	Each frame callback

Source: scene/Planet.ts, line 2158

flyExtent(extent, heightopt, upopt, amplopt, startCallbackopt, completeCallbackopt)

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.
`up`	Vec3	<optional>	Camera UP vector on the end of a flying.
`ampl`	Number	<optional>	Altitude amplitude factor.
`startCallback`	function	<optional>	Callback that calls before the flying begins.
`completeCallback`	function	<optional>	Callback that calls after flying when flying is finished.

Source: scene/Planet.ts, line 2137

flyLonLat(lonlat, lookopt, upopt, amplopt, completeCallbackopt, startCallbackopt, frameCallbackopt)

Fly camera to the geodetic position.

Parameters:

Name	Type	Attributes	Description
`lonlat`	LonLat		Fly geographical coordinates.
`look`	Vec3 \| LonLat	<optional>	Camera viewpoint in the end of the flight.
`up`	Vec3	<optional>	Camera UP vector on the end of a flying.
`ampl`	Number	<optional>	Altitude amplitude factor.
`completeCallback`		<optional>
`startCallback`		<optional>
`frameCallback`		<optional>

Source: scene/Planet.ts, line 2181

frame()

Render node callback. Frame function is called for each renderer activrCamera frustum.

Source: scene/Planet.ts, line 1461

getCartesianFromMouseTerrain() → {Vec3|undefined}

Returns mouse position cartesian coordinates on the current terrain.

Source: scene/Planet.ts, line 1972

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 1948

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	Pixel screen 2d coordinates.

Source: scene/Planet.ts, line 1985

Returns:

Type:: Vec3 | undefined

getDistanceFromPixel(px) → {number|undefined}

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 2050

Returns:

Type:: number | undefined

getDistanceFromPixelEllipsoid(px) → {number}

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

Parameters:

Name	Type	Description
`px`	Vec2	Screen coordinates.

Source: scene/Planet.ts, line 2037

Returns:

Type:: number

getHeightFactor() → {number}

Gets elevation scale.

Source: scene/Planet.ts, line 809

Returns:

Terrain elevation scale

Type:: number

getLayerByName(name) → {Layer}

Return layer by it name

Parameters:

Name	Type	Description
`name`	string	Name of the layer. og.Layer.prototype.name

Source: scene/Planet.ts, line 712

Returns:

Type:: Layer

getLayers() → {Array.<Layer>}

Source: scene/Planet.ts, line 666

Returns:

Layers array.

Type:: Array.<Layer>

getLightByName(name) → {LightSource}

Gets light object by its name.

Parameters:

Name	Type	Description
`name`	string	Point light name.

Overrides: RenderNode#getLightByName
Source: scene/RenderNode.ts, line 184

Returns:

Type:: LightSource

getLonLatFromPixelEllipsoid(px) → {LonLat|undefined}

Project screen coordinates to the planet ellipsoid.

Parameters:

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

Source: scene/Planet.ts, line 1959

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 2000

Returns:

Type:: LonLat | undefined

getNodeByName(name) → {RenderNode}

Gets node by name in the current.

Parameters:

Name	Type	Description
`name`	string	Node name.

Overrides: RenderNode#getNodeByName
Source: scene/BaseNode.ts, line 90

Returns:

Node object in the current node.

Type:: RenderNode

getPixelFromCartesian(coords) → {Vec2}

Project cartesian coordinates to screen space.

Parameters:

Name	Type	Description
`coords`	Vec3	Cartesian coordinates.

Source: scene/Planet.ts, line 2014

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 2024

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 1937

Returns:

Type:: Vec3 | undefined

getViewExtent() → {Extent}

Gets current camera view extent.

Source: scene/Planet.ts, line 2117

Returns:

Type:: Extent

isActive() → {Boolean}

Gets render node activity.

Overrides: RenderNode#isActive
Source: scene/RenderNode.ts, line 221

Returns:

Type:: Boolean

memClear()

Starts clear memory thread.

Source: scene/Planet.ts, line 1912

preDrawNode()

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

Overrides: RenderNode#preDrawNode
Source: scene/RenderNode.ts, line 213

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: RenderNode#removeEntityCollection
Source: scene/RenderNode.ts, line 164

removeLayer(layer)

Removes the given layer from the planet.

Parameters:

Name	Type	Description
`layer`	Layer	Layer to remove.

Source: scene/Planet.ts, line 755

removeLight(light)

Removes light source.

Parameters:

Name	Type	Description
`light`	LightSource	Light source object.

Overrides: RenderNode#removeLight
Source: scene/RenderNode.ts, line 195

setActive(isActive)

Rendering activation.

Parameters:

Name	Type	Description
`isActive`	boolean	Activation flag.

Overrides: RenderNode#setActive
Source: scene/RenderNode.ts, line 230

setBaseLayer(layer)

Sets base layer coverage to the planet.

Parameters:

Name	Type	Description
`layer`	Layer	Layer object.

Source: scene/Planet.ts, line 773

setDrawMode(mode)

Sets draw mode

Parameters:

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

Overrides: RenderNode#setDrawMode
Source: scene/RenderNode.ts, line 257

setHeightFactor(factor)

Sets elevation scale. 1.0 is default.

Parameters:

Name	Type	Description
`factor`	number	Elevation scale.

Source: scene/Planet.ts, line 793

setTerrain(terrain)

Sets terrain provider

Parameters:

Name	Type	Description
`terrain`	EmptyTerrain	Terrain provider.

Source: scene/Planet.ts, line 817

stopFlying()

Stop current flight.

Source: scene/Planet.ts, line 2204

transformLights()

IMPORTANT: This function have to be called manually in each render node frame callback, before drawing scene geometry.

Overrides: RenderNode#transformLights
Source: scene/RenderNode.ts, line 269

updateAttributionsList()

Updates attribution lists

Source: scene/Planet.ts, line 1137

viewExtent(extent)

Sets camera to the planet geographical extent.

Parameters:

Name	Type	Description
`extent`	Extent	Geographical extent.

Source: scene/Planet.ts, line 2094

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 2107

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 2126