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 | 1x 1x 1x 1x 26x 26x 26x 26x 1x 1x 4x 4x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 2x 2x 2x 2x 2x 1x 1x 1x 1x 2x 1x 26x 26x 26x 1x 179x 106x 179x 1x 17x 17x 5x 1x 10x 10x 26x 26x 26x 1x 23x 23x 23x 23x 23x 23x 23x 23x 23x 1x 26x 26x 26x 23x 23x 26x 1x 28x 28x 28x 28x 28x 26x 26x 26x 26x 26x 26x 28x 26x 26x 26x 26x 26x 26x 26x 26x 26x 26x 26x 26x 1x 25x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 1x 1x 1x 1x 1x 26x 26x 26x 26x 26x 26x 26x 26x 26x 26x 26x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 1x 1x 1x 1x 1x 1x 1x 28x 28x 25x 25x 25x 25x 25x 1x 1x 1x 1x 1x 1x 1x 1x 1x 25x 25x 25x 25x 25x 25x 25x 23x 23x 28x 23x 25x 24x 1x 1x 1x 1x 2x 1x 28x 28x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 28x 28x 28x 28x 28x 14x 14x 14x 3x 3x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 3x 3x 9x 9x 9x 1x 1x 1x 1x 1x 1x 2x 2x 2x 2x 1x 1x 1x 1x 4x 4x 4x 12x 12x 12x 12x 4x 1x 4x 4x 4x 4x 3x 3x 4x 4x 1x 1x 1x 1x 1x 1x 1x 1x 7x 7x 7x 7x 7x 2x 2x 7x 7x 2x 7x 7x 7x 7x 7x 7x 7x 3x 3x 3x 3x 3x 1x 1x 1x 1x 3x 7x 7x 1x 1x 7x 7x 1x 7x 7x 3x 3x 3x 3x 3x 3x 1x 2x 1x 3x 3x 1x 2x 1x 3x 3x 3x 3x 3x 3x 7x 7x 7x 2x 2x 1x 2x 7x 28x 28x 28x 28x 25x 3x 3x 3x 3x 1x 1x 2x 3x 3x 3x 3x 3x 3x 3x 3x 1x 3x 3x 3x 3x 3x 3x 3x 2x 2x 2x 2x 1x 2x 2x 2x 2x 2x 8x 8x 2x 2x 2x 2x 2x 2x 6x 6x 6x 6x 6x 24x 24x 6x 6x 6x 6x 5x 5x 5x 5x 5x 1x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 1x 1x 1x 5x 56x 56x 56x 48x 8x 8x 1x 1x 7x 7x 7x 3x 7x 7x 7x 8x 7x 7x 7x 7x 7x 7x 7x 2x 7x 7x 7x 2x 2x 2x 2x 2x 2x 2x 2x 7x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 2x 2x 2x 2x 2x 1x 1x 1x 1x 1x 2x 2x 2x 2x 2x 28x 28x 28x 28x 26x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 11x 11x 11x 4x 7x 7x 7x 7x 6x 6x 1x 1x 1x 1x 1x 1x 7x 7x 7x 24x 24x 24x 24x 14x 14x 10x 10x 24x 26x 23x 26x 26x 26x 35x 35x 26x 222x 222x 36x 222x 222x 222x 222x 14x 14x 14x 56x 14x | import buildModuleUrl from "../Core/buildModuleUrl.js";
import Cartesian2 from "../Core/Cartesian2.js";
import Cartesian3 from "../Core/Cartesian3.js";
import Cartographic from "../Core/Cartographic.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 Ellipsoid from "../Core/Ellipsoid.js";
import Iso8601 from "../Core/Iso8601.js";
import JulianDate from "../Core/JulianDate.js";
import CesiumMath from "../Core/Math.js";
import Rectangle from "../Core/Rectangle.js";
import ReferenceFrame from "../Core/ReferenceFrame.js";
import Resource from "../Core/Resource.js";
import RuntimeError from "../Core/RuntimeError.js";
import TimeInterval from "../Core/TimeInterval.js";
import TimeIntervalCollection from "../Core/TimeIntervalCollection.js";
import HeightReference from "../Scene/HeightReference.js";
import HorizontalOrigin from "../Scene/HorizontalOrigin.js";
import VerticalOrigin from "../Scene/VerticalOrigin.js";
import {
configure,
BlobReader,
BlobWriter,
TextReader,
ZipWriter,
} from "@zip.js/zip.js/lib/zip-core.js";
import BillboardGraphics from "./BillboardGraphics.js";
import CompositePositionProperty from "./CompositePositionProperty.js";
import ModelGraphics from "./ModelGraphics.js";
import RectangleGraphics from "./RectangleGraphics.js";
import SampledPositionProperty from "./SampledPositionProperty.js";
import SampledProperty from "./SampledProperty.js";
import ScaledPositionProperty from "./ScaledPositionProperty.js";
const BILLBOARD_SIZE = 32;
const kmlNamespace = "http://www.opengis.net/kml/2.2";
const gxNamespace = "http://www.google.com/kml/ext/2.2";
const xmlnsNamespace = "http://www.w3.org/2000/xmlns/";
//
// Handles files external to the KML (eg. textures and models)
//
function ExternalFileHandler(modelCallback) {
this._files = {};
this._promises = [];
this._count = 0;
this._modelCallback = modelCallback;
}
const imageTypeRegex = /^data:image\/([^,;]+)/;
ExternalFileHandler.prototype.texture = function (texture) {
const that = this;
let filename;
if (typeof texture === "string" || texture instanceof Resource) {
texture = Resource.createIfNeeded(texture);
Eif (!texture.isDataUri) {
return texture.url;
}
// If its a data URI try and get the correct extension and then fetch the blob
const regexResult = texture.url.match(imageTypeRegex);
filename = `texture_${++this._count}`;
if (defined(regexResult)) {
filename += `.${regexResult[1]}`;
}
const promise = texture.fetchBlob().then(function (blob) {
that._files[filename] = blob;
});
this._promises.push(promise);
return filename;
}
Eif (texture instanceof HTMLCanvasElement) {
filename = `texture_${++this._count}.png`;
const promise = new Promise((resolve) => {
texture.toBlob(function (blob) {
that._files[filename] = blob;
resolve();
});
});
this._promises.push(promise);
return filename;
}
return "";
};
function getModelBlobHander(that, filename) {
return function (blob) {
that._files[filename] = blob;
};
}
ExternalFileHandler.prototype.model = function (model, time) {
const modelCallback = this._modelCallback;
Iif (!defined(modelCallback)) {
throw new RuntimeError(
"Encountered a model entity while exporting to KML, but no model callback was supplied.",
);
}
const externalFiles = {};
const url = modelCallback(model, time, externalFiles);
// Iterate through external files and add them to our list once the promise resolves
for (const filename in externalFiles) {
Eif (externalFiles.hasOwnProperty(filename)) {
const promise = Promise.resolve(externalFiles[filename]);
this._promises.push(promise);
promise.then(getModelBlobHander(this, filename));
}
}
return url;
};
Object.defineProperties(ExternalFileHandler.prototype, {
promise: {
get: function () {
return Promise.all(this._promises);
},
},
files: {
get: function () {
return this._files;
},
},
});
//
// Handles getting values from properties taking the desired time and default values into account
//
function ValueGetter(time) {
this._time = time;
}
ValueGetter.prototype.get = function (property, defaultVal, result) {
let value;
if (defined(property)) {
value = defined(property.getValue)
? property.getValue(this._time, result)
: property;
}
return value ?? defaultVal;
};
ValueGetter.prototype.getColor = function (property, defaultVal) {
const result = this.get(property, defaultVal);
if (defined(result)) {
return colorToString(result);
}
};
ValueGetter.prototype.getMaterialType = function (property) {
Iif (!defined(property)) {
return;
}
return property.getType(this._time);
};
//
// Caches styles so we don't generate a ton of duplicate styles
//
function StyleCache() {
this._ids = {};
this._styles = {};
this._count = 0;
}
StyleCache.prototype.get = function (element) {
const ids = this._ids;
const key = element.innerHTML;
Iif (defined(ids[key])) {
return ids[key];
}
let styleId = `style-${++this._count}`;
element.setAttribute("id", styleId);
// Store with #
styleId = `#${styleId}`;
ids[key] = styleId;
this._styles[key] = element;
return styleId;
};
StyleCache.prototype.save = function (parentElement) {
const styles = this._styles;
const firstElement = parentElement.childNodes[0];
for (const key in styles) {
Eif (styles.hasOwnProperty(key)) {
parentElement.insertBefore(styles[key], firstElement);
}
}
};
//
// Manages the generation of IDs because an entity may have geometry and a Folder for children
//
function IdManager() {
this._ids = {};
}
IdManager.prototype.get = function (id) {
Iif (!defined(id)) {
return this.get(createGuid());
}
const ids = this._ids;
Eif (!defined(ids[id])) {
ids[id] = 0;
return id;
}
return `${id.toString()}-${++ids[id]}`;
};
/**
* @typedef exportKmlResultKml
* @type {object}
* @property {string} kml The generated KML.
* @property {Object<string, Blob>} externalFiles An object dictionary of external files
*/
/**
* @typedef exportKmlResultKmz
* @type {object}
* @property {Blob} kmz The generated kmz file.
*/
/**
* Exports an EntityCollection as a KML document. Only Point, Billboard, Model, Path, Polygon, Polyline geometries
* will be exported. Note that there is not a 1 to 1 mapping of Entity properties to KML Feature properties. For
* example, entity properties that are time dynamic but cannot be dynamic in KML are exported with their values at
* options.time or the beginning of the EntityCollection's time interval if not specified. For time-dynamic properties
* that are supported in KML, we use the samples if it is a {@link SampledProperty} otherwise we sample the value using
* the options.sampleDuration. Point, Billboard, Model and Path geometries with time-dynamic positions will be exported
* as gx:Track Features. Not all Materials are representable in KML, so for more advanced Materials just the primary
* color is used. Canvas objects are exported as PNG images.
*
* @function exportKml
*
* @param {object} options An object with the following properties:
* @param {EntityCollection} options.entities The EntityCollection to export as KML.
* @param {Ellipsoid} [options.ellipsoid=Ellipsoid.default] The ellipsoid for the output file.
* @param {exportKmlModelCallback} [options.modelCallback] A callback that will be called with a {@link ModelGraphics} instance and should return the URI to use in the KML. Required if a model exists in the entity collection.
* @param {JulianDate} [options.time=entities.computeAvailability().start] The time value to use to get properties that are not time varying in KML.
* @param {TimeInterval} [options.defaultAvailability=entities.computeAvailability()] The interval that will be sampled if an entity doesn't have an availability.
* @param {number} [options.sampleDuration=60] The number of seconds to sample properties that are varying in KML.
* @param {boolean} [options.kmz=false] If true KML and external files will be compressed into a kmz file.
*
* @returns {Promise<exportKmlResultKml|exportKmlResultKmz>} A promise that resolved to an object containing the KML string and a dictionary of external file blobs, or a kmz file as a blob if options.kmz is true.
* @demo {@link https://sandcastle.cesium.com/index.html?src=Export%20KML.html|Cesium Sandcastle KML Export Demo}
* @example
* Cesium.exportKml({
* entities: entityCollection
* })
* .then(function(result) {
* // The XML string is in result.kml
*
* const externalFiles = result.externalFiles
* for(const file in externalFiles) {
* // file is the name of the file used in the KML document as the href
* // externalFiles[file] is a blob with the contents of the file
* }
* });
*
*/
function exportKml(options) {
options = options ?? Frozen.EMPTY_OBJECT;
const entities = options.entities;
const kmz = options.kmz ?? false;
//>>includeStart('debug', pragmas.debug);
Iif (!defined(entities)) {
throw new DeveloperError("entities is required.");
}
//>>includeEnd('debug');
// Get the state that is passed around during the recursion
// This is separated out for testing.
const state = exportKml._createState(options);
// Filter EntityCollection so we only have top level entities
const rootEntities = entities.values.filter(function (entity) {
return !defined(entity.parent);
});
// Add the <Document>
const kmlDoc = state.kmlDoc;
const kmlElement = kmlDoc.documentElement;
kmlElement.setAttributeNS(xmlnsNamespace, "xmlns:gx", gxNamespace);
const kmlDocumentElement = kmlDoc.createElement("Document");
kmlElement.appendChild(kmlDocumentElement);
// Create the KML Hierarchy
recurseEntities(state, kmlDocumentElement, rootEntities);
// Write out the <Style> elements
state.styleCache.save(kmlDocumentElement);
// Once all the blobs have resolved return the KML string along with the blob collection
const externalFileHandler = state.externalFileHandler;
return externalFileHandler.promise.then(function () {
const serializer = new XMLSerializer();
const kmlString = serializer.serializeToString(state.kmlDoc);
if (kmz) {
return createKmz(kmlString, externalFileHandler.files);
}
return {
kml: kmlString,
externalFiles: externalFileHandler.files,
};
});
}
async function createKmz(kmlString, externalFiles) {
const zWorkerUri = buildModuleUrl("ThirdParty/Workers/zip-web-worker.js");
const zWasmUri = buildModuleUrl("ThirdParty/zip-module.wasm");
configure({
workerURI: zWorkerUri,
wasmURI: zWasmUri,
});
const blobWriter = new BlobWriter("application/vnd.google-earth.kmz");
const writer = new ZipWriter(blobWriter);
// We need to only write one file at a time so the zip doesn't get corrupted
await writer.add("doc.kml", new TextReader(kmlString));
const keys = Object.keys(externalFiles);
await addExternalFilesToZip(writer, keys, externalFiles, 0);
await writer.close();
const blob = await blobWriter.getData();
return {
kmz: blob,
};
}
async function addExternalFilesToZip(writer, keys, externalFiles, index) {
if (keys.length === index) {
return;
}
const filename = keys[index];
await writer.add(filename, new BlobReader(externalFiles[filename]));
return addExternalFilesToZip(writer, keys, externalFiles, index + 1);
}
exportKml._createState = function (options) {
const entities = options.entities;
const styleCache = new StyleCache();
// Use the start time as the default because just in case they define
// properties with an interval even if they don't change.
const entityAvailability = entities.computeAvailability();
const time = defined(options.time) ? options.time : entityAvailability.start;
// Figure out how we will sample dynamic position properties
let defaultAvailability = options.defaultAvailability ?? entityAvailability;
const sampleDuration = options.sampleDuration ?? 60;
// Make sure we don't have infinite availability if we need to sample
Iif (defaultAvailability.start === Iso8601.MINIMUM_VALUE) {
if (defaultAvailability.stop === Iso8601.MAXIMUM_VALUE) {
// Infinite, so just use the default
defaultAvailability = new TimeInterval();
} else {
// No start time, so just sample 10 times before the stop
JulianDate.addSeconds(
defaultAvailability.stop,
-10 * sampleDuration,
defaultAvailability.start,
);
}
} else Iif (defaultAvailability.stop === Iso8601.MAXIMUM_VALUE) {
// No stop time, so just sample 10 times after the start
JulianDate.addSeconds(
defaultAvailability.start,
10 * sampleDuration,
defaultAvailability.stop,
);
}
const externalFileHandler = new ExternalFileHandler(options.modelCallback);
const kmlDoc = document.implementation.createDocument(kmlNamespace, "kml");
return {
kmlDoc: kmlDoc,
ellipsoid: options.ellipsoid ?? Ellipsoid.default,
idManager: new IdManager(),
styleCache: styleCache,
externalFileHandler: externalFileHandler,
time: time,
valueGetter: new ValueGetter(time),
sampleDuration: sampleDuration,
// Wrap it in a TimeIntervalCollection because that is what entity.availability is
defaultAvailability: new TimeIntervalCollection([defaultAvailability]),
};
};
function recurseEntities(state, parentNode, entities) {
const kmlDoc = state.kmlDoc;
const styleCache = state.styleCache;
const valueGetter = state.valueGetter;
const idManager = state.idManager;
const count = entities.length;
let overlays;
let geometries;
let styles;
for (let i = 0; i < count; ++i) {
const entity = entities[i];
overlays = [];
geometries = [];
styles = [];
createPoint(state, entity, geometries, styles);
createLineString(state, entity.polyline, geometries, styles);
createPolygon(state, entity.rectangle, geometries, styles, overlays);
createPolygon(state, entity.polygon, geometries, styles, overlays);
createModel(state, entity, entity.model, geometries, styles);
let timeSpan;
const availability = entity.availability;
Iif (defined(availability)) {
timeSpan = kmlDoc.createElement("TimeSpan");
if (!JulianDate.equals(availability.start, Iso8601.MINIMUM_VALUE)) {
timeSpan.appendChild(
createBasicElementWithText(
kmlDoc,
"begin",
JulianDate.toIso8601(availability.start),
),
);
}
if (!JulianDate.equals(availability.stop, Iso8601.MAXIMUM_VALUE)) {
timeSpan.appendChild(
createBasicElementWithText(
kmlDoc,
"end",
JulianDate.toIso8601(availability.stop),
),
);
}
}
for (let overlayIndex = 0; overlayIndex < overlays.length; ++overlayIndex) {
const overlay = overlays[overlayIndex];
overlay.setAttribute("id", idManager.get(entity.id));
overlay.appendChild(
createBasicElementWithText(kmlDoc, "name", entity.name),
);
overlay.appendChild(
createBasicElementWithText(kmlDoc, "visibility", entity.show),
);
overlay.appendChild(
createBasicElementWithText(kmlDoc, "description", entity.description),
);
Iif (defined(timeSpan)) {
overlay.appendChild(timeSpan);
}
parentNode.appendChild(overlay);
}
const geometryCount = geometries.length;
if (geometryCount > 0) {
const placemark = kmlDoc.createElement("Placemark");
placemark.setAttribute("id", idManager.get(entity.id));
let name = entity.name;
const labelGraphics = entity.label;
if (defined(labelGraphics)) {
const labelStyle = kmlDoc.createElement("LabelStyle");
// KML only shows the name as a label, so just change the name if we need to show a label
const text = valueGetter.get(labelGraphics.text);
name = defined(text) && text.length > 0 ? text : name;
const color = valueGetter.getColor(labelGraphics.fillColor);
Iif (defined(color)) {
labelStyle.appendChild(
createBasicElementWithText(kmlDoc, "color", color),
);
labelStyle.appendChild(
createBasicElementWithText(kmlDoc, "colorMode", "normal"),
);
}
const scale = valueGetter.get(labelGraphics.scale);
Eif (defined(scale)) {
labelStyle.appendChild(
createBasicElementWithText(kmlDoc, "scale", scale),
);
}
styles.push(labelStyle);
}
placemark.appendChild(createBasicElementWithText(kmlDoc, "name", name));
placemark.appendChild(
createBasicElementWithText(kmlDoc, "visibility", entity.show),
);
placemark.appendChild(
createBasicElementWithText(kmlDoc, "description", entity.description),
);
Iif (defined(timeSpan)) {
placemark.appendChild(timeSpan);
}
parentNode.appendChild(placemark);
const styleCount = styles.length;
if (styleCount > 0) {
const style = kmlDoc.createElement("Style");
for (let styleIndex = 0; styleIndex < styleCount; ++styleIndex) {
style.appendChild(styles[styleIndex]);
}
placemark.appendChild(
createBasicElementWithText(kmlDoc, "styleUrl", styleCache.get(style)),
);
}
if (geometries.length === 1) {
placemark.appendChild(geometries[0]);
} else Eif (geometries.length > 1) {
const multigeometry = kmlDoc.createElement("MultiGeometry");
for (
let geometryIndex = 0;
geometryIndex < geometryCount;
++geometryIndex
) {
multigeometry.appendChild(geometries[geometryIndex]);
}
placemark.appendChild(multigeometry);
}
}
const children = entity._children;
if (children.length > 0) {
const folderNode = kmlDoc.createElement("Folder");
folderNode.setAttribute("id", idManager.get(entity.id));
folderNode.appendChild(
createBasicElementWithText(kmlDoc, "name", entity.name),
);
folderNode.appendChild(
createBasicElementWithText(kmlDoc, "visibility", entity.show),
);
folderNode.appendChild(
createBasicElementWithText(kmlDoc, "description", entity.description),
);
parentNode.appendChild(folderNode);
recurseEntities(state, folderNode, children);
}
}
}
const scratchCartesian3 = new Cartesian3();
const scratchCartographic = new Cartographic();
const scratchJulianDate = new JulianDate();
function createPoint(state, entity, geometries, styles) {
const kmlDoc = state.kmlDoc;
const ellipsoid = state.ellipsoid;
const valueGetter = state.valueGetter;
const pointGraphics = entity.billboard ?? entity.point;
if (!defined(pointGraphics) && !defined(entity.path)) {
return;
}
// If the point isn't constant then create gx:Track or gx:MultiTrack
const entityPositionProperty = entity.position;
if (!entityPositionProperty.isConstant) {
createTracks(state, entity, pointGraphics, geometries, styles);
return;
}
valueGetter.get(entityPositionProperty, undefined, scratchCartesian3);
const coordinates = createBasicElementWithText(
kmlDoc,
"coordinates",
getCoordinates(scratchCartesian3, ellipsoid),
);
const pointGeometry = kmlDoc.createElement("Point");
// Set altitude mode
const altitudeMode = kmlDoc.createElement("altitudeMode");
altitudeMode.appendChild(
getAltitudeMode(state, pointGraphics.heightReference),
);
pointGeometry.appendChild(altitudeMode);
pointGeometry.appendChild(coordinates);
geometries.push(pointGeometry);
// Create style
const iconStyle =
pointGraphics instanceof BillboardGraphics
? createIconStyleFromBillboard(state, pointGraphics)
: createIconStyleFromPoint(state, pointGraphics);
styles.push(iconStyle);
}
function createTracks(state, entity, pointGraphics, geometries, styles) {
const kmlDoc = state.kmlDoc;
const ellipsoid = state.ellipsoid;
const valueGetter = state.valueGetter;
let intervals;
const entityPositionProperty = entity.position;
let useEntityPositionProperty = true;
Iif (entityPositionProperty instanceof CompositePositionProperty) {
intervals = entityPositionProperty.intervals;
useEntityPositionProperty = false;
} else {
intervals = entity.availability ?? state.defaultAvailability;
}
const isModel = pointGraphics instanceof ModelGraphics;
let i, j, times;
const tracks = [];
for (i = 0; i < intervals.length; ++i) {
const interval = intervals.get(i);
let positionProperty = useEntityPositionProperty
? entityPositionProperty
: interval.data;
const trackAltitudeMode = kmlDoc.createElement("altitudeMode");
// This is something that KML importing uses to handle clampToGround,
// so just extract the internal property and set the altitudeMode.
Iif (positionProperty instanceof ScaledPositionProperty) {
positionProperty = positionProperty._value;
trackAltitudeMode.appendChild(
getAltitudeMode(state, HeightReference.CLAMP_TO_GROUND),
);
} else if (defined(pointGraphics)) {
trackAltitudeMode.appendChild(
getAltitudeMode(state, pointGraphics.heightReference),
);
} else E{
// Path graphics only, which has no height reference
trackAltitudeMode.appendChild(
getAltitudeMode(state, HeightReference.NONE),
);
}
const positionTimes = [];
const positionValues = [];
Iif (positionProperty.isConstant) {
valueGetter.get(positionProperty, undefined, scratchCartesian3);
const constCoordinates = createBasicElementWithText(
kmlDoc,
"coordinates",
getCoordinates(scratchCartesian3, ellipsoid),
);
// This interval is constant so add a track with the same position
positionTimes.push(JulianDate.toIso8601(interval.start));
positionValues.push(constCoordinates);
positionTimes.push(JulianDate.toIso8601(interval.stop));
positionValues.push(constCoordinates);
} else if (positionProperty instanceof SampledPositionProperty) {
times = positionProperty._property._times;
for (j = 0; j < times.length; ++j) {
positionTimes.push(JulianDate.toIso8601(times[j]));
positionProperty.getValueInReferenceFrame(
times[j],
ReferenceFrame.FIXED,
scratchCartesian3,
);
positionValues.push(getCoordinates(scratchCartesian3, ellipsoid));
}
} else Iif (positionProperty instanceof SampledProperty) {
times = positionProperty._times;
const values = positionProperty._values;
for (j = 0; j < times.length; ++j) {
positionTimes.push(JulianDate.toIso8601(times[j]));
Cartesian3.fromArray(values, j * 3, scratchCartesian3);
positionValues.push(getCoordinates(scratchCartesian3, ellipsoid));
}
} else {
const duration = state.sampleDuration;
interval.start.clone(scratchJulianDate);
Iif (!interval.isStartIncluded) {
JulianDate.addSeconds(scratchJulianDate, duration, scratchJulianDate);
}
const stopDate = interval.stop;
while (JulianDate.lessThan(scratchJulianDate, stopDate)) {
positionProperty.getValue(scratchJulianDate, scratchCartesian3);
positionTimes.push(JulianDate.toIso8601(scratchJulianDate));
positionValues.push(getCoordinates(scratchCartesian3, ellipsoid));
JulianDate.addSeconds(scratchJulianDate, duration, scratchJulianDate);
}
Eif (
interval.isStopIncluded &&
JulianDate.equals(scratchJulianDate, stopDate)
) {
positionProperty.getValue(scratchJulianDate, scratchCartesian3);
positionTimes.push(JulianDate.toIso8601(scratchJulianDate));
positionValues.push(getCoordinates(scratchCartesian3, ellipsoid));
}
}
const trackGeometry = kmlDoc.createElementNS(gxNamespace, "Track");
trackGeometry.appendChild(trackAltitudeMode);
for (let k = 0; k < positionTimes.length; ++k) {
const when = createBasicElementWithText(kmlDoc, "when", positionTimes[k]);
const coord = createBasicElementWithText(
kmlDoc,
"coord",
positionValues[k],
gxNamespace,
);
trackGeometry.appendChild(when);
trackGeometry.appendChild(coord);
}
if (isModel) {
trackGeometry.appendChild(createModelGeometry(state, pointGraphics));
}
tracks.push(trackGeometry);
}
// If one track, then use it otherwise combine into a multitrack
if (tracks.length === 1) {
geometries.push(tracks[0]);
} else Eif (tracks.length > 1) {
const multiTrackGeometry = kmlDoc.createElementNS(
gxNamespace,
"MultiTrack",
);
for (i = 0; i < tracks.length; ++i) {
multiTrackGeometry.appendChild(tracks[i]);
}
geometries.push(multiTrackGeometry);
}
// Create style
if (defined(pointGraphics) && !isModel) {
const iconStyle =
pointGraphics instanceof BillboardGraphics
? createIconStyleFromBillboard(state, pointGraphics)
: createIconStyleFromPoint(state, pointGraphics);
styles.push(iconStyle);
}
// See if we have a line that needs to be drawn
const path = entity.path;
if (defined(path)) {
const width = valueGetter.get(path.width);
const material = path.material;
Eif (defined(material) || defined(width)) {
const lineStyle = kmlDoc.createElement("LineStyle");
Eif (defined(width)) {
lineStyle.appendChild(
createBasicElementWithText(kmlDoc, "width", width),
);
}
processMaterial(state, material, lineStyle);
styles.push(lineStyle);
}
}
}
function createIconStyleFromPoint(state, pointGraphics) {
const kmlDoc = state.kmlDoc;
const valueGetter = state.valueGetter;
const iconStyle = kmlDoc.createElement("IconStyle");
const color = valueGetter.getColor(pointGraphics.color);
if (defined(color)) {
iconStyle.appendChild(createBasicElementWithText(kmlDoc, "color", color));
iconStyle.appendChild(
createBasicElementWithText(kmlDoc, "colorMode", "normal"),
);
}
const pixelSize = valueGetter.get(pointGraphics.pixelSize);
if (defined(pixelSize)) {
iconStyle.appendChild(
createBasicElementWithText(kmlDoc, "scale", pixelSize / BILLBOARD_SIZE),
);
}
return iconStyle;
}
function createIconStyleFromBillboard(state, billboardGraphics) {
const kmlDoc = state.kmlDoc;
const valueGetter = state.valueGetter;
const externalFileHandler = state.externalFileHandler;
const iconStyle = kmlDoc.createElement("IconStyle");
let image = valueGetter.get(billboardGraphics.image);
if (defined(image)) {
image = externalFileHandler.texture(image);
const icon = kmlDoc.createElement("Icon");
icon.appendChild(createBasicElementWithText(kmlDoc, "href", image));
const imageSubRegion = valueGetter.get(billboardGraphics.imageSubRegion);
if (defined(imageSubRegion)) {
icon.appendChild(
createBasicElementWithText(kmlDoc, "x", imageSubRegion.x, gxNamespace),
);
icon.appendChild(
createBasicElementWithText(kmlDoc, "y", imageSubRegion.y, gxNamespace),
);
icon.appendChild(
createBasicElementWithText(
kmlDoc,
"w",
imageSubRegion.width,
gxNamespace,
),
);
icon.appendChild(
createBasicElementWithText(
kmlDoc,
"h",
imageSubRegion.height,
gxNamespace,
),
);
}
iconStyle.appendChild(icon);
}
const color = valueGetter.getColor(billboardGraphics.color);
if (defined(color)) {
iconStyle.appendChild(createBasicElementWithText(kmlDoc, "color", color));
iconStyle.appendChild(
createBasicElementWithText(kmlDoc, "colorMode", "normal"),
);
}
let scale = valueGetter.get(billboardGraphics.scale);
if (defined(scale)) {
iconStyle.appendChild(createBasicElementWithText(kmlDoc, "scale", scale));
}
const pixelOffset = valueGetter.get(billboardGraphics.pixelOffset);
if (defined(pixelOffset)) {
scale = scale ?? 1.0;
Cartesian2.divideByScalar(pixelOffset, scale, pixelOffset);
const width = valueGetter.get(billboardGraphics.width, BILLBOARD_SIZE);
const height = valueGetter.get(billboardGraphics.height, BILLBOARD_SIZE);
// KML Hotspots are from the bottom left, but we work from the top left
// Move to left
const horizontalOrigin = valueGetter.get(
billboardGraphics.horizontalOrigin,
HorizontalOrigin.CENTER,
);
if (horizontalOrigin === HorizontalOrigin.CENTER) {
pixelOffset.x -= width * 0.5;
} else if (horizontalOrigin === HorizontalOrigin.RIGHT) {
pixelOffset.x -= width;
}
// Move to bottom
const verticalOrigin = valueGetter.get(
billboardGraphics.verticalOrigin,
VerticalOrigin.CENTER,
);
if (verticalOrigin === VerticalOrigin.TOP) {
pixelOffset.y += height;
} else if (verticalOrigin === VerticalOrigin.CENTER) {
pixelOffset.y += height * 0.5;
}
const hotSpot = kmlDoc.createElement("hotSpot");
hotSpot.setAttribute("x", -pixelOffset.x);
hotSpot.setAttribute("y", pixelOffset.y);
hotSpot.setAttribute("xunits", "pixels");
hotSpot.setAttribute("yunits", "pixels");
iconStyle.appendChild(hotSpot);
}
// We can only specify heading so if axis isn't Z, then we skip the rotation
// GE treats a heading of zero as no heading but can still point north using a 360 degree angle
let rotation = valueGetter.get(billboardGraphics.rotation);
const alignedAxis = valueGetter.get(billboardGraphics.alignedAxis);
if (defined(rotation) && Cartesian3.equals(Cartesian3.UNIT_Z, alignedAxis)) {
rotation = CesiumMath.toDegrees(-rotation);
if (rotation === 0) {
rotation = 360;
}
iconStyle.appendChild(
createBasicElementWithText(kmlDoc, "heading", rotation),
);
}
return iconStyle;
}
function createLineString(state, polylineGraphics, geometries, styles) {
const kmlDoc = state.kmlDoc;
const ellipsoid = state.ellipsoid;
const valueGetter = state.valueGetter;
if (!defined(polylineGraphics)) {
return;
}
const lineStringGeometry = kmlDoc.createElement("LineString");
// Set altitude mode
const altitudeMode = kmlDoc.createElement("altitudeMode");
const clampToGround = valueGetter.get(polylineGraphics.clampToGround, false);
let altitudeModeText;
if (clampToGround) {
lineStringGeometry.appendChild(
createBasicElementWithText(kmlDoc, "tessellate", true),
);
altitudeModeText = kmlDoc.createTextNode("clampToGround");
} else {
altitudeModeText = kmlDoc.createTextNode("absolute");
}
altitudeMode.appendChild(altitudeModeText);
lineStringGeometry.appendChild(altitudeMode);
// Set coordinates
const positionsProperty = polylineGraphics.positions;
const cartesians = valueGetter.get(positionsProperty);
const coordinates = createBasicElementWithText(
kmlDoc,
"coordinates",
getCoordinates(cartesians, ellipsoid),
);
lineStringGeometry.appendChild(coordinates);
// Set draw order
const zIndex = valueGetter.get(polylineGraphics.zIndex);
if (clampToGround && defined(zIndex)) {
lineStringGeometry.appendChild(
createBasicElementWithText(kmlDoc, "drawOrder", zIndex, gxNamespace),
);
}
geometries.push(lineStringGeometry);
// Create style
const lineStyle = kmlDoc.createElement("LineStyle");
const width = valueGetter.get(polylineGraphics.width);
Eif (defined(width)) {
lineStyle.appendChild(createBasicElementWithText(kmlDoc, "width", width));
}
processMaterial(state, polylineGraphics.material, lineStyle);
styles.push(lineStyle);
}
function getRectangleBoundaries(state, rectangleGraphics, extrudedHeight) {
const kmlDoc = state.kmlDoc;
const valueGetter = state.valueGetter;
let height = valueGetter.get(rectangleGraphics.height, 0.0);
if (extrudedHeight > 0) {
// We extrude up and KML extrudes down, so if we extrude, set the polygon height to
// the extruded height so KML will look similar to Cesium
height = extrudedHeight;
}
const coordinatesProperty = rectangleGraphics.coordinates;
const rectangle = valueGetter.get(coordinatesProperty);
const coordinateStrings = [];
const cornerFunction = [
Rectangle.northeast,
Rectangle.southeast,
Rectangle.southwest,
Rectangle.northwest,
];
for (let i = 0; i < 4; ++i) {
cornerFunction[i](rectangle, scratchCartographic);
coordinateStrings.push(
`${CesiumMath.toDegrees(
scratchCartographic.longitude,
)},${CesiumMath.toDegrees(scratchCartographic.latitude)},${height}`,
);
}
const coordinates = createBasicElementWithText(
kmlDoc,
"coordinates",
coordinateStrings.join(" "),
);
const outerBoundaryIs = kmlDoc.createElement("outerBoundaryIs");
const linearRing = kmlDoc.createElement("LinearRing");
linearRing.appendChild(coordinates);
outerBoundaryIs.appendChild(linearRing);
return [outerBoundaryIs];
}
function getLinearRing(state, positions, height, perPositionHeight) {
const kmlDoc = state.kmlDoc;
const ellipsoid = state.ellipsoid;
const coordinateStrings = [];
const positionCount = positions.length;
for (let i = 0; i < positionCount; ++i) {
Cartographic.fromCartesian(positions[i], ellipsoid, scratchCartographic);
coordinateStrings.push(
`${CesiumMath.toDegrees(
scratchCartographic.longitude,
)},${CesiumMath.toDegrees(scratchCartographic.latitude)},${
perPositionHeight ? scratchCartographic.height : height
}`,
);
}
const coordinates = createBasicElementWithText(
kmlDoc,
"coordinates",
coordinateStrings.join(" "),
);
const linearRing = kmlDoc.createElement("LinearRing");
linearRing.appendChild(coordinates);
return linearRing;
}
function getPolygonBoundaries(state, polygonGraphics, extrudedHeight) {
const kmlDoc = state.kmlDoc;
const valueGetter = state.valueGetter;
let height = valueGetter.get(polygonGraphics.height, 0.0);
const perPositionHeight = valueGetter.get(
polygonGraphics.perPositionHeight,
false,
);
if (!perPositionHeight && extrudedHeight > 0) {
// We extrude up and KML extrudes down, so if we extrude, set the polygon height to
// the extruded height so KML will look similar to Cesium
height = extrudedHeight;
}
const boundaries = [];
const hierarchyProperty = polygonGraphics.hierarchy;
const hierarchy = valueGetter.get(hierarchyProperty);
// Polygon hierarchy can sometimes just be an array of positions
const positions = Array.isArray(hierarchy) ? hierarchy : hierarchy.positions;
// Polygon boundaries
const outerBoundaryIs = kmlDoc.createElement("outerBoundaryIs");
outerBoundaryIs.appendChild(
getLinearRing(state, positions, height, perPositionHeight),
);
boundaries.push(outerBoundaryIs);
// Hole boundaries
const holes = hierarchy.holes;
Eif (defined(holes)) {
const holeCount = holes.length;
for (let i = 0; i < holeCount; ++i) {
const innerBoundaryIs = kmlDoc.createElement("innerBoundaryIs");
innerBoundaryIs.appendChild(
getLinearRing(state, holes[i].positions, height, perPositionHeight),
);
boundaries.push(innerBoundaryIs);
}
}
return boundaries;
}
function createPolygon(state, geometry, geometries, styles, overlays) {
const kmlDoc = state.kmlDoc;
const valueGetter = state.valueGetter;
if (!defined(geometry)) {
return;
}
// Detect textured quads and use ground overlays instead
const isRectangle = geometry instanceof RectangleGraphics;
if (
isRectangle &&
valueGetter.getMaterialType(geometry.material) === "Image"
) {
createGroundOverlay(state, geometry, overlays);
return;
}
const polygonGeometry = kmlDoc.createElement("Polygon");
const extrudedHeight = valueGetter.get(geometry.extrudedHeight, 0.0);
if (extrudedHeight > 0) {
polygonGeometry.appendChild(
createBasicElementWithText(kmlDoc, "extrude", true),
);
}
// Set boundaries
const boundaries = isRectangle
? getRectangleBoundaries(state, geometry, extrudedHeight)
: getPolygonBoundaries(state, geometry, extrudedHeight);
const boundaryCount = boundaries.length;
for (let i = 0; i < boundaryCount; ++i) {
polygonGeometry.appendChild(boundaries[i]);
}
// Set altitude mode
const altitudeMode = kmlDoc.createElement("altitudeMode");
altitudeMode.appendChild(getAltitudeMode(state, geometry.heightReference));
polygonGeometry.appendChild(altitudeMode);
geometries.push(polygonGeometry);
// Create style
const polyStyle = kmlDoc.createElement("PolyStyle");
const fill = valueGetter.get(geometry.fill, false);
if (fill) {
polyStyle.appendChild(createBasicElementWithText(kmlDoc, "fill", fill));
}
processMaterial(state, geometry.material, polyStyle);
const outline = valueGetter.get(geometry.outline, false);
if (outline) {
polyStyle.appendChild(
createBasicElementWithText(kmlDoc, "outline", outline),
);
// Outline uses LineStyle
const lineStyle = kmlDoc.createElement("LineStyle");
const outlineWidth = valueGetter.get(geometry.outlineWidth, 1.0);
lineStyle.appendChild(
createBasicElementWithText(kmlDoc, "width", outlineWidth),
);
const outlineColor = valueGetter.getColor(
geometry.outlineColor,
Color.BLACK,
);
lineStyle.appendChild(
createBasicElementWithText(kmlDoc, "color", outlineColor),
);
lineStyle.appendChild(
createBasicElementWithText(kmlDoc, "colorMode", "normal"),
);
styles.push(lineStyle);
}
styles.push(polyStyle);
}
function createGroundOverlay(state, rectangleGraphics, overlays) {
const kmlDoc = state.kmlDoc;
const valueGetter = state.valueGetter;
const externalFileHandler = state.externalFileHandler;
const groundOverlay = kmlDoc.createElement("GroundOverlay");
// Set altitude mode
const altitudeMode = kmlDoc.createElement("altitudeMode");
altitudeMode.appendChild(
getAltitudeMode(state, rectangleGraphics.heightReference),
);
groundOverlay.appendChild(altitudeMode);
const height = valueGetter.get(rectangleGraphics.height);
Eif (defined(height)) {
groundOverlay.appendChild(
createBasicElementWithText(kmlDoc, "altitude", height),
);
}
const rectangle = valueGetter.get(rectangleGraphics.coordinates);
const latLonBox = kmlDoc.createElement("LatLonBox");
latLonBox.appendChild(
createBasicElementWithText(
kmlDoc,
"north",
CesiumMath.toDegrees(rectangle.north),
),
);
latLonBox.appendChild(
createBasicElementWithText(
kmlDoc,
"south",
CesiumMath.toDegrees(rectangle.south),
),
);
latLonBox.appendChild(
createBasicElementWithText(
kmlDoc,
"east",
CesiumMath.toDegrees(rectangle.east),
),
);
latLonBox.appendChild(
createBasicElementWithText(
kmlDoc,
"west",
CesiumMath.toDegrees(rectangle.west),
),
);
groundOverlay.appendChild(latLonBox);
// We should only end up here if we have an ImageMaterialProperty
const material = valueGetter.get(rectangleGraphics.material);
const href = externalFileHandler.texture(material.image);
const icon = kmlDoc.createElement("Icon");
icon.appendChild(createBasicElementWithText(kmlDoc, "href", href));
groundOverlay.appendChild(icon);
const color = material.color;
Eif (defined(color)) {
groundOverlay.appendChild(
createBasicElementWithText(
kmlDoc,
"color",
colorToString(material.color),
),
);
}
overlays.push(groundOverlay);
}
function createModelGeometry(state, modelGraphics) {
const kmlDoc = state.kmlDoc;
const valueGetter = state.valueGetter;
const externalFileHandler = state.externalFileHandler;
const modelGeometry = kmlDoc.createElement("Model");
const scale = valueGetter.get(modelGraphics.scale);
if (defined(scale)) {
const scaleElement = kmlDoc.createElement("scale");
scaleElement.appendChild(createBasicElementWithText(kmlDoc, "x", scale));
scaleElement.appendChild(createBasicElementWithText(kmlDoc, "y", scale));
scaleElement.appendChild(createBasicElementWithText(kmlDoc, "z", scale));
modelGeometry.appendChild(scaleElement);
}
const link = kmlDoc.createElement("Link");
const uri = externalFileHandler.model(modelGraphics, state.time);
link.appendChild(createBasicElementWithText(kmlDoc, "href", uri));
modelGeometry.appendChild(link);
return modelGeometry;
}
function createModel(state, entity, modelGraphics, geometries, styles) {
const kmlDoc = state.kmlDoc;
const ellipsoid = state.ellipsoid;
const valueGetter = state.valueGetter;
if (!defined(modelGraphics)) {
return;
}
// If the point isn't constant then create gx:Track or gx:MultiTrack
const entityPositionProperty = entity.position;
if (!entityPositionProperty.isConstant) {
createTracks(state, entity, modelGraphics, geometries, styles);
return;
}
const modelGeometry = createModelGeometry(state, modelGraphics);
// Set altitude mode
const altitudeMode = kmlDoc.createElement("altitudeMode");
altitudeMode.appendChild(
getAltitudeMode(state, modelGraphics.heightReference),
);
modelGeometry.appendChild(altitudeMode);
valueGetter.get(entityPositionProperty, undefined, scratchCartesian3);
Cartographic.fromCartesian(scratchCartesian3, ellipsoid, scratchCartographic);
const location = kmlDoc.createElement("Location");
location.appendChild(
createBasicElementWithText(
kmlDoc,
"longitude",
CesiumMath.toDegrees(scratchCartographic.longitude),
),
);
location.appendChild(
createBasicElementWithText(
kmlDoc,
"latitude",
CesiumMath.toDegrees(scratchCartographic.latitude),
),
);
location.appendChild(
createBasicElementWithText(kmlDoc, "altitude", scratchCartographic.height),
);
modelGeometry.appendChild(location);
geometries.push(modelGeometry);
}
function processMaterial(state, materialProperty, style) {
const kmlDoc = state.kmlDoc;
const valueGetter = state.valueGetter;
if (!defined(materialProperty)) {
return;
}
const material = valueGetter.get(materialProperty);
Iif (!defined(material)) {
return;
}
let color;
const type = valueGetter.getMaterialType(materialProperty);
let outlineColor;
let outlineWidth;
switch (type) {
case "Image":
// Image materials are only able to be represented on rectangles, so if we make it
// here we can't texture a generic polygon or polyline in KML, so just use white.
color = colorToString(Color.WHITE);
break;
case "Color":
case "Grid":
case "PolylineGlow":
case "PolylineArrow":
case "PolylineDash":
color = colorToString(material.color);
break;
case "PolylineOutline":
color = colorToString(material.color);
outlineColor = colorToString(material.outlineColor);
outlineWidth = material.outlineWidth;
style.appendChild(
createBasicElementWithText(
kmlDoc,
"outerColor",
outlineColor,
gxNamespace,
),
);
style.appendChild(
createBasicElementWithText(
kmlDoc,
"outerWidth",
outlineWidth,
gxNamespace,
),
);
break;
case "Stripe":
color = colorToString(material.oddColor);
break;
}
Eif (defined(color)) {
style.appendChild(createBasicElementWithText(kmlDoc, "color", color));
style.appendChild(
createBasicElementWithText(kmlDoc, "colorMode", "normal"),
);
}
}
function getAltitudeMode(state, heightReferenceProperty) {
const kmlDoc = state.kmlDoc;
const valueGetter = state.valueGetter;
const heightReference = valueGetter.get(
heightReferenceProperty,
HeightReference.NONE,
);
let altitudeModeText;
switch (heightReference) {
case HeightReference.NONE:
altitudeModeText = kmlDoc.createTextNode("absolute");
break;
case HeightReference.CLAMP_TO_GROUND:
altitudeModeText = kmlDoc.createTextNode("clampToGround");
break;
case HeightReference.RELATIVE_TO_GROUND:
altitudeModeText = kmlDoc.createTextNode("relativeToGround");
break;
}
return altitudeModeText;
}
function getCoordinates(coordinates, ellipsoid) {
if (!Array.isArray(coordinates)) {
coordinates = [coordinates];
}
const count = coordinates.length;
const coordinateStrings = [];
for (let i = 0; i < count; ++i) {
Cartographic.fromCartesian(coordinates[i], ellipsoid, scratchCartographic);
coordinateStrings.push(
`${CesiumMath.toDegrees(
scratchCartographic.longitude,
)},${CesiumMath.toDegrees(scratchCartographic.latitude)},${
scratchCartographic.height
}`,
);
}
return coordinateStrings.join(" ");
}
function createBasicElementWithText(
kmlDoc,
elementName,
elementValue,
namespace,
) {
elementValue = elementValue ?? "";
if (typeof elementValue === "boolean") {
elementValue = elementValue ? "1" : "0";
}
// Create element with optional namespace
const element = defined(namespace)
? kmlDoc.createElementNS(namespace, elementName)
: kmlDoc.createElement(elementName);
// Wrap value in CDATA section if it contains HTML
const text =
elementValue === "string" && elementValue.indexOf("<") !== -1
? kmlDoc.createCDATASection(elementValue)
: kmlDoc.createTextNode(elementValue);
element.appendChild(text);
return element;
}
function colorToString(color) {
let result = "";
const bytes = color.toBytes();
for (let i = 3; i >= 0; --i) {
result +=
bytes[i] < 16 ? `0${bytes[i].toString(16)}` : bytes[i].toString(16);
}
return result;
}
/**
* Since KML does not support glTF models, this callback is required to specify what URL to use for the model in the KML document.
* It can also be used to add additional files to the <code>externalFiles</code> object, which is the list of files embedded in the exported KMZ,
* or otherwise returned with the KML string when exporting.
*
* @callback exportKmlModelCallback
*
* @param {ModelGraphics} model The ModelGraphics instance for an Entity.
* @param {JulianDate} time The time that any properties should use to get the value.
* @param {object} externalFiles An object that maps a filename to a Blob or a Promise that resolves to a Blob.
* @returns {string} The URL to use for the href in the KML document.
*/
export default exportKml;
|