KML

Layer to render KML files.

Constructor

new KML(name, optionsopt)

Parameters:
NameTypeAttributesDescription
namestring

Layer name.

optionsIKMLParams<optional>

KML layer options.

Source

Extends

Members

_id

Overrides
Source

(protected) _pickingColor :Vec3

Layer picking color. Assign when added to the planet.

Type:
Overrides
Source

pickingEnabled

Sets layer picking events active.

Overrides
Source

planet

Returns planet instance.

Overrides
Source

receiveProjectors

Gets projector effect reception state for this vector layer entities.

Overrides
Source

receiveShadows

Gets shadow map reception state for this vector layer entities.

Overrides
Source

Methods

(abstract, protected) _assignPlanet(planet)

Assign the planet.

Parameters:
NameTypeDescription
planetPlanet

Planet render node.

Overrides
Source

_bindEventsDefault(entityCollection)

Parameters:
NameTypeDescription
entityCollection
Overrides
Source
To Do
  • (refactoring) could be used in something like bindEntityCollectionQuad(...)

(abstract, protected) _bindPicking()

Assign picking color to the layer.

Overrides
Source

(protected) _convertCoordonatesIntoEntities(coordinates, color, billboardopt) → {Object}

Creates billboards or polylines from array of lonlat.

Parameters:
NameTypeAttributesDescription
coordinatesArray.<Array.<Array.<Array.<number>>>>

Coordinates grouped by files and paths.

colorstring

Polyline color.

billboardIBillboardParams<optional>

Billboard options.

Source
Returns:
Type: 
Object

(protected) _correctFullExtent()

Special correction of the whole globe extent.

Overrides
Source

(protected) _getXmlContent() → {Promise.<XMLDocument>}

Source
Returns:
Type: 
Promise.<XMLDocument>

(protected) _parseKMLcoordinates() → {Array.<Array.<number>>}

Source
Returns:

Array of [longitude, latitude, altitude?].

Type: 
Array.<Array.<number>>

(protected) _reindexEntitiesArray(startIndex)

Refresh collected entities indexes from startIndex entities collection array position.

Parameters:
NameTypeDescription
startIndexnumber

Entity array index.

Overrides
Source

abortMaterialLoading(material)

Abort exact material loading.

Parameters:
NameTypeDescription
materialMaterial

Segment material.

Inherited From
Source

add(entity) → {Vector}

Adds entity to the layer.

Parameters:
NameTypeDescription
entityEntity

Entity.

Overrides
Source
Returns:
  • Returns this layer.
Type: 
Vector

addEntities(entities) → {Vector}

Adds entity array to the layer.

Parameters:
NameTypeDescription
entitiesArray.<Entity>

Entities array.

Overrides
Source
Returns:
  • Returns this layer.
Type: 
Vector

(async) addKmlFromFiles(kmls, coloropt, billboardopt) → {Promise.<{entities: Array.<Entity>, extent: Extent}>}

Parameters:
NameTypeAttributesDescription
kmlsArray.<Blob>

KML files.

colorstring<optional>

Polyline color.

billboardIBillboardParams<optional>

Billboard options.

Source
Returns:
Type: 
Promise.<{entities: Array.<Entity>, extent: Extent}>

(async) addKmlFromUrl(url, coloropt, billboardopt) → {Promise.<{entities: Array.<Entity>, extent: Extent}>}

Parameters:
NameTypeAttributesDescription
urlstring

URL of the KML to display. For example: './myFile.kml' or 'http://mySite/myFile.kml'.

colorstring<optional>

Polyline color.

billboardBillboard | IBillboardParams<optional>

Billboard options.

Source
Returns:
Type: 
Promise.<{entities: Array.<Entity>, extent: Extent}>

addTo(planet)

Adds layer to the planet.

Parameters:
NameTypeDescription
planetPlanet

Planet scene object.

Overrides
Source

bringToFront()

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

Overrides
Source

clear()

Clear the layer.

Overrides
Source

each(callback)

Safety entities loop.

Parameters:
NameTypeDescription
callbackfunction

Entity callback.

Overrides
Source

flyExtent()

Fly extent.

Overrides
Source

getAttribution() → {string}

Gets layer attribution.

Overrides
Source
Returns:

Layer attribution.

Type: 
string

getEntities() → {Array.<Entity>}

Returns stored entities.

Overrides
Source
Returns:

Stored entities.

Type: 
Array.<Entity>

getExtent() → {Extent}

Gets layer extent.

Overrides
Source
Returns:

Layer geodetic extent.

Type: 
Extent

getExtentMerc() → {Extent}

Gets layer web-mercator extent.

Overrides
Source
Returns:

Layer extent.

Type: 
Extent

getHeight() → {number}

Gets layer height.

Overrides
Source
Returns:
Type: 
number

getID() → {number}

Gets layer identifier.

Overrides
Source
Returns:

Layer object id.

Type: 
number

getVisibility() → {boolean}

Gets layer visibility.

Overrides
Source
Returns:

Layer visibility.

Type: 
boolean

getZIndex() → {number}

Gets z-index.

Overrides
Source
Returns:
Type: 
number

(abstract) hasImageryTiles() → {boolean}

Returns true if a layer has imagery tiles.

Overrides
Source
Returns:

Imagery tiles flag.

Type: 
boolean

insert(entity, index) → {Vector}

Adds entity to the layer in the index position.

Parameters:
NameTypeDescription
entityEntity

Entity.

indexNumber

Index position.

Overrides
Source
Returns:
  • Returns this layer.
Type: 
Vector

isBaseLayer() → {boolean}

Returns true if the layer is a base.

Overrides
Source
Returns:

Base layer flag.

Type: 
boolean

isEqual(layer) → {boolean}

Compares layers instances.

Parameters:
NameTypeDescription
layerLayer

Layer instance to compare.

Overrides
Source
Returns:

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

Type: 
boolean

(abstract) loadMaterial(material)

Start to load tile material.

Parameters:
NameTypeDescription
materialMaterial

Current material.

Overrides
Source

remove() → {Layer}

Removes from a planet.

Overrides
Source
Returns:

This layer.

Type: 
Layer

removeEntities(entities) → {Vector}

Removes entities from layer.

Parameters:
NameTypeDescription
entitiesArray.<Entity>

Entity array.

Overrides
Source
Returns:
  • Returns this layer.
Type: 
Vector

removeEntity(entity) → {Vector}

Remove entity from layer. TODO: memory leaks.

Parameters:
NameTypeDescription
entityEntity

Entity to remove.

Overrides
Source
Returns:
  • Returns this layer.
Type: 
Vector

setAttribution(html)

Sets layer attribution text.

Parameters:
NameTypeDescription
htmlstring

HTML string that represents layer attribution.

Overrides
Source

setBaseLayer(isBaseLayer)

Sets base layer type flag.

Parameters:
NameTypeDescription
isBaseLayerboolean
Overrides
Source

setColor(color)

Parameters:
NameTypeDescription
colorstring

Layer color.

Source

setEntities(entities) → {Vector}

Removes current entities from layer and adds new entities.

Parameters:
NameTypeDescription
entitiesArray.<Entity>

New entity array.

Overrides
Source
Returns:
  • Returns layer instance.
Type: 
Vector

setExtent(extent)

Sets visible geographical extent.

Parameters:
NameTypeDescription
extentExtent

Layer visible geographical extent.

Overrides
Source

setHeight(height)

Sets height over the ground.

Parameters:
NameTypeDescription
heightnumber

Layer height.

Overrides
Source

(abstract) setVisibility(visibility)

Sets layer visibility.

Parameters:
NameTypeDescription
visibilityboolean

Layer visibility.

Overrides
Source

setZIndex(zIndex)

Sets z-index.

Parameters:
NameTypeDescription
zIndexnumber

Layer z-index.

Overrides
Source

viewExtent()

View extent.

Overrides
Source