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 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 | 1x 1x 9x 9x 9x 9x 9x 9x 9x 9x 1x 80x 1x 79x 78x 78x 1x 77x 77x 1x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 2x 2x 74x 74x 74x 76x 76x 76x 76x 76x 75x 75x 75x 75x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 75x 75x 75x 75x 1x 74x 2x 75x 75x 76x 75x 75x 74x 1x 1x 1x 75x 76x 76x 75x 76x 76x 70x 70x 70x 70x 70x 76x 1x 1x 1x 76x 1x 1x 76x 76x 75x 75x 75x 75x 75x 74x 1x 75x 76x 74x 74x 74x 74x 76x 73x 73x 73x 73x 73x 73x 76x 73x 73x 73x 73x 73x 73x 73x 72x 72x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 76x 1x 23x 1x 2x 15x 12x 1x 23x 13x 12x 16x 12x 14x 12x 13x 5x 6x 39x 1x 50x 1x 1x 1x 2x 1x 1x 7x 9x 305x 1x 1x 10x 1x 3x 2x 2x 1x 25x 2x 52x 6x 6x 6x 6x 3x 3x 3x 3x 6x 1x 9x 1x 22x 1x 21x 1x 30x 30x 30x 30x 30x 30x 30x 30x 12x 18x 18x 18x 17x 18x 17x 17x 18x 18x 18x 18x 18x 18x 18x 18x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 18x 15x 15x 15x 15x 15x 15x 15x 15x 14x 15x 15x 15x 18x 1x 18x 18x 18x 18x 18x 1x 1x 12x 1x 72x 1x 76x 76x 76x 76x 76x 76x 76x 75x 76x 75x 76x 75x 76x 76x 70x 76x 74x 74x 76x 73x 73x 73x 76x 73x 73x 73x 76x 76x 76x 76x 76x 75x 75x 76x 74x 76x 76x 1x 85x 85x 1x 4x 4x 4x 1x 76x 22x 1x 23x 23x 23x 23x 23x 2x 2x 2x 2x 23x 23x 22x 22x 22x 23x 23x 23x 23x 23x 23x 2x 2x 21x 21x 1x 1x 1x 1x 1x 1x 1x 1x 9x 9x 9x 9x 9x 1x 4x 4x 4x 1x 1x 9x | import {
BoundingSphere,
BoundingSphereState,
Cartesian3,
CesiumWidget,
Cesium3DTileFeature,
Clock,
ConstantPositionProperty,
Frozen,
defined,
destroyObject,
DeveloperError,
Entity,
Event,
EventHelper,
getElement,
JulianDate,
Math as CesiumMath,
Property,
ScreenSpaceEventType,
IonGeocoderService,
} from "@cesium/engine";
import Animation from "../Animation/Animation.js";
import AnimationViewModel from "../Animation/AnimationViewModel.js";
import BaseLayerPicker from "../BaseLayerPicker/BaseLayerPicker.js";
import createDefaultImageryProviderViewModels from "../BaseLayerPicker/createDefaultImageryProviderViewModels.js";
import createDefaultTerrainProviderViewModels from "../BaseLayerPicker/createDefaultTerrainProviderViewModels.js";
import ClockViewModel from "../ClockViewModel.js";
import FullscreenButton from "../FullscreenButton/FullscreenButton.js";
import Geocoder from "../Geocoder/Geocoder.js";
import HomeButton from "../HomeButton/HomeButton.js";
import InfoBox from "../InfoBox/InfoBox.js";
import NavigationHelpButton from "../NavigationHelpButton/NavigationHelpButton.js";
import ProjectionPicker from "../ProjectionPicker/ProjectionPicker.js";
import SceneModePicker from "../SceneModePicker/SceneModePicker.js";
import SelectionIndicator from "../SelectionIndicator/SelectionIndicator.js";
import subscribeAndEvaluate from "../subscribeAndEvaluate.js";
import Timeline from "../Timeline/Timeline.js";
import VRButton from "../VRButton/VRButton.js";
const boundingSphereScratch = new BoundingSphere();
function onTimelineScrubfunction(e) {
const clock = e.clock;
clock.currentTime = e.timeJulian;
clock.shouldAnimate = false;
}
function getCesium3DTileFeatureDescription(feature) {
const propertyIds = feature.getPropertyIds();
let html = "";
propertyIds.forEach(function (propertyId) {
const value = feature.getProperty(propertyId);
if (defined(value)) {
html += `<tr><th>${propertyId}</th><td>${value}</td></tr>`;
}
});
if (html.length > 0) {
html = `<table class="cesium-infoBox-defaultTable"><tbody>${html}</tbody></table>`;
}
return html;
}
function getCesium3DTileFeatureName(feature) {
// We need to iterate all property IDs to find potential
// candidates, but since we prefer some property IDs
// over others, we store them in an indexed array
// and then use the first defined element in the array
// as the preferred choice.
let i;
const possibleIds = [];
const propertyIds = feature.getPropertyIds();
for (i = 0; i < propertyIds.length; i++) {
const propertyId = propertyIds[i];
if (/^name$/i.test(propertyId)) {
possibleIds[0] = feature.getProperty(propertyId);
} else if (/name/i.test(propertyId)) {
possibleIds[1] = feature.getProperty(propertyId);
} else if (/^title$/i.test(propertyId)) {
possibleIds[2] = feature.getProperty(propertyId);
} else if (/^(id|identifier)$/i.test(propertyId)) {
possibleIds[3] = feature.getProperty(propertyId);
} else if (/element/i.test(propertyId)) {
possibleIds[4] = feature.getProperty(propertyId);
} else if (/(id|identifier)$/i.test(propertyId)) {
possibleIds[5] = feature.getProperty(propertyId);
}
}
const length = possibleIds.length;
for (i = 0; i < length; i++) {
const item = possibleIds[i];
if (defined(item) && item !== "") {
return item;
}
}
return "Unnamed Feature";
}
function pickEntity(viewer, e) {
const picked = viewer.scene.pick(e.position);
if (defined(picked)) {
const id = picked.id ?? picked.primitive.id;
if (id instanceof Entity) {
return id;
}
if (picked instanceof Cesium3DTileFeature) {
return new Entity({
name: getCesium3DTileFeatureName(picked),
description: getCesium3DTileFeatureDescription(picked),
feature: picked,
});
}
}
// No regular entity picked. Try picking features from imagery layers.
if (defined(viewer.scene.globe)) {
return pickImageryLayerFeature(viewer, e.position);
}
}
const scratchStopTime = new JulianDate();
function linkTimelineToDataSourceClock(timeline, dataSource) {
Eif (defined(dataSource)) {
const dataSourceClock = dataSource.clock;
Eif (defined(dataSourceClock) && defined(timeline)) {
const startTime = dataSourceClock.startTime;
let stopTime = dataSourceClock.stopTime;
// When the start and stop times are equal, set the timeline to the shortest interval
// starting at the start time. This prevents an invalid timeline configuration.
Iif (JulianDate.equals(startTime, stopTime)) {
stopTime = JulianDate.addSeconds(
startTime,
CesiumMath.EPSILON2,
scratchStopTime,
);
}
timeline.updateFromClock();
timeline.zoomTo(startTime, stopTime);
}
}
}
const cartesian3Scratch = new Cartesian3();
function pickImageryLayerFeature(viewer, windowPosition) {
const scene = viewer.scene;
const pickRay = scene.camera.getPickRay(windowPosition);
const imageryLayerFeaturePromise =
scene.imageryLayers.pickImageryLayerFeatures(pickRay, scene);
if (!defined(imageryLayerFeaturePromise)) {
return;
}
// Imagery layer feature picking is asynchronous, so put up a message while loading.
const loadingMessage = new Entity({
id: "Loading...",
description: "Loading feature information...",
});
imageryLayerFeaturePromise.then(
function (features) {
// Has this async pick been superseded by a later one?
if (viewer.selectedEntity !== loadingMessage) {
return;
}
if (!defined(features) || features.length === 0) {
viewer.selectedEntity = createNoFeaturesEntity();
return;
}
// Select the first feature.
const feature = features[0];
const entity = new Entity({
id: feature.name,
description: feature.description,
});
if (defined(feature.position)) {
const ecfPosition = viewer.scene.ellipsoid.cartographicToCartesian(
feature.position,
cartesian3Scratch,
);
entity.position = new ConstantPositionProperty(ecfPosition);
}
viewer.selectedEntity = entity;
},
function () {
// Has this async pick been superseded by a later one?
if (viewer.selectedEntity !== loadingMessage) {
return;
}
viewer.selectedEntity = createNoFeaturesEntity();
},
);
return loadingMessage;
}
function createNoFeaturesEntity() {
return new Entity({
id: "None",
description: "No features found.",
});
}
function enableVRUI(viewer, enabled) {
const geocoder = viewer._geocoder;
const homeButton = viewer._homeButton;
const sceneModePicker = viewer._sceneModePicker;
const projectionPicker = viewer._projectionPicker;
const baseLayerPicker = viewer._baseLayerPicker;
const animation = viewer._animation;
const timeline = viewer._timeline;
const fullscreenButton = viewer._fullscreenButton;
const infoBox = viewer._infoBox;
const selectionIndicator = viewer._selectionIndicator;
const visibility = enabled ? "hidden" : "visible";
if (defined(geocoder)) {
geocoder.container.style.visibility = visibility;
}
if (defined(homeButton)) {
homeButton.container.style.visibility = visibility;
}
if (defined(sceneModePicker)) {
sceneModePicker.container.style.visibility = visibility;
}
if (defined(projectionPicker)) {
projectionPicker.container.style.visibility = visibility;
}
if (defined(baseLayerPicker)) {
baseLayerPicker.container.style.visibility = visibility;
}
if (defined(animation)) {
animation.container.style.visibility = visibility;
}
if (defined(timeline)) {
timeline.container.style.visibility = visibility;
}
if (
defined(fullscreenButton) &&
fullscreenButton.viewModel.isFullscreenEnabled
) {
fullscreenButton.container.style.visibility = visibility;
}
if (defined(infoBox)) {
infoBox.container.style.visibility = visibility;
}
if (defined(selectionIndicator)) {
selectionIndicator.container.style.visibility = visibility;
}
if (viewer._container) {
const right =
enabled || !defined(fullscreenButton)
? 0
: fullscreenButton.container.clientWidth;
viewer._vrButton.container.style.right = `${right}px`;
viewer.forceResize();
}
}
/**
* @typedef {object} Viewer.ConstructorOptions
*
* Initialization options for the Viewer constructor
*
* @property {boolean} [animation=true] If set to false, the Animation widget will not be created.
* @property {boolean} [baseLayerPicker=true] If set to false, the BaseLayerPicker widget will not be created.
* @property {boolean} [fullscreenButton=true] If set to false, the FullscreenButton widget will not be created.
* @property {boolean} [vrButton=false] If set to true, the VRButton widget will be created.
* @property {boolean|IonGeocodeProviderType|GeocoderService[]} [geocoder=IonGeocodeProviderType.DEFAULT] The geocoding service or services to use when searching with the Geocoder widget. If set to false, the Geocoder widget will not be created.
* @property {boolean} [homeButton=true] If set to false, the HomeButton widget will not be created.
* @property {boolean} [infoBox=true] If set to false, the InfoBox widget will not be created.
* @property {boolean} [sceneModePicker=true] If set to false, the SceneModePicker widget will not be created.
* @property {boolean} [selectionIndicator=true] If set to false, the SelectionIndicator widget will not be created.
* @property {boolean} [timeline=true] If set to false, the Timeline widget will not be created.
* @property {boolean} [navigationHelpButton=true] If set to false, the navigation help button will not be created.
* @property {boolean} [navigationInstructionsInitiallyVisible=true] True if the navigation instructions should initially be visible, or false if the should not be shown until the user explicitly clicks the button.
* @property {boolean} [scene3DOnly=false] When <code>true</code>, each geometry instance will only be rendered in 3D to save GPU memory.
* @property {boolean} [shouldAnimate=false] <code>true</code> if the clock should attempt to advance simulation time by default, <code>false</code> otherwise. This option takes precedence over setting {@link Viewer#clockViewModel}.
* @property {ClockViewModel} [clockViewModel=new ClockViewModel(clock)] The clock view model to use to control current time.
* @property {ProviderViewModel} [selectedImageryProviderViewModel] The view model for the current base imagery layer, if not supplied the first available base layer is used. This value is only valid if `baseLayerPicker` is set to true.
* @property {ProviderViewModel[]} [imageryProviderViewModels=createDefaultImageryProviderViewModels()] The array of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if `baseLayerPicker` is set to true.
* @property {ProviderViewModel} [selectedTerrainProviderViewModel] The view model for the current base terrain layer, if not supplied the first available base layer is used. This value is only valid if `baseLayerPicker` is set to true.
* @property {ProviderViewModel[]} [terrainProviderViewModels=createDefaultTerrainProviderViewModels()] The array of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if `baseLayerPicker` is set to true.
* @property {ImageryLayer|false} [baseLayer=ImageryLayer.fromWorldImagery()] The bottommost imagery layer applied to the globe. If set to <code>false</code>, no imagery provider will be added. This value is only valid if `baseLayerPicker` is set to false. Cannot be used when `globe` is set to false.
* @property {Ellipsoid} [ellipsoid = Ellipsoid.default] The default ellipsoid.
* @property {TerrainProvider} [terrainProvider=new EllipsoidTerrainProvider()] The terrain provider to use
* @property {Terrain} [terrain] A terrain object which handles asynchronous terrain provider. Can only specify if options.terrainProvider is undefined.
* @property {SkyBox|false} [skyBox] The skybox used to render the stars. When <code>undefined</code> and the WGS84 ellipsoid used, the default stars are used. If set to <code>false</code>, no skyBox, Sun, or Moon will be added.
* @property {SkyAtmosphere|false} [skyAtmosphere] Blue sky, and the glow around the Earth's limb. Enabled when the WGS84 ellipsoid used. Set to <code>false</code> to turn it off.
* @property {Element|string} [fullscreenElement=document.body] The element or id to be placed into fullscreen mode when the full screen button is pressed.
* @property {boolean} [useDefaultRenderLoop=true] True if this widget should control the render loop, false otherwise.
* @property {number} [targetFrameRate] The target frame rate when using the default render loop.
* @property {boolean} [showRenderLoopErrors=true] If true, this widget will automatically display an HTML panel to the user containing the error, if a render loop error occurs.
* @property {boolean} [useBrowserRecommendedResolution=true] If true, render at the browser's recommended resolution and ignore <code>window.devicePixelRatio</code>.
* @property {boolean} [automaticallyTrackDataSourceClocks=true] If true, this widget will automatically track the clock settings of newly added DataSources, updating if the DataSource's clock changes. Set this to false if you want to configure the clock independently.
* @property {ContextOptions} [contextOptions] Context and WebGL creation properties passed to {@link Scene}.
* @property {SceneMode} [sceneMode=SceneMode.SCENE3D] The initial scene mode.
* @property {MapProjection} [mapProjection=new GeographicProjection(options.ellipsoid)] The map projection to use in 2D and Columbus View modes.
* @property {Globe|false} [globe=new Globe(options.ellipsoid)] The globe to use in the scene. If set to <code>false</code>, no globe will be added and the sky atmosphere will be hidden by default.
* @property {boolean} [orderIndependentTranslucency=true] If true and the configuration supports it, use order independent translucency.
* @property {Element|string} [creditContainer] The DOM element or ID that will contain the {@link CreditDisplay}. If not specified, the credits are added to the bottom of the widget itself.
* @property {Element|string} [creditViewport] The DOM element or ID that will contain the credit pop up created by the {@link CreditDisplay}. If not specified, it will appear over the widget itself.
* @property {DataSourceCollection} [dataSources=new DataSourceCollection()] The collection of data sources visualized by the widget. If this parameter is provided,
* the instance is assumed to be owned by the caller and will not be destroyed when the viewer is destroyed.
* @property {boolean} [shadows=false] Determines if shadows are cast by light sources.
* @property {ShadowMode} [terrainShadows=ShadowMode.RECEIVE_ONLY] Determines if the terrain casts or receives shadows from light sources.
* @property {MapMode2D} [mapMode2D=MapMode2D.INFINITE_SCROLL] Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction.
* @property {boolean} [projectionPicker=false] If set to true, the ProjectionPicker widget will be created.
* @property {boolean} [blurActiveElementOnCanvasFocus=true] If true, the active element will blur when the viewer's canvas is clicked. Setting this to false is useful for cases when the canvas is clicked only for retrieving position or an entity data without actually meaning to set the canvas to be the active element.
* @property {boolean} [requestRenderMode=false] If true, rendering a frame will only occur when needed as determined by changes within the scene. Enabling reduces the CPU/GPU usage of your application and uses less battery on mobile, but requires using {@link Scene#requestRender} to render a new frame explicitly in this mode. This will be necessary in many cases after making changes to the scene in other parts of the API. See {@link https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/|Improving Performance with Explicit Rendering}.
* @property {number} [maximumRenderTimeChange=0.0] If requestRenderMode is true, this value defines the maximum change in simulation time allowed before a render is requested. See {@link https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/|Improving Performance with Explicit Rendering}.
* @property {number} [depthPlaneEllipsoidOffset=0.0] Adjust the DepthPlane to address rendering artefacts below ellipsoid zero elevation.
* @property {number} [msaaSamples=4] If provided, this value controls the rate of multisample antialiasing. Typical multisampling rates are 2, 4, and sometimes 8 samples per pixel. Higher sampling rates of MSAA may impact performance in exchange for improved visual quality. This value only applies to WebGL2 contexts that support multisample render targets. Set to 1 to disable MSAA.
*/
/**
* A base widget for building applications. It composites all of the standard Cesium widgets into one reusable package.
* The widget can always be extended by using mixins, which add functionality useful for a variety of applications.
*
* @alias Viewer
* @constructor
*
* @param {Element|string} container The DOM element or ID that will contain the widget.
* @param {Viewer.ConstructorOptions} [options] Object describing initialization options
*
* @exception {DeveloperError} Element with id "container" does not exist in the document.
* @exception {DeveloperError} options.selectedImageryProviderViewModel is not available when not using the BaseLayerPicker widget, specify options.baseLayer instead.
* @exception {DeveloperError} options.selectedTerrainProviderViewModel is not available when not using the BaseLayerPicker widget, specify options.terrainProvider instead.
*
* @see Animation
* @see BaseLayerPicker
* @see CesiumWidget
* @see FullscreenButton
* @see HomeButton
* @see SceneModePicker
* @see Timeline
* @see viewerDragDropMixin
*
* @demo {@link https://sandcastle.cesium.com/index.html?src=Hello%20World.html|Cesium Sandcastle Hello World Demo}
*
* @example
* // Initialize the viewer widget with several custom options and mixins.
* try {
* const viewer = new Cesium.Viewer("cesiumContainer", {
* // Start in Columbus Viewer
* sceneMode: Cesium.SceneMode.COLUMBUS_VIEW,
* // Use Cesium World Terrain
* terrain: Cesium.Terrain.fromWorldTerrain(),
* // Hide the base layer picker
* baseLayerPicker: false,
* // Use OpenStreetMaps
* baseLayer: new Cesium.ImageryLayer(new Cesium.OpenStreetMapImageryProvider({
* url: "https://tile.openstreetmap.org/"
* })),
* skyBox: new Cesium.SkyBox({
* sources: {
* positiveX: "stars/TychoSkymapII.t3_08192x04096_80_px.jpg",
* negativeX: "stars/TychoSkymapII.t3_08192x04096_80_mx.jpg",
* positiveY: "stars/TychoSkymapII.t3_08192x04096_80_py.jpg",
* negativeY: "stars/TychoSkymapII.t3_08192x04096_80_my.jpg",
* positiveZ: "stars/TychoSkymapII.t3_08192x04096_80_pz.jpg",
* negativeZ: "stars/TychoSkymapII.t3_08192x04096_80_mz.jpg"
* }
* }),
* // Show Columbus View map with Web Mercator projection
* mapProjection: new Cesium.WebMercatorProjection()
* });
* } catch (error) {
* console.log(error);
* }
*
* // Add basic drag and drop functionality
* viewer.extend(Cesium.viewerDragDropMixin);
*
* // Show a pop-up alert if we encounter an error when processing a dropped file
* viewer.dropError.addEventListener(function(dropHandler, name, error) {
* console.log(error);
* window.alert(error);
* });
*/
function Viewer(container, options) {
//>>includeStart('debug', pragmas.debug);
if (!defined(container)) {
throw new DeveloperError("container is required.");
}
//>>includeEnd('debug');
container = getElement(container);
options = options ?? Frozen.EMPTY_OBJECT;
//>>includeStart('debug', pragmas.debug);
if (
options.globe === false &&
defined(options.baseLayer) &&
options.baseLayer !== false
) {
throw new DeveloperError("Cannot use baseLayer when globe is disabled.");
}
//>>includeEnd('debug');
const createBaseLayerPicker =
(!defined(options.globe) || options.globe !== false) &&
(!defined(options.baseLayerPicker) || options.baseLayerPicker !== false);
//>>includeStart('debug', pragmas.debug);
// If not using BaseLayerPicker, selectedImageryProviderViewModel is an invalid option
if (
!createBaseLayerPicker &&
defined(options.selectedImageryProviderViewModel)
) {
throw new DeveloperError(
"options.selectedImageryProviderViewModel is not available when not using the BaseLayerPicker widget. \
Either specify options.baseLayer instead or set options.baseLayerPicker to true.",
);
}
// If not using BaseLayerPicker, selectedTerrainProviderViewModel is an invalid option
Iif (
!createBaseLayerPicker &&
defined(options.selectedTerrainProviderViewModel)
) {
throw new DeveloperError(
"options.selectedTerrainProviderViewModel is not available when not using the BaseLayerPicker widget. \
Either specify options.terrainProvider instead or set options.baseLayerPicker to true.",
);
}
//>>includeEnd('debug');
const that = this;
const viewerContainer = document.createElement("div");
viewerContainer.className = "cesium-viewer";
container.appendChild(viewerContainer);
// Cesium widget container
const cesiumWidgetContainer = document.createElement("div");
cesiumWidgetContainer.className = "cesium-viewer-cesiumWidgetContainer";
viewerContainer.appendChild(cesiumWidgetContainer);
// Bottom container
const bottomContainer = document.createElement("div");
bottomContainer.className = "cesium-viewer-bottom";
viewerContainer.appendChild(bottomContainer);
const scene3DOnly = options.scene3DOnly ?? false;
let clock;
let clockViewModel;
let destroyClockViewModel = false;
if (defined(options.clockViewModel)) {
clockViewModel = options.clockViewModel;
clock = clockViewModel.clock;
} else {
clock = new Clock();
clockViewModel = new ClockViewModel(clock);
destroyClockViewModel = true;
}
// Cesium widget
const cesiumWidget = new CesiumWidget(cesiumWidgetContainer, {
baseLayer:
(createBaseLayerPicker &&
defined(options.selectedImageryProviderViewModel)) ||
defined(options.baseLayer) ||
defined(options.imageryProvider)
? false
: undefined,
clock: clock,
shouldAnimate: options.shouldAnimate,
skyBox: options.skyBox,
skyAtmosphere: options.skyAtmosphere,
sceneMode: options.sceneMode,
ellipsoid: options.ellipsoid,
mapProjection: options.mapProjection,
globe: options.globe,
orderIndependentTranslucency: options.orderIndependentTranslucency,
automaticallyTrackDataSourceClocks:
options.automaticallyTrackDataSourceClocks,
contextOptions: options.contextOptions,
useDefaultRenderLoop: options.useDefaultRenderLoop,
targetFrameRate: options.targetFrameRate,
showRenderLoopErrors: options.showRenderLoopErrors,
useBrowserRecommendedResolution: options.useBrowserRecommendedResolution,
creditContainer: defined(options.creditContainer)
? options.creditContainer
: bottomContainer,
creditViewport: options.creditViewport,
dataSources: options.dataSources,
scene3DOnly: scene3DOnly,
shadows: options.shadows,
terrainShadows: options.terrainShadows,
mapMode2D: options.mapMode2D,
blurActiveElementOnCanvasFocus: options.blurActiveElementOnCanvasFocus,
requestRenderMode: options.requestRenderMode,
maximumRenderTimeChange: options.maximumRenderTimeChange,
depthPlaneEllipsoidOffset: options.depthPlaneEllipsoidOffset,
msaaSamples: options.msaaSamples,
});
const scene = cesiumWidget.scene;
const eventHelper = new EventHelper();
eventHelper.add(clock.onTick, Viewer.prototype._onTick, this);
// Selection Indicator
let selectionIndicator;
if (
!defined(options.selectionIndicator) ||
options.selectionIndicator !== false
) {
const selectionIndicatorContainer = document.createElement("div");
selectionIndicatorContainer.className =
"cesium-viewer-selectionIndicatorContainer";
viewerContainer.appendChild(selectionIndicatorContainer);
selectionIndicator = new SelectionIndicator(
selectionIndicatorContainer,
scene,
);
}
// Info Box
let infoBox;
Eif (!defined(options.infoBox) || options.infoBox !== false) {
const infoBoxContainer = document.createElement("div");
infoBoxContainer.className = "cesium-viewer-infoBoxContainer";
viewerContainer.appendChild(infoBoxContainer);
infoBox = new InfoBox(infoBoxContainer);
const infoBoxViewModel = infoBox.viewModel;
eventHelper.add(
infoBoxViewModel.cameraClicked,
Viewer.prototype._onInfoBoxCameraClicked,
this,
);
eventHelper.add(
infoBoxViewModel.closeClicked,
Viewer.prototype._onInfoBoxClockClicked,
this,
);
}
// Main Toolbar
const toolbar = document.createElement("div");
toolbar.className = "cesium-viewer-toolbar";
viewerContainer.appendChild(toolbar);
// Geocoder
let geocoder;
if (!defined(options.geocoder) || options.geocoder !== false) {
const geocoderContainer = document.createElement("div");
geocoderContainer.className = "cesium-viewer-geocoderContainer";
toolbar.appendChild(geocoderContainer);
let geocoderService;
if (typeof options.geocoder === "string") {
geocoderService = [
new IonGeocoderService({
scene,
geocodeProviderType: options.geocoder,
}),
];
} else if (
defined(options.geocoder) &&
typeof options.geocoder !== "boolean"
) {
geocoderService = Array.isArray(options.geocoder)
? options.geocoder
: [options.geocoder];
}
geocoder = new Geocoder({
container: geocoderContainer,
geocoderServices: geocoderService,
scene: scene,
});
// Subscribe to search so that we can clear the trackedEntity when it is clicked.
eventHelper.add(
geocoder.viewModel.search.beforeExecute,
Viewer.prototype._clearObjects,
this,
);
}
// HomeButton
let homeButton;
if (!defined(options.homeButton) || options.homeButton !== false) {
homeButton = new HomeButton(toolbar, scene);
if (defined(geocoder)) {
eventHelper.add(homeButton.viewModel.command.afterExecute, function () {
const viewModel = geocoder.viewModel;
viewModel.searchText = "";
Iif (viewModel.isSearchInProgress) {
viewModel.search();
}
});
}
// Subscribe to the home button beforeExecute event so that we can clear the trackedEntity.
eventHelper.add(
homeButton.viewModel.command.beforeExecute,
Viewer.prototype._clearTrackedObject,
this,
);
}
// SceneModePicker
// By default, we silently disable the scene mode picker if scene3DOnly is true,
// but if sceneModePicker is explicitly set to true, throw an error.
//>>includeStart('debug', pragmas.debug);
Iif (options.sceneModePicker === true && scene3DOnly) {
throw new DeveloperError(
"options.sceneModePicker is not available when options.scene3DOnly is set to true.",
);
}
//>>includeEnd('debug');
let sceneModePicker;
if (
!scene3DOnly &&
(!defined(options.sceneModePicker) || options.sceneModePicker !== false)
) {
sceneModePicker = new SceneModePicker(toolbar, scene);
}
let projectionPicker;
Iif (options.projectionPicker) {
projectionPicker = new ProjectionPicker(toolbar, scene);
}
// BaseLayerPicker
let baseLayerPicker;
let baseLayerPickerDropDown;
if (createBaseLayerPicker) {
const imageryProviderViewModels =
options.imageryProviderViewModels ??
createDefaultImageryProviderViewModels();
const terrainProviderViewModels =
options.terrainProviderViewModels ??
createDefaultTerrainProviderViewModels();
baseLayerPicker = new BaseLayerPicker(toolbar, {
globe: scene.globe,
imageryProviderViewModels: imageryProviderViewModels,
selectedImageryProviderViewModel:
options.selectedImageryProviderViewModel,
terrainProviderViewModels: terrainProviderViewModels,
selectedTerrainProviderViewModel:
options.selectedTerrainProviderViewModel,
});
//Grab the dropdown for resize code.
const elements = toolbar.getElementsByClassName(
"cesium-baseLayerPicker-dropDown",
);
baseLayerPickerDropDown = elements[0];
}
// These need to be set after the BaseLayerPicker is created in order to take effect
if (defined(options.baseLayer) && options.baseLayer !== false) {
Iif (createBaseLayerPicker) {
baseLayerPicker.viewModel.selectedImagery = undefined;
}
scene.imageryLayers.removeAll();
scene.imageryLayers.add(options.baseLayer);
}
if (defined(options.terrainProvider)) {
Iif (createBaseLayerPicker) {
baseLayerPicker.viewModel.selectedTerrain = undefined;
}
scene.terrainProvider = options.terrainProvider;
}
Iif (defined(options.terrain)) {
//>>includeStart('debug', pragmas.debug);
if (defined(options.terrainProvider)) {
throw new DeveloperError(
"Specify either options.terrainProvider or options.terrain.",
);
}
//>>includeEnd('debug');
if (createBaseLayerPicker) {
// Required as this is otherwise set by the baseLayerPicker
scene.globe.depthTestAgainstTerrain = true;
}
scene.setTerrain(options.terrain);
}
// Navigation Help Button
let navigationHelpButton;
if (
!defined(options.navigationHelpButton) ||
options.navigationHelpButton !== false
) {
let showNavHelp = true;
try {
//window.localStorage is null if disabled in Firefox or undefined in browsers with implementation
Eif (defined(window.localStorage)) {
const hasSeenNavHelp = window.localStorage.getItem(
"cesium-hasSeenNavHelp",
);
if (defined(hasSeenNavHelp) && Boolean(hasSeenNavHelp)) {
showNavHelp = false;
} else {
window.localStorage.setItem("cesium-hasSeenNavHelp", "true");
}
}
} catch (e) {
//Accessing window.localStorage throws if disabled in Chrome
//window.localStorage.setItem throws if in Safari private browsing mode or in any browser if we are over quota.
}
navigationHelpButton = new NavigationHelpButton({
container: toolbar,
instructionsInitiallyVisible:
options.navigationInstructionsInitiallyVisible ?? showNavHelp,
});
}
// Animation
let animation;
if (!defined(options.animation) || options.animation !== false) {
const animationContainer = document.createElement("div");
animationContainer.className = "cesium-viewer-animationContainer";
viewerContainer.appendChild(animationContainer);
animation = new Animation(
animationContainer,
new AnimationViewModel(clockViewModel),
);
}
// Timeline
let timeline;
if (!defined(options.timeline) || options.timeline !== false) {
const timelineContainer = document.createElement("div");
timelineContainer.className = "cesium-viewer-timelineContainer";
viewerContainer.appendChild(timelineContainer);
timeline = new Timeline(timelineContainer, clock);
timeline.addEventListener("settime", onTimelineScrubfunction, false);
timeline.zoomTo(clock.startTime, clock.stopTime);
}
// Fullscreen
let fullscreenButton;
let fullscreenSubscription;
let fullscreenContainer;
if (
!defined(options.fullscreenButton) ||
options.fullscreenButton !== false
) {
fullscreenContainer = document.createElement("div");
fullscreenContainer.className = "cesium-viewer-fullscreenContainer";
viewerContainer.appendChild(fullscreenContainer);
fullscreenButton = new FullscreenButton(
fullscreenContainer,
options.fullscreenElement,
);
//Subscribe to fullscreenButton.viewModel.isFullscreenEnabled so
//that we can hide/show the button as well as size the timeline.
fullscreenSubscription = subscribeAndEvaluate(
fullscreenButton.viewModel,
"isFullscreenEnabled",
function (isFullscreenEnabled) {
fullscreenContainer.style.display = isFullscreenEnabled
? "block"
: "none";
if (defined(timeline)) {
timeline.container.style.right = `${fullscreenContainer.clientWidth}px`;
timeline.resize();
}
},
);
}
// VR
let vrButton;
let vrSubscription;
let vrModeSubscription;
Iif (options.vrButton) {
const vrContainer = document.createElement("div");
vrContainer.className = "cesium-viewer-vrContainer";
viewerContainer.appendChild(vrContainer);
vrButton = new VRButton(vrContainer, scene, options.fullScreenElement);
vrSubscription = subscribeAndEvaluate(
vrButton.viewModel,
"isVREnabled",
function (isVREnabled) {
vrContainer.style.display = isVREnabled ? "block" : "none";
if (defined(fullscreenButton)) {
vrContainer.style.right = `${fullscreenContainer.clientWidth}px`;
}
if (defined(timeline)) {
timeline.container.style.right = `${vrContainer.clientWidth}px`;
timeline.resize();
}
},
);
vrModeSubscription = subscribeAndEvaluate(
vrButton.viewModel,
"isVRMode",
function (isVRMode) {
enableVRUI(that, isVRMode);
},
);
}
//Assign all properties to this instance. No "this" assignments should
//take place above this line.
this._baseLayerPickerDropDown = baseLayerPickerDropDown;
this._fullscreenSubscription = fullscreenSubscription;
this._vrSubscription = vrSubscription;
this._vrModeSubscription = vrModeSubscription;
this._dataSourceChangedListeners = {};
this._container = container;
this._bottomContainer = bottomContainer;
this._element = viewerContainer;
this._cesiumWidget = cesiumWidget;
this._selectionIndicator = selectionIndicator;
this._infoBox = infoBox;
this._clockViewModel = clockViewModel;
this._destroyClockViewModel = destroyClockViewModel;
this._toolbar = toolbar;
this._homeButton = homeButton;
this._sceneModePicker = sceneModePicker;
this._projectionPicker = projectionPicker;
this._baseLayerPicker = baseLayerPicker;
this._navigationHelpButton = navigationHelpButton;
this._animation = animation;
this._timeline = timeline;
this._fullscreenButton = fullscreenButton;
this._vrButton = vrButton;
this._geocoder = geocoder;
this._eventHelper = eventHelper;
this._lastWidth = 0;
this._lastHeight = 0;
this._enableInfoOrSelection = defined(infoBox) || defined(selectionIndicator);
this._selectedEntity = undefined;
this._selectedEntityChanged = new Event();
const dataSourceCollection = this._cesiumWidget.dataSources;
const dataSourceDisplay = this._cesiumWidget.dataSourceDisplay;
//Listen to data source events in order to track clock changes.
eventHelper.add(
dataSourceCollection.dataSourceAdded,
Viewer.prototype._onDataSourceAdded,
this,
);
eventHelper.add(
dataSourceCollection.dataSourceRemoved,
Viewer.prototype._onDataSourceRemoved,
this,
);
// Prior to each render, check if anything needs to be resized.
eventHelper.add(scene.postUpdate, Viewer.prototype.resize, this);
// We need to subscribe to the data sources and collections so that we can clear the
// tracked object when it is removed from the scene.
// Subscribe to current data sources
const dataSourceLength = dataSourceCollection.length;
for (let i = 0; i < dataSourceLength; i++) {
this._dataSourceAdded(dataSourceCollection, dataSourceCollection.get(i));
}
this._dataSourceAdded(undefined, dataSourceDisplay.defaultDataSource);
// Hook up events so that we can subscribe to future sources.
eventHelper.add(
dataSourceCollection.dataSourceAdded,
Viewer.prototype._dataSourceAdded,
this,
);
eventHelper.add(
dataSourceCollection.dataSourceRemoved,
Viewer.prototype._dataSourceRemoved,
this,
);
// Subscribe to left clicks and zoom to the picked object.
function pickAndTrackObject(e) {
const entity = pickEntity(that, e);
if (defined(entity)) {
//Only track the entity if it has a valid position at the current time.
if (
Property.getValueOrUndefined(entity.position, that.clock.currentTime)
) {
that.trackedEntity = entity;
} else {
that.zoomTo(entity);
}
} else if (defined(that.trackedEntity)) {
that.trackedEntity = undefined;
}
}
function pickAndSelectObject(e) {
that.selectedEntity = pickEntity(that, e);
}
cesiumWidget.screenSpaceEventHandler.setInputAction(
pickAndSelectObject,
ScreenSpaceEventType.LEFT_CLICK,
);
cesiumWidget.screenSpaceEventHandler.setInputAction(
pickAndTrackObject,
ScreenSpaceEventType.LEFT_DOUBLE_CLICK,
);
// This allows to update the Viewer's _clockViewModel instead of the CesiumWidget's _clock
// when CesiumWidget is created from the Viewer.
cesiumWidget._canAnimateUpdateCallback = this._updateCanAnimate(this);
}
Object.defineProperties(Viewer.prototype, {
/**
* Gets the parent container.
* @memberof Viewer.prototype
* @type {Element}
* @readonly
*/
container: {
get: function () {
return this._container;
},
},
/**
* Manages the list of credits to display on screen and in the lightbox.
* @memberof Viewer.prototype
*
* @type {CreditDisplay}
*/
creditDisplay: {
get: function () {
return this._cesiumWidget.creditDisplay;
},
},
/**
* Gets the DOM element for the area at the bottom of the window containing the
* {@link CreditDisplay} and potentially other things.
* @memberof Viewer.prototype
* @type {Element}
* @readonly
*/
bottomContainer: {
get: function () {
return this._bottomContainer;
},
},
/**
* Gets the CesiumWidget.
* @memberof Viewer.prototype
* @type {CesiumWidget}
* @readonly
*/
cesiumWidget: {
get: function () {
return this._cesiumWidget;
},
},
/**
* Gets the selection indicator.
* @memberof Viewer.prototype
* @type {SelectionIndicator}
* @readonly
*/
selectionIndicator: {
get: function () {
return this._selectionIndicator;
},
},
/**
* Gets the info box.
* @memberof Viewer.prototype
* @type {InfoBox}
* @readonly
*/
infoBox: {
get: function () {
return this._infoBox;
},
},
/**
* Gets the Geocoder.
* @memberof Viewer.prototype
* @type {Geocoder}
* @readonly
*/
geocoder: {
get: function () {
return this._geocoder;
},
},
/**
* Gets the HomeButton.
* @memberof Viewer.prototype
* @type {HomeButton}
* @readonly
*/
homeButton: {
get: function () {
return this._homeButton;
},
},
/**
* Gets the SceneModePicker.
* @memberof Viewer.prototype
* @type {SceneModePicker}
* @readonly
*/
sceneModePicker: {
get: function () {
return this._sceneModePicker;
},
},
/**
* Gets the ProjectionPicker.
* @memberof Viewer.prototype
* @type {ProjectionPicker}
* @readonly
*/
projectionPicker: {
get: function () {
return this._projectionPicker;
},
},
/**
* Gets the BaseLayerPicker.
* @memberof Viewer.prototype
* @type {BaseLayerPicker}
* @readonly
*/
baseLayerPicker: {
get: function () {
return this._baseLayerPicker;
},
},
/**
* Gets the NavigationHelpButton.
* @memberof Viewer.prototype
* @type {NavigationHelpButton}
* @readonly
*/
navigationHelpButton: {
get: function () {
return this._navigationHelpButton;
},
},
/**
* Gets the Animation widget.
* @memberof Viewer.prototype
* @type {Animation}
* @readonly
*/
animation: {
get: function () {
return this._animation;
},
},
/**
* Gets the Timeline widget.
* @memberof Viewer.prototype
* @type {Timeline}
* @readonly
*/
timeline: {
get: function () {
return this._timeline;
},
},
/**
* Gets the FullscreenButton.
* @memberof Viewer.prototype
* @type {FullscreenButton}
* @readonly
*/
fullscreenButton: {
get: function () {
return this._fullscreenButton;
},
},
/**
* Gets the VRButton.
* @memberof Viewer.prototype
* @type {VRButton}
* @readonly
*/
vrButton: {
get: function () {
return this._vrButton;
},
},
/**
* Gets the display used for {@link DataSource} visualization.
* @memberof Viewer.prototype
* @type {DataSourceDisplay}
* @readonly
*/
dataSourceDisplay: {
get: function () {
return this._cesiumWidget.dataSourceDisplay;
},
},
/**
* Gets the collection of entities not tied to a particular data source.
* This is a shortcut to [dataSourceDisplay.defaultDataSource.entities]{@link Viewer#dataSourceDisplay}.
* @memberof Viewer.prototype
* @type {EntityCollection}
* @readonly
*/
entities: {
get: function () {
return this._cesiumWidget.entities;
},
},
/**
* Gets the set of {@link DataSource} instances to be visualized.
* @memberof Viewer.prototype
* @type {DataSourceCollection}
* @readonly
*/
dataSources: {
get: function () {
return this._cesiumWidget.dataSources;
},
},
/**
* Gets the canvas.
* @memberof Viewer.prototype
* @type {HTMLCanvasElement}
* @readonly
*/
canvas: {
get: function () {
return this._cesiumWidget.canvas;
},
},
/**
* Gets the scene.
* @memberof Viewer.prototype
* @type {Scene}
* @readonly
*/
scene: {
get: function () {
return this._cesiumWidget.scene;
},
},
/**
* Determines if shadows are cast by light sources.
* @memberof Viewer.prototype
* @type {boolean}
*/
shadows: {
get: function () {
return this.scene.shadowMap.enabled;
},
set: function (value) {
this.scene.shadowMap.enabled = value;
},
},
/**
* Determines if the terrain casts or shadows from light sources.
* @memberof Viewer.prototype
* @type {ShadowMode}
*/
terrainShadows: {
get: function () {
return this.scene.globe.shadows;
},
set: function (value) {
this.scene.globe.shadows = value;
},
},
/**
* Get the scene's shadow map
* @memberof Viewer.prototype
* @type {ShadowMap}
* @readonly
*/
shadowMap: {
get: function () {
return this.scene.shadowMap;
},
},
/**
* Gets the collection of image layers that will be rendered on the globe.
* @memberof Viewer.prototype
*
* @type {ImageryLayerCollection}
* @readonly
*/
imageryLayers: {
get: function () {
return this.scene.imageryLayers;
},
},
/**
* The terrain provider providing surface geometry for the globe.
* @memberof Viewer.prototype
*
* @type {TerrainProvider}
*/
terrainProvider: {
get: function () {
return this.scene.terrainProvider;
},
set: function (terrainProvider) {
this.scene.terrainProvider = terrainProvider;
},
},
/**
* Gets the camera.
* @memberof Viewer.prototype
*
* @type {Camera}
* @readonly
*/
camera: {
get: function () {
return this.scene.camera;
},
},
/**
* Gets the default ellipsoid for the scene.
* @memberof Viewer.prototype
*
* @type {Ellipsoid}
* @default Ellipsoid.default
* @readonly
*/
ellipsoid: {
get: function () {
return this._scene.ellipsoid;
},
},
/**
* Gets the post-process stages.
* @memberof Viewer.prototype
*
* @type {PostProcessStageCollection}
* @readonly
*/
postProcessStages: {
get: function () {
return this.scene.postProcessStages;
},
},
/**
* Gets the clock.
* @memberof Viewer.prototype
* @type {Clock}
* @readonly
*/
clock: {
get: function () {
return this._clockViewModel.clock;
},
},
/**
* Gets the clock view model.
* @memberof Viewer.prototype
* @type {ClockViewModel}
* @readonly
*/
clockViewModel: {
get: function () {
return this._clockViewModel;
},
},
/**
* Gets the screen space event handler.
* @memberof Viewer.prototype
* @type {ScreenSpaceEventHandler}
* @readonly
*/
screenSpaceEventHandler: {
get: function () {
return this._cesiumWidget.screenSpaceEventHandler;
},
},
/**
* Gets or sets the target frame rate of the widget when <code>useDefaultRenderLoop</code>
* is true. If undefined, the browser's requestAnimationFrame implementation
* determines the frame rate. If defined, this value must be greater than 0. A value higher
* than the underlying requestAnimationFrame implementation will have no effect.
* @memberof Viewer.prototype
*
* @type {number}
*/
targetFrameRate: {
get: function () {
return this._cesiumWidget.targetFrameRate;
},
set: function (value) {
this._cesiumWidget.targetFrameRate = value;
},
},
/**
* Gets or sets whether or not this widget should control the render loop.
* If true the widget will use requestAnimationFrame to
* perform rendering and resizing of the widget, as well as drive the
* simulation clock. If set to false, you must manually call the
* <code>resize</code>, <code>render</code> methods
* as part of a custom render loop. If an error occurs during rendering, {@link Scene}'s
* <code>renderError</code> event will be raised and this property
* will be set to false. It must be set back to true to continue rendering
* after the error.
* @memberof Viewer.prototype
*
* @type {boolean}
*/
useDefaultRenderLoop: {
get: function () {
return this._cesiumWidget.useDefaultRenderLoop;
},
set: function (value) {
this._cesiumWidget.useDefaultRenderLoop = value;
},
},
/**
* Gets or sets a scaling factor for rendering resolution. Values less than 1.0 can improve
* performance on less powerful devices while values greater than 1.0 will render at a higher
* resolution and then scale down, resulting in improved visual fidelity.
* For example, if the widget is laid out at a size of 640x480, setting this value to 0.5
* will cause the scene to be rendered at 320x240 and then scaled up while setting
* it to 2.0 will cause the scene to be rendered at 1280x960 and then scaled down.
* @memberof Viewer.prototype
*
* @type {number}
* @default 1.0
*/
resolutionScale: {
get: function () {
return this._cesiumWidget.resolutionScale;
},
set: function (value) {
this._cesiumWidget.resolutionScale = value;
},
},
/**
* Boolean flag indicating if the browser's recommended resolution is used.
* If true, the browser's device pixel ratio is ignored and 1.0 is used instead,
* effectively rendering based on CSS pixels instead of device pixels. This can improve
* performance on less powerful devices that have high pixel density. When false, rendering
* will be in device pixels. {@link Viewer#resolutionScale} will still take effect whether
* this flag is true or false.
* @memberof Viewer.prototype
*
* @type {boolean}
* @default true
*/
useBrowserRecommendedResolution: {
get: function () {
return this._cesiumWidget.useBrowserRecommendedResolution;
},
set: function (value) {
this._cesiumWidget.useBrowserRecommendedResolution = value;
},
},
/**
* Gets or sets whether or not data sources can temporarily pause
* animation in order to avoid showing an incomplete picture to the user.
* For example, if asynchronous primitives are being processed in the
* background, the clock will not advance until the geometry is ready.
*
* @memberof Viewer.prototype
*
* @type {boolean}
*/
allowDataSourcesToSuspendAnimation: {
get: function () {
return this._cesiumWidget.allowDataSourcesToSuspendAnimation;
},
set: function (value) {
this._cesiumWidget.allowDataSourcesToSuspendAnimation = value;
},
},
/**
* Gets or sets the Entity instance currently being tracked by the camera.
* @memberof Viewer.prototype
* @type {Entity | undefined}
*/
trackedEntity: {
get: function () {
return this._cesiumWidget.trackedEntity;
},
set: function (value) {
this._cesiumWidget.trackedEntity = value;
},
},
/**
* Gets or sets the object instance for which to display a selection indicator.
*
* If a user interactively picks a Cesium3DTilesFeature instance, then this property
* will contain a transient Entity instance with a property named "feature" that is
* the instance that was picked.
* @memberof Viewer.prototype
* @type {Entity | undefined}
*/
selectedEntity: {
get: function () {
return this._selectedEntity;
},
set: function (value) {
Eif (this._selectedEntity !== value) {
this._selectedEntity = value;
const selectionIndicatorViewModel = defined(this._selectionIndicator)
? this._selectionIndicator.viewModel
: undefined;
if (defined(value)) {
Eif (defined(selectionIndicatorViewModel)) {
selectionIndicatorViewModel.animateAppear();
}
} else Eif (defined(selectionIndicatorViewModel)) {
// Leave the info text in place here, it is needed during the exit animation.
selectionIndicatorViewModel.animateDepart();
}
this._selectedEntityChanged.raiseEvent(value);
}
},
},
/**
* Gets the event that is raised when the selected entity changes.
* @memberof Viewer.prototype
* @type {Event}
* @readonly
*/
selectedEntityChanged: {
get: function () {
return this._selectedEntityChanged;
},
},
/**
* Gets the event that is raised when the tracked entity changes.
* @memberof Viewer.prototype
* @type {Event}
* @readonly
*/
trackedEntityChanged: {
get: function () {
return this._cesiumWidget.trackedEntityChanged;
},
},
/**
* Gets or sets the data source to track with the viewer's clock.
* @memberof Viewer.prototype
* @type {DataSource}
*/
clockTrackedDataSource: {
get: function () {
return this._cesiumWidget.clockTrackedDataSource;
},
set: function (value) {
if (this._cesiumWidget.clockTrackedDataSource !== value) {
this._cesiumWidget.clockTrackedDataSource = value;
linkTimelineToDataSourceClock(this._timeline, value);
}
},
},
});
/**
* Extends the base viewer functionality with the provided mixin.
* A mixin may add additional properties, functions, or other behavior
* to the provided viewer instance.
*
* @param {Viewer.ViewerMixin} mixin The Viewer mixin to add to this instance.
* @param {object} [options] The options object to be passed to the mixin function.
*
* @see viewerDragDropMixin
*/
Viewer.prototype.extend = function (mixin, options) {
//>>includeStart('debug', pragmas.debug);
if (!defined(mixin)) {
throw new DeveloperError("mixin is required.");
}
//>>includeEnd('debug');
mixin(this, options);
};
/**
* Resizes the widget to match the container size.
* This function is called automatically as needed unless
* <code>useDefaultRenderLoop</code> is set to false.
*/
Viewer.prototype.resize = function () {
const cesiumWidget = this._cesiumWidget;
const container = this._container;
const width = container.clientWidth;
const height = container.clientHeight;
const animationExists = defined(this._animation);
const timelineExists = defined(this._timeline);
cesiumWidget.resize();
if (width === this._lastWidth && height === this._lastHeight) {
return;
}
const panelMaxHeight = height - 125;
const baseLayerPickerDropDown = this._baseLayerPickerDropDown;
if (defined(baseLayerPickerDropDown)) {
baseLayerPickerDropDown.style.maxHeight = `${panelMaxHeight}px`;
}
if (defined(this._geocoder)) {
const geocoderSuggestions = this._geocoder.searchSuggestionsContainer;
geocoderSuggestions.style.maxHeight = `${panelMaxHeight}px`;
}
Eif (defined(this._infoBox)) {
this._infoBox.viewModel.maxHeight = panelMaxHeight;
}
const timeline = this._timeline;
let animationContainer;
let animationWidth = 0;
let creditLeft = 5;
let creditBottom = 3;
let creditRight = 0;
if (
animationExists &&
window.getComputedStyle(this._animation.container).visibility !== "hidden"
) {
const lastWidth = this._lastWidth;
animationContainer = this._animation.container;
Iif (width > 900) {
animationWidth = 169;
if (lastWidth <= 900) {
animationContainer.style.width = "169px";
animationContainer.style.height = "112px";
this._animation.resize();
}
} else Iif (width >= 600) {
animationWidth = 136;
if (lastWidth < 600 || lastWidth > 900) {
animationContainer.style.width = "136px";
animationContainer.style.height = "90px";
this._animation.resize();
}
} else {
animationWidth = 106;
Eif (lastWidth > 600 || lastWidth === 0) {
animationContainer.style.width = "106px";
animationContainer.style.height = "70px";
this._animation.resize();
}
}
creditLeft = animationWidth + 5;
}
if (
timelineExists &&
window.getComputedStyle(this._timeline.container).visibility !== "hidden"
) {
const fullscreenButton = this._fullscreenButton;
const vrButton = this._vrButton;
const timelineContainer = timeline.container;
const timelineStyle = timelineContainer.style;
creditBottom = timelineContainer.clientHeight + 3;
timelineStyle.left = `${animationWidth}px`;
let pixels = 0;
if (defined(fullscreenButton)) {
pixels += fullscreenButton.container.clientWidth;
}
Iif (defined(vrButton)) {
pixels += vrButton.container.clientWidth;
}
timelineStyle.right = `${pixels}px`;
timeline.resize();
}
if (!timelineExists && defined(this._fullscreenButton)) {
// don't let long credits (like the default ion token) go behind the fullscreen button
creditRight = this._fullscreenButton.container.clientWidth;
}
this._bottomContainer.style.left = `${creditLeft}px`;
this._bottomContainer.style.bottom = `${creditBottom}px`;
this._bottomContainer.style.right = `${creditRight}px`;
this._lastWidth = width;
this._lastHeight = height;
};
/**
* This forces the widget to re-think its layout, including
* widget sizes and credit placement.
*/
Viewer.prototype.forceResize = function () {
this._lastWidth = 0;
this.resize();
};
/**
* Renders the scene. This function is called automatically
* unless <code>useDefaultRenderLoop</code> is set to false;
*/
Viewer.prototype.render = function () {
this._cesiumWidget.render();
};
/**
* @returns {boolean} true if the object has been destroyed, false otherwise.
*/
Viewer.prototype.isDestroyed = function () {
return false;
};
/**
* Destroys the widget. Should be called if permanently
* removing the widget from layout.
*/
Viewer.prototype.destroy = function () {
Eif (
defined(this.screenSpaceEventHandler) &&
!this.screenSpaceEventHandler.isDestroyed()
) {
this.screenSpaceEventHandler.removeInputAction(
ScreenSpaceEventType.LEFT_CLICK,
);
this.screenSpaceEventHandler.removeInputAction(
ScreenSpaceEventType.LEFT_DOUBLE_CLICK,
);
}
this._container.removeChild(this._element);
this._element.removeChild(this._toolbar);
this._eventHelper.removeAll();
if (defined(this._geocoder)) {
this._geocoder = this._geocoder.destroy();
}
if (defined(this._homeButton)) {
this._homeButton = this._homeButton.destroy();
}
if (defined(this._sceneModePicker)) {
this._sceneModePicker = this._sceneModePicker.destroy();
}
Iif (defined(this._projectionPicker)) {
this._projectionPicker = this._projectionPicker.destroy();
}
if (defined(this._baseLayerPicker)) {
this._baseLayerPicker = this._baseLayerPicker.destroy();
}
if (defined(this._animation)) {
this._element.removeChild(this._animation.container);
this._animation = this._animation.destroy();
}
if (defined(this._timeline)) {
this._timeline.removeEventListener(
"settime",
onTimelineScrubfunction,
false,
);
this._element.removeChild(this._timeline.container);
this._timeline = this._timeline.destroy();
}
if (defined(this._fullscreenButton)) {
this._fullscreenSubscription.dispose();
this._element.removeChild(this._fullscreenButton.container);
this._fullscreenButton = this._fullscreenButton.destroy();
}
Iif (defined(this._vrButton)) {
this._vrSubscription.dispose();
this._vrModeSubscription.dispose();
this._element.removeChild(this._vrButton.container);
this._vrButton = this._vrButton.destroy();
}
Eif (defined(this._infoBox)) {
this._element.removeChild(this._infoBox.container);
this._infoBox = this._infoBox.destroy();
}
if (defined(this._selectionIndicator)) {
this._element.removeChild(this._selectionIndicator.container);
this._selectionIndicator = this._selectionIndicator.destroy();
}
if (this._destroyClockViewModel) {
this._clockViewModel = this._clockViewModel.destroy();
}
this._cesiumWidget = this._cesiumWidget.destroy();
return destroyObject(this);
};
/**
* @private
*/
Viewer.prototype._dataSourceAdded = function (
dataSourceCollection,
dataSource,
) {
const entityCollection = dataSource.entities;
entityCollection.collectionChanged.addEventListener(
Viewer.prototype._onEntityCollectionChanged,
this,
);
};
/**
* @private
*/
Viewer.prototype._dataSourceRemoved = function (
dataSourceCollection,
dataSource,
) {
const entityCollection = dataSource.entities;
entityCollection.collectionChanged.removeEventListener(
Viewer.prototype._onEntityCollectionChanged,
this,
);
Iif (defined(this.selectedEntity)) {
if (
entityCollection.getById(this.selectedEntity.id) === this.selectedEntity
) {
this.selectedEntity = undefined;
}
}
};
/**
* @private
*/
Viewer.prototype._updateCanAnimate = function (that) {
return function (isUpdated) {
that._clockViewModel.canAnimate = isUpdated;
};
};
/**
* @private
*/
Viewer.prototype._onTick = function (clock) {
const time = clock.currentTime;
let position;
let enableCamera = false;
const selectedEntity = this.selectedEntity;
const showSelection = defined(selectedEntity) && this._enableInfoOrSelection;
if (
showSelection &&
selectedEntity.isShowing &&
selectedEntity.isAvailable(time)
) {
const state = this._cesiumWidget.dataSourceDisplay.getBoundingSphere(
selectedEntity,
true,
boundingSphereScratch,
);
Iif (state !== BoundingSphereState.FAILED) {
position = boundingSphereScratch.center;
} else Iif (defined(selectedEntity.position)) {
position = selectedEntity.position.getValue(time, position);
}
enableCamera = defined(position);
}
const selectionIndicatorViewModel = defined(this._selectionIndicator)
? this._selectionIndicator.viewModel
: undefined;
if (defined(selectionIndicatorViewModel)) {
selectionIndicatorViewModel.position = Cartesian3.clone(
position,
selectionIndicatorViewModel.position,
);
selectionIndicatorViewModel.showSelection = showSelection && enableCamera;
selectionIndicatorViewModel.update();
}
const infoBoxViewModel = defined(this._infoBox)
? this._infoBox.viewModel
: undefined;
Eif (defined(infoBoxViewModel)) {
infoBoxViewModel.showInfo = showSelection;
infoBoxViewModel.enableCamera = enableCamera;
infoBoxViewModel.isCameraTracking =
this.trackedEntity === this.selectedEntity;
if (showSelection) {
infoBoxViewModel.titleText = selectedEntity.name ?? selectedEntity.id;
infoBoxViewModel.description = Property.getValueOrDefault(
selectedEntity.description,
time,
"",
);
} else {
infoBoxViewModel.titleText = "";
infoBoxViewModel.description = "";
}
}
};
/**
* @private
*/
Viewer.prototype._onEntityCollectionChanged = function (
collection,
added,
removed,
) {
const length = removed.length;
for (let i = 0; i < length; i++) {
const removedObject = removed[i];
if (this.selectedEntity === removedObject) {
this.selectedEntity = undefined;
}
}
};
/**
* @private
*/
Viewer.prototype._onInfoBoxCameraClicked = function (infoBoxViewModel) {
if (
infoBoxViewModel.isCameraTracking &&
this.trackedEntity === this.selectedEntity
) {
this.trackedEntity = undefined;
} else {
const selectedEntity = this.selectedEntity;
const position = selectedEntity.position;
if (defined(position)) {
this.trackedEntity = this.selectedEntity;
} else {
this.zoomTo(this.selectedEntity);
}
}
};
/**
* @private
*/
Viewer.prototype._clearTrackedObject = function () {
this.trackedEntity = undefined;
};
/**
* @private
*/
Viewer.prototype._onInfoBoxClockClicked = function (infoBoxViewModel) {
this.selectedEntity = undefined;
};
/**
* @private
*/
Viewer.prototype._clearObjects = function () {
this.trackedEntity = undefined;
this.selectedEntity = undefined;
};
/**
* @private
*/
Viewer.prototype._onDataSourceChanged = function (dataSource) {
if (this.clockTrackedDataSource === dataSource) {
linkTimelineToDataSourceClock(this.timeline, dataSource);
}
};
/**
* @private
*/
Viewer.prototype._onDataSourceAdded = function (
dataSourceCollection,
dataSource,
) {
Eif (
this._cesiumWidget._automaticallyTrackDataSourceClocks &&
dataSource === this.clockTrackedDataSource
) {
// When data sources are added to the CesiumWidget they may be automatically
// tracked in that class but we also need to update the timeline in this class
linkTimelineToDataSourceClock(this._timeline, dataSource);
}
const id = dataSource.entities.id;
const removalFunc = this._eventHelper.add(
dataSource.changedEvent,
Viewer.prototype._onDataSourceChanged,
this,
);
this._dataSourceChangedListeners[id] = removalFunc;
};
/**
* @private
*/
Viewer.prototype._onDataSourceRemoved = function (
dataSourceCollection,
dataSource,
) {
const id = dataSource.entities.id;
this._dataSourceChangedListeners[id]();
this._dataSourceChangedListeners[id] = undefined;
};
/**
* Asynchronously sets the camera to view the provided entity, entities, or data source.
* If the data source is still in the process of loading or the visualization is otherwise still loading,
* this method waits for the data to be ready before performing the zoom.
*
* <p>The offset is heading/pitch/range in the local east-north-up reference frame centered at the center of the bounding sphere.
* The heading and the pitch angles are defined in the local east-north-up reference frame.
* The heading is the angle from y axis and increasing towards the x axis. Pitch is the rotation from the xy-plane. Positive pitch
* angles are above the plane. Negative pitch angles are below the plane. The range is the distance from the center. If the range is
* zero, a range will be computed such that the whole bounding sphere is visible.</p>
*
* <p>In 2D, there must be a top down view. The camera will be placed above the target looking down. The height above the
* target will be the range. The heading will be determined from the offset. If the heading cannot be
* determined from the offset, the heading will be north.</p>
*
* @param {Entity|Entity[]|EntityCollection|DataSource|ImageryLayer|Cesium3DTileset|TimeDynamicPointCloud|Promise<Entity|Entity[]|EntityCollection|DataSource|ImageryLayer|Cesium3DTileset|TimeDynamicPointCloud|VoxelPrimitive>} target The entity, array of entities, entity collection, data source, Cesium3DTileset, point cloud, or imagery layer to view. You can also pass a promise that resolves to one of the previously mentioned types.
* @param {HeadingPitchRange} [offset] The offset from the center of the entity in the local east-north-up reference frame.
* @returns {Promise<boolean>} A Promise that resolves to true if the zoom was successful or false if the target is not currently visualized in the scene or the zoom was cancelled.
*/
Viewer.prototype.zoomTo = function (target, offset) {
return this._cesiumWidget.zoomTo(target, offset);
};
/**
* Flies the camera to the provided entity, entities, or data source.
* If the data source is still in the process of loading or the visualization is otherwise still loading,
* this method waits for the data to be ready before performing the flight.
*
* <p>The offset is heading/pitch/range in the local east-north-up reference frame centered at the center of the bounding sphere.
* The heading and the pitch angles are defined in the local east-north-up reference frame.
* The heading is the angle from y axis and increasing towards the x axis. Pitch is the rotation from the xy-plane. Positive pitch
* angles are above the plane. Negative pitch angles are below the plane. The range is the distance from the center. If the range is
* zero, a range will be computed such that the whole bounding sphere is visible.</p>
*
* <p>In 2D, there must be a top down view. The camera will be placed above the target looking down. The height above the
* target will be the range. The heading will be determined from the offset. If the heading cannot be
* determined from the offset, the heading will be north.</p>
*
* @param {Entity|Entity[]|EntityCollection|DataSource|ImageryLayer|Cesium3DTileset|TimeDynamicPointCloud|Promise<Entity|Entity[]|EntityCollection|DataSource|ImageryLayer|Cesium3DTileset|TimeDynamicPointCloud|VoxelPrimitive>} target The entity, array of entities, entity collection, data source, Cesium3DTileset, point cloud, or imagery layer to view. You can also pass a promise that resolves to one of the previously mentioned types.
* @param {object} [options] Object with the following properties:
* @param {number} [options.duration=3.0] The duration of the flight in seconds.
* @param {number} [options.maximumHeight] The maximum height at the peak of the flight.
* @param {HeadingPitchRange} [options.offset] The offset from the target in the local east-north-up reference frame centered at the target.
* @returns {Promise<boolean>} A Promise that resolves to true if the flight was successful or false if the target is not currently visualized in the scene or the flight was cancelled. //TODO: Cleanup entity mentions
*/
Viewer.prototype.flyTo = function (target, options) {
return this._cesiumWidget.flyTo(target, options);
};
/**
* A function that augments a Viewer instance with additional functionality.
* @callback Viewer.ViewerMixin
* @param {Viewer} viewer The viewer instance.
* @param {object} options Options object to be passed to the mixin function.
*
* @see Viewer#extend
*/
export default Viewer;
|