-
protected_entitiesArray.<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.
-
billboardHandlerBillboardHandler
-
Billboards handler
-
eventsEvents
-
Entity collection events handler.
-
geoObjectHandlerog.GeoObjectHandler
-
Geo object handler
-
readonlyid
-
Unic identifier.
-
labelHandlerLabelHandler
-
Labels handler
-
pointCloudHandlerPointCloudHandler
-
PointCloud handler
-
polygonOffsetFactorNumber
-
Specifies the scale factor for gl.polygonOffset function to calculate depth values, 0.0 is default.
-
polygonOffsetUnitsNumber
-
Specifies the scale Units for gl.polygonOffset function to calculate depth values, 0.0 is default.
-
polylineHandlerPolylineHandler
-
Polyline handler
-
-
Ray handler
-
-
Render node context.
-
scaleByDistanceArray.<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.
-
shapeHandlerShapeHandler
-
Shape handler
-
-
Strip handler
-
add(entity){EntityCollection}
-
Adds entity to the collection and returns collection.
Name |
Type |
Description |
entity |
Entity
|
Entity. |
Returns:
Type |
Description |
EntityCollection
|
- |
-
addEntities(entities){EntityCollection}
-
Adds entities array to the collection and returns collection.
Name |
Type |
Description |
entities |
Array.<Entity>
|
Entities array. |
Returns:
Type |
Description |
EntityCollection
|
- |
-
addTo(renderNode, isHidden){EntityCollection}
-
Adds this collection to render node.
Name |
Type |
Description |
renderNode |
RenderNode
|
Render node. |
isHidden |
boolean
|
optional
Uses in vector layers that render in planet render specific function. |
Returns:
Type |
Description |
EntityCollection
|
- |
-
-
Returns true if the entity belongs this collection, otherwise returns false.
Name |
Type |
Description |
entity |
Entity
|
Entity. |
Returns:
Type |
Description |
boolean
|
- |
-
bindRenderNode(renderNode)
-
This function is called in the RenderNode assign function.
-
-
Removes all entities from colection and clear handlers.
-
-
Creates or refresh collected entities picking color.
-
-
Safety entities loop.
Name |
Type |
Description |
callback |
function
|
Entity callback. |
-
getEntities(){Array.<Entity>}
-
Gets entity array.
Returns:
Type |
Description |
Array.<Entity>
|
- |
-
-
Gets collection opacity.
Returns:
Type |
Description |
number
|
- |
-
-
Returns collection visibility.
Returns:
Type |
Description |
boolean
|
- |
-
reindexEntitiesArray(startIndex)
-
Refresh collected entities indexes from startIndex entitytes collection array position.
Name |
Type |
Description |
startIndex |
number
|
Entities collection array index. |
-
-
Removes collection from render node.
-
-
Removes entity from this collection.
Name |
Type |
Description |
entity |
Entity
|
Entity to remove. |
-
-
Sets collection opacity.
Name |
Type |
Description |
opacity |
number
|
Opacity. |
-
setPickingEnabled(enable)
-
Sets collection picking ability.
Name |
Type |
Description |
enable |
boolean
|
Picking enable flag. |
-
setScaleByDistance(near, far, farInvisible)
-
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. |
-
setVisibility(visibility)
-
Sets collection visibility.
Name |
Type |
Description |
visibility |
boolean
|
Visibility flag. |
-
updateBillboardsTextureAtlas()
-
Updates billboard texture atlas.
-
-
Updates labels font atlas.