new EntityCollection(options)
| Name | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
optional
Entity options:
|
Fires:
- entitymove - Triggered when entity has moved.
- draw - Triggered when collection entities begin draw.
- drawend - Triggered after collection has drawn.
- add - Triggered when added to the render node.
- remove - Triggered when removed from the render node.
- entityadd - Triggered when new entity added to the collection.
- entityremove - Triggered when entity removes from the collection.
- visibilitychange - Triggered when visibility changes.
- mousemove - Triggered when mouse moves over the entity.
- mouseenter - Triggered when mouse has entered over the entity.
- mouseleave - Triggered when mouse leaves the entity.
- lclick - Mouse left button clicked.
- rclick - Mouse right button clicked.
- mclick - Mouse right button clicked.
- ldblclick - Mouse left button double click.
- rdblclick - Mouse right button double click.
- mdblclick - Mouse middle button double click.
- lup - Mouse left button up(stop pressing).
- rup - Mouse right button up(stop pressing).
- mup - Mouse middle button up(stop pressing).
- ldown - Mouse left button is just pressed down(start pressing).
- rdown - Mouse right button is just pressed down(start pressing).
- mdown - Mouse middle button is just pressed down(start pressing).
- lhold - Mouse left button is pressing.
- rhold - Mouse right button is pressing.
- mhold - Mouse middle button is pressing.
- mousewheel - Mouse wheel is rotated.
- touchmove - Triggered when touch moves over the entity.
- touchstart - Triggered when entity begins to touch.
- touchend - Triggered when entity ends touching.
- doubletouch - Triggered entity double touch.
- touchleave - Triggered when touching leaves entity.
- touchenter - Triggered when touch enters over the entity.
Members
-
protected_entitiesArray.<og.Entity>
-
Entities array.
-
protected_fadingOpacitynumber
-
Opacity state during the animated opacity.
-
protected_opacitynumber
-
Global opacity.
-
protected_renderNodeIndexnumber
-
Render node collections array index.
-
protected_visibilityboolean
-
Visibility option.
-
billboardHandlerog.BillboardHandler
-
Billboards handler
-
eventsog.Events
-
Entity collection events handler.
-
readonlyid
-
Unic identifier.
-
labelHandlerog.LabelHandler
-
Labels handler
-
pointCloudHandlerog.PointCloudHandler
-
PointCloud handler
-
polylineHandlerog.PolylineHandler
-
Polyline handler
-
renderNodeog.scene.RenderNode
-
Render node context.
-
scaleByDistanceArray.<number, number, number>
-
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.
-
shapeHandlerog.ShapeHandler
-
Shape handler
Methods
-
add(entity){og.EntityCollection}
-
Adds entity to the collection and returns collection.
Name Type Description entityog.Entity Entity. Returns:
Type Description og.EntityCollection -
addEntities(entities){og.EntityCollection}
-
Adds entities array to the collection and returns collection.
Name Type Description entitiesArray.<og.Entity> Entities array. Returns:
Type Description og.EntityCollection -
addTo(renderNode, isHidden){og.EntityCollection}
-
Adds this collection to render node.
Name Type Description renderNodeog.scene.RenderNode Render node. isHiddenboolean optional Uses in vector layers that render in planet render specific function. Returns:
Type Description og.EntityCollection -
belongs(entity){boolean}
-
Returns true if the entity belongs this collection, otherwise returns false.
Name Type Description entityog.Entity Entity. Returns:
Type Description boolean -
clear()
-
Removes all entities from colection and clear handlers.
-
createPickingColors()
-
Creates or refresh collected entities picking color.
-
each(callback)
-
Safety entities loop.
Name Type Description callbackfunction Entity callback. -
getEntities(){Array.<og.Entity>}
-
Gets entities.
Returns:
Type Description Array.<og.Entity> -
getOpacity(opacity)
-
Gets collection opacity.
Name Type Description opacitynumber Opacity. -
getVisibility(){boolean}
-
Returns collection visibility.
Returns:
Type Description boolean -
reindexEntitiesArray(startIndex)
-
Refresh collected entities indexes from startIndex entitytes collection array position.
Name Type Description startIndexnumber Entities collection array index. -
remove()
-
Removes collection from render node.
-
removeEntity(entity)
-
Removes entity from this collection.
Name Type Description entityog.Entity Entity to remove. -
setOpacity(opacity)
-
Sets collection opacity.
Name Type Description opacitynumber Opacity. -
setPickingEnabled(enable)
-
Sets collection picking ability.
Name Type Description enableboolean Picking enable flag. -
setRenderer(renderer)
-
Sets renderer. Used in renderer initialization, when entity collection starts before renderer has initialized.
Name Type Description rendererog.Renderer Renderer. -
setScaleByDistance(near, far, farInvisible)
-
Sets scale by distance parameters.
Name Type Description nearnumber Full scale entity distance. farnumber Zerol scale entity distance. farInvisiblenumber optional Entity visibility distance. -
setVisibility(visibility)
-
Sets collection visibility.
Name Type Description visibilityboolean Visibility flag. -
updateBillboardsTextureAtlas()
-
Updates billboard texture atlas.
-
updateLabelsFontAtlas()
-
Updates labels font atlas.