Class: Globe

Constructor

new Globe(options)

Parameters:

Name Type Description

options

IGlobeParams

Options:

Properties

Name	Type	Attributes	Default	Description
`target`	string \| HTMLElement			HTML element id where planet canvas have to be created.
`name`	string	<optional>		Planet name. Default is uniq identifier.
`terrain`	EmptyTerrain	<optional>		Terrain provider. Default no terrain - og.terrain.EmptyTerrain.
`controls`	Array.<Control>	<optional>		Controls.
`layers`	Array.<Layer>	<optional>		Planet layers.
`viewExtent`	Extent \| ExtentBoundingBox	<optional>		[options.viewExtent] - Viewable starting extent.
`autoActivate`	boolean	<optional>	true	Globe rendering auto activation flag. True is default.
`attributionContainer`	HTMLElement	<optional>		Container for attribution list.
`maxGridSize`	number	<optional>	128	= Maximal segment grid size. 128 is default
`fontsSrc`	string	<optional>		Fonts collection url.
`resourcesSrc`	string	<optional>		Resources root src.
`nightTextureSrc`	string	<optional>		Night glowing image sources
`specularTextureSrc`	string	<optional>		Specular water mask image sourcr
`maxAltitude`	number	<optional>	15000000.0	Maximal camera altitude above terrain
`minAltitude`	number	<optional>	1.0	Minimal camera altitude above terrain
`maxEqualZoomAltitude`	number	<optional>	15000000.0	Maximal altitude since segments on the screen became the same zoom level
`minEqualZoomAltitude`	number	<optional>	10000.0	Minimal altitude since segments on the screen became the same zoom level
`minEqualZoomCameraSlope`	number	<optional>	0.8	Minimal camera slope above te globe where segments on the screen became the same zoom level
`loadingBatchSize`	number	<optional>	12
`quadTreeStrategyPrototype`	number	<optional>		Prototype of quadTree. QuadTreeStrategy for Earth is default.
`msaa`	number	<optional>	0	MSAA antialiasing parameter: 2,4,8,16. Default is 0.
`dpi`	number	<optional>		Device pixel ratio. Default is current screen DPI.
`atmosphereEnabled`	boolean	<optional>		Enables atmosphere effect.
`transtitionOpacityEnabled`	boolean	<optional>		Enables terrain smooth opacity transition effect.
`atmosphereParameters`	IAtmosphereParams	<optional>		Atmosphere model parameters.
`gamma`	number	<optional>		Gamma
`exposure`	number	<optional>		Exposure

Source: Globe.ts, line 76

Example

Basic initialization

globus = new Globe({
    atmosphere: false,
    target: 'globus',
    name: 'Earth',
    controls: [
         new control.MouseNavigation(),
         new control.KeyboardNavigation(),
         new control.EarthCoordinates(),
         new control.LayerSwitcher({),
         new control.ZoomControl(),
         new control.TouchNavigation(),
         new control.Sun()
     ],
    terrain: new GlobusRGBTerrain(),
    layers: [new OpenStreetMap(), new Bing()],
    atmosphereEnabled: true
});

Members

$inner :Element

Dom element where WebGL canvas creates

Type:

Element

Source: Globe.ts, line 177

Methods

fadeIn()

Starts screen brightness fading in effect by the duration time.

Source: Globe.ts, line 339

fadeOut()

Starts screen brightness fading out effect by the duration time.

Source: Globe.ts, line 347