Class: Vector

og/layer/Vector~Vector

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

new Vector(name, options)

og/layer/Vector.js, line 72

Name Type Default Description

name string "noname" optional Layer name.

options

Object

optional Layer options:

Name	Type	Default	Description
`minZoom`	number	0	optional Minimal visible zoom. 0 is default
`maxZoom`	number	50	optional Maximal visible zoom. 50 is default.
`attribution`	string		optional Layer attribution.
`zIndex`	string	0	optional Layer Z-order index. 0 is default.
`visibility`	boolean	true	optional Layer visibility. True is default.
`isBaseLayer`	boolean	false	optional Layer base layer. False is default.
`entities`	Array.<og.Entity>		optional Entities array.
`scaleByDistance`	Array.<number, number, number>		optional Scale by distance parameters. 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.
`nodeCapacity`	number	30	optional Maximum entities quantity in the tree node. Rendering optimization parameter. 30 is default.
`async`	boolean	true	optional Asynchronous vector data handling before rendering. True for optimization huge data.
`clampToGround`	boolean	false	optional Clamp vector data to the ground.
`relativeToGround`	boolean	false	optional Place vector data relative to the ground relief.

Fires:

entitymove
draw - Triggered when entity has moved.
add
remove
entityadd - Triggered when new entity added to the layer.
entityremove - Triggered when entity removes from the collection.
visibilitychange

Extends

og.Layer

Members

asyncboolean

Asynchronous data handling before rendering.

clampToGroundboolean

Vector data clamp to ground flag.

pickingEnabled

Set layer picking events active.

relativeToGroundboolean

Sets vector data relative to the ground relief.

scaleByDistanceArray.<number, number, number>

First index - near distance to the entity, after that 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.

Methods

_reindexEntitiesArray(startIndex) og/layer/Vector.js, line 365

Refresh collected entities indexes from startIndex entitytes collection array position.

Name	Type	Description
`startIndex`	number	Entity array index.

abortMaterialLoading(material) og/layer/Vector.js, line 701

Abort exact material loading.

Name	Type	Description
`material`	og.planetSegment.Material	Segment material.

add(entity, rightNow){og.layer.Vector} og/layer/Vector.js, line 220

Adds entity to the layer.

Name	Type	Description
`entity`	og.Entity	Entity.
`rightNow`	boolean	optional Entity insertion option. False is deafult.

Returns:

Type	Description
og.layer.Vector	- Returns this layer.

addEntities(entities, rightNow){og.layer.Vector} og/layer/Vector.js, line 273

Adds entity array to the layer.

Name	Type	Description
`entities`	Array.<og.Entity>	Entities array.
`rightNow`	boolean	optional Entity insertion option. False is deafult.

Returns:

Type	Description
og.layer.Vector	- Returns this layer.

addTo(planet){og.layer.Vector} og/layer/Vector.js, line 168

Adds layer to the planet.

Name	Type	Description
`planet`	og.Planet	Planet scene object.

Returns:

Type	Description
og.layer.Vector	-

clear() og/layer/Vector.js, line 405

TODO: Clear the layer.

each(callback) og/layer/Vector.js, line 414

Safety entities loop.

Name	Type	Description
`callback`	callback	Entity callback.

getEntities(){Array.<og.Entity>} og/layer/Vector.js, line 191

Returns stored entities.

Returns:

Type	Description
Array.<og.Entity>	-

abstracthasImageryTiles(){boolean} og/layer/Vector.js, line 182

Returns true if the layer has vector rasterized data.

Returns:

Type	Description
boolean	-

abstractloadMaterial(material) og/layer/Vector.js, line 679

Start to load tile material.

Name	Type	Description
`material`	og.Segment.Material	Current material.

removeEntities(entities){og.layer.Vector} og/layer/Vector.js, line 378

Removes entities from layer.

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

Returns:

Type	Description
og.layer.Vector	- Returns this layer.

removeEntity(entity){og.layer.Vector} og/layer/Vector.js, line 288

Remove entity from layer. TODO: memory leaks.

Name	Type	Description
`entity`	og.Entity	Entity to remove.

Returns:

Type	Description
og.layer.Vector	- Returns this layer.

setEntities(entities) og/layer/Vector.js, line 427

Removes current entities from layer and adds new entities.

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

setScaleByDistance(near, far, farInvisible){og.layer.Vector} og/layer/Vector.js, line 394

Sets scale by distance parameters.

Name	Type	Description
`near`	number	Full scale entity distance.
`far`	number	Zerol scale entity distance.
`farInvisible`	number	optional Entity visibility distance.

Returns:

Type	Description
og.layer.Vector	-

Events

inherited add og/layer/Layer.js, line 579

Triggered when layer has added to the planet.

inherited doubletouch og/layer/Layer.js, line 723

Triggered layer has double touched.

inherited lclick og/layer/Layer.js, line 609

Mouse left button clicked.

inherited ldblclick og/layer/Layer.js, line 627

Mouse left button double click.

inherited ldown og/layer/Layer.js, line 663

Mouse left button is just pressed down(start pressing).

inherited lhold og/layer/Layer.js, line 681

Mouse left button is pressing.

inherited lup og/layer/Layer.js, line 645

Mouse left button up(stop pressing).

inherited mclick og/layer/Layer.js, line 621

Mouse right button clicked.

inherited mdblclick og/layer/Layer.js, line 639

Mouse middle button double click.

inherited mdown og/layer/Layer.js, line 675

Mouse middle button is just pressed down(start pressing).

inherited mhold og/layer/Layer.js, line 693

Mouse middle button is pressing.

inherited mouseenter og/layer/Layer.js, line 597

Triggered when mouse has entered over the layer.

inherited mousemove og/layer/Layer.js, line 591

Triggered when mouse moves over the layer.

inherited mousewheel og/layer/Layer.js, line 699

Mouse wheel is rotated.

inherited mup og/layer/Layer.js, line 657

Mouse middle button up(stop pressing).

inherited rclick og/layer/Layer.js, line 615

Mouse right button clicked.

inherited rdblclick og/layer/Layer.js, line 633

Mouse right button double click.

inherited rdown og/layer/Layer.js, line 669

Mouse right button is just pressed down(start pressing).

inherited remove og/layer/Layer.js, line 585

Triggered when layer has removed from the planet.

inherited rhold og/layer/Layer.js, line 687

Mouse right button is pressing.

inherited rup og/layer/Layer.js, line 651

Mouse right button up(stop pressing).

inherited touchend og/layer/Layer.js, line 717

Triggered when layer has finished touching.

inherited touchenter og/layer/Layer.js, line 735

Triggered when touch enters over the layer.

inherited touchleave og/layer/Layer.js, line 729

Triggered when touching leaves layer borders.

inherited touchmove og/layer/Layer.js, line 705

Triggered when touching moves over the layer.

inherited touchstart og/layer/Layer.js, line 711

Triggered when layer begins to touch.

inherited visibilitychange og/layer/Layer.js, line 573

Triggered when layer visibilty chanched.