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 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 | 67826x 67826x 1x 67825x 67825x 67825x 67825x 67825x 6x 1x 5x 67824x 4x 1x 3x 67823x 4x 1x 3x 67822x 3x 1x 2x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 66493x 66493x 67821x 3x 67821x 67821x 67821x 67821x 67821x 67821x 67821x 67820x 67820x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 218588x 218588x 218587x 218587x 1x 544761x 70082x 70080x 26137x 26137x 67147x 69065x 69063x 69063x 68834x 68834x 68834x 68834x 451375x 1307x 1307x 1307x 31x 31x 30x 225711x 1228x 1226x 1226x 197x 197x 150699x 1275x 133x 132x 2x 1272x 1272x 126x 126x 225703x 1277x 132x 131x 2x 1274x 1274x 125x 125x 150699x 1236x 99x 98x 2x 1233x 1233x 92x 92x 300715x 1228x 1226x 1226x 87x 87x 225806x 1233x 1231x 1145x 1145x 158x 1265x 1263x 1124x 1124x 225731x 68947x 68945x 1169x 1169x 526407x 68939x 68937x 68937x 105x 105x 225677x 23x 21x 7x 7x 526384x 23x 21x 21x 7x 7x 450646x 67801x 67792x 67800x 25060x 25060x 525649x 67801x 67792x 67800x 25058x 25058x 300697x 67731x 67729x 6x 6x 225692x 1259x 44x 43x 42x 1x 42x 42x 225692x 1242x 893x 892x 1x 1240x 887x 887x 270x 1239x 1239x 54x 3x 1196x 1196x 51x 35x 67835x 67799x 67799x 36x 36x 606355x 319005x 319005x 225718x 359796x 31x 31x 118246x 134x 64x 64x 786x 1134x 1134x 1134x 22x 22x 786x 1134x 24x 24x 150685x 19x 4x 4x 1x 300345x 66857x 300345x 1x 136687x 1x 1x 137166x 136896x 2x 136894x 270x 270x 270x 270x 270x 270x 5x 5x 5x 270x 223x 47x 3x 47x 47x 5x 5x 44x 44x 2x 2x 2x 44x 42x 42x 42x 42x 42x 1x 292283x 1x 117x 115x 113x 113x 1x 1194x 1194x 1x 1x 66642x 66642x 66642x 66642x 30x 66612x 66612x 66484x 66642x 66642x 66642x 2x 2x 3x 3x 1x 9x 9x 9x 1x 1245x 1245x 1245x 1196x 1196x 1x 225672x 1x 67009x 67001x 67009x 1x 1x 67009x 8x 8x 67001x 66961x 40x 40x 1x 1x 57x 57x 57x 2x 55x 55x 1x 1x 48x 48x 47x 48x 1x 47x 1x 46x 46x 46x 46x 46x 46x 46x 1x 48x 48x 48x 48x 48x 48x 48x 1x 47x 46x 48x 48x 1x 47x 46x 48x 5x 48x 48x 48x 48x 48x 1x 10x 1x 67784x 67784x 15x 15x 67784x 67784x 67784x | import BoundingRectangle from "../Core/BoundingRectangle.js";
import Cartesian2 from "../Core/Cartesian2.js";
import Cartesian3 from "../Core/Cartesian3.js";
import Cartesian4 from "../Core/Cartesian4.js";
import Cartographic from "../Core/Cartographic.js";
import Check from "../Core/Check.js";
import Color from "../Core/Color.js";
import createGuid from "../Core/createGuid.js";
import Frozen from "../Core/Frozen.js";
import defined from "../Core/defined.js";
import DeveloperError from "../Core/DeveloperError.js";
import DistanceDisplayCondition from "../Core/DistanceDisplayCondition.js";
import Ellipsoid from "../Core/Ellipsoid.js";
import Matrix4 from "../Core/Matrix4.js";
import NearFarScalar from "../Core/NearFarScalar.js";
import Resource from "../Core/Resource.js";
import BillboardTexture from "./BillboardTexture.js";
import HeightReference, {
isHeightReferenceRelative,
} from "./HeightReference.js";
import HorizontalOrigin from "./HorizontalOrigin.js";
import SceneMode from "./SceneMode.js";
import SceneTransforms from "./SceneTransforms.js";
import VerticalOrigin from "./VerticalOrigin.js";
import SplitDirection from "./SplitDirection.js";
import getExtensionFromUri from "../Core/getExtensionFromUri.js";
import isDataUri from "../Core/isDataUri.js";
/**
* @typedef {object} Billboard.ConstructorOptions
*
* Initialization options for the first param of Billboard constructor
*
* @property {Cartesian3} position The cartesian position of the billboard.
* @property {*} [id] A user-defined object to return when the billboard is picked with {@link Scene#pick}.
* @property {boolean} [show=true] Determines if this billboard will be shown.
* @property {string | HTMLImageElement | HTMLCanvasElement} [image] A loaded HTMLImageElement, ImageData, or a url to an image to use for the billboard.
* @property {number} [scale=1.0] A number specifying the uniform scale that is multiplied with the billboard's image size in pixels.
* @property {Cartesian2} [pixelOffset=Cartesian2.ZERO] A {@link Cartesian2} Specifying the pixel offset in screen space from the origin of this billboard.
* @property {Cartesian3} [eyeOffset=Cartesian3.ZERO] A {@link Cartesian3} Specifying the 3D Cartesian offset applied to this billboard in eye coordinates.
* @property {HorizontalOrigin} [horizontalOrigin=HorizontalOrigin.CENTER] A {@link HorizontalOrigin} Specifying the horizontal origin of this billboard.
* @property {VerticalOrigin} [verticalOrigin=VerticalOrigin.CENTER] A {@link VerticalOrigin} Specifying the vertical origin of this billboard.
* @property {HeightReference} [heightReference=HeightReference.NONE] A {@link HeightReference} Specifying the height reference of this billboard.
* @property {Color} [color=Color.WHITE] A {@link Color} Specifying the color that is multiplied with the billboard's texture.
* @property {number} [rotation=0] A number specifying the rotation angle in radians.
* @property {Cartesian3} [alignedAxis=Cartesian3.ZERO] A {@link Cartesian3} Specifying the aligned axis in world space.
* @property {boolean} [sizeInMeters] A boolean specifying if the billboard size is in meters or pixels.
* @property {number} [width] A number specifying the width of the billboard. If undefined, the image width will be used.
* @property {number} [height] A number specifying the height of the billboard. If undefined, the image height will be used.
* @property {NearFarScalar} [scaleByDistance] A {@link NearFarScalar} Specifying near and far scaling properties of a Billboard based on the billboard's distance from the camera.
* @property {NearFarScalar} [translucencyByDistance] A {@link NearFarScalar} Specifying near and far translucency properties of a Billboard based on the billboard's distance from the camera.
* @property {NearFarScalar} [pixelOffsetScaleByDistance] A {@link NearFarScalar} Specifying near and far pixel offset scaling properties of a Billboard based on the billboard's distance from the camera.
* @property {BoundingRectangle} [imageSubRegion] A {@link BoundingRectangle} Specifying the sub-region of the image to use for the billboard, rather than the entire image.
* @property {DistanceDisplayCondition} [distanceDisplayCondition] A {@link DistanceDisplayCondition} Specifying the distance from the camera at which this billboard will be displayed.
* @property {number} [disableDepthTestDistance] A number specifying the distance from the camera at which to disable the depth test to, for example, prevent clipping against terrain.
* @property {SplitDirection} [splitDirection] A {@link SplitDirection} Specifying the split property of the billboard.
*/
/**
* <div class="notice">
* A billboard is created and its initial
* properties are set by calling {@link BillboardCollection#add}. Do not call the constructor directly.
* </div>
* A viewport-aligned image positioned in the 3D scene, that is created
* and rendered using a {@link BillboardCollection}.
* <br /><br />
* <div align='center'>
* <img src='Images/Billboard.png' width='400' height='300' /><br />
* Example billboards
* </div>
*
* @alias Billboard
*
* @performance Reading a property, e.g., {@link Billboard#show}, is constant time.
* Assigning to a property is constant time but results in
* CPU to GPU traffic when {@link BillboardCollection#update} is called. The per-billboard traffic is
* the same regardless of how many properties were updated. If most billboards in a collection need to be
* updated, it may be more efficient to clear the collection with {@link BillboardCollection#removeAll}
* and add new billboards instead of modifying each one.
*
* @exception {DeveloperError} scaleByDistance.far must be greater than scaleByDistance.near
* @exception {DeveloperError} translucencyByDistance.far must be greater than translucencyByDistance.near
* @exception {DeveloperError} pixelOffsetScaleByDistance.far must be greater than pixelOffsetScaleByDistance.near
* @exception {DeveloperError} distanceDisplayCondition.far must be greater than distanceDisplayCondition.near
*
* @see BillboardCollection
* @see BillboardCollection#add
* @see Label
*
* @internalConstructor
* @class
*
* @param {Billboard.ConstructorOptions} options Object describing initialization options
* @param {BillboardCollection} billboardCollection Instance of BillboardCollection
*
* @demo {@link https://sandcastle.cesium.com/index.html?src=Billboards.html|Cesium Sandcastle Billboard Demo}
*/
function Billboard(options, billboardCollection) {
options = options ?? Frozen.EMPTY_OBJECT;
//>>includeStart('debug', pragmas.debug);
if (
defined(options.disableDepthTestDistance) &&
options.disableDepthTestDistance < 0.0
) {
throw new DeveloperError(
"disableDepthTestDistance must be greater than or equal to 0.0.",
);
}
//>>includeEnd('debug');
let translucencyByDistance = options.translucencyByDistance;
let pixelOffsetScaleByDistance = options.pixelOffsetScaleByDistance;
let scaleByDistance = options.scaleByDistance;
let distanceDisplayCondition = options.distanceDisplayCondition;
if (defined(translucencyByDistance)) {
//>>includeStart('debug', pragmas.debug);
if (translucencyByDistance.far <= translucencyByDistance.near) {
throw new DeveloperError(
"translucencyByDistance.far must be greater than translucencyByDistance.near.",
);
}
//>>includeEnd('debug');
translucencyByDistance = NearFarScalar.clone(translucencyByDistance);
}
if (defined(pixelOffsetScaleByDistance)) {
//>>includeStart('debug', pragmas.debug);
if (pixelOffsetScaleByDistance.far <= pixelOffsetScaleByDistance.near) {
throw new DeveloperError(
"pixelOffsetScaleByDistance.far must be greater than pixelOffsetScaleByDistance.near.",
);
}
//>>includeEnd('debug');
pixelOffsetScaleByDistance = NearFarScalar.clone(
pixelOffsetScaleByDistance,
);
}
if (defined(scaleByDistance)) {
//>>includeStart('debug', pragmas.debug);
if (scaleByDistance.far <= scaleByDistance.near) {
throw new DeveloperError(
"scaleByDistance.far must be greater than scaleByDistance.near.",
);
}
//>>includeEnd('debug');
scaleByDistance = NearFarScalar.clone(scaleByDistance);
}
if (defined(distanceDisplayCondition)) {
//>>includeStart('debug', pragmas.debug);
if (distanceDisplayCondition.far <= distanceDisplayCondition.near) {
throw new DeveloperError(
"distanceDisplayCondition.far must be greater than distanceDisplayCondition.near.",
);
}
//>>includeEnd('debug');
distanceDisplayCondition = DistanceDisplayCondition.clone(
distanceDisplayCondition,
);
}
this._show = options.show ?? true;
this._position = Cartesian3.clone(options.position ?? Cartesian3.ZERO);
this._actualPosition = Cartesian3.clone(this._position); // For columbus view and 2D
this._pixelOffset = Cartesian2.clone(options.pixelOffset ?? Cartesian2.ZERO);
this._translate = new Cartesian2(0.0, 0.0); // used by labels for glyph vertex translation
this._eyeOffset = Cartesian3.clone(options.eyeOffset ?? Cartesian3.ZERO);
this._heightReference = options.heightReference ?? HeightReference.NONE;
this._verticalOrigin = options.verticalOrigin ?? VerticalOrigin.CENTER;
this._horizontalOrigin = options.horizontalOrigin ?? HorizontalOrigin.CENTER;
this._scale = options.scale ?? 1.0;
this._color = Color.clone(options.color ?? Color.WHITE);
this._rotation = options.rotation ?? 0.0;
this._alignedAxis = Cartesian3.clone(options.alignedAxis ?? Cartesian3.ZERO);
this._width = options.width;
this._height = options.height;
this._scaleByDistance = scaleByDistance;
this._translucencyByDistance = translucencyByDistance;
this._pixelOffsetScaleByDistance = pixelOffsetScaleByDistance;
this._sizeInMeters = options.sizeInMeters ?? false;
this._distanceDisplayCondition = distanceDisplayCondition;
this._disableDepthTestDistance = options.disableDepthTestDistance;
this._id = options.id;
this._collection = options.collection ?? billboardCollection; // Used only for pick ids
this._pickId = undefined;
this._pickPrimitive = options._pickPrimitive ?? this;
this._billboardCollection = billboardCollection;
this._dirty = false;
this._index = -1; // Used only by BillboardCollection
this._batchIndex = undefined; // Used only by Vector3DTilePoints and BillboardCollection
this._imageTexture = new BillboardTexture(billboardCollection);
this._imageId = options.imageId;
this._imageWidth = undefined;
this._imageHeight = undefined;
this._labelDimensions = undefined;
this._labelHorizontalOrigin = undefined;
this._labelTranslate = undefined;
const image = options.image;
if (defined(image)) {
this._computeImageTextureProperties(options.imageId, image);
this._imageTexture.loadImage(
this._imageId,
image,
this._imageWidth,
this._imageHeight,
);
}
if (defined(options.imageSubRegion)) {
this._imageTexture.addImageSubRegion(this._imageId, options.imageSubRegion);
}
this._actualClampedPosition = undefined;
this._removeCallbackFunc = undefined;
this._mode = SceneMode.SCENE3D;
this._clusterShow = true;
this._outlineColor = Color.clone(options.outlineColor ?? Color.BLACK);
this._outlineWidth = options.outlineWidth ?? 0.0;
this._updateClamping();
this._splitDirection = options.splitDirection ?? SplitDirection.NONE;
// Primarily used by labels to indicate that the position is derived from the parent.
// and expensive operations like clamping can be skipped.
this._positionFromParent = false;
}
const SHOW_INDEX = (Billboard.SHOW_INDEX = 0);
const POSITION_INDEX = (Billboard.POSITION_INDEX = 1);
const PIXEL_OFFSET_INDEX = (Billboard.PIXEL_OFFSET_INDEX = 2);
const EYE_OFFSET_INDEX = (Billboard.EYE_OFFSET_INDEX = 3);
const HORIZONTAL_ORIGIN_INDEX = (Billboard.HORIZONTAL_ORIGIN_INDEX = 4);
const VERTICAL_ORIGIN_INDEX = (Billboard.VERTICAL_ORIGIN_INDEX = 5);
const SCALE_INDEX = (Billboard.SCALE_INDEX = 6);
const IMAGE_INDEX_INDEX = (Billboard.IMAGE_INDEX_INDEX = 7);
const COLOR_INDEX = (Billboard.COLOR_INDEX = 8);
const ROTATION_INDEX = (Billboard.ROTATION_INDEX = 9);
const ALIGNED_AXIS_INDEX = (Billboard.ALIGNED_AXIS_INDEX = 10);
const SCALE_BY_DISTANCE_INDEX = (Billboard.SCALE_BY_DISTANCE_INDEX = 11);
const TRANSLUCENCY_BY_DISTANCE_INDEX =
(Billboard.TRANSLUCENCY_BY_DISTANCE_INDEX = 12);
const PIXEL_OFFSET_SCALE_BY_DISTANCE_INDEX =
(Billboard.PIXEL_OFFSET_SCALE_BY_DISTANCE_INDEX = 13);
const DISTANCE_DISPLAY_CONDITION = (Billboard.DISTANCE_DISPLAY_CONDITION = 14);
const DISABLE_DEPTH_DISTANCE = (Billboard.DISABLE_DEPTH_DISTANCE = 15);
Billboard.TEXTURE_COORDINATE_BOUNDS = 16;
const SDF_INDEX = (Billboard.SDF_INDEX = 17);
const SPLIT_DIRECTION_INDEX = (Billboard.SPLIT_DIRECTION_INDEX = 18);
Billboard.NUMBER_OF_PROPERTIES = 19;
function makeDirty(billboard, propertyChanged) {
const billboardCollection = billboard._billboardCollection;
if (defined(billboardCollection)) {
billboardCollection._updateBillboard(billboard, propertyChanged);
billboard._dirty = true;
}
}
Object.defineProperties(Billboard.prototype, {
/**
* Determines if this billboard will be shown. Use this to hide or show a billboard, instead
* of removing it and re-adding it to the collection.
* @memberof Billboard.prototype
* @type {boolean}
* @default true
*/
show: {
get: function () {
return this._show;
},
set: function (value) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.bool("value", value);
//>>includeEnd('debug');
if (this._show !== value) {
this._show = value;
makeDirty(this, SHOW_INDEX);
}
},
},
/**
* Gets or sets the Cartesian position of this billboard.
* @memberof Billboard.prototype
* @type {Cartesian3}
*/
position: {
get: function () {
return this._position;
},
set: function (value) {
//>>includeStart('debug', pragmas.debug)
Check.typeOf.object("value", value);
//>>includeEnd('debug');
const position = this._position;
if (!Cartesian3.equals(position, value)) {
Cartesian3.clone(value, position);
Cartesian3.clone(value, this._actualPosition);
this._updateClamping();
makeDirty(this, POSITION_INDEX);
}
},
},
/**
* Gets or sets the height reference of this billboard.
* @memberof Billboard.prototype
* @type {HeightReference}
* @default HeightReference.NONE
*/
heightReference: {
get: function () {
return this._heightReference;
},
set: function (value) {
//>>includeStart('debug', pragmas.debug)
Check.typeOf.number("value", value);
//>>includeEnd('debug');
const heightReference = this._heightReference;
if (value !== heightReference) {
this._heightReference = value;
this._updateClamping();
makeDirty(this, POSITION_INDEX);
}
},
},
/**
* Gets or sets the pixel offset in screen space from the origin of this billboard. This is commonly used
* to align multiple billboards and labels at the same position, e.g., an image and text. The
* screen space origin is the top, left corner of the canvas; <code>x</code> increases from
* left to right, and <code>y</code> increases from top to bottom.
* <br /><br />
* <div align='center'>
* <table border='0' cellpadding='5'><tr>
* <td align='center'><code>default</code><br/><img src='Images/Billboard.setPixelOffset.default.png' width='250' height='188' /></td>
* <td align='center'><code>b.pixeloffset = new Cartesian2(50, 25);</code><br/><img src='Images/Billboard.setPixelOffset.x50y-25.png' width='250' height='188' /></td>
* </tr></table>
* The billboard's origin is indicated by the yellow point.
* </div>
* @memberof Billboard.prototype
* @type {Cartesian2}
*/
pixelOffset: {
get: function () {
return this._pixelOffset;
},
set: function (value) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.object("value", value);
//>>includeEnd('debug');
const pixelOffset = this._pixelOffset;
if (!Cartesian2.equals(pixelOffset, value)) {
Cartesian2.clone(value, pixelOffset);
makeDirty(this, PIXEL_OFFSET_INDEX);
}
},
},
/**
* Gets or sets near and far scaling properties of a Billboard based on the billboard's distance from the camera.
* A billboard's scale will interpolate between the {@link NearFarScalar#nearValue} and
* {@link NearFarScalar#farValue} while the camera distance falls within the lower and upper bounds
* of the specified {@link NearFarScalar#near} and {@link NearFarScalar#far}.
* Outside of these ranges the billboard's scale remains clamped to the nearest bound. If undefined,
* scaleByDistance will be disabled.
* @memberof Billboard.prototype
* @type {NearFarScalar}
*
* @example
* // Example 1.
* // Set a billboard's scaleByDistance to scale by 1.5 when the
* // camera is 1500 meters from the billboard and disappear as
* // the camera distance approaches 8.0e6 meters.
* b.scaleByDistance = new Cesium.NearFarScalar(1.5e2, 1.5, 8.0e6, 0.0);
*
* @example
* // Example 2.
* // disable scaling by distance
* b.scaleByDistance = undefined;
*/
scaleByDistance: {
get: function () {
return this._scaleByDistance;
},
set: function (value) {
//>>includeStart('debug', pragmas.debug);
if (defined(value)) {
Check.typeOf.object("value", value);
if (value.far <= value.near) {
throw new DeveloperError(
"far distance must be greater than near distance.",
);
}
}
//>>includeEnd('debug');
const scaleByDistance = this._scaleByDistance;
if (!NearFarScalar.equals(scaleByDistance, value)) {
this._scaleByDistance = NearFarScalar.clone(value, scaleByDistance);
makeDirty(this, SCALE_BY_DISTANCE_INDEX);
}
},
},
/**
* Gets or sets near and far translucency properties of a Billboard based on the billboard's distance from the camera.
* A billboard's translucency will interpolate between the {@link NearFarScalar#nearValue} and
* {@link NearFarScalar#farValue} while the camera distance falls within the lower and upper bounds
* of the specified {@link NearFarScalar#near} and {@link NearFarScalar#far}.
* Outside of these ranges the billboard's translucency remains clamped to the nearest bound. If undefined,
* translucencyByDistance will be disabled.
* @memberof Billboard.prototype
* @type {NearFarScalar}
*
* @example
* // Example 1.
* // Set a billboard's translucency to 1.0 when the
* // camera is 1500 meters from the billboard and disappear as
* // the camera distance approaches 8.0e6 meters.
* b.translucencyByDistance = new Cesium.NearFarScalar(1.5e2, 1.0, 8.0e6, 0.0);
*
* @example
* // Example 2.
* // disable translucency by distance
* b.translucencyByDistance = undefined;
*/
translucencyByDistance: {
get: function () {
return this._translucencyByDistance;
},
set: function (value) {
//>>includeStart('debug', pragmas.debug);
if (defined(value)) {
Check.typeOf.object("value", value);
if (value.far <= value.near) {
throw new DeveloperError(
"far distance must be greater than near distance.",
);
}
}
//>>includeEnd('debug');
const translucencyByDistance = this._translucencyByDistance;
if (!NearFarScalar.equals(translucencyByDistance, value)) {
this._translucencyByDistance = NearFarScalar.clone(
value,
translucencyByDistance,
);
makeDirty(this, TRANSLUCENCY_BY_DISTANCE_INDEX);
}
},
},
/**
* Gets or sets near and far pixel offset scaling properties of a Billboard based on the billboard's distance from the camera.
* A billboard's pixel offset will be scaled between the {@link NearFarScalar#nearValue} and
* {@link NearFarScalar#farValue} while the camera distance falls within the lower and upper bounds
* of the specified {@link NearFarScalar#near} and {@link NearFarScalar#far}.
* Outside of these ranges the billboard's pixel offset scale remains clamped to the nearest bound. If undefined,
* pixelOffsetScaleByDistance will be disabled.
* @memberof Billboard.prototype
* @type {NearFarScalar}
*
* @example
* // Example 1.
* // Set a billboard's pixel offset scale to 0.0 when the
* // camera is 1500 meters from the billboard and scale pixel offset to 10.0 pixels
* // in the y direction the camera distance approaches 8.0e6 meters.
* b.pixelOffset = new Cesium.Cartesian2(0.0, 1.0);
* b.pixelOffsetScaleByDistance = new Cesium.NearFarScalar(1.5e2, 0.0, 8.0e6, 10.0);
*
* @example
* // Example 2.
* // disable pixel offset by distance
* b.pixelOffsetScaleByDistance = undefined;
*/
pixelOffsetScaleByDistance: {
get: function () {
return this._pixelOffsetScaleByDistance;
},
set: function (value) {
//>>includeStart('debug', pragmas.debug);
if (defined(value)) {
Check.typeOf.object("value", value);
if (value.far <= value.near) {
throw new DeveloperError(
"far distance must be greater than near distance.",
);
}
}
//>>includeEnd('debug');
const pixelOffsetScaleByDistance = this._pixelOffsetScaleByDistance;
if (!NearFarScalar.equals(pixelOffsetScaleByDistance, value)) {
this._pixelOffsetScaleByDistance = NearFarScalar.clone(
value,
pixelOffsetScaleByDistance,
);
makeDirty(this, PIXEL_OFFSET_SCALE_BY_DISTANCE_INDEX);
}
},
},
/**
* Gets or sets the 3D Cartesian offset applied to this billboard in eye coordinates. Eye coordinates is a left-handed
* coordinate system, where <code>x</code> points towards the viewer's right, <code>y</code> points up, and
* <code>z</code> points into the screen. Eye coordinates use the same scale as world and model coordinates,
* which is typically meters.
* <br /><br />
* An eye offset is commonly used to arrange multiple billboards or objects at the same position, e.g., to
* arrange a billboard above its corresponding 3D model.
* <br /><br />
* Below, the billboard is positioned at the center of the Earth but an eye offset makes it always
* appear on top of the Earth regardless of the viewer's or Earth's orientation.
* <br /><br />
* <div align='center'>
* <table border='0' cellpadding='5'><tr>
* <td align='center'><img src='Images/Billboard.setEyeOffset.one.png' width='250' height='188' /></td>
* <td align='center'><img src='Images/Billboard.setEyeOffset.two.png' width='250' height='188' /></td>
* </tr></table>
* <code>b.eyeOffset = new Cartesian3(0.0, 8000000.0, 0.0);</code><br /><br />
* </div>
* @memberof Billboard.prototype
* @type {Cartesian3}
*/
eyeOffset: {
get: function () {
return this._eyeOffset;
},
set: function (value) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.object("value", value);
//>>includeEnd('debug');
const eyeOffset = this._eyeOffset;
if (!Cartesian3.equals(eyeOffset, value)) {
Cartesian3.clone(value, eyeOffset);
makeDirty(this, EYE_OFFSET_INDEX);
}
},
},
/**
* Gets or sets the horizontal origin of this billboard, which determines if the billboard is
* to the left, center, or right of its anchor position.
* <br /><br />
* <div align='center'>
* <img src='Images/Billboard.setHorizontalOrigin.png' width='648' height='196' /><br />
* </div>
* @memberof Billboard.prototype
* @type {HorizontalOrigin}
* @example
* // Use a bottom, left origin
* b.horizontalOrigin = Cesium.HorizontalOrigin.LEFT;
* b.verticalOrigin = Cesium.VerticalOrigin.BOTTOM;
*/
horizontalOrigin: {
get: function () {
return this._horizontalOrigin;
},
set: function (value) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.number("value", value);
//>>includeEnd('debug');
if (this._horizontalOrigin !== value) {
this._horizontalOrigin = value;
makeDirty(this, HORIZONTAL_ORIGIN_INDEX);
}
},
},
/**
* Gets or sets the vertical origin of this billboard, which determines if the billboard is
* to the above, below, or at the center of its anchor position.
* <br /><br />
* <div align='center'>
* <img src='Images/Billboard.setVerticalOrigin.png' width='695' height='175' /><br />
* </div>
* @memberof Billboard.prototype
* @type {VerticalOrigin}
* @example
* // Use a bottom, left origin
* b.horizontalOrigin = Cesium.HorizontalOrigin.LEFT;
* b.verticalOrigin = Cesium.VerticalOrigin.BOTTOM;
*/
verticalOrigin: {
get: function () {
return this._verticalOrigin;
},
set: function (value) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.number("value", value);
//>>includeEnd('debug');
if (this._verticalOrigin !== value) {
this._verticalOrigin = value;
makeDirty(this, VERTICAL_ORIGIN_INDEX);
}
},
},
/**
* Gets or sets the uniform scale that is multiplied with the billboard's image size in pixels.
* A scale of <code>1.0</code> does not change the size of the billboard; a scale greater than
* <code>1.0</code> enlarges the billboard; a positive scale less than <code>1.0</code> shrinks
* the billboard.
* <br /><br />
* <div align='center'>
* <img src='Images/Billboard.setScale.png' width='400' height='300' /><br/>
* From left to right in the above image, the scales are <code>0.5</code>, <code>1.0</code>,
* and <code>2.0</code>.
* </div>
* @memberof Billboard.prototype
* @type {number}
*/
scale: {
get: function () {
return this._scale;
},
set: function (value) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.number("value", value);
//>>includeEnd('debug');
if (this._scale !== value) {
this._scale = value;
makeDirty(this, SCALE_INDEX);
}
},
},
/**
* Gets or sets the color that is multiplied with the billboard's texture. This has two common use cases. First,
* the same white texture may be used by many different billboards, each with a different color, to create
* colored billboards. Second, the color's alpha component can be used to make the billboard translucent as shown below.
* An alpha of <code>0.0</code> makes the billboard transparent, and <code>1.0</code> makes the billboard opaque.
* <br /><br />
* <div align='center'>
* <table border='0' cellpadding='5'><tr>
* <td align='center'><code>default</code><br/><img src='Images/Billboard.setColor.Alpha255.png' width='250' height='188' /></td>
* <td align='center'><code>alpha : 0.5</code><br/><img src='Images/Billboard.setColor.Alpha127.png' width='250' height='188' /></td>
* </tr></table>
* </div>
* <br />
* The red, green, blue, and alpha values are indicated by <code>value</code>'s <code>red</code>, <code>green</code>,
* <code>blue</code>, and <code>alpha</code> properties as shown in Example 1. These components range from <code>0.0</code>
* (no intensity) to <code>1.0</code> (full intensity).
* @memberof Billboard.prototype
* @type {Color}
*
* @example
* // Example 1. Assign yellow.
* b.color = Cesium.Color.YELLOW;
*
* @example
* // Example 2. Make a billboard 50% translucent.
* b.color = new Cesium.Color(1.0, 1.0, 1.0, 0.5);
*/
color: {
get: function () {
return this._color;
},
set: function (value) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.object("value", value);
//>>includeEnd('debug');
const color = this._color;
if (!Color.equals(color, value)) {
Color.clone(value, color);
makeDirty(this, COLOR_INDEX);
}
},
},
/**
* Gets or sets the rotation angle in radians.
* @memberof Billboard.prototype
* @type {number}
*/
rotation: {
get: function () {
return this._rotation;
},
set: function (value) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.number("value", value);
//>>includeEnd('debug');
if (this._rotation !== value) {
this._rotation = value;
makeDirty(this, ROTATION_INDEX);
}
},
},
/**
* Gets or sets the aligned axis in world space. The aligned axis is the unit vector that the billboard up vector points towards.
* The default is the zero vector, which means the billboard is aligned to the screen up vector.
* @memberof Billboard.prototype
* @type {Cartesian3}
* @example
* // Example 1.
* // Have the billboard up vector point north
* billboard.alignedAxis = Cesium.Cartesian3.UNIT_Z;
*
* @example
* // Example 2.
* // Have the billboard point east.
* billboard.alignedAxis = Cesium.Cartesian3.UNIT_Z;
* billboard.rotation = -Cesium.Math.PI_OVER_TWO;
*
* @example
* // Example 3.
* // Reset the aligned axis
* billboard.alignedAxis = Cesium.Cartesian3.ZERO;
*/
alignedAxis: {
get: function () {
return this._alignedAxis;
},
set: function (value) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.object("value", value);
//>>includeEnd('debug');
const alignedAxis = this._alignedAxis;
if (!Cartesian3.equals(alignedAxis, value)) {
Cartesian3.clone(value, alignedAxis);
makeDirty(this, ALIGNED_AXIS_INDEX);
}
},
},
/**
* Gets or sets a width for the billboard. If undefined, the image width will be used.
* @memberof Billboard.prototype
* @type {number|undefined}
*/
width: {
get: function () {
return this._width ?? this._imageTexture.width;
},
set: function (value) {
//>>includeStart('debug', pragmas.debug);
if (defined(value)) {
Check.typeOf.number("width", value);
}
//>>includeEnd('debug');
if (this._width !== value) {
this._width = value;
makeDirty(this, IMAGE_INDEX_INDEX);
}
},
},
/**
* Gets or sets a height for the billboard. If undefined, the image height will be used.
* @memberof Billboard.prototype
* @type {number|undefined}
*/
height: {
get: function () {
return this._height ?? this._imageTexture.height;
},
set: function (value) {
//>>includeStart('debug', pragmas.debug);
if (defined(value)) {
Check.typeOf.number("height", value);
}
//>>includeEnd('debug');
if (this._height !== value) {
this._height = value;
makeDirty(this, IMAGE_INDEX_INDEX);
}
},
},
/**
* Gets or sets if the billboard size is in meters or pixels. <code>true</code> to size the billboard in meters;
* otherwise, the size is in pixels.
* @memberof Billboard.prototype
* @type {boolean}
* @default false
*/
sizeInMeters: {
get: function () {
return this._sizeInMeters;
},
set: function (value) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.bool("value", value);
//>>includeEnd('debug');
if (this._sizeInMeters !== value) {
this._sizeInMeters = value;
makeDirty(this, COLOR_INDEX);
}
},
},
/**
* Gets or sets the condition specifying at what distance from the camera that this billboard will be displayed.
* @memberof Billboard.prototype
* @type {DistanceDisplayCondition}
* @default undefined
*/
distanceDisplayCondition: {
get: function () {
return this._distanceDisplayCondition;
},
set: function (value) {
if (
!DistanceDisplayCondition.equals(value, this._distanceDisplayCondition)
) {
//>>includeStart('debug', pragmas.debug);
if (defined(value)) {
Check.typeOf.object("value", value);
if (value.far <= value.near) {
throw new DeveloperError(
"far distance must be greater than near distance.",
);
}
}
//>>includeEnd('debug');
this._distanceDisplayCondition = DistanceDisplayCondition.clone(
value,
this._distanceDisplayCondition,
);
makeDirty(this, DISTANCE_DISPLAY_CONDITION);
}
},
},
/**
* Gets or sets the distance from the camera at which to disable the depth test to, for example, prevent clipping against terrain.
* When set to zero, the depth test is always applied. When set to Number.POSITIVE_INFINITY, the depth test is never applied.
* @memberof Billboard.prototype
* @type {number}
*/
disableDepthTestDistance: {
get: function () {
return this._disableDepthTestDistance;
},
set: function (value) {
//>>includeStart('debug', pragmas.debug);
if (defined(value)) {
Check.typeOf.number("value", value);
if (value < 0.0) {
throw new DeveloperError(
"disableDepthTestDistance must be greater than or equal to 0.0.",
);
}
}
//>>includeEnd('debug');
if (this._disableDepthTestDistance !== value) {
this._disableDepthTestDistance = value;
makeDirty(this, DISABLE_DEPTH_DISTANCE);
}
},
},
/**
* Gets or sets the user-defined object returned when the billboard is picked.
* @memberof Billboard.prototype
* @type {*}
*/
id: {
get: function () {
return this._id;
},
set: function (value) {
this._id = value;
if (defined(this._pickId)) {
this._pickId.object.id = value;
}
},
},
/**
* The primitive to return when picking this billboard.
* @memberof Billboard.prototype
* @private
*/
pickPrimitive: {
get: function () {
return this._pickPrimitive;
},
set: function (value) {
this._pickPrimitive = value;
if (defined(this._pickId)) {
this._pickId.object.primitive = value;
}
},
},
/**
* @private
*/
pickId: {
get: function () {
return this._pickId;
},
},
/**
* <p>
* Gets or sets the image to be used for this billboard. If a texture has already been created for the
* given image, the existing texture is used.
* </p>
* <p>
* This property can be set to a loaded Image, a URL which will be loaded as an Image automatically,
* a canvas, or another billboard's image property (from the same billboard collection).
* </p>
*
* @memberof Billboard.prototype
* @type {string}
* @example
* // load an image from a URL
* b.image = 'some/image/url.png';
*
* // assuming b1 and b2 are billboards in the same billboard collection,
* // use the same image for both billboards.
* b2.image = b1.image;
*/
image: {
get: function () {
return this._imageTexture.id;
},
set: function (value) {
if (!defined(value)) {
this._imageTexture.unload();
return;
}
this._computeImageTextureProperties(undefined, value);
this._imageTexture.loadImage(
this._imageId,
value,
this._imageWidth,
this._imageHeight,
);
},
},
/**
* When <code>true</code>, this billboard is ready to render, i.e., the image
* has been downloaded and the WebGL resources are created.
* @memberof Billboard.prototype
* @type {boolean}
* @readonly
* @default false
*/
ready: {
get: function () {
return this._imageTexture.ready;
},
},
/**
* If defined, this error was encountered during the loading process.
* @memberof Billboard.prototype
* @type {Error|undefined}
* @readonly
* @private
*/
loadError: {
get: function () {
return this._imageTexture.loadError;
},
},
/**
* Used by <code>billboardCollection</code> to track which billboards to update based on image load status.
* @memberof Billboard.prototype
* @type {boolean}
* @private
* @default false
*/
textureDirty: {
get: function () {
return this._imageTexture.dirty;
},
set: function (value) {
this._imageTexture.dirty = value;
},
},
/**
* Keeps track of the position of the billboard based on the height reference.
* @memberof Billboard.prototype
* @type {Cartesian3}
* @private
*/
_clampedPosition: {
get: function () {
return this._actualClampedPosition;
},
set: function (value) {
this._actualClampedPosition = Cartesian3.clone(
value,
this._actualClampedPosition,
);
makeDirty(this, POSITION_INDEX);
},
},
/**
* Determines whether or not this billboard will be shown or hidden because it was clustered.
* @memberof Billboard.prototype
* @type {boolean}
* @private
*/
clusterShow: {
get: function () {
return this._clusterShow;
},
set: function (value) {
if (this._clusterShow !== value) {
this._clusterShow = value;
makeDirty(this, SHOW_INDEX);
}
},
},
/**
* The outline color of this Billboard. Effective only for SDF billboards like Label glyphs.
* @memberof Billboard.prototype
* @type {Color}
* @private
*/
outlineColor: {
get: function () {
return this._outlineColor;
},
set: function (value) {
//>>includeStart('debug', pragmas.debug);
Iif (!defined(value)) {
throw new DeveloperError("value is required.");
}
//>>includeEnd('debug');
const outlineColor = this._outlineColor;
if (!Color.equals(outlineColor, value)) {
Color.clone(value, outlineColor);
makeDirty(this, SDF_INDEX);
}
},
},
/**
* The outline width of this Billboard in pixels. Effective only for SDF billboards like Label glyphs.
* @memberof Billboard.prototype
* @type {number}
* @private
*/
outlineWidth: {
get: function () {
return this._outlineWidth;
},
set: function (value) {
if (this._outlineWidth !== value) {
this._outlineWidth = value;
makeDirty(this, SDF_INDEX);
}
},
},
/**
* Gets or sets the {@link SplitDirection} of this billboard.
* @memberof Billboard.prototype
* @type {SplitDirection}
* @default {@link SplitDirection.NONE}
*/
splitDirection: {
get: function () {
return this._splitDirection;
},
set: function (value) {
if (this._splitDirection !== value) {
this._splitDirection = value;
makeDirty(this, SPLIT_DIRECTION_INDEX);
}
},
},
});
Billboard.prototype.getPickId = function (context) {
if (!defined(this._pickId)) {
this._pickId = context.createPickId({
primitive: this._pickPrimitive,
collection: this._collection,
id: this._id,
});
}
return this._pickId;
};
Billboard.prototype._updateClamping = function () {
Billboard._updateClamping(this._billboardCollection, this);
};
const scratchCartographic = new Cartographic();
Billboard._updateClamping = function (collection, owner) {
if (!defined(collection) || !defined(collection._scene)) {
//>>includeStart('debug', pragmas.debug);
if (owner._heightReference !== HeightReference.NONE) {
throw new DeveloperError(
"Height reference is not supported without a scene.",
);
}
//>>includeEnd('debug');
return;
}
const scene = collection._scene;
const ellipsoid = scene.ellipsoid ?? Ellipsoid.default;
const mode = scene.frameState.mode;
const modeChanged = mode !== owner._mode;
owner._mode = mode;
if (
(owner._heightReference === HeightReference.NONE || modeChanged) &&
defined(owner._removeCallbackFunc)
) {
owner._removeCallbackFunc();
owner._removeCallbackFunc = undefined;
owner._clampedPosition = undefined;
}
if (
owner._heightReference === HeightReference.NONE ||
owner._positionFromParent ||
!defined(owner._position)
) {
return;
}
if (defined(owner._removeCallbackFunc)) {
owner._removeCallbackFunc();
}
const position = ellipsoid.cartesianToCartographic(owner._position);
if (!defined(position)) {
owner._actualClampedPosition = undefined;
return;
}
function updateFunction(clampedPosition) {
const updatedClampedPosition = ellipsoid.cartographicToCartesian(
clampedPosition,
owner._clampedPosition,
);
if (isHeightReferenceRelative(owner._heightReference)) {
if (owner._mode === SceneMode.SCENE3D) {
clampedPosition.height += position.height;
ellipsoid.cartographicToCartesian(
clampedPosition,
updatedClampedPosition,
);
} else E{
updatedClampedPosition.x += position.height;
}
}
owner._clampedPosition = updatedClampedPosition;
}
owner._removeCallbackFunc = scene.updateHeight(
position,
updateFunction,
owner._heightReference,
);
Cartographic.clone(position, scratchCartographic);
const height = scene.getHeight(position, owner._heightReference);
Iif (defined(height)) {
scratchCartographic.height = height;
}
updateFunction(scratchCartographic);
};
/**
* Get the texture coordinates for reading the loaded texture in shaders.
* @param {BoundingRectangle} [result] The modified result parameter or a new BoundingRectangle instance if one was not provided.
* @return {BoundingRectangle} The modified result parameter or a new BoundingRectangle instance if one was not provided.
* @private
*/
Billboard.prototype.computeTextureCoordinates = function (result) {
return this._imageTexture.computeTextureCoordinates(result);
};
/**
* <p>
* Sets the image to be used for this billboard. If a texture has already been created for the
* given id, the existing texture is used.
* </p>
* <p>
* This function is useful for dynamically creating textures that are shared across many billboards.
* Only the first billboard will actually call the function and create the texture, while subsequent
* billboards created with the same id will simply re-use the existing texture.
* </p>
* <p>
* To load an image from a URL, setting the {@link Billboard#image} property is more convenient.
* </p>
*
* @param {string} id The id of the image. This can be any string that uniquely identifies the image.
* @param {HTMLImageElement|HTMLCanvasElement|string|Resource|Billboard.CreateImageCallback} image The image to load. This parameter
* can either be a loaded Image or Canvas, a URL which will be loaded as an Image automatically,
* or a function which will be called to create the image if it hasn't been loaded already.
* @example
* // create a billboard image dynamically
* function drawImage(id) {
* // create and draw an image using a canvas
* const canvas = document.createElement('canvas');
* const context2D = canvas.getContext('2d');
* // ... draw image
* return canvas;
* }
* // drawImage will be called to create the texture
* b.setImage('myImage', drawImage);
*
* // subsequent billboards created in the same collection using the same id will use the existing
* // texture, without the need to create the canvas or draw the image
* b2.setImage('myImage', drawImage);
*/
Billboard.prototype.setImage = function (id, image) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.string("id", id);
Check.defined("image", image);
//>>includeEnd('debug');
this._computeImageTextureProperties(id, image);
this._imageTexture.loadImage(
this._imageId,
image,
this._imageWidth,
this._imageHeight,
);
};
/**
* Copy the values of an existing billboard texture into this one. Useful for prevent downtime for images that have already been loaded.
* @private
* @param {BillboardTexture} billboardTexture
*/
Billboard.prototype.setImageTexture = function (billboardTexture) {
//>>includeStart('debug', pragmas.debug);
Check.defined("billboardTexture", billboardTexture);
//>>includeEnd('debug');
BillboardTexture.clone(billboardTexture, this._imageTexture);
};
/** Arbitrary limit on allocated SVG size, in pixels. Raster images use image resolution. */
const SVG_MAX_SIZE_PX = 512;
/**
* Computes billboard texture ID, width, and height. For raster images, width and height are left
* undefined, defaulting to image resolution. For SVG, use billboard pixel width and height.
* @param {string | undefined} id The id of the image.
* @param {string | HTMLImageElement | HTMLCanvasElement | undefined} image A loaded HTMLImageElement, ImageData, or a url to an image to use for the billboard.
* @private
*/
Billboard.prototype._computeImageTextureProperties = function (id, image) {
this._imageWidth = undefined;
this._imageHeight = undefined;
Iif (!defined(image)) {
this._imageId = createGuid();
return;
}
let imageUri;
if (typeof image === "string") {
imageUri = image;
} else Iif (image instanceof Resource) {
imageUri = image._url;
} else if (defined(image.src)) {
imageUri = image.src;
}
this._imageId = id ?? imageUri ?? createGuid();
const hasSizeInPixels =
defined(this._width) && defined(this._height) && !this._sizeInMeters;
if (hasSizeInPixels && isSvgUri(imageUri)) {
this._imageWidth = Math.min(this._width, SVG_MAX_SIZE_PX);
this._imageHeight = Math.min(this._height, SVG_MAX_SIZE_PX);
}
};
function isSvgUri(uri) {
Iif (!defined(uri)) {
return false;
}
return isDataUri(uri)
? uri.startsWith("data:image/svg+xml")
: getExtensionFromUri(uri) === "svg";
}
/**
* Uses a sub-region of the image with the given id as the image for this billboard,
* measured in pixels from the bottom-left.
*
* @param {string} id The id of the image to use.
* @param {BoundingRectangle} subRegion The sub-region of the image.
*
* @exception {RuntimeError} image with id must be in the atlas
*/
Billboard.prototype.setImageSubRegion = function (id, subRegion) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.string("id", id);
Check.defined("subRegion", subRegion);
//>>includeEnd('debug');
this._imageTexture.addImageSubRegion(id, subRegion);
};
Billboard.prototype._setTranslate = function (value) {
//>>includeStart('debug', pragmas.debug);
Iif (!defined(value)) {
throw new DeveloperError("value is required.");
}
//>>includeEnd('debug');
const translate = this._translate;
if (!Cartesian2.equals(translate, value)) {
Cartesian2.clone(value, translate);
makeDirty(this, PIXEL_OFFSET_INDEX);
}
};
Billboard.prototype._getActualPosition = function () {
return defined(this._clampedPosition)
? this._clampedPosition
: this._actualPosition;
};
Billboard.prototype._setActualPosition = function (value) {
if (!defined(this._clampedPosition)) {
Cartesian3.clone(value, this._actualPosition);
}
makeDirty(this, POSITION_INDEX);
};
const tempCartesian3 = new Cartesian4();
Billboard._computeActualPosition = function (
billboard,
position,
frameState,
modelMatrix,
) {
if (defined(billboard._clampedPosition)) {
Iif (frameState.mode !== billboard._mode) {
billboard._updateClamping();
}
return billboard._clampedPosition;
} else if (frameState.mode === SceneMode.SCENE3D) {
return position;
}
Matrix4.multiplyByPoint(modelMatrix, position, tempCartesian3);
return SceneTransforms.computeActualEllipsoidPosition(
frameState,
tempCartesian3,
);
};
const scratchCartesian3 = new Cartesian3();
// This function is basically a stripped-down JavaScript version of BillboardCollectionVS.glsl
Billboard._computeScreenSpacePosition = function (
modelMatrix,
position,
eyeOffset,
pixelOffset,
scene,
result,
) {
// Model to world coordinates
const positionWorld = Matrix4.multiplyByPoint(
modelMatrix,
position,
scratchCartesian3,
);
// World to window coordinates
const positionWC = SceneTransforms.worldWithEyeOffsetToWindowCoordinates(
scene,
positionWorld,
eyeOffset,
result,
);
if (!defined(positionWC)) {
return undefined;
}
// Apply pixel offset
Cartesian2.add(positionWC, pixelOffset, positionWC);
return positionWC;
};
const scratchPixelOffset = new Cartesian2(0.0, 0.0);
/**
* Computes the screen-space position of the billboard's origin, taking into account eye and pixel offsets.
* The screen space origin is the top, left corner of the canvas; <code>x</code> increases from
* left to right, and <code>y</code> increases from top to bottom.
*
* @param {Scene} scene The scene.
* @param {Cartesian2} [result] The object onto which to store the result.
* @returns {Cartesian2} The screen-space position of the billboard.
*
* @exception {DeveloperError} Billboard must be in a collection.
*
* @example
* console.log(b.computeScreenSpacePosition(scene).toString());
*
* @see Billboard#eyeOffset
* @see Billboard#pixelOffset
*/
Billboard.prototype.computeScreenSpacePosition = function (scene, result) {
const billboardCollection = this._billboardCollection;
if (!defined(result)) {
result = new Cartesian2();
}
//>>includeStart('debug', pragmas.debug);
if (!defined(billboardCollection)) {
throw new DeveloperError(
"Billboard must be in a collection. Was it removed?",
);
}
if (!defined(scene)) {
throw new DeveloperError("scene is required.");
}
//>>includeEnd('debug');
// pixel offset for screen space computation is the pixelOffset + screen space translate
Cartesian2.clone(this._pixelOffset, scratchPixelOffset);
Cartesian2.add(scratchPixelOffset, this._translate, scratchPixelOffset);
let modelMatrix = billboardCollection.modelMatrix;
let position = this._position;
Iif (defined(this._clampedPosition)) {
position = this._clampedPosition;
if (scene.mode !== SceneMode.SCENE3D) {
// position needs to be in world coordinates
const projection = scene.mapProjection;
const ellipsoid = projection.ellipsoid;
const cart = projection.unproject(position, scratchCartographic);
position = ellipsoid.cartographicToCartesian(cart, scratchCartesian3);
modelMatrix = Matrix4.IDENTITY;
}
}
const windowCoordinates = Billboard._computeScreenSpacePosition(
modelMatrix,
position,
this._eyeOffset,
scratchPixelOffset,
scene,
result,
);
return windowCoordinates;
};
/**
* Gets a billboard's screen space bounding box centered around screenSpacePosition.
* @param {Billboard} billboard The billboard to get the screen space bounding box for.
* @param {Cartesian2} screenSpacePosition The screen space center of the label.
* @param {BoundingRectangle} [result] The object onto which to store the result.
* @returns {BoundingRectangle} The screen space bounding box.
*
* @private
*/
Billboard.getScreenSpaceBoundingBox = function (
billboard,
screenSpacePosition,
result,
) {
let width = billboard.width;
let height = billboard.height;
const scale = billboard.scale;
width *= scale;
height *= scale;
let x = screenSpacePosition.x;
if (billboard.horizontalOrigin === HorizontalOrigin.RIGHT) {
x -= width;
} else if (billboard.horizontalOrigin === HorizontalOrigin.CENTER) {
x -= width * 0.5;
}
let y = screenSpacePosition.y;
if (
billboard.verticalOrigin === VerticalOrigin.BOTTOM ||
billboard.verticalOrigin === VerticalOrigin.BASELINE
) {
y -= height;
} else if (billboard.verticalOrigin === VerticalOrigin.CENTER) {
y -= height * 0.5;
}
if (!defined(result)) {
result = new BoundingRectangle();
}
result.x = x;
result.y = y;
result.width = width;
result.height = height;
return result;
};
/**
* Determines if this billboard equals another billboard. Billboards are equal if all their properties
* are equal. Billboards in different collections can be equal.
*
* @param {Billboard} [other] The billboard to compare for equality.
* @returns {boolean} <code>true</code> if the billboards are equal; otherwise, <code>false</code>.
*/
Billboard.prototype.equals = function (other) {
return (
this === other ||
(defined(other) &&
this._id === other._id &&
Cartesian3.equals(this._position, other._position) &&
this.image === other.image &&
this._show === other._show &&
this._scale === other._scale &&
this._verticalOrigin === other._verticalOrigin &&
this._horizontalOrigin === other._horizontalOrigin &&
this._heightReference === other._heightReference &&
Color.equals(this._color, other._color) &&
Cartesian2.equals(this._pixelOffset, other._pixelOffset) &&
Cartesian2.equals(this._translate, other._translate) &&
Cartesian3.equals(this._eyeOffset, other._eyeOffset) &&
NearFarScalar.equals(this._scaleByDistance, other._scaleByDistance) &&
NearFarScalar.equals(
this._translucencyByDistance,
other._translucencyByDistance,
) &&
NearFarScalar.equals(
this._pixelOffsetScaleByDistance,
other._pixelOffsetScaleByDistance,
) &&
DistanceDisplayCondition.equals(
this._distanceDisplayCondition,
other._distanceDisplayCondition,
) &&
this._disableDepthTestDistance === other._disableDepthTestDistance &&
this._splitDirection === other._splitDirection)
);
};
Billboard.prototype._destroy = function () {
Iif (defined(this._customData)) {
this._billboardCollection._scene.globe._surface.removeTileCustomData(
this._customData,
);
this._customData = undefined;
}
if (defined(this._removeCallbackFunc)) {
this._removeCallbackFunc();
this._removeCallbackFunc = undefined;
}
this.image = undefined;
this._pickId = this._pickId && this._pickId.destroy();
this._billboardCollection = undefined;
};
/**
* A function that creates an image.
* @callback Billboard.CreateImageCallback
* @param {string} id The identifier of the image to load.
* @returns {HTMLImageElement|HTMLCanvasElement|Promise<HTMLImageElement|HTMLCanvasElement>} The image, or a promise that will resolve to an image.
*/
export default Billboard;
|