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 | 1x 1x 1x 1x 1x 9x 1x 1x 1267x 12x 14x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 7100x 526x 1291008x 1270837x 77195x 630226x 63008x 184664x 7x 13897x 207x 13690x 21x 77022x 77022x 77022x 73425x 77022x 76927x 95x 95x 95x 237x 95x 977x 16x 1668x 77022x 77022x 92995x 92995x 92995x 92995x 77022x 1668x 1668x 1668x 1668x 143080x 77022x 24844x 24844x 42117x 16418x 8426x 77022x 6547x 77022x 7077x 7077x 17279x 17279x 8x 17271x 308x 16963x 3x 16963x 16963x 7077x 77022x 326x 314x 12x 12x 40x 12x 77022x 77022x 133340x 5050x 5050x 77022x 2188x 16x 2172x 2172x 28368x 2631x 25737x 1657x 24080x 6964x 17116x 409x 2172x 2172x 25737x 2172x 2085x 2172x 77022x 304x 304x 304x 304x 304x 3144x 3144x 84x 3060x 3144x 304x 304x 77022x 722x 77022x 1x 14x 3x 93331x 416575x 34x 34x 14x 20x 678600x 1x 20x 20x 6x 1x 1x 1x 5x 4x 3x 12x 2x 2x 2x 2x 2x 1x 1x 1x 1x 1x 84x 84x 398x 249x 249x 249x 249x 249x 149x 369760x 104x 104x 104x 369656x 369656x 369656x 81597x 81597x 65504x 65504x 65504x 65504x 65504x 16093x 71139x 369760x 104x 369656x 61427x 61427x 12697x 22407x 35244x 38359x 7556x 15593x 1x 15592x 15592x 3205x 3205x 3205x 3205x 1641x 1641x 3205x 1x 3204x 205x 197x 197x 205x 8x 3196x 3196x 5890x 3196x 942x 3197x 1998x 1998x 1998x 1998x 3197x 15592x 3x 3x 12x 7064x 7064x 11112x 11540x 11540x 794x 794x 2075x 29x 2046x 2075x 29x 2046x 2075x 29x 2046x 2075x 29x 2046x 2075x 377x 377x 377x 371x 371x 371x 369x 20220x 16632x 20220x 861x 861x 861x 861x 24x 24x 1x 24x 23x 24x 1x 1x 23x 23x 16878x 16878x 993x 16878x 2075x 18493x 18493x 18493x 18493x 18431x 1831x 16600x 16600x 163x 16437x 16437x 16499x 16499x 2138x 43x 16456x 16633x 858x 858x 2075x 1173x 1173x 1267x 1267x 1173x 1173x 1173x 1173x 1173x 1173x 2075x 1172x 1172x 2075x 1151x 1151x 398x 398x 526x 526x 1151x 1048x 2075x 2075x 2075x 25x 25x 25x 3x 22x 2075x 3x 3x 1x 11520x 11520x 11520x 430x 442x 442x 412x 412x 256x 2458x 9462x 9462x 9462x 217x 217x 217x 1x 216x 216x 1x 11520x 11520x 2458x 2458x 2458x 2458x 2458x 2458x 11520x 3613x 3613x 337x 60972x 60972x 60972x 60971x 337x 316x 337x 5262x 5x 1x 1x 1x 1x 1x 1x 5x 5x 30x 30x 1x 30x 30x 30x 30x 2x 1x 1x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 3x 3x 3x 3x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 1x 1x 1x 1x 1x 22x 19x 19x 9x 9x 9x 9x 9x 54x 54x 54x 54x 54x 54x 54x 45x 9x 1x 3x 1x 2x 2x 2x 2x 1x 1x 1x 1x 2x 1x 1x 1x 1x 2x 2x 2x 2x 2x 2x 2x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x | /**
* macros.js is the old macro.js.
* The name change is so we do not get eaten by babel-plugin-macros.
*/
import DeepEqual from 'fast-deep-equal';
import vtk, { vtkGlobal } from './vtk';
import ClassHierarchy from './Common/Core/ClassHierarchy';
let globalMTime = 0;
export const VOID = Symbol('void');
function getCurrentGlobalMTime() {
return globalMTime;
}
// ----------------------------------------------------------------------------
// Logging function calls
// ----------------------------------------------------------------------------
/* eslint-disable no-prototype-builtins */
const fakeConsole = {};
function noOp() {}
const consoleMethods = [
'log',
'debug',
'info',
'warn',
'error',
'time',
'timeEnd',
'group',
'groupEnd',
];
consoleMethods.forEach((methodName) => {
fakeConsole[methodName] = noOp;
});
vtkGlobal.console = console.hasOwnProperty('log') ? console : fakeConsole;
const loggerFunctions = {
debug: noOp, // Don't print debug by default
error: vtkGlobal.console.error || noOp,
info: vtkGlobal.console.info || noOp,
log: vtkGlobal.console.log || noOp,
warn: vtkGlobal.console.warn || noOp,
};
export function setLoggerFunction(name, fn) {
if (loggerFunctions[name]) {
loggerFunctions[name] = fn || noOp;
}
}
export function vtkLogMacro(...args) {
loggerFunctions.log(...args);
}
export function vtkInfoMacro(...args) {
loggerFunctions.info(...args);
}
export function vtkDebugMacro(...args) {
loggerFunctions.debug(...args);
}
export function vtkErrorMacro(...args) {
loggerFunctions.error(...args);
}
export function vtkWarningMacro(...args) {
loggerFunctions.warn(...args);
}
const ERROR_ONCE_MAP = {};
export function vtkOnceErrorMacro(str) {
if (!ERROR_ONCE_MAP[str]) {
loggerFunctions.error(str);
ERROR_ONCE_MAP[str] = true;
}
}
// ----------------------------------------------------------------------------
// TypedArray
// ----------------------------------------------------------------------------
export const TYPED_ARRAYS = Object.create(null);
TYPED_ARRAYS.Float32Array = Float32Array;
TYPED_ARRAYS.Float64Array = Float64Array;
TYPED_ARRAYS.Uint8Array = Uint8Array;
TYPED_ARRAYS.Int8Array = Int8Array;
TYPED_ARRAYS.Uint16Array = Uint16Array;
TYPED_ARRAYS.Int16Array = Int16Array;
TYPED_ARRAYS.Uint32Array = Uint32Array;
TYPED_ARRAYS.Int32Array = Int32Array;
TYPED_ARRAYS.Uint8ClampedArray = Uint8ClampedArray;
try {
TYPED_ARRAYS.BigInt64Array = BigInt64Array;
TYPED_ARRAYS.BigUint64Array = BigUint64Array;
} catch {
// ignore
}
export function newTypedArray(type, ...args) {
return new (TYPED_ARRAYS[type] || Float64Array)(...args);
}
export function newTypedArrayFrom(type, ...args) {
return (TYPED_ARRAYS[type] || Float64Array).from(...args);
}
// ----------------------------------------------------------------------------
// capitilize provided string
// ----------------------------------------------------------------------------
export function capitalize(str) {
return str.charAt(0).toUpperCase() + str.slice(1);
}
export function _capitalize(str) {
return capitalize(str[0] === '_' ? str.slice(1) : str);
}
export function uncapitalize(str) {
return str.charAt(0).toLowerCase() + str.slice(1);
}
// ----------------------------------------------------------------------------
// Convert byte size into a well formatted string
// ----------------------------------------------------------------------------
export function formatBytesToProperUnit(size, precision = 2, chunkSize = 1000) {
const units = ['TB', 'GB', 'MB', 'KB'];
let value = Number(size);
let currentUnit = 'B';
while (value > chunkSize) {
value /= chunkSize;
currentUnit = units.pop();
}
return `${value.toFixed(precision)} ${currentUnit}`;
}
// ----------------------------------------------------------------------------
// Convert thousand number with proper separator
// ----------------------------------------------------------------------------
export function formatNumbersWithThousandSeparator(n, separator = ' ') {
const sections = [];
let size = n;
while (size > 1000) {
sections.push(`000${size % 1000}`.slice(-3));
size = Math.floor(size / 1000);
}
if (size > 0) {
sections.push(size);
}
sections.reverse();
return sections.join(separator);
}
// ----------------------------------------------------------------------------
// Array helper
// ----------------------------------------------------------------------------
function safeArrays(model) {
Object.keys(model).forEach((key) => {
if (Array.isArray(model[key])) {
model[key] = [].concat(model[key]);
}
});
}
function isTypedArray(value) {
return Object.values(TYPED_ARRAYS).some((ctor) => value instanceof ctor);
}
// ----------------------------------------------------------------------------
// shallow equals
// ----------------------------------------------------------------------------
function shallowEquals(a, b) {
if (a === b) {
return true;
}
if (Array.isArray(a) && Array.isArray(b)) {
if (a.length !== b.length) {
return false;
}
for (let i = 0; i < a.length; i++) {
if (a[i] !== b[i]) {
return false;
}
}
return true;
}
return false;
}
// ----------------------------------------------------------------------------
function enumToString(e, value) {
return Object.keys(e).find((key) => e[key] === value);
}
function getStateArrayMapFunc(item) {
if (item && item.isA) {
return item.getState();
}
return item;
}
// ----------------------------------------------------------------------------
// setImmediate
// ----------------------------------------------------------------------------
export function setImmediateVTK(fn) {
setTimeout(fn, 0);
}
// ----------------------------------------------------------------------------
// measurePromiseExecution
//
// Measures the time it takes for a promise to finish from
// the time this function is invoked.
// The callback receives the time it took for the promise to resolve or reject.
// ----------------------------------------------------------------------------
export function measurePromiseExecution(promise, callback) {
const start = performance.now();
promise.finally(() => {
const delta = performance.now() - start;
callback(delta);
});
}
// ----------------------------------------------------------------------------
// vtkObject: modified(), onModified(callback), delete()
// ----------------------------------------------------------------------------
export function obj(publicAPI = {}, model = {}) {
// Ensure each instance as a unique ref of array
safeArrays(model);
const callbacks = [];
if (!Number.isInteger(model.mtime)) {
model.mtime = ++globalMTime;
}
if (!('classHierarchy' in model)) {
model.classHierarchy = new ClassHierarchy('vtkObject');
} else if (!(model.classHierarchy instanceof ClassHierarchy)) {
const hierarchy = new ClassHierarchy();
for (let i = 0; i < model.classHierarchy.length; i++) {
hierarchy.push(model.classHierarchy[i]);
}
model.classHierarchy = hierarchy;
}
function off(index) {
callbacks[index] = null;
}
function on(index) {
function unsubscribe() {
off(index);
}
return Object.freeze({
unsubscribe,
});
}
publicAPI.isDeleted = () => !!model.deleted;
publicAPI.modified = (otherMTime) => {
Iif (model.deleted) {
vtkErrorMacro('instance deleted - cannot call any method');
return;
}
Iif (otherMTime && otherMTime < publicAPI.getMTime()) {
return;
}
model.mtime = ++globalMTime;
callbacks.forEach((callback) => callback && callback(publicAPI));
};
publicAPI.onModified = (callback) => {
Iif (model.deleted) {
vtkErrorMacro('instance deleted - cannot call any method');
return null;
}
const index = callbacks.length;
callbacks.push(callback);
return on(index);
};
publicAPI.getMTime = () => model.mtime;
publicAPI.isA = (className) => {
let count = model.classHierarchy.length;
// we go backwards as that is more likely for
// early termination
while (count--) {
if (model.classHierarchy[count] === className) {
return true;
}
}
return false;
};
publicAPI.getClassName = (depth = 0) =>
model.classHierarchy[model.classHierarchy.length - 1 - depth];
publicAPI.set = (map = {}, noWarning = false, noFunction = false) => {
let ret = false;
Object.keys(map).forEach((name) => {
const fn = noFunction ? null : publicAPI[`set${capitalize(name)}`];
if (fn && Array.isArray(map[name]) && fn.length > 1) {
ret = fn(...map[name]) || ret;
} else if (fn) {
ret = fn(map[name]) || ret;
} else {
// Set data on model directly
if (['mtime'].indexOf(name) === -1 && !noWarning) {
vtkWarningMacro(
`Warning: Set value to model directly ${name}, ${map[name]}`
);
}
ret = model[name] !== map[name] || ret;
model[name] = map[name];
}
});
return ret;
};
publicAPI.get = (...list) => {
if (!list.length) {
return model;
}
const subset = {};
list.forEach((name) => {
subset[name] = model[name];
});
return subset;
};
publicAPI.getReferenceByName = (val) => model[val];
publicAPI.delete = () => {
Object.keys(model).forEach((field) => delete model[field]);
callbacks.forEach((el, index) => off(index));
// Flag the instance being deleted
model.deleted = true;
};
// Add serialization support
publicAPI.getState = () => {
if (model.deleted) {
return null;
}
const jsonArchive = { ...model, vtkClass: publicAPI.getClassName() };
// Convert every vtkObject to its serializable form
Object.keys(jsonArchive).forEach((keyName) => {
if (
jsonArchive[keyName] === null ||
jsonArchive[keyName] === undefined ||
keyName[0] === '_' // protected members start with _
) {
delete jsonArchive[keyName];
} else if (jsonArchive[keyName].isA) {
jsonArchive[keyName] = jsonArchive[keyName].getState();
} else if (Array.isArray(jsonArchive[keyName])) {
jsonArchive[keyName] = jsonArchive[keyName].map(getStateArrayMapFunc);
} else if (isTypedArray(jsonArchive[keyName])) {
jsonArchive[keyName] = Array.from(jsonArchive[keyName]);
}
});
// Sort resulting object by key name
const sortedObj = {};
Object.keys(jsonArchive)
.sort()
.forEach((name) => {
sortedObj[name] = jsonArchive[name];
});
// Remove mtime
if (sortedObj.mtime) {
delete sortedObj.mtime;
}
return sortedObj;
};
// Add shallowCopy(otherInstance) support
publicAPI.shallowCopy = (other, debug = false) => {
Iif (other.getClassName() !== publicAPI.getClassName()) {
throw new Error(
`Cannot ShallowCopy ${other.getClassName()} into ${publicAPI.getClassName()}`
);
}
const otherModel = other.get();
const keyList = Object.keys(model).sort();
const otherKeyList = Object.keys(otherModel).sort();
otherKeyList.forEach((key) => {
const keyIdx = keyList.indexOf(key);
if (keyIdx === -1) {
Iif (debug) {
vtkDebugMacro(`add ${key} in shallowCopy`);
}
} else {
keyList.splice(keyIdx, 1);
}
model[key] = otherModel[key];
});
Iif (keyList.length && debug) {
vtkDebugMacro(`Untouched keys: ${keyList.join(', ')}`);
}
publicAPI.modified();
};
// This function will get called when one invoke JSON.stringify(vtkObject)
// JSON.stringify will only stringify the return value of this function
publicAPI.toJSON = function vtkObjToJSON() {
return publicAPI.getState();
};
// Allow usage as decorator
return publicAPI;
}
// ----------------------------------------------------------------------------
// getXXX: add getters
// ----------------------------------------------------------------------------
const objectGetterMap = {
object(publicAPI, model, field) {
return function getter() {
return { ...model[field.name] };
};
},
};
export function get(publicAPI, model, fieldNames) {
fieldNames.forEach((field) => {
if (typeof field === 'object') {
const getter = objectGetterMap[field.type];
if (getter) {
publicAPI[`get${_capitalize(field.name)}`] = getter(
publicAPI,
model,
field
);
} else {
publicAPI[`get${_capitalize(field.name)}`] = () => model[field.name];
}
} else {
publicAPI[`get${_capitalize(field)}`] = () => model[field];
}
});
}
// ----------------------------------------------------------------------------
// setXXX: add setters
// ----------------------------------------------------------------------------
const objectSetterMap = {
enum(publicAPI, model, field) {
const onChanged = `_on${_capitalize(field.name)}Changed`;
return (value) => {
if (typeof value === 'string') {
Iif (field.enum[value] !== undefined) {
if (model[field.name] !== field.enum[value]) {
model[field.name] = field.enum[value];
publicAPI.modified();
return true;
}
return false;
}
vtkErrorMacro(`Set Enum with invalid argument ${field}, ${value}`);
throw new RangeError('Set Enum with invalid string argument');
}
if (typeof value === 'number') {
if (model[field.name] !== value) {
if (
Object.keys(field.enum)
.map((key) => field.enum[key])
.indexOf(value) !== -1
) {
const previousValue = model[field.name];
model[field.name] = value;
model[onChanged]?.(publicAPI, model, value, previousValue);
publicAPI.modified();
return true;
}
vtkErrorMacro(`Set Enum outside numeric range ${field}, ${value}`);
throw new RangeError('Set Enum outside numeric range');
}
return false;
}
vtkErrorMacro(
`Set Enum with invalid argument (String/Number) ${field}, ${value}`
);
throw new TypeError('Set Enum with invalid argument (String/Number)');
};
},
object(publicAPI, model, field) {
const onChanged = `_on${_capitalize(field.name)}Changed`;
return (value) => {
if (!DeepEqual(model[field.name], value)) {
const previousValue = model[field.name];
model[field.name] = value;
model[onChanged]?.(publicAPI, model, value, previousValue);
publicAPI.modified();
return true;
}
return false;
};
},
};
function findSetter(field) {
if (typeof field === 'object') {
const fn = objectSetterMap[field.type];
if (fn) {
return (publicAPI, model) => fn(publicAPI, model, field);
}
vtkErrorMacro(`No setter for field ${field}`);
throw new TypeError('No setter for field');
}
return function getSetter(publicAPI, model) {
const onChanged = `_on${_capitalize(field)}Changed`;
return function setter(value) {
Iif (model.deleted) {
vtkErrorMacro('instance deleted - cannot call any method');
return false;
}
if (model[field] !== value) {
const previousValue = model[field.name];
model[field] = value;
model[onChanged]?.(publicAPI, model, value, previousValue);
publicAPI.modified();
return true;
}
return false;
};
};
}
export function set(publicAPI, model, fields) {
fields.forEach((field) => {
if (typeof field === 'object') {
publicAPI[`set${_capitalize(field.name)}`] = findSetter(field)(
publicAPI,
model
);
} else {
publicAPI[`set${_capitalize(field)}`] = findSetter(field)(
publicAPI,
model
);
}
});
}
// ----------------------------------------------------------------------------
// set/get XXX: add both setters and getters
// ----------------------------------------------------------------------------
export function setGet(publicAPI, model, fieldNames) {
get(publicAPI, model, fieldNames);
set(publicAPI, model, fieldNames);
}
// ----------------------------------------------------------------------------
// getXXX: add getters for object of type array with copy to be safe
// getXXXByReference: add getters for object of type array without copy
// ----------------------------------------------------------------------------
export function getArray(publicAPI, model, fieldNames) {
fieldNames.forEach((field) => {
publicAPI[`get${_capitalize(field)}`] = () =>
model[field] ? Array.from(model[field]) : model[field];
publicAPI[`get${_capitalize(field)}ByReference`] = () => model[field];
});
}
// ----------------------------------------------------------------------------
// setXXX: add setter for object of type array
// if 'defaultVal' is supplied, shorter arrays will be padded to 'size' with 'defaultVal'
// set...From: fast path to copy the content of an array to the current one without call to modified.
// ----------------------------------------------------------------------------
export function setArray(
publicAPI,
model,
fieldNames,
size,
defaultVal = undefined
) {
fieldNames.forEach((field) => {
if (model[field] && size && model[field].length !== size) {
throw new RangeError(
`Invalid initial number of values for array (${field})`
);
}
const onChanged = `_on${_capitalize(field)}Changed`;
publicAPI[`set${_capitalize(field)}`] = (...args) => {
Iif (model.deleted) {
vtkErrorMacro('instance deleted - cannot call any method');
return false;
}
let array = args;
let changeDetected;
let needCopy = false;
// allow null or an array to be passed as a single arg.
if (array.length === 1 && (array[0] == null || array[0].length >= 0)) {
/* eslint-disable prefer-destructuring */
array = array[0];
/* eslint-enable prefer-destructuring */
needCopy = true;
}
if (array == null) {
changeDetected = model[field] !== array;
} else {
if (size && array.length !== size) {
if (array.length < size && defaultVal !== undefined) {
array = Array.from(array);
needCopy = false;
while (array.length < size) array.push(defaultVal);
} else {
throw new RangeError(
`Invalid number of values for array setter (${field})`
);
}
}
changeDetected =
model[field] == null || model[field].length !== array.length;
for (let i = 0; !changeDetected && i < array.length; ++i) {
changeDetected = model[field][i] !== array[i];
}
if (changeDetected && needCopy) {
array = Array.from(array);
}
}
if (changeDetected) {
const previousValue = model[field.name];
model[field] = array;
model[onChanged]?.(publicAPI, model, array, previousValue);
publicAPI.modified();
}
return changeDetected;
};
publicAPI[`set${_capitalize(field)}From`] = (otherArray) => {
const target = model[field];
otherArray.forEach((v, i) => {
target[i] = v;
});
};
});
}
// ----------------------------------------------------------------------------
// set/get XXX: add setter and getter for object of type array
// ----------------------------------------------------------------------------
export function setGetArray(
publicAPI,
model,
fieldNames,
size,
defaultVal = undefined
) {
getArray(publicAPI, model, fieldNames);
setArray(publicAPI, model, fieldNames, size, defaultVal);
}
export function moveToProtected(publicAPI, model, fieldNames) {
for (let i = 0; i < fieldNames.length; i++) {
const fieldName = fieldNames[i];
if (model[fieldName] !== undefined) {
model[`_${fieldName}`] = model[fieldName];
delete model[fieldName];
}
}
}
// ----------------------------------------------------------------------------
// vtkAlgorithm: setInputData(), setInputConnection(), getOutputData(), getOutputPort()
// ----------------------------------------------------------------------------
export function algo(publicAPI, model, numberOfInputs, numberOfOutputs) {
if (model.inputData) {
model.inputData = model.inputData.map(vtk);
} else {
model.inputData = [];
}
if (model.inputConnection) {
model.inputConnection = model.inputConnection.map(vtk);
} else {
model.inputConnection = [];
}
if (model.output) {
model.output = model.output.map(vtk);
} else {
model.output = [];
}
if (model.inputArrayToProcess) {
model.inputArrayToProcess = model.inputArrayToProcess.map(vtk);
} else {
model.inputArrayToProcess = [];
}
// Cache the argument for later manipulation
model.numberOfInputs = numberOfInputs;
// Methods
function setInputData(dataset, port = 0) {
Iif (model.deleted) {
vtkErrorMacro('instance deleted - cannot call any method');
return;
}
Iif (port >= model.numberOfInputs) {
vtkErrorMacro(
`algorithm ${publicAPI.getClassName()} only has ${
model.numberOfInputs
} input ports. To add more input ports, use addInputData()`
);
return;
}
if (model.inputData[port] !== dataset || model.inputConnection[port]) {
model.inputData[port] = dataset;
model.inputConnection[port] = null;
if (publicAPI.modified) {
publicAPI.modified();
}
}
}
function getInputData(port = 0) {
if (model.inputConnection[port]) {
model.inputData[port] = model.inputConnection[port]();
}
return model.inputData[port];
}
function setInputConnection(outputPort, port = 0) {
Iif (model.deleted) {
vtkErrorMacro('instance deleted - cannot call any method');
return;
}
Iif (port >= model.numberOfInputs) {
let msg = `algorithm ${publicAPI.getClassName()} only has `;
msg += `${model.numberOfInputs}`;
msg += ' input ports. To add more input ports, use addInputConnection()';
vtkErrorMacro(msg);
return;
}
model.inputData[port] = null;
model.inputConnection[port] = outputPort;
}
function getInputConnection(port = 0) {
return model.inputConnection[port];
}
function getPortToFill() {
let portToFill = model.numberOfInputs;
while (
portToFill &&
!model.inputData[portToFill - 1] &&
!model.inputConnection[portToFill - 1]
) {
portToFill--;
}
if (portToFill === model.numberOfInputs) {
model.numberOfInputs++;
}
return portToFill;
}
function addInputConnection(outputPort) {
Iif (model.deleted) {
vtkErrorMacro('instance deleted - cannot call any method');
return;
}
setInputConnection(outputPort, getPortToFill());
}
function addInputData(dataset) {
Iif (model.deleted) {
vtkErrorMacro('instance deleted - cannot call any method');
return;
}
setInputData(dataset, getPortToFill());
}
function getOutputData(port = 0) {
Iif (model.deleted) {
vtkErrorMacro('instance deleted - cannot call any method');
return null;
}
if (publicAPI.shouldUpdate()) {
publicAPI.update();
}
return model.output[port];
}
publicAPI.shouldUpdate = () => {
const localMTime = publicAPI.getMTime();
let minOutputMTime = Infinity;
let count = numberOfOutputs;
while (count--) {
if (!model.output[count] || model.output[count].isDeleted()) {
return true;
}
const mt = model.output[count].getMTime();
if (mt < localMTime) {
return true;
}
if (mt < minOutputMTime) {
minOutputMTime = mt;
}
}
count = model.numberOfInputs;
while (count--) {
if (
model.inputConnection[count]?.filter.shouldUpdate() ||
publicAPI.getInputData(count)?.getMTime() > minOutputMTime
) {
return true;
}
}
return false;
};
function getOutputPort(port = 0) {
const outputPortAccess = () => getOutputData(port);
// Add reference to filter
outputPortAccess.filter = publicAPI;
return outputPortAccess;
}
// Handle input if needed
if (model.numberOfInputs) {
// Reserve inputs
let count = model.numberOfInputs;
while (count--) {
model.inputData.push(null);
model.inputConnection.push(null);
}
// Expose public methods
publicAPI.setInputData = setInputData;
publicAPI.setInputConnection = setInputConnection;
publicAPI.addInputData = addInputData;
publicAPI.addInputConnection = addInputConnection;
publicAPI.getInputData = getInputData;
publicAPI.getInputConnection = getInputConnection;
}
if (numberOfOutputs) {
publicAPI.getOutputData = getOutputData;
publicAPI.getOutputPort = getOutputPort;
}
publicAPI.update = () => {
const ins = [];
if (model.numberOfInputs) {
let count = 0;
while (count < model.numberOfInputs) {
ins[count] = publicAPI.getInputData(count);
count++;
}
}
if (publicAPI.shouldUpdate() && publicAPI.requestData) {
publicAPI.requestData(ins, model.output);
}
};
publicAPI.getNumberOfInputPorts = () => model.numberOfInputs;
publicAPI.getNumberOfOutputPorts = () =>
numberOfOutputs || model.output.length;
publicAPI.getInputArrayToProcess = (inputPort) => {
const arrayDesc = model.inputArrayToProcess[inputPort];
const ds = model.inputData[inputPort];
if (arrayDesc && ds) {
return ds[`get${arrayDesc.fieldAssociation}`]().getArray(
arrayDesc.arrayName
);
}
return null;
};
publicAPI.setInputArrayToProcess = (
inputPort,
arrayName,
fieldAssociation,
attributeType = 'Scalars'
) => {
while (model.inputArrayToProcess.length < inputPort) {
model.inputArrayToProcess.push(null);
}
model.inputArrayToProcess[inputPort] = {
arrayName,
fieldAssociation,
attributeType,
};
};
}
// ----------------------------------------------------------------------------
// Event handling: onXXX(callback), invokeXXX(args...)
// ----------------------------------------------------------------------------
export const EVENT_ABORT = Symbol('Event abort');
export function event(publicAPI, model, eventName) {
const callbacks = [];
const previousDelete = publicAPI.delete;
let curCallbackID = 1;
function off(callbackID) {
for (let i = 0; i < callbacks.length; ++i) {
const [cbID] = callbacks[i];
if (cbID === callbackID) {
callbacks.splice(i, 1);
return;
}
}
}
function on(callbackID) {
function unsubscribe() {
off(callbackID);
}
return Object.freeze({
unsubscribe,
});
}
function invoke() {
Iif (model.deleted) {
vtkErrorMacro('instance deleted - cannot call any method');
return;
}
/* eslint-disable prefer-rest-params */
// Go through a copy of the callbacks array in case new callbacks
// get prepended within previous callbacks
const currentCallbacks = callbacks.slice();
for (let index = 0; index < currentCallbacks.length; ++index) {
const [, cb, priority] = currentCallbacks[index];
Iif (!cb) {
continue; // eslint-disable-line
}
if (priority < 0) {
setTimeout(() => cb.apply(publicAPI, arguments), 1 - priority);
} else {
// Abort only if the callback explicitly returns false
const continueNext = cb.apply(publicAPI, arguments);
if (continueNext === EVENT_ABORT) {
break;
}
}
}
/* eslint-enable prefer-rest-params */
}
publicAPI[`invoke${_capitalize(eventName)}`] = invoke;
publicAPI[`on${_capitalize(eventName)}`] = (callback, priority = 0.0) => {
Iif (!callback.apply) {
console.error(`Invalid callback for event ${eventName}`);
return null;
}
Iif (model.deleted) {
vtkErrorMacro('instance deleted - cannot call any method');
return null;
}
const callbackID = curCallbackID++;
callbacks.push([callbackID, callback, priority]);
callbacks.sort((cb1, cb2) => cb2[2] - cb1[2]);
return on(callbackID);
};
publicAPI.delete = () => {
previousDelete();
callbacks.forEach(([cbID]) => off(cbID));
};
}
// ----------------------------------------------------------------------------
// newInstance
// ----------------------------------------------------------------------------
export function newInstance(extend, className) {
const constructor = (initialValues = {}) => {
const model = {};
const publicAPI = {};
extend(publicAPI, model, initialValues);
return Object.freeze(publicAPI);
};
// Register constructor to factory
if (className) {
vtk.register(className, constructor);
}
return constructor;
}
// ----------------------------------------------------------------------------
// Chain function calls
// ----------------------------------------------------------------------------
export function chain(...fn) {
return (...args) => fn.filter((i) => !!i).map((i) => i(...args));
}
// ----------------------------------------------------------------------------
// Some utility methods for vtk objects
// ----------------------------------------------------------------------------
export function isVtkObject(instance) {
return instance && instance.isA && instance.isA('vtkObject');
}
export function traverseInstanceTree(
instance,
extractFunction,
accumulator = [],
visitedInstances = []
) {
if (isVtkObject(instance)) {
if (visitedInstances.indexOf(instance) >= 0) {
// avoid cycles
return accumulator;
}
visitedInstances.push(instance);
const result = extractFunction(instance);
if (result !== undefined) {
accumulator.push(result);
}
// Now go through this instance's model
const model = instance.get();
Object.keys(model).forEach((key) => {
const modelObj = model[key];
if (Array.isArray(modelObj)) {
modelObj.forEach((subObj) => {
traverseInstanceTree(
subObj,
extractFunction,
accumulator,
visitedInstances
);
});
} else {
traverseInstanceTree(
modelObj,
extractFunction,
accumulator,
visitedInstances
);
}
});
}
return accumulator;
}
// ----------------------------------------------------------------------------
// Returns a function, that, as long as it continues to be invoked, will not
// be triggered. The function will be called after it stops being called for
// N milliseconds. If `immediate` is passed, trigger the function on the
// leading edge, instead of the trailing.
export function debounce(func, wait, immediate) {
let timeout;
const debounced = (...args) => {
const context = this;
const later = () => {
timeout = null;
if (!immediate) {
func.apply(context, args);
}
};
const callNow = immediate && !timeout;
clearTimeout(timeout);
timeout = setTimeout(later, wait);
Iif (callNow) {
func.apply(context, args);
}
};
debounced.cancel = () => clearTimeout(timeout);
return debounced;
}
// ----------------------------------------------------------------------------
// Creates a throttled function that only invokes `func` at most once per
// every `wait` milliseconds.
export function throttle(callback, delay) {
let isThrottled = false;
let argsToUse = null;
function next() {
isThrottled = false;
if (argsToUse !== null) {
wrapper(...argsToUse); // eslint-disable-line
argsToUse = null;
}
}
function wrapper(...args) {
if (isThrottled) {
argsToUse = args;
return;
}
isThrottled = true;
callback(...args);
setTimeout(next, delay);
}
return wrapper;
}
// ----------------------------------------------------------------------------
// keystore(publicAPI, model, initialKeystore)
//
// - initialKeystore: Initial keystore. This can be either a Map or an
// object.
//
// Generated API
// setKey(key, value) : mixed (returns value)
// getKey(key) : mixed
// getAllKeys() : [mixed]
// deleteKey(key) : Boolean
// ----------------------------------------------------------------------------
export function keystore(publicAPI, model, initialKeystore = {}) {
model.keystore = Object.assign(model.keystore || {}, initialKeystore);
publicAPI.setKey = (key, value) => {
model.keystore[key] = value;
};
publicAPI.getKey = (key) => model.keystore[key];
publicAPI.getAllKeys = () => Object.keys(model.keystore);
publicAPI.deleteKey = (key) => delete model.keystore[key];
publicAPI.clearKeystore = () =>
publicAPI.getAllKeys().forEach((key) => delete model.keystore[key]);
}
// ----------------------------------------------------------------------------
// proxy(publicAPI, model, sectionName, propertyUI)
//
// - sectionName: Name of the section for UI
// - propertyUI: List of props with their UI description
//
// Generated API
// getProxyId() : String
// listProxyProperties() : [string]
// updateProxyProperty(name, prop)
// getProxySection() => List of properties for UI generation
// ----------------------------------------------------------------------------
let nextProxyId = 1;
const ROOT_GROUP_NAME = '__root__';
export function proxy(publicAPI, model) {
// Proxies are keystores
keystore(publicAPI, model);
const parentDelete = publicAPI.delete;
// getProxyId
model.proxyId = `${nextProxyId++}`;
// ui handling
model.ui = JSON.parse(JSON.stringify(model.ui || [])); // deep copy
get(publicAPI, model, ['proxyId', 'proxyGroup', 'proxyName']);
setGet(publicAPI, model, ['proxyManager']);
// group properties
const propertyMap = {};
const groupChildrenNames = {};
function registerProperties(descriptionList, currentGroupName) {
if (!groupChildrenNames[currentGroupName]) {
groupChildrenNames[currentGroupName] = [];
}
const childrenNames = groupChildrenNames[currentGroupName];
for (let i = 0; i < descriptionList.length; i++) {
childrenNames.push(descriptionList[i].name);
propertyMap[descriptionList[i].name] = descriptionList[i];
if (descriptionList[i].children && descriptionList[i].children.length) {
registerProperties(
descriptionList[i].children,
descriptionList[i].name
);
}
}
}
registerProperties(model.ui, ROOT_GROUP_NAME);
publicAPI.updateUI = (ui) => {
model.ui = JSON.parse(JSON.stringify(ui || [])); // deep copy
Object.keys(propertyMap).forEach((k) => delete propertyMap[k]);
Object.keys(groupChildrenNames).forEach(
(k) => delete groupChildrenNames[k]
);
registerProperties(model.ui, ROOT_GROUP_NAME);
publicAPI.modified();
};
function listProxyProperties(gName = ROOT_GROUP_NAME) {
return groupChildrenNames[gName];
}
publicAPI.updateProxyProperty = (propertyName, propUI) => {
const prop = propertyMap[propertyName];
if (prop) {
Object.assign(prop, propUI);
} else {
propertyMap[propertyName] = { ...propUI };
}
};
publicAPI.activate = () => {
if (model.proxyManager) {
const setActiveMethod = `setActive${_capitalize(
publicAPI.getProxyGroup().slice(0, -1)
)}`;
if (model.proxyManager[setActiveMethod]) {
model.proxyManager[setActiveMethod](publicAPI);
}
}
};
// property link
model.propertyLinkSubscribers = {};
publicAPI.registerPropertyLinkForGC = (otherLink, type) => {
if (!(type in model.propertyLinkSubscribers)) {
model.propertyLinkSubscribers[type] = [];
}
model.propertyLinkSubscribers[type].push(otherLink);
};
publicAPI.gcPropertyLinks = (type) => {
const subscribers = model.propertyLinkSubscribers[type] || [];
while (subscribers.length) {
subscribers.pop().unbind(publicAPI);
}
};
model.propertyLinkMap = {};
publicAPI.getPropertyLink = (id, persistent = false) => {
if (model.propertyLinkMap[id]) {
return model.propertyLinkMap[id];
}
let value = null;
const links = [];
let count = 0;
let updateInProgress = false;
function update(source, force = false) {
if (updateInProgress) {
return null;
}
const needUpdate = [];
let sourceLink = null;
count = links.length;
while (count--) {
const link = links[count];
if (link.instance === source) {
sourceLink = link;
} else {
needUpdate.push(link);
}
}
if (!sourceLink) {
return null;
}
const newValue =
sourceLink.instance[`get${_capitalize(sourceLink.propertyName)}`]();
if (!shallowEquals(newValue, value) || force) {
value = newValue;
updateInProgress = true;
while (needUpdate.length) {
const linkToUpdate = needUpdate.pop();
linkToUpdate.instance.set({
[linkToUpdate.propertyName]: value,
});
}
updateInProgress = false;
}
if (model.propertyLinkMap[id].persistent) {
model.propertyLinkMap[id].value = newValue;
}
return newValue;
}
function unbind(instance, propertyName) {
const indexToDelete = [];
count = links.length;
while (count--) {
const link = links[count];
if (
link.instance === instance &&
(link.propertyName === propertyName || propertyName === undefined)
) {
link.subscription.unsubscribe();
indexToDelete.push(count);
}
}
while (indexToDelete.length) {
links.splice(indexToDelete.pop(), 1);
}
}
function bind(instance, propertyName, updateMe = false) {
const subscription = instance.onModified(update);
const other = links[0];
links.push({
instance,
propertyName,
subscription,
});
if (updateMe) {
if (
model.propertyLinkMap[id].persistent &&
model.propertyLinkMap[id].value !== undefined
) {
instance.set({
[propertyName]: model.propertyLinkMap[id].value,
});
} else if (other) {
update(other.instance, true);
}
}
return {
unsubscribe: () => unbind(instance, propertyName),
};
}
function unsubscribe() {
while (links.length) {
links.pop().subscription.unsubscribe();
}
}
const linkHandler = {
bind,
unbind,
unsubscribe,
persistent,
};
model.propertyLinkMap[id] = linkHandler;
return linkHandler;
};
// extract values
function getProperties(groupName = ROOT_GROUP_NAME) {
const values = [];
const id = model.proxyId;
const propertyNames = listProxyProperties(groupName) || [];
for (let i = 0; i < propertyNames.length; i++) {
const name = propertyNames[i];
const method = publicAPI[`get${_capitalize(name)}`];
const value = method ? method() : undefined;
const prop = {
id,
name,
value,
};
const children = getProperties(name);
if (children.length) {
prop.children = children;
}
values.push(prop);
}
return values;
}
publicAPI.listPropertyNames = () => getProperties().map((p) => p.name);
publicAPI.getPropertyByName = (name) =>
getProperties().find((p) => p.name === name);
publicAPI.getPropertyDomainByName = (name) =>
(propertyMap[name] || {}).domain;
// ui section
publicAPI.getProxySection = () => ({
id: model.proxyId,
name: model.proxyGroup,
ui: model.ui,
properties: getProperties(),
});
// free resources
publicAPI.delete = () => {
const list = Object.keys(model.propertyLinkMap);
let count = list.length;
while (count--) {
model.propertyLinkMap[list[count]].unsubscribe();
}
Object.keys(model.propertyLinkSubscribers).forEach(
publicAPI.gcPropertyLinks
);
parentDelete();
};
// @todo fix infinite recursion due to active source
publicAPI.getState = () => null;
function registerLinks() {
// Allow dynamic registration of links at the application level
Iif (model.links) {
for (let i = 0; i < model.links.length; i++) {
const { link, property, persistent, updateOnBind, type } =
model.links[i];
if (type === 'application') {
const sLink = model.proxyManager.getPropertyLink(link, persistent);
publicAPI.registerPropertyLinkForGC(sLink, 'application');
sLink.bind(publicAPI, property, updateOnBind);
}
}
}
}
setImmediateVTK(registerLinks);
}
// ----------------------------------------------------------------------------
// proxyPropertyMapping(publicAPI, model, map)
//
// map = {
// opacity: { modelKey: 'property', property: 'opacity' },
// }
//
// Generated API:
// Elevate set/get methods from internal object stored in the model to current one
// ----------------------------------------------------------------------------
export function proxyPropertyMapping(publicAPI, model, map) {
const parentDelete = publicAPI.delete;
const subscriptions = [];
const propertyNames = Object.keys(map);
let count = propertyNames.length;
while (count--) {
const propertyName = propertyNames[count];
const { modelKey, property, modified = true } = map[propertyName];
const methodSrc = _capitalize(property);
const methodDst = _capitalize(propertyName);
publicAPI[`get${methodDst}`] = model[modelKey][`get${methodSrc}`];
publicAPI[`set${methodDst}`] = model[modelKey][`set${methodSrc}`];
if (modified) {
subscriptions.push(model[modelKey].onModified(publicAPI.modified));
}
}
publicAPI.delete = () => {
while (subscriptions.length) {
subscriptions.pop().unsubscribe();
}
parentDelete();
};
}
// ----------------------------------------------------------------------------
// proxyPropertyState(publicAPI, model, state, defaults)
//
// state = {
// representation: {
// 'Surface with edges': { property: { edgeVisibility: true, representation: 2 } },
// Surface: { property: { edgeVisibility: false, representation: 2 } },
// Wireframe: { property: { edgeVisibility: false, representation: 1 } },
// Points: { property: { edgeVisibility: false, representation: 0 } },
// },
// }
//
// defaults = {
// representation: 'Surface',
// }
//
// Generated API
// get / set Representation ( string ) => push state to various internal objects
// ----------------------------------------------------------------------------
export function proxyPropertyState(
publicAPI,
model,
state = {},
defaults = {}
) {
model.this = publicAPI;
function applyState(map) {
const modelKeys = Object.keys(map);
let count = modelKeys.length;
while (count--) {
const modelKey = modelKeys[count];
model[modelKey].set(map[modelKey]);
}
}
const modelKeys = Object.keys(defaults);
let count = modelKeys.length;
while (count--) {
// Add default
const key = modelKeys[count];
model[key] = defaults[key];
// Add set method
const mapping = state[key];
publicAPI[`set${_capitalize(key)}`] = (value) => {
if (value !== model[key]) {
model[key] = value;
const propValues = mapping[value];
applyState(propValues);
publicAPI.modified();
}
};
}
// Add getter
if (modelKeys.length) {
get(publicAPI, model, modelKeys);
}
}
// ----------------------------------------------------------------------------
// From : https://github.com/facebookarchive/fixed-data-table/blob/master/src/vendor_upstream/dom/normalizeWheel.js
//
//
// Copyright (c) 2015, Facebook, Inc.
// All rights reserved.
//
// This source code is licensed under the BSD-style license found in the
// LICENSE file in the root directory of this source tree. An additional grant
// of patent rights can be found in the PATENTS file in the same directory.
//
//
// Mouse wheel (and 2-finger trackpad) support on the web sucks. It is
// complicated, thus this doc is long and (hopefully) detailed enough to answer
// your questions.
//
// If you need to react to the mouse wheel in a predictable way, this code is
// like your bestest friend.// hugs//
//
// As of today, there are 4 DOM event types you can listen to:
//
// 'wheel' -- Chrome(31+), FF(17+), IE(9+)
// 'mousewheel' -- Chrome, IE(6+), Opera, Safari
// 'MozMousePixelScroll' -- FF(3.5 only!) (2010-2013) -- don't bother!
// 'DOMMouseScroll' -- FF(0.9.7+) since 2003
//
// So what to do? The is the best:
//
// normalizeWheel.getEventType();
//
// In your event callback, use this code to get sane interpretation of the
// deltas. This code will return an object with properties:
//
// spinX -- normalized spin speed (use for zoom) - x plane
// spinY -- " - y plane
// pixelX -- normalized distance (to pixels) - x plane
// pixelY -- " - y plane
//
// Wheel values are provided by the browser assuming you are using the wheel to
// scroll a web page by a number of lines or pixels (or pages). Values can vary
// significantly on different platforms and browsers, forgetting that you can
// scroll at different speeds. Some devices (like trackpads) emit more events
// at smaller increments with fine granularity, and some emit massive jumps with
// linear speed or acceleration.
//
// This code does its best to normalize the deltas for you:
//
// - spin is trying to normalize how far the wheel was spun (or trackpad
// dragged). This is super useful for zoom support where you want to
// throw away the chunky scroll steps on the PC and make those equal to
// the slow and smooth tiny steps on the Mac. Key data: This code tries to
// resolve a single slow step on a wheel to 1.
//
// - pixel is normalizing the desired scroll delta in pixel units. You'll
// get the crazy differences between browsers, but at least it'll be in
// pixels!
//
// - positive value indicates scrolling DOWN/RIGHT, negative UP/LEFT. This
// should translate to positive value zooming IN, negative zooming OUT.
// This matches the newer 'wheel' event.
//
// Why are there spinX, spinY (or pixels)?
//
// - spinX is a 2-finger side drag on the trackpad, and a shift + wheel turn
// with a mouse. It results in side-scrolling in the browser by default.
//
// - spinY is what you expect -- it's the classic axis of a mouse wheel.
//
// - I dropped spinZ/pixelZ. It is supported by the DOM 3 'wheel' event and
// probably is by browsers in conjunction with fancy 3D controllers .. but
// you know.
//
// Implementation info:
//
// Examples of 'wheel' event if you scroll slowly (down) by one step with an
// average mouse:
//
// OS X + Chrome (mouse) - 4 pixel delta (wheelDelta -120)
// OS X + Safari (mouse) - N/A pixel delta (wheelDelta -12)
// OS X + Firefox (mouse) - 0.1 line delta (wheelDelta N/A)
// Win8 + Chrome (mouse) - 100 pixel delta (wheelDelta -120)
// Win8 + Firefox (mouse) - 3 line delta (wheelDelta -120)
//
// On the trackpad:
//
// OS X + Chrome (trackpad) - 2 pixel delta (wheelDelta -6)
// OS X + Firefox (trackpad) - 1 pixel delta (wheelDelta N/A)
//
// On other/older browsers.. it's more complicated as there can be multiple and
// also missing delta values.
//
// The 'wheel' event is more standard:
//
// http://www.w3.org/TR/DOM-Level-3-Events/#events-wheelevents
//
// The basics is that it includes a unit, deltaMode (pixels, lines, pages), and
// deltaX, deltaY and deltaZ. Some browsers provide other values to maintain
// backward compatibility with older events. Those other values help us
// better normalize spin speed. Example of what the browsers provide:
//
// | event.wheelDelta | event.detail
// ------------------+------------------+--------------
// Safari v5/OS X | -120 | 0
// Safari v5/Win7 | -120 | 0
// Chrome v17/OS X | -120 | 0
// Chrome v17/Win7 | -120 | 0
// IE9/Win7 | -120 | undefined
// Firefox v4/OS X | undefined | 1
// Firefox v4/Win7 | undefined | 3
//
// ----------------------------------------------------------------------------
// Reasonable defaults
const PIXEL_STEP = 10;
const LINE_HEIGHT = 40;
const PAGE_HEIGHT = 800;
export function normalizeWheel(wheelEvent) {
let sX = 0; // spinX
let sY = 0; // spinY
let pX = 0; // pixelX
let pY = 0; // pixelY
// Legacy
Iif ('detail' in wheelEvent) {
sY = wheelEvent.detail;
}
Iif ('wheelDelta' in wheelEvent) {
sY = -wheelEvent.wheelDelta / 120;
}
if ('wheelDeltaY' in wheelEvent) {
sY = -wheelEvent.wheelDeltaY / 120;
}
if ('wheelDeltaX' in wheelEvent) {
sX = -wheelEvent.wheelDeltaX / 120;
}
// side scrolling on FF with DOMMouseScroll
Iif ('axis' in wheelEvent && wheelEvent.axis === wheelEvent.HORIZONTAL_AXIS) {
sX = sY;
sY = 0;
}
pX = sX * PIXEL_STEP;
pY = sY * PIXEL_STEP;
Iif ('deltaY' in wheelEvent) {
pY = wheelEvent.deltaY;
}
Iif ('deltaX' in wheelEvent) {
pX = wheelEvent.deltaX;
}
Iif ((pX || pY) && wheelEvent.deltaMode) {
if (wheelEvent.deltaMode === 1) {
// delta in LINE units
pX *= LINE_HEIGHT;
pY *= LINE_HEIGHT;
} else {
// delta in PAGE units
pX *= PAGE_HEIGHT;
pY *= PAGE_HEIGHT;
}
}
// Fall-back if spin cannot be determined
Iif (pX && !sX) {
sX = pX < 1 ? -1 : 1;
}
Iif (pY && !sY) {
sY = pY < 1 ? -1 : 1;
}
return {
spinX: sX,
spinY: sY || sX,
pixelX: pX,
pixelY: pY || pX,
};
}
// ----------------------------------------------------------------------------
// Default export
// ----------------------------------------------------------------------------
export default {
algo,
capitalize,
chain,
debounce,
enumToString,
event,
EVENT_ABORT,
formatBytesToProperUnit,
formatNumbersWithThousandSeparator,
get,
getArray,
getCurrentGlobalMTime,
getStateArrayMapFunc,
isVtkObject,
keystore,
measurePromiseExecution,
moveToProtected,
newInstance,
newTypedArray,
newTypedArrayFrom,
normalizeWheel,
obj,
proxy,
proxyPropertyMapping,
proxyPropertyState,
safeArrays,
set,
setArray,
setGet,
setGetArray,
setImmediate: setImmediateVTK,
setLoggerFunction,
throttle,
traverseInstanceTree,
TYPED_ARRAYS, // deprecated todo remove on breaking API revision
uncapitalize,
VOID,
vtkDebugMacro,
vtkErrorMacro,
vtkInfoMacro,
vtkLogMacro,
vtkOnceErrorMacro,
vtkWarningMacro,
};
|