On this page

Vector

Vector#

Vector layer represents alternative entities store. Used for geospatial data rendering like points, lines, polygons, geometry objects etc.

Constructor#

new Vector(nameopt, optionsopt)#

Parameters:

Name Type Attributes Default Description

name

string

<optional>

"noname"

Layer name.

options

IVectorParams

<optional>

Layer options:

Properties

Name	Type	Attributes	Default	Description
`minZoom`	number	<optional>	0	Minimal visible zoom. 0 is default
`maxZoom`	number	<optional>	50	Maximal visible zoom. 50 is default.
`attribution`	string	<optional>		Layer attribution.
`zIndex`	string	<optional>	0	Layer Z-order index. 0 is default.
`visibility`	boolean	<optional>	true	Layer visibility. True is default.
`isBaseLayer`	boolean	<optional>	false	Layer base layer. False is default.
`entities`	Array.<Entity>	<optional>		Entities array.
`scaleByDistance`	Array.<number>	<optional>		Scale by distance parameters. (exactly 3 entries) First index - near distance to the entity, after entity becomes full scale. Second index - far distance to the entity, when entity becomes zero scale. Third index - far distance to the entity, when entity becomes invisible. Use [1.0, 1.0, 1.0] for real sized objects
`nodeCapacity`	number	<optional>	30	Maximum entities quantity in the tree node. Rendering optimization parameter. 30 is default.
`async`	boolean	<optional>	true	Asynchronous vector data handling before rendering. True for optimization huge data.
`clampToGround`	boolean	<optional>	false	Clamp vector data to the ground.
`relativeToGround`	boolean	<optional>	false	Place vector data relative to the ground relief.
`polygonOffsetUnits`	Number	<optional>	0.0	The multiplier by which an implementation-specific value is multiplied with to create a constant depth offset. //@fires EventsHandler#entitymove

Source: layer/Vector.ts, line 59

Fires:

EventsHandler#event:draw
EventsHandler#event:add
EventsHandler#event:remove
EventsHandler#event:entityadd
EventsHandler#event:entityremove
EventsHandler#event:visibilitychange

Extends#

Layer

Members#

_id#

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

(protected) _pickingColor :Vec3#

Layer picking color. Assign when added to the planet.

Type:

Vec3

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

pickingEnabled#

Set layer picking events active.

Source: layer/Vector.ts, line 494

planet#

Returns planet instance.

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

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 471

_bindEventsDefault(entityCollection)#

Parameters:

Name	Type	Description
`entityCollection`

Source: layer/Vector.ts, line 635
To Do: (refactoring) could be used in something like bindEntityCollectionQuad(...)

(abstract, protected) _bindPicking()#

Assign picking color to the layer.

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

(protected) _correctFullExtent()#

Special correction of the whole globe extent.

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

(protected) _reindexEntitiesArray(startIndex)#

Refresh collected entities indexes from startIndex entities collection array position.

Parameters:

Name	Type	Description
`startIndex`	number	Entity array index.

Source: layer/Vector.ts, line 507

abortMaterialLoading(material)#

Abort exact material loading.

Parameters:

Name	Type	Description
`material`	Material	Segment material.

Source: layer/Vector.ts, line 882

add(entity, rightNowopt) → {Vector}#

Adds entity to the layer.

Parameters:

Name	Type	Attributes	Default	Description
`entity`	Entity			Entity.
`rightNow`	boolean	<optional>	false	Entity insertion option. False is default.

Source: layer/Vector.ts, line 313

Returns:

Returns this layer.

Type:: Vector

addEntities(entities, rightNowopt) → {Vector}#

Adds entity array to the layer.

Parameters:

Name	Type	Attributes	Default	Description
`entities`	Array.<Entity>			Entities array.
`rightNow`	boolean	<optional>	false	Entity insertion option. False is default.

Source: layer/Vector.ts, line 410

Returns:

Returns this layer.

Type:: Vector

addTo(planet) → {Vector}#

Adds layer to the planet.

Parameters:

Name	Type	Description
`planet`	Planet	Planet scene object.

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

Returns:

Type:: Vector

bringToFront()#

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

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

clear()#

Clear the layer.

Overrides: Layer#clear
Source: layer/Vector.ts, line 533

each(callback)#

Safety entities loop.

Parameters:

Name	Type	Description
`callback`	function	Entity callback.

Source: layer/Vector.ts, line 561

flyExtent()#

Fly extent.

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

getAttribution() → {string}#

Gets layer attribution.

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

Returns:

Layer attribution

Type:: string

getEntities() → {Array.<Entity>}#

Returns stored entities.

Source: layer/Vector.ts, line 304

Returns:

Type:: Array.<Entity>

getExtent() → {Extent}#

Gets layer extent.

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

Returns:

Layer geodetic extent.

Type:: Extent

getExtentMerc() → {Extent}#

Gets layer web-mercator extent.

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

Returns:

Layer extent.

Type:: Extent

getHeight() → {number}#

Gets layer height.

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

Returns:

Type:: number

getID() → {string}#

Gets layer identifier.

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

Returns:

Layer object id.

Type:: string

getVisibility() → {boolean}#

Gets layer visibility.

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

Returns:

Layer visibility.

Type:: boolean

getZIndex() → {number}#

Gets z-index.

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

Returns:

Type:: number

(abstract) hasImageryTiles() → {boolean}#

Returns true if a layer has imagery tiles.

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

Returns:

Imagery tiles flag.

Type:: boolean

insert(entity, index, rightNowopt) → {Vector}#

Adds entity to the layer in the index position.

Parameters:

Name	Type	Attributes	Default	Description
`entity`	Entity			Entity.
`index`	Number			Index position.
`rightNow`	boolean	<optional>	false	Entity insertion option. False is default.

Source: layer/Vector.ts, line 331

Returns:

Returns this layer.

Type:: Vector

isBaseLayer() → {boolean}#

Returns true if the layer is a base.

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

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 461

Returns:

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

Type:: boolean

(abstract) loadMaterial(material)#

Start to load tile material.

Parameters:

Name	Type	Description
`material`	Material	Current material.

Source: layer/Vector.ts, line 860

remove() → {Layer}#

Removes from planet.

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

Returns:

-This layer.

Type:: Layer

removeEntities(entities) → {Vector}#

Removes entities from layer.

Parameters:

Name	Type	Description
`entities`	Array.<Entity>	Entity array.

Source: layer/Vector.ts, line 519

Returns:

Returns this layer.

Type:: Vector

removeEntity(entity) → {Vector}#

Remove entity from layer. TODO: memory leaks.

Parameters:

Name	Type	Description
`entity`	Entity	Entity to remove.

Source: layer/Vector.ts, line 425

Returns:

Returns this layer.

Type:: Vector

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 577

setBaseLayer(isBaseLayer)#

Sets base layer type true.

Parameters:

Name	Type	Description
`isBaseLayer`	boolean

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

setEntities(entities) → {Vector}#

Removes current entities from layer and adds new entities.

Parameters:

Name	Type	Description
`entities`	Array.<Entity>	New entity array.

Source: layer/Vector.ts, line 574

Returns:

Returns layer instance.

Type:: Vector

setExtent(extent)#

Sets visible geographical extent.

Parameters:

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

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

setHeight(height)#

Sets height over the ground.

Parameters:

Name	Type	Description
`height`	number	Layer height.

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

(abstract) setVisibility(visibility)#

Sets layer visibility.

Parameters:

Name	Type	Description
`visibility`	boolean	Layer visibility.

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

setZIndex(zIndex)#

Sets z-index.

Parameters:

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

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

viewExtent()#

View extent.

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