GeoImage#

Used to load and display a single image over specific corner coordinates on the globe.

Constructor#

new GeoImage()#

Extends#

Members#

_id#

(protected) _pickingColor :Vec3#

Layer picking color. Assign when added to the planet.

Type:

getFrameHeight#

Gets frame height size in pixels.

getFrameWidth#

Gets frame width size in pixels.

planet#

Returns planet instance.

rendering#

rendering function pointer

Methods#

(abstract, protected) _assignPlanet(planet)#

Assign the planet.

Parameters:
NameTypeDescription
planetPlanet

Planet render node.

(abstract, protected) _bindPicking()#

Assign picking color to the layer.

(protected) _correctFullExtent()#

Special correction of the whole globe extent.

(protected) _createFrame()#

Creates geoImage frame.

(abstract, protected) _createSourceTexture()#

Creates source gl texture.

abortMaterialLoading(material)#

Parameters:
NameTypeDescription
materialMaterial

GeoImage material.

addTo(planet)#

Adds layer to the planet.

Parameters:
NameTypeDescription
planetPlanet

Adds layer to the planet.

applyMaterial() → {Array.<number>}#

Returns:
Type: 
Array.<number>

bringToFront()#

Set zIndex to the maximal value depend on other layers on the planet.

clearMaterial(material)#

Parameters:
NameTypeDescription
materialMaterial

GeoImage material.

flyExtent()#

Fly extent.

getAttribution() → {string}#

Gets layer attribution.

Returns:

Layer attribution

Type: 
string

getCorners() → {Array.<Array.<number>>}#

Gets corners coordinates.

Returns:
  • (exactly 3 entries)
Type: 
Array.<Array.<number>>

getCornersLonLat() → {Array.<LonLat>}#

Gets corners coordinates.

Returns:
  • (exactly 4 entries)
Type: 
Array.<LonLat>

getExtent() → {Extent}#

Gets layer extent.

Returns:
  • Layer geodetic extent.
Type: 
Extent

getExtentMerc() → {Extent}#

Gets layer web-mercator extent.

Returns:
  • Layer extent.
Type: 
Extent

getHeight() → {number}#

Gets layer height.

Returns:
Type: 
number

getID() → {string}#

Gets layer identifier.

Returns:
  • Layer object id.
Type: 
string

getVisibility() → {boolean}#

Gets layer visibility.

Returns:
  • Layer visibility.
Type: 
boolean

getZIndex() → {number}#

Gets z-index.

Returns:
Type: 
number

(abstract) hasImageryTiles() → {boolean}#

Returns true if a layer has imagery tiles.

Returns:
  • Imagery tiles flag.
Type: 
boolean

isBaseLayer() → {boolean}#

Returns true if the layer is a base.

Returns:
  • Base layer flag.
Type: 
boolean

isEqual(layer) → {boolean}#

Compares layers instances.

Parameters:
NameTypeDescription
layerLayer

Layer instance to compare.

Returns:
  • Returns true if the layers is the same instance of the input.
Type: 
boolean

loadMaterial(material)#

Loads planet segment material. In this case - GeoImage source image.

Parameters:
NameTypeDescription
materialMaterial

GeoImage planet material.

remove() → {Layer}#

Removes from planet.

Returns:

-This layer.

Type: 
Layer

setAttribution(html)#

Sets layer attribution text.

Parameters:
NameTypeDescription
htmlstring

HTML code that represents layer attribution, it could be just a text.

setBaseLayer(isBaseLayer)#

Sets base layer type true.

Parameters:
NameTypeDescription
isBaseLayerboolean

setCorners(corners)#

Sets geoImage geographical corners coordinates.

Parameters:
NameTypeDescription
cornersArray.<Array.<number>>

GeoImage corners coordinates. Where first coordinate (exactly 3 entries) coincedents to the left top image corner, secont to the right top image corner, third to the right bottom and fourth - left bottom image corner.

setCornersLonLat(corners)#

Sets geoImage geographical corners coordinates.

Parameters:
NameTypeDescription
cornersArray.<LonLat>

GeoImage corners coordinates. Where first coordinate coincedents to the left top image corner, secont to the right top image corner, third to the right bottom and fourth - left bottom image corner. (exactly 4 entries)

setExtent(extent)#

Sets visible geographical extent.

Parameters:
NameTypeDescription
extentExtent

Layer visible geographical extent.

setHeight(height)#

Sets height over the ground.

Parameters:
NameTypeDescription
heightnumber

Layer height.

setImage(image)#

Sets image object.

Parameters:
NameTypeDescription
imageImage

Image object.

setSrc(srs)#

Sets image source url path.

Parameters:
NameTypeDescription
srsstring

Image url path.

setZIndex(zIndex)#

Sets z-index.

Parameters:
NameTypeDescription
zIndexnumber

Layer z-index.

viewExtent()#

View extent.