Class: GeoImage

Constructor

new GeoImage()

Source: layer/GeoImage.ts, line 12

Extends

BaseGeoImage

Members

_id

Overrides: BaseGeoImage#_id
Source: layer/Layer.ts, line 447

(protected) _pickingColor :Vec3

Layer picking color. Assign when added to the planet.

Type:

Vec3

Overrides: BaseGeoImage#_pickingColor
Source: layer/Layer.ts, line 299

getFrameHeight

Gets frame height size in pixels.

Overrides: BaseGeoImage#getFrameHeight
Source: layer/BaseGeoImage.ts, line 416

getFrameWidth

Gets frame width size in pixels.

Overrides: BaseGeoImage#getFrameWidth
Source: layer/BaseGeoImage.ts, line 407

planet

Returns planet instance.

Overrides: BaseGeoImage#planet
Source: layer/Layer.ts, line 562

rendering

rendering function pointer

Overrides: BaseGeoImage#rendering
Source: layer/BaseGeoImage.ts, line 120

Methods

(abstract, protected) _assignPlanet(planet)

Assign the planet.

Parameters:

Name	Type	Description
`planet`	Planet	Planet render node.

Overrides: BaseGeoImage#_assignPlanet
Source: layer/Layer.ts, line 464

(abstract, protected) _bindPicking()

Assign picking color to the layer.

Overrides: BaseGeoImage#_bindPicking
Source: layer/Layer.ts, line 505

(protected) _correctFullExtent()

Special correction of the whole globe extent.

Overrides: BaseGeoImage#_correctFullExtent
Source: layer/Layer.ts, line 809

(protected) _createFrame()

Creates geoImage frame.

Overrides: BaseGeoImage#_createFrame
Source: layer/BaseGeoImage.ts, line 231

(abstract, protected) _createSourceTexture()

Creates source gl texture.

Overrides: BaseGeoImage#_createSourceTexture
Source: layer/GeoImage.ts, line 88

abortMaterialLoading(material)

Parameters:

Name	Type	Description
`material`	Material	GeoImage material.

Overrides: BaseGeoImage#abortMaterialLoading
Source: layer/GeoImage.ts, line 149

addTo(planet)

Adds layer to the planet.

Parameters:

Name	Type	Description
`planet`	Planet	Adds layer to the planet.

Overrides: BaseGeoImage#addTo
Source: layer/Layer.ts, line 514

applyMaterial() → {NumberArray4}

Inherited From: BaseGeoImage#applyMaterial
Source: layer/BaseGeoImage.ts, line 373

Returns:

Type:: NumberArray4

bringToFront()

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

Overrides: BaseGeoImage#bringToFront
Source: layer/Layer.ts, line 628

clearMaterial(material)

Parameters:

Name	Type	Description
`material`	Material	GeoImage material.

Overrides: BaseGeoImage#clearMaterial
Source: layer/BaseGeoImage.ts, line 363

flyExtent()

Fly extent.

Overrides: BaseGeoImage#flyExtent
Source: layer/Layer.ts, line 793

getAttribution() → {string}

Gets layer attribution.

Overrides: BaseGeoImage#getAttribution
Source: layer/Layer.ts, line 581

Returns:

Layer attribution.

Type:: string

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

Gets corners coordinates.

Overrides: BaseGeoImage#getCorners
Source: layer/BaseGeoImage.ts, line 171

Returns:

(exactly 4 entries)

Type:: Array.<Array.<number>>

getCornersLonLat() → {Array.<LonLat>}

Gets corners coordinates.

Overrides: BaseGeoImage#getCornersLonLat
Source: layer/BaseGeoImage.ts, line 156

Returns:

(exactly 4 entries)

Type:: Array.<LonLat>

getExtent() → {Extent}

Gets layer extent.

Overrides: BaseGeoImage#getExtent
Source: layer/Layer.ts, line 775

Returns:

Layer geodetic extent.

Type:: Extent

getExtentMerc() → {Extent}

Gets layer web-mercator extent.

Overrides: BaseGeoImage#getExtentMerc
Source: layer/Layer.ts, line 784

Returns:

Layer extent.

Type:: Extent

getHeight() → {number}

Gets layer height.

Overrides: BaseGeoImage#getHeight
Source: layer/Layer.ts, line 600

Returns:

Type:: number

getID() → {number}

Gets layer identifier.

Overrides: BaseGeoImage#getID
Source: layer/Layer.ts, line 434

Returns:

Layer object id.

Type:: number

getVisibility() → {boolean}

Gets layer visibility.

Overrides: BaseGeoImage#getVisibility
Source: layer/Layer.ts, line 743

Returns:

Layer visibility.

Type:: boolean

getZIndex() → {number}

Gets z-index.

Overrides: BaseGeoImage#getZIndex
Source: layer/Layer.ts, line 619

Returns:

Type:: number

(abstract) hasImageryTiles() → {boolean}

Returns true if a layer has imagery tiles.

Overrides: BaseGeoImage#hasImageryTiles
Source: layer/Layer.ts, line 424

Returns:

Imagery tiles flag.

Type:: boolean

isBaseLayer() → {boolean}

Returns true if the layer is a base.

Overrides: BaseGeoImage#isBaseLayer
Source: layer/Layer.ts, line 642

Returns:

Base layer flag.

Type:: boolean

isEqual(layer) → {boolean}

Compares layers instances.

Parameters:

Name	Type	Description
`layer`	Layer	Layer instance to compare.

Overrides: BaseGeoImage#isEqual
Source: layer/Layer.ts, line 454

Returns:

Returns true if the layer is the same instance as the input.

Type:: boolean

loadMaterial(material)

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

Parameters:

Name	Type	Description
`material`	Material	GeoImage planet material.

Source: layer/GeoImage.ts, line 119

remove() → {Layer}

Removes from planet.

Overrides: BaseGeoImage#remove
Source: layer/Layer.ts, line 525

Returns:

This layer.

Type:: Layer

setAttribution(html)

Sets layer attribution text.

Parameters:

Name	Type	Description
`html`	string	HTML string that represents layer attribution.

Overrides: BaseGeoImage#setAttribution
Source: layer/Layer.ts, line 569

setBaseLayer(isBaseLayer)

Sets base layer type true.

Parameters:

Name	Type	Description
`isBaseLayer`	boolean

Overrides: BaseGeoImage#setBaseLayer
Source: layer/Layer.ts, line 651

setCorners(corners)

Sets geoImage geographical corners coordinates.

Parameters:

Name	Type	Description
`corners`	Array.<Array.<number>>	GeoImage corner coordinates. Each coordinate has exactly 2 entries. First corner is top-left, second is top-right, third is bottom-right, and fourth is bottom-left.

Overrides: BaseGeoImage#setCorners
Source: layer/BaseGeoImage.ts, line 186

setCornersLonLat(corners)

Sets geoImage geographical corners coordinates.

Parameters:

Name	Type	Description
`corners`	Array.<LonLat>	GeoImage corner coordinates. First corner is top-left, second is top-right, third is bottom-right, and fourth is bottom-left. (exactly 4 entries)

Overrides: BaseGeoImage#setCornersLonLat
Source: layer/BaseGeoImage.ts, line 196

setExtent(extent)

Sets visible geographical extent.

Parameters:

Name	Type	Description
`extent`	Extent	Layer visible geographical extent.

Overrides: BaseGeoImage#setExtent
Source: layer/Layer.ts, line 752

setHeight(height)

Sets height over the ground.

Parameters:

Name	Type	Description
`height`	number	Layer height.

Overrides: BaseGeoImage#setHeight
Source: layer/Layer.ts, line 590

setImage(image)

Sets image object.

Parameters:

Name	Type	Description
`image`	Image	Image object.

Source: layer/GeoImage.ts, line 68

setSrc(src)

Sets image source url path.

Parameters:

Name	Type	Description
`src`	string	Image url path.

Source: layer/GeoImage.ts, line 51

setZIndex(zIndex)

Sets z-index.

Parameters:

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

Overrides: BaseGeoImage#setZIndex
Source: layer/Layer.ts, line 609

viewExtent()

View extent.

Overrides: BaseGeoImage#viewExtent
Source: layer/Layer.ts, line 801