BaseGeoImage
Extends: Layer
Source: BaseGeoImage.ts:43
BaseGeoImage represents a square imagery layer displayed on the globe. It can use a static image, animated video, or WebGL buffer as a source.
Constructor
new BaseGeoImage(name, options): BaseGeoImageInstance Methods
getCornersLonLat(): Array.<LonLat>
Gets corners coordinates.
Returns
Array.<LonLat>
getCorners(): Array.<Array.<number>>
Gets corners coordinates.
Returns
Array.<Array.<number>>
setCorners(corners: Array.<Array.<number>>)
Sets geoImage geographical corners coordinates.
Parameters
corners(Array.<Array.<number>>) — GeoImage corner coordinates. Each coordinate has exactly 2 entries. The first corner is top-left, the second is top-right, the third is bottom-right, and the fourth is bottom-left.
setCornersLonLat(corners: Array.<LonLat>)
Sets geoImage geographical corners coordinates.
Parameters
corners(Array.<LonLat>) — GeoImage corner coordinates. The first corner is top-left, the second is top-right, the third is bottom-right, and the fourth is bottom-left. (exactly 4 entries)
_createFrame()
Creates geoImage frame.
abortMaterialLoading(material: Material)
Parameters
material(Material) — GeoImage material.
clear()
Clear layer material.
setVisibility(visibility: boolean)
Sets layer visibility.
Parameters
visibility(boolean) — GeoImage visibility.
clearMaterial(material: Material)
Parameters
material(Material) — GeoImage material.
applyMaterial(): NumberArray4
Returns
NumberArray4
_createSourceTexture()
Method depends on GeoImage instance
hasImageryTiles(): boolean
Inherited from Layer#hasImageryTiles
Overrides: Layer#hasImageryTiles
Returns true if a layer has imagery tiles.
Returns
boolean— Imagery tiles flag.
getID(): number
Inherited from Layer#getID
Overrides: Layer#getID
Gets layer identifier.
Returns
number— Layer object id.
isEqual(layer: Layer): boolean
Inherited from Layer#isEqual
Overrides: Layer#isEqual
Compares layers instances.
Parameters
layer(Layer) — Layer instance to compare.
Returns
boolean— Returns true if the layer is the same instance as the input.
_assignPlanet(planet: Planet)
Inherited from Layer#_assignPlanet
Overrides: Layer#_assignPlanet
Assign the planet.
Parameters
planet(Planet) — Planet render node.
_bindPicking()
Inherited from Layer#_bindPicking
Overrides: Layer#_bindPicking
Assign picking color to the layer.
addTo(planet: Planet)
Inherited from Layer#addTo
Overrides: Layer#addTo
Adds layer to the planet.
Parameters
planet(Planet) — Adds layer to the planet.
remove(): Layer
Inherited from Layer#remove
Overrides: Layer#remove
Removes from a planet.
Returns
Layer— This layer.
clear()
Inherited from BaseGeoImage#clear
Overrides: Layer#clear
Clear layer material.
setAttribution(html: string)
Inherited from Layer#setAttribution
Overrides: Layer#setAttribution
Sets layer attribution text.
Parameters
html(string) — HTML string that represents layer attribution.
getAttribution(): string
Inherited from Layer#getAttribution
Overrides: Layer#getAttribution
Gets layer attribution.
Returns
string— Layer attribution.
setHeight(height: number)
Inherited from Layer#setHeight
Overrides: Layer#setHeight
Sets height over the ground.
Parameters
height(number) — Layer height.
getHeight(): number
Inherited from Layer#getHeight
Overrides: Layer#getHeight
Gets layer height.
Returns
number
setZIndex(zIndex: number)
Inherited from Layer#setZIndex
Overrides: Layer#setZIndex
Sets z-index.
Parameters
zIndex(number) — Layer z-index.
getZIndex(): number
Inherited from Layer#getZIndex
Overrides: Layer#getZIndex
Gets z-index.
Returns
number
bringToFront()
Inherited from Layer#bringToFront
Overrides: Layer#bringToFront
Sets z-index to the maximum value relative to other layers on the planet.
isBaseLayer(): boolean
Inherited from Layer#isBaseLayer
Overrides: Layer#isBaseLayer
Returns true if the layer is a base.
Returns
boolean— Base layer flag.
setBaseLayer(isBaseLayer: boolean)
Inherited from Layer#setBaseLayer
Overrides: Layer#setBaseLayer
Sets base layer type flag.
Parameters
isBaseLayer(boolean)
setVisibility(visibility: boolean)
Inherited from BaseGeoImage#setVisibility
Overrides: Layer#setVisibility
Sets layer visibility.
Parameters
visibility(boolean) — GeoImage visibility.
getVisibility(): boolean
Inherited from Layer#getVisibility
Overrides: Layer#getVisibility
Gets layer visibility.
Returns
boolean— Layer visibility.
setExtent(extent: Extent)
Inherited from Layer#setExtent
Overrides: Layer#setExtent
Sets visible geographical extent.
Parameters
extent(Extent) — Layer visible geographical extent.
getExtent(): Extent
Inherited from Layer#getExtent
Overrides: Layer#getExtent
Gets layer extent.
Returns
Extent— Layer geodetic extent.
getExtentMerc(): Extent
Inherited from Layer#getExtentMerc
Overrides: Layer#getExtentMerc
Gets layer web-mercator extent.
Returns
Extent— Layer extent.
flyExtent()
Inherited from Layer#flyExtent
Overrides: Layer#flyExtent
Fly extent.
viewExtent()
Inherited from Layer#viewExtent
Overrides: Layer#viewExtent
View extent.
_correctFullExtent()
Inherited from Layer#_correctFullExtent
Overrides: Layer#_correctFullExtent
Special correction of the whole globe extent.
clear()
Inherited from BaseGeoImage#clear
Overrides: Layer#clear
Clear layer material.
setVisibility(visibility: boolean)
Inherited from BaseGeoImage#setVisibility
Overrides: Layer#setVisibility
Sets layer visibility.
Parameters
visibility(boolean) — GeoImage visibility.
Instance Fields
rendering
rendering function pointer
getFrameWidth
Gets frame width size in pixels.
Returns
number— Frame width.
getFrameHeight
Gets frame height size in pixels.
Returns
number— Frame height.
_pickingColor: Vec3
Inherited from Layer#_pickingColor
Overrides: Layer#_pickingColor
Layer picking color. Assign when added to the planet.
nightTextureCoefficient: number
Inherited from Layer#nightTextureCoefficient
Overrides: Layer#nightTextureCoefficient
Night texture blending coefficient.
_id
Inherited from Layer#_id
Overrides: Layer#_id
planet
Inherited from Layer#planet
Overrides: Layer#planet
Returns planet instance.