GeoImage

Extends: BaseGeoImage

Source: GeoImage.ts:17

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

Constructor

Instance Methods

setSrc(src: string)

Sets image source url path.

Parameters

• src (string) — Image url path.

setImage(image: Image)

Sets image object.

Parameters

• image (Image) — Image object.

_createSourceTexture()

Overrides: BaseGeoImage#_createSourceTexture

Creates source gl texture.

loadMaterial(material: Material)

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

Parameters

• material (Material) — GeoImage planet material.

abortMaterialLoading(material: Material)

Overrides: BaseGeoImage#abortMaterialLoading

Parameters

• material (Material) — GeoImage material.

getCornersLonLat(): Array.<LonLat>

Inherited from BaseGeoImage#getCornersLonLat

Overrides: BaseGeoImage#getCornersLonLat

Gets corners coordinates.

Returns

• Array.<LonLat>

getCorners(): Array.<Array.<number>>

Inherited from BaseGeoImage#getCorners

Overrides: BaseGeoImage#getCorners

Gets corners coordinates.

Returns

• Array.<Array.<number>>

setCorners(corners: Array.<Array.<number>>)

Inherited from BaseGeoImage#setCorners

Overrides: BaseGeoImage#setCorners

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>)

Inherited from BaseGeoImage#setCornersLonLat

Overrides: BaseGeoImage#setCornersLonLat

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()

Inherited from BaseGeoImage#_createFrame

Overrides: BaseGeoImage#_createFrame

Creates geoImage frame.

clear()

Inherited from BaseGeoImage#clear

Clear layer material.

setVisibility(visibility: boolean)

Inherited from BaseGeoImage#setVisibility

Sets layer visibility.

Parameters

• visibility (boolean) — GeoImage visibility.

clearMaterial(material: Material)

Inherited from BaseGeoImage#clearMaterial

Overrides: BaseGeoImage#clearMaterial

Parameters

• material (Material) — GeoImage material.

applyMaterial(): NumberArray4

Inherited from BaseGeoImage#applyMaterial

Returns

• NumberArray4

hasImageryTiles(): boolean

Inherited from Layer#hasImageryTiles

Overrides: BaseGeoImage#hasImageryTiles

Returns true if a layer has imagery tiles.

Returns

• boolean — Imagery tiles flag.

getID(): number

Inherited from Layer#getID

Overrides: BaseGeoImage#getID

Gets layer identifier.

Returns

• number — Layer object id.

isEqual(layer: Layer): boolean

Inherited from Layer#isEqual

Overrides: BaseGeoImage#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: BaseGeoImage#_assignPlanet

Assign the planet.

Parameters

• planet (Planet) — Planet render node.

_bindPicking()

Inherited from Layer#_bindPicking

Overrides: BaseGeoImage#_bindPicking

Assign picking color to the layer.

addTo(planet: Planet)

Inherited from Layer#addTo

Overrides: BaseGeoImage#addTo

Adds layer to the planet.

Parameters

• planet (Planet) — Adds layer to the planet.

remove(): Layer

Inherited from Layer#remove

Overrides: BaseGeoImage#remove

Removes from a planet.

Returns

• Layer — This layer.

setAttribution(html: string)

Inherited from Layer#setAttribution

Overrides: BaseGeoImage#setAttribution

Sets layer attribution text.

Parameters

• html (string) — HTML string that represents layer attribution.

getAttribution(): string

Inherited from Layer#getAttribution

Overrides: BaseGeoImage#getAttribution

Gets layer attribution.

Returns

• string — Layer attribution.

setHeight(height: number)

Inherited from Layer#setHeight

Overrides: BaseGeoImage#setHeight

Sets height over the ground.

Parameters

• height (number) — Layer height.

getHeight(): number

Inherited from Layer#getHeight

Overrides: BaseGeoImage#getHeight

Gets layer height.

Returns

• number

setZIndex(zIndex: number)

Inherited from Layer#setZIndex

Overrides: BaseGeoImage#setZIndex

Sets z-index.

Parameters

• zIndex (number) — Layer z-index.

getZIndex(): number

Inherited from Layer#getZIndex

Overrides: BaseGeoImage#getZIndex

Gets z-index.

Returns

• number

bringToFront()

Inherited from Layer#bringToFront

Overrides: BaseGeoImage#bringToFront

Sets z-index to the maximum value relative to other layers on the planet.

isBaseLayer(): boolean

Inherited from Layer#isBaseLayer

Overrides: BaseGeoImage#isBaseLayer

Returns true if the layer is a base.

Returns

• boolean — Base layer flag.

setBaseLayer(isBaseLayer: boolean)

Inherited from Layer#setBaseLayer

Overrides: BaseGeoImage#setBaseLayer

Sets base layer type flag.

Parameters

• isBaseLayer (boolean)

getVisibility(): boolean

Inherited from Layer#getVisibility

Overrides: BaseGeoImage#getVisibility

Gets layer visibility.

Returns

• boolean — Layer visibility.

setExtent(extent: Extent)

Inherited from Layer#setExtent

Overrides: BaseGeoImage#setExtent

Sets visible geographical extent.

Parameters

• extent (Extent) — Layer visible geographical extent.

getExtent(): Extent

Inherited from Layer#getExtent

Overrides: BaseGeoImage#getExtent

Gets layer extent.

Returns

• Extent — Layer geodetic extent.

getExtentMerc(): Extent

Inherited from Layer#getExtentMerc

Overrides: BaseGeoImage#getExtentMerc

Gets layer web-mercator extent.

Returns

• Extent — Layer extent.

flyExtent()

Inherited from Layer#flyExtent

Overrides: BaseGeoImage#flyExtent

Fly extent.

viewExtent()

Inherited from Layer#viewExtent

Overrides: BaseGeoImage#viewExtent

View extent.

_correctFullExtent()

Inherited from Layer#_correctFullExtent

Overrides: BaseGeoImage#_correctFullExtent

Special correction of the whole globe extent.

clear()

Inherited from BaseGeoImage#clear

Clear layer material.

setVisibility(visibility: boolean)

Inherited from BaseGeoImage#setVisibility

Sets layer visibility.

Parameters

• visibility (boolean) — GeoImage visibility.

applyMaterial(): NumberArray4

Inherited from BaseGeoImage#applyMaterial

Returns

• NumberArray4

Instance Fields

rendering

Inherited from BaseGeoImage#rendering

Overrides: BaseGeoImage#rendering

rendering function pointer

getFrameWidth

Inherited from BaseGeoImage#getFrameWidth

Overrides: BaseGeoImage#getFrameWidth

Gets frame width size in pixels.

Returns

• number — Frame width.

getFrameHeight

Inherited from BaseGeoImage#getFrameHeight

Overrides: BaseGeoImage#getFrameHeight

Gets frame height size in pixels.

Returns

• number — Frame height.

_pickingColor: Vec3

Inherited from Layer#_pickingColor

Overrides: BaseGeoImage#_pickingColor

Layer picking color. Assign when added to the planet.

nightTextureCoefficient: number

Inherited from Layer#nightTextureCoefficient

Overrides: BaseGeoImage#nightTextureCoefficient

Night texture blending coefficient.

_id

Inherited from Layer#_id

Overrides: BaseGeoImage#_id

planet

Inherited from Layer#planet

Overrides: BaseGeoImage#planet

Returns planet instance.