Class: BaseGeoImage

og.layer.BaseGeoImage

new og.layer.BaseGeoImage()

BaseGeoImage layer represents square imagery layer that could be an static image, or animated video or webgl buffer object displayed on the globe.

Extends

Members

protected_attributionstring

Layer attribution.

protected_extentog.Extent

Visible degrees extent.

protected_extentMercog.Extent

Visible mercator extent.

protected_heightnumber

Height over the ground.

protected_idnumber

Unic identifier.

protected_isBaseLayerboolean

Base layer type flag.

protected_pickingColorog.math.Vector3

Layer picking color. Assign when added to the planet.

protected_planetog.scene.Planet

Planet node.

protected_visibilityboolean

Layer visibility.

protected_zIndexnumber

Layer z-index.

ambientObject

Layer light material parameters.

eventsog.Events

Events handler.

maxZoomnumber

Maximal zoom level when layer is visibile.

minZoomnumber

Minimal zoom level when layer is visibile.

namestring

Layer user name.

opacitynumber

Layer global opacity.

transparentColorArray.<number, number, number>

Transparent RGB color mask.

Methods

inherited abstract,protected_assignPlanet(planet-)

Assign the planet.
Name Type Description
planet- og.scene.Planet Planet render node.

inherited abstract,protected_bindPicking()

Assign picking color to the layer.

inherited protected_correctFullExtent()

Special correction of the whole globe extent.

protected_createFrame()

Creates geoImage frame.

abstractabortMaterialLoading(material)

Name Type Description
material og.planetSegment.Material GeoImage material.
Adds layer to the planet.
Name Type Description
planet og.scene.Planet

abstract,protectedapplyMaterial(material)

Name Type Description
material og.planetSegment.Material GeoImage material.
Clear layer material.

abstract,protectedclearMaterial(material)

Name Type Description
material og.planetSegment.Material GeoImage material.

getCorners(){Array.<Array.<number, number, number>>}

Gets corners coordinates.
Returns:
Type Description
Array.<Array.<number, number, number>>
Gets corners coordinates.
Returns:
Type Description
Array.<og.LonLat, og.LonLat, og.LonLat, og.LonLat>
Gets layer extent.
Returns:
Type Description
og.Extent
Gets frame height size in pixels.
Gets frame width size in pixels.

inherited getHeight(){number}

Gets layer height.
Returns:
Type Description
number
Gets layer identifier.
Returns:
Type Description
string

inherited getVisibility(){boolean}

Gets layer visibility.
Returns:
Type Description
boolean

inherited getZIndex(){number}

Gets z-index.
Returns:
Type Description
number

inherited abstracthasImageryTiles(){boolean}

Returns true if a layer has imagery tiles.
Returns:
Type Description
boolean

inherited isBaseLayer(){boolean}

Returns true if the layer is a base.
Returns:
Type Description
boolean

inherited isEqual(layer){boolean}

Compares layers instances.
Name Type Description
layer og.layer.Layer
Returns:
Type Description
boolean - Returns true if the layers is the same instance of the input.
Removes from planet.

inherited setAttribution(html)

Sets layer attribution text.
Name Type Description
html string HTML code that represents layer attribution, it could be just a text.

inherited setBaseLayer(flag)

Sets base layer type true.
Name Type Description
flag boolean Base layer flag.

setCorners(corners)

Sets geoImage geographical corners coordinates.
Name Type Description
corners Array.<Array.<number, number, number>> 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.

setCornersLonLat(corners)

Sets geoImage geographical corners coordinates.
Name Type Description
corners Array.<og.LonLat, og.LonLat, og.LonLat, og.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.

inherited setExtent(extent)

Sets visible geographical extent.
Name Type Description
extent og.Extent Layer visible geographical extent.

inherited setHeight(height)

Sets height over the ground.
Name Type Description
height number Layer height.

abstractsetVisibility(visibility)

Sets layer visibility.
Name Type Description
visibility boolean GeoImage visibility.

inherited setZIndex(zIndex)

Sets z-index.
Name Type Description
zIndex number Layer z-index.

Events

Triggered when layer has added to the planet.
Triggered layer has double touched.
Mouse left button clicked.
Mouse left button double click.
Mouse left button is just pressed down(start pressing).
Mouse left button is pressing.
Mouse left button up(stop pressing).
Mouse right button clicked.
Mouse middle button double click.
Mouse middle button is just pressed down(start pressing).
Mouse middle button is pressing.
Triggered when mouse has entered over the layer.
Triggered when mouse moves over the layer.
Mouse wheel is rotated.
Mouse middle button up(stop pressing).
Mouse right button clicked.
Mouse right button double click.
Mouse right button is just pressed down(start pressing).
Triggered when layer has removed from the planet.
Mouse right button is pressing.
Mouse right button up(stop pressing).
Triggered when layer has finished touching.
Triggered when touch enters over the layer.
Triggered when touching leaves layer borders.
Triggered when touching moves over the layer.
Triggered when layer begins to touch.
Triggered when layer visibilty chanched.