Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 | 780x 780x 780x 780x 780x 780x 780x 780x 780x 780x 780x 780x 780x 780x 780x 780x 780x 780x 780x 780x 780x 780x 780x 780x 780x 59x 59x 59x 59x 1x 58x 6x 52x 42x 10x 10x 58x 58x 1x 1x 1x 1x 1x 58x 26x 26x 13x 13x 13x 13x 13x 13x 13x 13x 78x 80x 54x 26x 26x 58x 58x 58x 2x 56x 56x 56x 56x 56x 56x 2x 54x 1x 1x 1x 280x 36x 8x 28x 28x 28x 28x 28x 28x 28x 28x 28x 10x 18x 28x 10x 18x 28x 10x 18x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 27x 28x 27x 28x 26x 28x 23x 23x 54x 23x 23x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 1x 2x 23x 23x 54x 54x 16x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 44x 44x 44x 20x 20x 20x 20x 20x 20x 38x 12x 12x 12x 12x 26x 26x 28x 15x 15x 28x 15x 15x 28x 15x 15x 28x 28x 1x 280x 280x 280x 280x 1x 49x 11x 11x 4x 3x 3x 3x 3x 3x 1x 2x 1x 1x 2x 1x 1x 2x 2x 2x 23x 3x 59x 59x 1x 59x 59x 52x 59x 59x 43x 59x 59x 4x 4x 55x 55x 59x 59x 59x 59x 59x 26x 26x 22x 1x 1x 37x 37x 29x 8x 8x 8x 8x 8x 8x 8x 8x 8x 1x 1x 37x 37x 26x 11x 11x 11x 11x 11x 11x 11x 11x 11x 1x 1x 32x 32x 25x 7x 7x 7x 7x 7x 7x 7x 7x 10x 10x 1x 66x 66x 66x 6x 6x 6x 6x 66x 66x 22x 22x 22x 22x 66x 10x 10x 10x 66x 32x 32x 66x 19x 66x 19x 66x 19x 66x 8x 66x 30x 66x 11x 1x 282x 279x 279x 282x 282x 282x 282x 282x 282x 282x 282x 282x 282x 282x 282x 282x 282x 282x 282x 282x 282x 282x 282x 282x 282x | import BoundingRectangle from "../Core/BoundingRectangle.js";
import Cartesian2 from "../Core/Cartesian2.js";
import Cartesian3 from "../Core/Cartesian3.js";
import Frozen from "../Core/Frozen.js";
import defined from "../Core/defined.js";
import EllipsoidalOccluder from "../Core/EllipsoidalOccluder.js";
import Event from "../Core/Event.js";
import Matrix4 from "../Core/Matrix4.js";
import Billboard from "../Scene/Billboard.js";
import BillboardCollection from "../Scene/BillboardCollection.js";
import Label from "../Scene/Label.js";
import LabelCollection from "../Scene/LabelCollection.js";
import PointPrimitive from "../Scene/PointPrimitive.js";
import PointPrimitiveCollection from "../Scene/PointPrimitiveCollection.js";
import SceneMode from "../Scene/SceneMode.js";
import KDBush from "kdbush";
/**
* Defines how screen space objects (billboards, points, labels) are clustered.
*
* @param {object} [options] An object with the following properties:
* @param {boolean} [options.enabled=false] Whether or not to enable clustering.
* @param {number} [options.pixelRange=80] The pixel range to extend the screen space bounding box.
* @param {number} [options.minimumClusterSize=2] The minimum number of screen space objects that can be clustered.
* @param {boolean} [options.clusterBillboards=true] Whether or not to cluster the billboards of an entity.
* @param {boolean} [options.clusterLabels=true] Whether or not to cluster the labels of an entity.
* @param {boolean} [options.clusterPoints=true] Whether or not to cluster the points of an entity.
* @param {boolean} [options.show=true] Determines if the entities in the cluster will be shown.
*
* @alias EntityCluster
* @constructor
*
* @demo {@link https://sandcastle.cesium.com/index.html?src=Clustering.html|Cesium Sandcastle Clustering Demo}
*/
function EntityCluster(options) {
options = options ?? Frozen.EMPTY_OBJECT;
this._enabled = options.enabled ?? false;
this._pixelRange = options.pixelRange ?? 80;
this._minimumClusterSize = options.minimumClusterSize ?? 2;
this._clusterBillboards = options.clusterBillboards ?? true;
this._clusterLabels = options.clusterLabels ?? true;
this._clusterPoints = options.clusterPoints ?? true;
this._labelCollection = undefined;
this._billboardCollection = undefined;
this._pointCollection = undefined;
this._clusterBillboardCollection = undefined;
this._clusterLabelCollection = undefined;
this._clusterPointCollection = undefined;
this._collectionIndicesByEntity = {};
this._unusedLabelIndices = [];
this._unusedBillboardIndices = [];
this._unusedPointIndices = [];
this._previousClusters = [];
this._previousHeight = undefined;
this._enabledDirty = false;
this._clusterDirty = false;
this._cluster = undefined;
this._removeEventListener = undefined;
this._clusterEvent = new Event();
/**
* Determines if entities in this collection will be shown.
*
* @type {boolean}
* @default true
*/
this.show = options.show ?? true;
}
function expandBoundingBox(bbox, pixelRange) {
bbox.x -= pixelRange;
bbox.y -= pixelRange;
bbox.width += pixelRange * 2.0;
bbox.height += pixelRange * 2.0;
}
const labelBoundingBoxScratch = new BoundingRectangle();
function getBoundingBox(item, coord, pixelRange, entityCluster, result) {
if (defined(item._labelCollection) && entityCluster._clusterLabels) {
result = Label.getScreenSpaceBoundingBox(item, coord, result);
} else if (
defined(item._billboardCollection) &&
entityCluster._clusterBillboards
) {
result = Billboard.getScreenSpaceBoundingBox(item, coord, result);
} else Eif (
defined(item._pointPrimitiveCollection) &&
entityCluster._clusterPoints
) {
result = PointPrimitive.getScreenSpaceBoundingBox(item, coord, result);
}
expandBoundingBox(result, pixelRange);
if (
entityCluster._clusterLabels &&
!defined(item._labelCollection) &&
defined(item.id) &&
hasLabelIndex(entityCluster, item.id.id) &&
defined(item.id._label)
) {
const labelIndex =
entityCluster._collectionIndicesByEntity[item.id.id].labelIndex;
const label = entityCluster._labelCollection.get(labelIndex);
const labelBBox = Label.getScreenSpaceBoundingBox(
label,
coord,
labelBoundingBoxScratch,
);
expandBoundingBox(labelBBox, pixelRange);
result = BoundingRectangle.union(result, labelBBox, result);
}
return result;
}
function addNonClusteredItem(item, entityCluster) {
item.clusterShow = true;
Iif (
!defined(item._labelCollection) &&
defined(item.id) &&
hasLabelIndex(entityCluster, item.id.id) &&
defined(item.id._label)
) {
const labelIndex =
entityCluster._collectionIndicesByEntity[item.id.id].labelIndex;
const label = entityCluster._labelCollection.get(labelIndex);
label.clusterShow = true;
}
}
function addCluster(position, numPoints, ids, entityCluster) {
const cluster = {
billboard: entityCluster._clusterBillboardCollection.add(),
label: entityCluster._clusterLabelCollection.add(),
point: entityCluster._clusterPointCollection.add(),
};
cluster.billboard.show = false;
cluster.point.show = false;
cluster.label.show = true;
cluster.label.text = numPoints.toLocaleString();
cluster.label.id = ids;
cluster.billboard.position =
cluster.label.position =
cluster.point.position =
position;
entityCluster._clusterEvent.raiseEvent(ids, cluster);
}
function hasLabelIndex(entityCluster, entityId) {
return (
defined(entityCluster) &&
defined(entityCluster._collectionIndicesByEntity[entityId]) &&
defined(entityCluster._collectionIndicesByEntity[entityId].labelIndex)
);
}
function getScreenSpacePositions(
collection,
points,
scene,
occluder,
entityCluster,
) {
if (!defined(collection)) {
return;
}
const length = collection.length;
for (let i = 0; i < length; ++i) {
const item = collection.get(i);
item.clusterShow = false;
if (
!item.show ||
(entityCluster._scene.mode === SceneMode.SCENE3D &&
!occluder.isPointVisible(item.position))
) {
continue;
}
const canClusterLabels =
entityCluster._clusterLabels && defined(item._labelCollection);
const canClusterBillboards =
entityCluster._clusterBillboards && defined(item.id._billboard);
const canClusterPoints =
entityCluster._clusterPoints && defined(item.id._point);
Iif (canClusterLabels && (canClusterPoints || canClusterBillboards)) {
continue;
}
const coord = item.computeScreenSpacePosition(scene);
if (!defined(coord)) {
continue;
}
points.push({
index: i,
collection: collection,
clustered: false,
coord: coord,
});
}
}
const pointBoundinRectangleScratch = new BoundingRectangle();
const totalBoundingRectangleScratch = new BoundingRectangle();
const neighborBoundingRectangleScratch = new BoundingRectangle();
function createDeclutterCallback(entityCluster) {
return function (amount) {
if ((defined(amount) && amount < 0.05) || !entityCluster.enabled) {
return;
}
const scene = entityCluster._scene;
const labelCollection = entityCluster._labelCollection;
const billboardCollection = entityCluster._billboardCollection;
const pointCollection = entityCluster._pointCollection;
Iif (
(!defined(labelCollection) &&
!defined(billboardCollection) &&
!defined(pointCollection)) ||
(!entityCluster._clusterBillboards &&
!entityCluster._clusterLabels &&
!entityCluster._clusterPoints)
) {
return;
}
let clusteredLabelCollection = entityCluster._clusterLabelCollection;
let clusteredBillboardCollection =
entityCluster._clusterBillboardCollection;
let clusteredPointCollection = entityCluster._clusterPointCollection;
if (defined(clusteredLabelCollection)) {
clusteredLabelCollection.removeAll();
} else {
clusteredLabelCollection = entityCluster._clusterLabelCollection =
new LabelCollection({
scene: scene,
});
}
if (defined(clusteredBillboardCollection)) {
clusteredBillboardCollection.removeAll();
} else {
clusteredBillboardCollection = entityCluster._clusterBillboardCollection =
new BillboardCollection({
scene: scene,
});
}
if (defined(clusteredPointCollection)) {
clusteredPointCollection.removeAll();
} else {
clusteredPointCollection = entityCluster._clusterPointCollection =
new PointPrimitiveCollection();
}
const pixelRange = entityCluster._pixelRange;
const minimumClusterSize = entityCluster._minimumClusterSize;
const clusters = entityCluster._previousClusters;
const newClusters = [];
const previousHeight = entityCluster._previousHeight;
const currentHeight = scene.camera.positionCartographic.height;
const ellipsoid = scene.ellipsoid;
const cameraPosition = scene.camera.positionWC;
const occluder = new EllipsoidalOccluder(ellipsoid, cameraPosition);
const points = [];
if (entityCluster._clusterLabels) {
getScreenSpacePositions(
labelCollection,
points,
scene,
occluder,
entityCluster,
);
}
if (entityCluster._clusterBillboards) {
getScreenSpacePositions(
billboardCollection,
points,
scene,
occluder,
entityCluster,
);
}
if (entityCluster._clusterPoints) {
getScreenSpacePositions(
pointCollection,
points,
scene,
occluder,
entityCluster,
);
}
let i;
let j;
let length;
let bbox;
let neighbors;
let neighborLength;
let neighborIndex;
let neighborPoint;
let ids;
let numPoints;
let collection;
let collectionIndex;
if (points.length > 0) {
const index = new KDBush(points.length, 64, Uint32Array);
for (let p = 0; p < points.length; ++p) {
index.add(points[p].coord.x, points[p].coord.y);
}
index.finish();
if (currentHeight < previousHeight) {
length = clusters.length;
for (i = 0; i < length; ++i) {
const cluster = clusters[i];
Iif (!occluder.isPointVisible(cluster.position)) {
continue;
}
const coord = Billboard._computeScreenSpacePosition(
Matrix4.IDENTITY,
cluster.position,
Cartesian3.ZERO,
Cartesian2.ZERO,
scene,
);
Iif (!defined(coord)) {
continue;
}
const factor = 1.0 - currentHeight / previousHeight;
let width = (cluster.width = cluster.width * factor);
let height = (cluster.height = cluster.height * factor);
width = Math.max(width, cluster.minimumWidth);
height = Math.max(height, cluster.minimumHeight);
const minX = coord.x - width * 0.5;
const minY = coord.y - height * 0.5;
const maxX = coord.x + width;
const maxY = coord.y + height;
neighbors = index.range(minX, minY, maxX, maxY);
neighborLength = neighbors.length;
numPoints = 0;
ids = [];
for (j = 0; j < neighborLength; ++j) {
neighborIndex = neighbors[j];
neighborPoint = points[neighborIndex];
Eif (!neighborPoint.clustered) {
++numPoints;
collection = neighborPoint.collection;
collectionIndex = neighborPoint.index;
ids.push(collection.get(collectionIndex).id);
}
}
Eif (numPoints >= minimumClusterSize) {
addCluster(cluster.position, numPoints, ids, entityCluster);
newClusters.push(cluster);
for (j = 0; j < neighborLength; ++j) {
points[neighbors[j]].clustered = true;
}
}
}
}
length = points.length;
for (i = 0; i < length; ++i) {
const point = points[i];
if (point.clustered) {
continue;
}
point.clustered = true;
collection = point.collection;
collectionIndex = point.index;
const item = collection.get(collectionIndex);
bbox = getBoundingBox(
item,
point.coord,
pixelRange,
entityCluster,
pointBoundinRectangleScratch,
);
const totalBBox = BoundingRectangle.clone(
bbox,
totalBoundingRectangleScratch,
);
neighbors = index.range(
bbox.x,
bbox.y,
bbox.x + bbox.width,
bbox.y + bbox.height,
);
neighborLength = neighbors.length;
const clusterPosition = Cartesian3.clone(item.position);
numPoints = 1;
ids = [item.id];
for (j = 0; j < neighborLength; ++j) {
neighborIndex = neighbors[j];
neighborPoint = points[neighborIndex];
if (!neighborPoint.clustered) {
const neighborItem = neighborPoint.collection.get(
neighborPoint.index,
);
const neighborBBox = getBoundingBox(
neighborItem,
neighborPoint.coord,
pixelRange,
entityCluster,
neighborBoundingRectangleScratch,
);
Cartesian3.add(
neighborItem.position,
clusterPosition,
clusterPosition,
);
BoundingRectangle.union(totalBBox, neighborBBox, totalBBox);
++numPoints;
ids.push(neighborItem.id);
}
}
if (numPoints >= minimumClusterSize) {
const position = Cartesian3.multiplyByScalar(
clusterPosition,
1.0 / numPoints,
clusterPosition,
);
addCluster(position, numPoints, ids, entityCluster);
newClusters.push({
position: position,
width: totalBBox.width,
height: totalBBox.height,
minimumWidth: bbox.width,
minimumHeight: bbox.height,
});
for (j = 0; j < neighborLength; ++j) {
points[neighbors[j]].clustered = true;
}
} else {
addNonClusteredItem(item, entityCluster);
}
}
}
if (clusteredLabelCollection.length === 0) {
clusteredLabelCollection.destroy();
entityCluster._clusterLabelCollection = undefined;
}
if (clusteredBillboardCollection.length === 0) {
clusteredBillboardCollection.destroy();
entityCluster._clusterBillboardCollection = undefined;
}
if (clusteredPointCollection.length === 0) {
clusteredPointCollection.destroy();
entityCluster._clusterPointCollection = undefined;
}
entityCluster._previousClusters = newClusters;
entityCluster._previousHeight = currentHeight;
};
}
EntityCluster.prototype._initialize = function (scene) {
this._scene = scene;
const cluster = createDeclutterCallback(this);
this._cluster = cluster;
this._removeEventListener = scene.camera.changed.addEventListener(cluster);
};
Object.defineProperties(EntityCluster.prototype, {
/**
* Gets or sets whether clustering is enabled.
* @memberof EntityCluster.prototype
* @type {boolean}
*/
enabled: {
get: function () {
return this._enabled;
},
set: function (value) {
this._enabledDirty = value !== this._enabled;
this._enabled = value;
},
},
/**
* Gets or sets the pixel range to extend the screen space bounding box.
* @memberof EntityCluster.prototype
* @type {number}
*/
pixelRange: {
get: function () {
return this._pixelRange;
},
set: function (value) {
this._clusterDirty = this._clusterDirty || value !== this._pixelRange;
this._pixelRange = value;
},
},
/**
* Gets or sets the minimum number of screen space objects that can be clustered.
* @memberof EntityCluster.prototype
* @type {number}
*/
minimumClusterSize: {
get: function () {
return this._minimumClusterSize;
},
set: function (value) {
this._clusterDirty =
this._clusterDirty || value !== this._minimumClusterSize;
this._minimumClusterSize = value;
},
},
/**
* Gets the event that will be raised when a new cluster will be displayed. The signature of the event listener is {@link EntityCluster.newClusterCallback}.
* @memberof EntityCluster.prototype
* @type {Event<EntityCluster.newClusterCallback>}
*/
clusterEvent: {
get: function () {
return this._clusterEvent;
},
},
/**
* Gets or sets whether clustering billboard entities is enabled.
* @memberof EntityCluster.prototype
* @type {boolean}
*/
clusterBillboards: {
get: function () {
return this._clusterBillboards;
},
set: function (value) {
this._clusterDirty =
this._clusterDirty || value !== this._clusterBillboards;
this._clusterBillboards = value;
},
},
/**
* Gets or sets whether clustering labels entities is enabled.
* @memberof EntityCluster.prototype
* @type {boolean}
*/
clusterLabels: {
get: function () {
return this._clusterLabels;
},
set: function (value) {
this._clusterDirty = this._clusterDirty || value !== this._clusterLabels;
this._clusterLabels = value;
},
},
/**
* Gets or sets whether clustering point entities is enabled.
* @memberof EntityCluster.prototype
* @type {boolean}
*/
clusterPoints: {
get: function () {
return this._clusterPoints;
},
set: function (value) {
this._clusterDirty = this._clusterDirty || value !== this._clusterPoints;
this._clusterPoints = value;
},
},
/**
* Returns true when all clustered data has been rendered.
* @memberof EntityCluster.prototype
* @type {boolean}
* @readonly
* @private
*/
ready: {
get: function () {
return (
!this._enabledDirty &&
!this._clusterDirty &&
(!defined(this._billboardCollection) ||
this._billboardCollection.ready) &&
(!defined(this._labelCollection) || this._labelCollection.ready)
);
},
},
});
function createGetEntity(
collectionProperty,
CollectionConstructor,
unusedIndicesProperty,
entityIndexProperty,
) {
return function (entity) {
let collection = this[collectionProperty];
if (!defined(this._collectionIndicesByEntity)) {
this._collectionIndicesByEntity = {};
}
let entityIndices = this._collectionIndicesByEntity[entity.id];
if (!defined(entityIndices)) {
entityIndices = this._collectionIndicesByEntity[entity.id] = {
billboardIndex: undefined,
labelIndex: undefined,
pointIndex: undefined,
};
}
Iif (defined(collection) && defined(entityIndices[entityIndexProperty])) {
return collection.get(entityIndices[entityIndexProperty]);
}
if (!defined(collection)) {
collection = this[collectionProperty] = new CollectionConstructor({
scene: this._scene,
});
}
let index;
let entityItem;
const unusedIndices = this[unusedIndicesProperty];
if (unusedIndices.length > 0) {
index = unusedIndices.shift();
entityItem = collection.get(index);
} else {
entityItem = collection.add();
index = collection.length - 1;
}
entityIndices[entityIndexProperty] = index;
const that = this;
Promise.resolve().then(function () {
that._clusterDirty = true;
});
return entityItem;
};
}
function removeEntityIndicesIfUnused(entityCluster, entityId) {
const indices = entityCluster._collectionIndicesByEntity[entityId];
if (
!defined(indices.billboardIndex) &&
!defined(indices.labelIndex) &&
!defined(indices.pointIndex)
) {
delete entityCluster._collectionIndicesByEntity[entityId];
}
}
/**
* Returns a new {@link Label}.
* @param {Entity} entity The entity that will use the returned {@link Label} for visualization.
* @returns {Label} The label that will be used to visualize an entity.
*
* @private
*/
EntityCluster.prototype.getLabel = createGetEntity(
"_labelCollection",
LabelCollection,
"_unusedLabelIndices",
"labelIndex",
);
/**
* Removes the {@link Label} associated with an entity so it can be reused by another entity.
* @param {Entity} entity The entity that will uses the returned {@link Label} for visualization.
*
* @private
*/
EntityCluster.prototype.removeLabel = function (entity) {
const entityIndices =
this._collectionIndicesByEntity &&
this._collectionIndicesByEntity[entity.id];
if (
!defined(this._labelCollection) ||
!defined(entityIndices) ||
!defined(entityIndices.labelIndex)
) {
return;
}
const index = entityIndices.labelIndex;
entityIndices.labelIndex = undefined;
removeEntityIndicesIfUnused(this, entity.id);
const label = this._labelCollection.get(index);
label.show = false;
label.text = "";
label.id = undefined;
this._unusedLabelIndices.push(index);
this._clusterDirty = true;
};
/**
* Returns a new {@link Billboard}.
* @param {Entity} entity The entity that will use the returned {@link Billboard} for visualization.
* @returns {Billboard} The label that will be used to visualize an entity.
*
* @private
*/
EntityCluster.prototype.getBillboard = createGetEntity(
"_billboardCollection",
BillboardCollection,
"_unusedBillboardIndices",
"billboardIndex",
);
/**
* Removes the {@link Billboard} associated with an entity so it can be reused by another entity.
* @param {Entity} entity The entity that will uses the returned {@link Billboard} for visualization.
*
* @private
*/
EntityCluster.prototype.removeBillboard = function (entity) {
const entityIndices =
this._collectionIndicesByEntity &&
this._collectionIndicesByEntity[entity.id];
if (
!defined(this._billboardCollection) ||
!defined(entityIndices) ||
!defined(entityIndices.billboardIndex)
) {
return;
}
const index = entityIndices.billboardIndex;
entityIndices.billboardIndex = undefined;
removeEntityIndicesIfUnused(this, entity.id);
const billboard = this._billboardCollection.get(index);
billboard.id = undefined;
billboard.show = false;
billboard.image = undefined;
this._unusedBillboardIndices.push(index);
this._clusterDirty = true;
};
/**
* Returns a new {@link Point}.
* @param {Entity} entity The entity that will use the returned {@link Point} for visualization.
* @returns {Point} The label that will be used to visualize an entity.
*
* @private
*/
EntityCluster.prototype.getPoint = createGetEntity(
"_pointCollection",
PointPrimitiveCollection,
"_unusedPointIndices",
"pointIndex",
);
/**
* Removes the {@link Point} associated with an entity so it can be reused by another entity.
* @param {Entity} entity The entity that will uses the returned {@link Point} for visualization.
*
* @private
*/
EntityCluster.prototype.removePoint = function (entity) {
const entityIndices =
this._collectionIndicesByEntity &&
this._collectionIndicesByEntity[entity.id];
if (
!defined(this._pointCollection) ||
!defined(entityIndices) ||
!defined(entityIndices.pointIndex)
) {
return;
}
const index = entityIndices.pointIndex;
entityIndices.pointIndex = undefined;
removeEntityIndicesIfUnused(this, entity.id);
const point = this._pointCollection.get(index);
point.show = false;
point.id = undefined;
this._unusedPointIndices.push(index);
this._clusterDirty = true;
};
function disableCollectionClustering(collection) {
if (!defined(collection)) {
return;
}
const length = collection.length;
for (let i = 0; i < length; ++i) {
collection.get(i).clusterShow = true;
}
}
function updateEnable(entityCluster) {
Eif (entityCluster.enabled) {
return;
}
if (defined(entityCluster._clusterLabelCollection)) {
entityCluster._clusterLabelCollection.destroy();
}
if (defined(entityCluster._clusterBillboardCollection)) {
entityCluster._clusterBillboardCollection.destroy();
}
if (defined(entityCluster._clusterPointCollection)) {
entityCluster._clusterPointCollection.destroy();
}
entityCluster._clusterLabelCollection = undefined;
entityCluster._clusterBillboardCollection = undefined;
entityCluster._clusterPointCollection = undefined;
disableCollectionClustering(entityCluster._labelCollection);
disableCollectionClustering(entityCluster._billboardCollection);
disableCollectionClustering(entityCluster._pointCollection);
}
/**
* Gets the draw commands for the clustered billboards/points/labels if enabled, otherwise,
* queues the draw commands for billboards/points/labels created for entities.
* @private
*/
EntityCluster.prototype.update = function (frameState) {
Iif (!this.show) {
return;
}
// If clustering is enabled before the label collection is updated,
// the glyphs haven't been created so the screen space bounding boxes
// are incorrect.
let commandList;
const labelCollection = this._labelCollection;
if (
defined(labelCollection) &&
labelCollection.length > 0 &&
!labelCollection.ready
) {
commandList = frameState.commandList;
frameState.commandList = [];
labelCollection.update(frameState);
frameState.commandList = commandList;
}
// If clustering is enabled before the billboard collections are updated,
// the images haven't been added to the image atlas so the screen space bounding boxes
// are incorrect.
const billboardCollection = this._billboardCollection;
if (
defined(billboardCollection) &&
billboardCollection.length > 0 &&
!billboardCollection.ready
) {
commandList = frameState.commandList;
frameState.commandList = [];
billboardCollection.update(frameState);
frameState.commandList = commandList;
}
if (this._enabledDirty) {
this._enabledDirty = false;
updateEnable(this);
this._clusterDirty = true;
}
if (this._clusterDirty) {
this._cluster();
// Unless all existing billboards and labels were clustered, clustering will need to execute again next frame
this._clusterDirty =
(defined(labelCollection) && !labelCollection.ready) ||
(defined(billboardCollection) && !billboardCollection.ready);
}
if (defined(this._clusterLabelCollection)) {
this._clusterLabelCollection.update(frameState);
}
if (defined(this._clusterBillboardCollection)) {
this._clusterBillboardCollection.update(frameState);
}
if (defined(this._clusterPointCollection)) {
this._clusterPointCollection.update(frameState);
}
if (defined(labelCollection)) {
labelCollection.update(frameState);
}
if (defined(billboardCollection)) {
billboardCollection.update(frameState);
}
if (defined(this._pointCollection)) {
this._pointCollection.update(frameState);
}
};
/**
* Destroys the WebGL resources held by this object. Destroying an object allows for deterministic
* release of WebGL resources, instead of relying on the garbage collector to destroy this object.
* <p>
* Unlike other objects that use WebGL resources, this object can be reused. For example, if a data source is removed
* from a data source collection and added to another.
* </p>
*/
EntityCluster.prototype.destroy = function () {
if (defined(this._removeEventListener)) {
this._removeEventListener();
this._removeEventListener = undefined;
}
this._labelCollection =
this._labelCollection && this._labelCollection.destroy();
this._billboardCollection =
this._billboardCollection && this._billboardCollection.destroy();
this._pointCollection =
this._pointCollection && this._pointCollection.destroy();
this._clusterLabelCollection =
this._clusterLabelCollection && this._clusterLabelCollection.destroy();
this._clusterBillboardCollection =
this._clusterBillboardCollection &&
this._clusterBillboardCollection.destroy();
this._clusterPointCollection =
this._clusterPointCollection && this._clusterPointCollection.destroy();
this._labelCollection = undefined;
this._billboardCollection = undefined;
this._pointCollection = undefined;
this._clusterBillboardCollection = undefined;
this._clusterLabelCollection = undefined;
this._clusterPointCollection = undefined;
this._collectionIndicesByEntity = undefined;
this._unusedLabelIndices = [];
this._unusedBillboardIndices = [];
this._unusedPointIndices = [];
this._previousClusters = [];
this._previousHeight = undefined;
this._enabledDirty = false;
this._pixelRangeDirty = false;
this._minimumClusterSizeDirty = false;
return undefined;
};
/**
* A event listener function used to style clusters.
* @callback EntityCluster.newClusterCallback
*
* @param {Entity[]} clusteredEntities An array of the entities contained in the cluster.
* @param {object} cluster An object containing the Billboard, Label, and Point
* primitives that represent this cluster of entities.
* @param {Billboard} cluster.billboard
* @param {Label} cluster.label
* @param {PointPrimitive} cluster.point
*
* @example
* // The default cluster values.
* dataSource.clustering.clusterEvent.addEventListener(function(entities, cluster) {
* cluster.label.show = true;
* cluster.label.text = entities.length.toLocaleString();
* });
*/
export default EntityCluster;
|