Class: BaseGeoImage

Constructor

new BaseGeoImage()

Source: layer/BaseGeoImage.ts, line 32

Extends

Layer

Members

_id

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

(protected) _pickingColor :Vec3

Layer picking color. Assign when added to the planet.

Type:

Vec3

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

getFrameHeight

Gets frame height size in pixels.

Source: layer/BaseGeoImage.ts, line 425

getFrameWidth

Gets frame width size in pixels.

Source: layer/BaseGeoImage.ts, line 416

planet

Returns planet instance.

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

rendering

rendering function pointer

Source: layer/BaseGeoImage.ts, line 123

Methods

(abstract, protected) _assignPlanet(planet)

Assign the planet.

Parameters:

Name	Type	Description
`planet`	Planet	Planet render node.

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

(abstract, protected) _bindPicking()

Assign picking color to the layer.

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

(protected) _correctFullExtent()

Special correction of the whole globe extent.

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

(protected) _createFrame()

Creates geoImage frame.

Source: layer/BaseGeoImage.ts, line 240

(protected) _createSourceTexture()

Method depends on GeoImage instance

Source: layer/BaseGeoImage.ts, line 434

abortMaterialLoading(material)

Parameters:

Name	Type	Description
`material`	Material	GeoImage material.

Source: layer/BaseGeoImage.ts, line 306

addTo(planet)

Adds layer to the planet.

Parameters:

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

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

applyMaterial() → {Array.<number>}

Source: layer/BaseGeoImage.ts, line 382

Returns:

Type:: Array.<number>

bringToFront()

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

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

clear()

Clear layer material.

Overrides: Layer#clear
Source: layer/BaseGeoImage.ts, line 317

clearMaterial(material)

Parameters:

Name	Type	Description
`material`	Material	GeoImage material.

Source: layer/BaseGeoImage.ts, line 372

flyExtent()

Fly extent.

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

getAttribution() → {string}

Gets layer attribution.

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

Returns:

Layer attribution

Type:: string

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

Gets corners coordinates.

Source: layer/BaseGeoImage.ts, line 174

Returns:

(exactly 3 entries)

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

getCornersLonLat() → {Array.<LonLat>}

Gets corners coordinates.

Source: layer/BaseGeoImage.ts, line 159

Returns:

(exactly 4 entries)

Type:: Array.<LonLat>

getExtent() → {Extent}

Gets layer extent.

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

Returns:

Layer geodetic extent.

Type:: Extent

getExtentMerc() → {Extent}

Gets layer web-mercator extent.

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

Returns:

Layer extent.

Type:: Extent

getHeight() → {number}

Gets layer height.

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

Returns:

Type:: number

getID() → {string}

Gets layer identifier.

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

Returns:

Layer object id.

Type:: string

getVisibility() → {boolean}

Gets layer visibility.

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

Returns:

Layer visibility.

Type:: boolean

getZIndex() → {number}

Gets z-index.

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

Returns:

Type:: number

(abstract) hasImageryTiles() → {boolean}

Returns true if a layer has imagery tiles.

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

Returns:

Imagery tiles flag.

Type:: boolean

isBaseLayer() → {boolean}

Returns true if the layer is a base.

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

Returns:

Base layer flag.

Type:: boolean

isEqual(layer) → {boolean}

Compares layers instances.

Parameters:

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

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

Returns:

Returns true if the layers is the same instance of the input.

Type:: boolean

remove() → {Layer}

Removes from planet.

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

Returns:

-This layer.

Type:: Layer

setAttribution(html)

Sets layer attribution text.

Parameters:

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

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

setBaseLayer(isBaseLayer)

Sets base layer type true.

Parameters:

Name	Type	Description
`isBaseLayer`	boolean

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

setCorners(corners)

Sets geoImage geographical corners coordinates.

Parameters:

Name	Type	Description
`corners`	Array.<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.

Source: layer/BaseGeoImage.ts, line 189

setCornersLonLat(corners)

Sets geoImage geographical corners coordinates.

Parameters:

Name	Type	Description
`corners`	Array.<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)

Source: layer/BaseGeoImage.ts, line 200

setExtent(extent)

Sets visible geographical extent.

Parameters:

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

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

setHeight(height)

Sets height over the ground.

Parameters:

Name	Type	Description
`height`	number	Layer height.

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

setVisibility(visibility)

Sets layer visibility.

Parameters:

Name	Type	Description
`visibility`	boolean	GeoImage visibility.

Overrides: Layer#setVisibility
Source: layer/BaseGeoImage.ts, line 351

setZIndex(zIndex)

Sets z-index.

Parameters:

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

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

viewExtent()

View extent.

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