|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 |
--Vetical Scrollbar Base
------------------------
local OFF_ALPHA = 0.5
local SCROLL_AREA_ALPHA = 0.8
local ON_ALPHA = 1
local STATE_CHANGE_DURATION = 250
local MIN_SCROLL_VALUE = 0
local MAX_SCROLL_VALUE = 100
local MAX_FADE_DISTANCE_UI = 64
local DEFAULT_Y_DISTANCE_FROM_EDGE_WHERE_SELECTION_CAUSES_SCROLL = 150
local NO_SELECTED_DATA = nil
local NO_DATA_CONTROL = nil
local RESELECTING_DURING_REBUILD = true
local NOT_RESELECTING_DURING_REBUILD = false
local ANIMATE_INSTANTLY = true
ZO_SCROLL_LIST_OPERATION_ADVANCE_CURSOR = "advance_cursor"
ZO_SCROLL_LIST_OPERATION_LINE_BREAK = "line_break"
ZO_SCROLL_MOVEMENT_DIRECTION_NEGATIVE = -1
ZO_SCROLL_MOVEMENT_DIRECTION_NONE = 0
ZO_SCROLL_MOVEMENT_DIRECTION_POSITIVE = 1
ZO_SCROLL_BUILD_DIRECTION_LEFT_TO_RIGHT = 1
ZO_SCROLL_BUILD_DIRECTION_RIGHT_TO_LEFT = -1
ZO_SCROLL_SELECT_CATEGORY_PREVIOUS = -1
ZO_SCROLL_SELECT_CATEGORY_NEXT = 1
ZO_SCROLL_BAR_WIDTH = 16
-- Used by both ZO_VerticalScrollbarBase and ZO_Scroll
end
end
----
-- Start of VerticalScrollbarBase functions
----
local function VerticalScrollbarBase_SetOnInteractWithScrollbarCallback(self, onInteractWithScrollbarCallback)
end
end
end
end
local newAlpha = OFF_ALPHA
newAlpha = SCROLL_AREA_ALPHA
end
newAlpha = ON_ALPHA
end
else
end
end
end
end
end
end
end
end
end
end
end
end
end
----
-- End of VerticalScrollbarBase functions
----
if inScrollArea then
else
end
end
end
end
end
--Shared Scroll Animation Functions
---------------------------------------
local SCROLL_ANIMATION_UNITS_PERCENT = 1
local SCROLL_ANIMATION_UNITS_REAL = 2
local SCROLL_ANIMATION_DEFAULT_DURATION_MS = 400
local scrollObject = animationObject.scrollObject
local value = scrollObject.animationStart + (scrollObject.animationTarget - scrollObject.animationStart) * progress
if scrollObject.animationUnits == SCROLL_ANIMATION_UNITS_REAL then
if verticalExtents > 0 then
else
end
end
end
if animateInstantly then
else
end
local SCROLL_ANIMATION_COMPLETE = true
end
end
if animateInstantly then
else
end
local SCROLL_ANIMATION_COMPLETE = true
end
end
end
local scrollObject = animationObject.scrollObject
scrollObject.animationStart = nil
scrollObject.animationTarget = nil
end
end
animation.scrollObject = scrollObject
return animation, timeline
end
--Shared Scroll Edge Fades
-----------------------------------------------------------------
local function ComputeScrollFadeDistancesFromRealValues(sliderValue, sliderMin, sliderMax, maxFadeDistance)
return topFadeDistance, bottomFadeDistance
end
local function ComputeScrollFadeDistancesFromPercentValues(sliderValue, verticalExtents, maxFadeDistance)
local realSliderMin = 0
local realSliderMax = verticalExtents
local realSliderValue = (sliderValue / MAX_SCROLL_VALUE) * verticalExtents
return ComputeScrollFadeDistancesFromRealValues(realSliderValue, realSliderMin, realSliderMax, maxFadeDistance)
end
local topFadeDistance, bottomFadeDistance
if isPercent then
topFadeDistance, bottomFadeDistance = ComputeScrollFadeDistancesFromPercentValues(sliderValue, verticalExtents, maxFadeDistance)
else
topFadeDistance, bottomFadeDistance = ComputeScrollFadeDistancesFromRealValues(sliderValue, sliderMin, sliderMax, maxFadeDistance)
end
if topFadeDistance > 0 then
else
end
if bottomFadeDistance > 0 then
else
end
else
end
end
--Scroll Control - Encapsulates a scroll control with a scrollbar
-----------------------------------------------------------------
--Init
end
end
end
end
end
--Scrolling functions
end
end
end
if verticalExtents > 0 then
end
end
end
if verticalExtents > 0 then
local oldVerticalOffset
else
end
local newVerticalOffset = oldVerticalOffset + verticalDelta
else
local newVerticalOffset = currentVerticalOffset + verticalDelta
end
end
end
end
local SCROLL_TO_SIDE_TOP = 1
local SCROLL_TO_SIDE_BOTTOM = 2
local scrollDistance = 0
if scrollToSide == SCROLL_TO_SIDE_TOP then -- The control's top is above the top edge of the scroll, must scroll up to fully contain the control.
scrollDistance = controlTop - scrollTop
elseif scrollToSide == SCROLL_TO_SIDE_BOTTOM then -- The control's bottom is below the bottom edge of the scroll, must scroll down to fully contain the control.
scrollDistance = controlBottom - scrollBottom
end
local topFadeDistance, bottomFadeDistance = ComputeScrollFadeDistancesFromRealValues(verticalOffsetAfterScroll, 0, verticalExtents, ZO_Scroll_GetMaxFadeDistance(self))
if scrollToSide == SCROLL_TO_SIDE_TOP then
-- divide by 2 for effect
scrollDistance = scrollDistance - topFadeDistance * 0.5
else
-- divide by 2 for effect
scrollDistance = scrollDistance + bottomFadeDistance * 0.5
end
end
return scrollDistance
end
local scrollToSide
if controlTop < scrollTop then -- The control's top is above the top edge of the scroll, must scroll up to fully contain the control.
scrollToSide = SCROLL_TO_SIDE_TOP
elseif controlBottom > scrollBottom then -- The control's bottom is below the bottom edge of the scroll, must scroll down to fully contain the control.
scrollToSide = SCROLL_TO_SIDE_BOTTOM
end
if scrollDistance ~= 0 then
end
end
if scrollDistance ~= 0 then
end
end
local scrollDistance = ZO_Scroll_GetScrollDistanceToControl(self, otherControl, SCROLL_TO_SIDE_BOTTOM)
if scrollDistance ~= 0 then
end
end
return controlTop >= scrollTop and controlBottom <= scrollBottom
end
if controlTop < scrollTop then
elseif controlBottom > scrollBottom then
end
end
local halfControlHeight = (controlBottom - controlTop) * 0.5
local halfScrollHeight = (scrollBottom - scrollTop) * 0.5
local scrollDistance = controlTop + halfControlHeight - scrollTop - halfScrollHeight
if scrollInstantly then
local targetValue = (scrollToValue / verticalExtents) * MAX_SCROLL_VALUE
else
end
end
function ZO_Scroll_SetScrollToRealOffsetAccountingForGradients(self, finalTotalHeight, controlFinalTopOffset, durationMS)
local finalVerticalOffset = controlFinalTopOffset
local topGradientHeight = ComputeScrollFadeDistancesFromRealValues(finalVerticalOffset, 0, finalVerticalExtents, ZO_Scroll_GetMaxFadeDistance(self))
-- divide by 2 for effect
finalVerticalOffset = finalVerticalOffset - topGradientHeight * 0.5
end
local DONT_ANIMATE_INSTANTLY = false
end
--Scroll update functions
end
end
end
VerticalScrollbarBase_SetOnInteractWithScrollbarCallback(self.scrollbar, onInteractWithScrollbarCallback)
end
end
local scrollEnabled = (verticalExtents > 0 or verticalOffset > 0)
local verticalExtentsChanged = self.verticalExtents ~= nil and not zo_floatsAreEqual(self.verticalExtents, verticalExtents)
if scrollbar then
--thumb resizing
if verticalExtents > 0 and scrollBarHeight >= 0 and scrollAreaHeight >= 0 then
local thumbHeight = scrollBarHeight * scrollAreaHeight /(verticalExtents + scrollAreaHeight)
else
end
--auto scroll bar hiding
if wasHidden and not scrollbarHidden and scrollbar.resetScrollbarOnShow then
end
--update the scrollBar value when the extents changes or explicitly ask to
if verticalExtentsChanged or forceUpdateBarValue then
if verticalExtents > 0 then
local finalValue = MAX_SCROLL_VALUE * (verticalOffset / verticalExtents)
end
-- If the previous and current scrollBar values are the same,
-- the onValueChanged function will not be invoked to update the scroll child position.
-- We need to explicitly call to recalculate our scroll child position since our extents changed.
end
else
end
end
local IS_PERCENT = true
elseif scrollIndicator then
--auto scroll indicator hiding
if wasHidden and not scrollbarHidden then
end
--extents updating
if verticalExtentsChanged then
if verticalExtents <= 0 then
end
end
end
end
--Visual Config
end
end
end
end
end
end
end
--Scroll List Control
--A scrollable list of controls that reuses controls as they scroll out of view.
--Use this control when you have a very large number of a couple different types of controls to display.
--To use:
--(1) Add a scroll list to your XML.
--(2) Add data types to the scroll list, one for each type of control. A data type includes an XML control template, a height, and a callback that can setup the control given data.
--(3) Add data to the scroll list. First, use GetDataList to get the table holding the data. Next, use CreateDataEntry to create a list element of a certain data type. You may pass
-- in an arbitrary piece of data that will be given to the setup callback when the control is shown. Once you have made as many data entries as you need, add them to the data
-- list in any way you want. Finally, call Commit to update the scroll list with your data.
-- Note: The scroll list can use faster update logic if all controls are the same height.
-------------------------------------------------------------------------------------------------------------
local SCROLL_LIST_UNIFORM = 1
local SCROLL_LIST_NON_UNIFORM = 2
local SCROLL_LIST_OPERATIONS = 3
local NO_HEIGHT_SET = -1
end
end
self.yDistanceFromEdgeWhereSelectionCausesScroll = DEFAULT_Y_DISTANCE_FROM_EDGE_WHERE_SELECTION_CAUSES_SCROLL
end
function ZO_ScrollList_SetYDistanceFromEdgeWhereSelectionCausesScroll(self, yDistanceFromEdgeWhereSelectionCausesScroll)
end
end
end
end
end
end
end
end
end
--Adds a new control type for the list to handle. It must maintain a consistent size.
--@typeId - A unique identifier to give to CreateDataEntry when you want to add an element of this type.
--@templateName - The name of the virtual control template that will be used to hold this data
--@height - The control height
--@setupCallback - The function that will be called when a control of this type becomes visible. Signature: setupCallback(control, data)
--@dataTypeSelectSound - An optional sound to play when a row of this data type is selected.
--@resetControlCallback - An optional callback when the datatype control gets reset.
function ZO_ScrollList_AddDataType(self, typeId, templateName, height, setupCallback, hideCallback, dataTypeSelectSound, resetControlCallback)
local factoryFunction = function(objectPool) return ZO_ObjectPool_CreateNamedControl(string.format("%s%dRow", self:GetName(), typeId), templateName, objectPool, self.contents) end
local pool = ZO_ObjectPool:New(factoryFunction, resetControlCallback or ZO_ObjectPool_DefaultResetControl)
{
height = height,
pool = pool,
selectSound = dataTypeSelectSound,
selectable = true,
}
--automatically choose the scrolling logic based on if the controls are all the same height or not
end
end
-- Scroll List Construction Operations --
currentX = layoutInfo.startPos
currentY = currentY + lineBreakAmount
return currentX, currentY
end
-- ZO_ScrollListOperation --
return operation
end
end
end
end
-- ZO_ScrollList_AdvanceCursor_Operation --
end
function ZO_ScrollList_AdvanceCursor_Operation:GetPositionsAndAdvance(layoutInfo, currentX, currentY, data)
currentY = currentY + instanceData.moveY
return currentX, currentY
end
end
-- ZO_ScrollList_LineBreak_Operation --
end
function ZO_ScrollList_LineBreak_Operation:GetPositionsAndAdvance(layoutInfo, currentX, currentY, data)
if layoutInfo.startPos < layoutInfo.endPos then
else
end
currentX, currentY = GetLineBreakPositions(layoutInfo, currentX, currentY, instanceData.lineBreakAmount)
return currentX, currentY
end
end
-- ZO_ScrollList_AddControl_Operation --
end
-- Defined set of actions this operation can use
end
end
-- A controlWidth of nil will cause controls to be added Anchor TOPLEFT Anchor TOPRIGHT to fill the horizontal space of the parent control
function ZO_ScrollList_AddControl_Operation:SetControlTemplate(templateName, parentControl, operationId, controlWidth, controlHeight, resetControlCallback)
return
end
local factoryFunction = function(objectPool) return ZO_ObjectPool_CreateNamedControl(string.format("%s%dControl", parentControl:GetName(), operationId), templateName, objectPool, parentControl) end
self.pool = ZO_ObjectPool:New(factoryFunction, resetControlCallback or ZO_ObjectPool_DefaultResetControl)
end
end
end
end
function ZO_ScrollList_AddControl_Operation:GetPositionsAndAdvance(layoutInfo, currentX, currentY, data)
if controlWidth then
if currentX * layoutInfo.direction + controlWidth > layoutInfo.endPos then
currentX, currentY = GetLineBreakPositions(layoutInfo, currentX, currentY, self.controlHeight + self.spacingY)
end
-- Calculate left and right based on the direction we are told to advance
-- Since we want Left to always be less than Right, and having Right_To_Left
-- build direction will cause Left to be greater than Right
-- we need to compensate for that fact in this case, but keep the calculation the same
-- when we are in the direction of Left_To_Right
local halfControlWidth = controlWidth / 2
else
if layoutInfo.startPos < layoutInfo.endPos then
else
end
currentX, currentY = GetLineBreakPositions(layoutInfo, currentX, currentY, self.controlHeight + self.spacingY)
end
return currentX, currentY
end
function ZO_ScrollList_AddControl_Operation:AddToScrollContents(contents, control, currentX, currentY, offset)
local xOffset = currentX
local yOffset = currentY - offset
else
end
end
-- ZO_ScrollList_AddControl_Centered_Operation --
end
function ZO_ScrollList_AddControl_Centered_Operation:AddToScrollContents(contents, control, currentX, currentY, offset)
local xOffset = currentX
local yOffset = currentY - offset
control:SetAnchor(CENTER, contents, TOPLEFT, xOffset + self.controlWidth / 2, yOffset + self.controlHeight / 2)
else
end
end
do
if typeId == ZO_SCROLL_LIST_OPERATION_ADVANCE_CURSOR then
return advanceCursorOperation
elseif typeId == ZO_SCROLL_LIST_OPERATION_LINE_BREAK then
return lineBreakOperation
end
end
end
end
-- A controlWidth of nil will cause controls to be added Anchor TOPLEFT Anchor TOPRIGHT to fill the horizontal space of the parent control
function ZO_ScrollList_AddControlOperation(self, operationId, templateName, controlWidth, controlHeight, resetControlCallback, showCallback, hideCallback, spacingX, spacingY, selectable, centerEntries)
local operation = centerEntries and ZO_ScrollList_AddControl_Centered_Operation:New() or ZO_ScrollList_AddControl_Operation:New()
operation:SetControlTemplate(templateName, self.contents, operationId, controlWidth, controlHeight, resetControlCallback)
end
end
end
if dataTable and dataTable.height ~= newHeight then
dataTable.height = newHeight
end
end
end
end
end
end
end
end
return
end
--if a parent id is given and it doesn't exist, give up
local parent = nil
if parentId then
if not parent then
return
end
end
local category = {id = categoryId, parent = parent, children = {}, hidden = false}
if parent then
end
end
ZO_ScrollList_SelectData(self, NO_SELECTED_DATA, NO_DATA_CONTROL, RESELECTING_DURING_REBUILD, ANIMATE_INSTANTLY)
end
end
if category then
return category.hidden
end
end
--Creates a data entry for use in the scroll list. Add it to the data list then commit it.
local entry =
{
typeId = typeId,
categoryId = categoryId,
}
return entry
end
local operation =
{
typeId = operationId,
}
end
end
end
end
end
end
end
end
return nil
end
end
--Allows you to prevent the list from scrolling
end
end
end
end
local function PlayAnimationOnControl(control, controlTemplate, animationFieldName, animateInstantly)
if controlTemplate then
local highlight = CreateControlFromVirtual("$(parent)Scroll", control, controlTemplate, animationFieldName)
control[animationFieldName] = ANIMATION_MANAGER:CreateTimelineFromVirtual("ShowOnMouseOverLabelAnimation", highlight)
end
if animateInstantly then
else
end
end
end
if animateInstantly then
else
end
end
end
end
end
end
end
end
end
--Allows you to lock the highlight in place. The highlight will automatically unlock if the list is recommitted.
return
end
if lock then
else
end
end
end
end
--Reinitializes the highlight (used mostly when a mouse enter would have been missed)
return
end
end
--find the control to highlight if any
return
end
end
end
return
end
--allows us to place the highlight correctly when we unlock
return
end
end
return
end
return
end
end
end
else
if selectSound then
end
end
end
end
end
end
-- Not updating state here, you should call this when the list is being created.
-- The bar will update state properly when the list has data committed.
end
end
end
end
--Determines if one piece of selected data is the "same" as the other. Used mainly to
--keep an item selected even when the data for the list is updated if they share some
--property determined by the equality function. For example, if you have an item with
--id=1 and state=up and replace it with id=1 and state=down, the selection will be maintained
--if the equality function only compares ids.
if data1 == data2 then
return true
end
if data1 == nil or data2 == nil then
return false
end
local dataEntry1 = data1.dataEntry
local dataEntry2 = data2.dataEntry
if dataEntry1.typeId == dataEntry2.typeId then
end
end
return false
end
return true
end
return false
end
for i = 1, numActive do
local currentDataEntry = currentControl.dataEntry
return currentControl
end
end
end
return nil
end
return i
end
end
end
return nil
end
if reselectingDuringRebuild == nil then
reselectingDuringRebuild = false
end
if animateInstantly == nil then
animateInstantly = false
end
local dataIndex
dataIndex = i
break
end
end
--this data we tried to select isn't in the scroll list at all, just abort
if dataIndex == nil then
return
end
end
end
end
end
end
end
end
end
end
if windowHeight > 0 then
end
end
local currentDataEntry = currentControl.dataEntry
end
end
end
end
local controlPool = dataType.pool
end
currentControl.key = nil
currentControl.dataEntry = nil
currentControl.index = nil
end
local HIDE_SCROLLBAR = true
if scrollableDistance > 0 then
else
end
self.scrollbar:SetThumbTextureHeight(scrollBarHeight * scrollListHeight / (scrollableDistance + scrollListHeight))
end
else
else
end
end
end
end
end
end
end
return dataTypeInfo.selectable
end
return dataTypeInfo.categoryHeader
end
if recalledIndex then
ZO_ScrollList_SelectData(self, self.data[i].data, NO_DATA_CONTROL, NOT_RESELECTING_DURING_REBUILD, animateInstantly)
return
end
end
end
return
end
end
ZO_ScrollList_SelectData(self, NO_SELECTED_DATA, NO_DATA_CONTROL, NOT_RESELECTING_DURING_REBUILD, animateInstantly)
end
local controlTop
local controlBottom
else
controlTop = dataEntry.top
controlBottom = dataEntry.bottom
end
return controlTop, controlBottom
end
local controlWidth
local controlHeight
controlWidth = dataTypeInfo.controlWidth
controlHeight = dataTypeInfo.controlHeight
else
controlHeight = dataTypeInfo.height
end
return controlWidth, controlHeight
end
-- If an animation is in progress and we call to change the scrollBar's value,
-- we must account for the distance left to travel in our calculations
-- of the new scrollBar value so we do not over/under shoot the target
local animationOffset = 0
end
return animationOffset
end
function ZO_ScrollList_ScrollDataIntoView(self, dataIndex, onScrollCompleteCallback, animateInstantly)
local calculatedControlTop = controlTop - self.yDistanceFromEdgeWhereSelectionCausesScroll - scrollAnimationOffset
local calculatedControlBottom = controlBottom + self.yDistanceFromEdgeWhereSelectionCausesScroll - scrollAnimationOffset
if calculatedControlTop < scrollTop then
ZO_ScrollList_ScrollRelative(self, calculatedControlTop - scrollTop, onScrollCompleteCallback, animateInstantly)
elseif calculatedControlBottom > scrollBottom then
ZO_ScrollList_ScrollRelative(self, calculatedControlBottom - scrollBottom, onScrollCompleteCallback, animateInstantly)
end
end
function ZO_ScrollList_ScrollDataToCenter(self, dataIndex, onScrollCompleteCallback, animateInstantly)
local controlCenter = controlTop + controlHeight / 2
ZO_ScrollList_ScrollRelative(self, controlCenter - scrollCenter - scrollAnimationOffset, onScrollCompleteCallback, animateInstantly)
end
return
end
-- Allow Wraping
break
end
end
end
return
end
-- Allow Wrapping
break
end
end
end
-- x and y direction must use the values for directions described at the top of this file
return
end
-- Move Y Direction
if yDirection ~= ZO_SCROLL_MOVEMENT_DIRECTION_NONE then
local currentTopValue = currentData.top * yDirection
while nextIndex <= numDataEntries and nextIndex > 0 do
local nextDataTopValue = nextData.top * yDirection
-- check and see if the next data is within the y direction we are searching,
-- and has an x direction greater than or equal to our current data's x
if nextDataTopValue > currentTopValue and nextData.left * yDirection >= holdXPos * yDirection then
break
end
-- we only want to select an entry that is only one y delta away.
-- We must look ahead and see if the next data after current next data has an even greater y
local lookAheadIndex = nextIndex + yDirection
local nextSelectableData
local foundInLookAhead = false
while not nextSelectableData do
-- we can't look ahead anymore, bail out
if lookAheadIndex > numDataEntries or lookAheadIndex < 1 then
break
end
if currentTopValue < nextDataTopValue and nextDataTopValue < nextSelectableData.top * yDirection then
foundInLookAhead = true
break
end
end
lookAheadIndex = lookAheadIndex + yDirection
end
-- we found that our current next data is the best choice
-- and we no longer need to look any further
if foundInLookAhead then
break
end
end
nextIndex = nextIndex + yDirection
end
end
-- Move X Direction
-- Since data is given in X direction order, simply pick the next selectable data
-- in the correct layout direction in contigious order
-- we also save this X position for use in calculating Y direction
-- since this emulates how people already expect this form of selection to work (see text editors)
if xDirection == ZO_SCROLL_MOVEMENT_DIRECTION_POSITIVE then
while nextIndex <= numDataEntries do
break
end
nextIndex = nextIndex + xDirection
end
elseif xDirection == ZO_SCROLL_MOVEMENT_DIRECTION_NEGATIVE then
while nextIndex > 0 do
break
end
nextIndex = nextIndex + xDirection
end
end
end
end
end
end
return true
end
end
return false
end
return true
end
end
return false
end
end
--When the list in inactive, you can't get selected data. Auto select is a mechanic of lists that will reselect the last thing that was selected
-- Assuming it wasn't reset, or manually set to something else. If another party needs to know what data would be selected if the list were active, this is how
return recalledIndex
end
end
return nil
end
if recalledIndex then
end
return nil
end
end
-- direction: ZO_SCROLL_SELECT_CATEGORY_PREVIOUS or ZO_SCROLL_SELECT_CATEGORY_NEXT
if not currentlySelectedData then
return
end
if nextDataIndex < 1 or nextDataIndex > #listData then
-- we are already at the end of our list
return
end
-- if we are going backwards and hit a non-selectable entry, we need to keep going until we find a selectable entry so we don't just select the same value
if direction == ZO_SCROLL_SELECT_CATEGORY_PREVIOUS then
nextDataIndex = nextDataIndex + direction
if nextDataIndex == 0 or nextDataIndex == #listData then
-- could not find an acceptable target, we are at the selectable end of our list
return
end
end
end
while nextDataIndex > 0 and nextDataIndex <= #listData do
-- we found header data, select the first selectable entry under it
local lookAheadIndex = nextDataIndex + 1
return
end
nextDataIndex = nextDataIndex + direction
end
-- could not find another header data, so just pick the last selectable value we found
end
--Updates the scroll control with new data. Call this when you modify the data list by adding or removing entries.
--the window isn't big enough to show anything (its anchors probably haven't been processed yet), so delay the commit until that happens
if windowHeight <= 0 then
return
end
local scrollableDistance = 0
local foundSelected = false
foundSelected = true
ZO_ScrollList_SelectData(self, currentData.data, NO_DATA_CONTROL, RESELECTING_DURING_REBUILD, ANIMATE_INSTANTLY)
end
end
local currentY = 0
currentData.top = currentY
currentData.bottom = currentY
foundSelected = true
ZO_ScrollList_SelectData(self, currentData.data, NO_DATA_CONTROL, RESELECTING_DURING_REBUILD, ANIMATE_INSTANTLY)
end
end
scrollableDistance = currentY - windowHeight
local layoutInfo = {}
layoutInfo.startPos = 0
else
layoutInfo.endPos = 0
end
local currentX = layoutInfo.startPos
local currentY = 0
currentX, currentY = currentOperation:GetPositionsAndAdvance(layoutInfo, currentX, currentY, currentData)
foundSelected = true
ZO_ScrollList_SelectData(self, currentData.data, NO_DATA_CONTROL, RESELECTING_DURING_REBUILD, ANIMATE_INSTANTLY)
end
end
if numData > 0 then
else
scrollableDistance = 0
end
end
--nuke the active list since things may have left it
while i >= 1 do
i = i - 1
end
if selectionsEnabled then
if not foundSelected then
else
ZO_ScrollList_SelectData(self, NO_SELECTED_DATA, NO_DATA_CONTROL, RESELECTING_DURING_REBUILD, ANIMATE_INSTANTLY)
end
end
end
end
--updates the layout of visible controls
--data: optionally allows you to only update the control backed by the specified data table
--overrideSetupCallback: optionally allows you to call this function instead of the normal setup function if you only need to do a very specific update
end
end
end
end
--nuke the active list since things may have left it
while i >= 1 do
i = i - 1
end
--update scroll distance
end
end
break
end
end
end
end
if category then
category.hidden = true
local numRemoved = 0
local i = 1
local curCategory = categories[curCategoryId]
local found = false
--climb the hierarchy to see if this piece of data is under this category
while curCategory do
curCategoryId = curCategory.id
if curCategoryId == categoryId then
found = true
numRemoved = numRemoved + 1
break
end
curCategory = curCategory.parent
end
if not found then
i = i + 1
end
end
if numRemoved > 0 then
end
end
end
end
local inserted = false
return
inserted = true
break
end
end
if not inserted then
end
end
end
end
end
end
end
if category then
category.hidden = false
local numShown = 0
local i = 1
local shouldInsert = true
while curCategory do
if curCategory.hidden then
shouldInsert = false
break
end
curCategory = curCategory.parent
end
if shouldInsert then
if not found then
numShown = numShown + 1
end
end
i = i + 1
end
if numShown > 0 then
end
end
end
end
return topEdge - compareData.bottom
end
--Used to locate the point in the data list where we should start looking for in view controls
else
return insertPoint
end
end
--holds controls that have already been evaluated and do not need to be looked at again this update scroll call
local consideredMap = {}
local IS_REAL_NUMBER = false
--remove active controls that are now hidden
local activeIndex = 1
local numActive = #activeControls
while activeIndex <= numActive do
local currentDataEntry = activeControls[activeIndex].dataEntry
if currentDataEntry.bottom < offset or currentDataEntry.top > offset + windowHeight then
numActive = numActive - 1
else
activeIndex = activeIndex + 1
end
consideredMap[currentDataEntry] = true
end
--add revealed controls
local nextCandidateIndex = firstInViewIndex
local visibleDataIndex = visibleData[nextCandidateIndex]
local bottomEdge = offset + windowHeight
local controlTop
if dataEntry then
if mode == SCROLL_LIST_UNIFORM then
controlTop = (nextCandidateIndex - 1) * uniformControlHeight
else
controlTop = dataEntry.top
end
end
while dataEntry and controlTop <= bottomEdge do
if not consideredMap[dataEntry] then
local controlPool = dataType.pool
if controlPool then
end
consideredMap[dataEntry] = true
end
end
--even uniform active controls need to know their position to determine if they are still active
dataEntry.top = controlTop
dataEntry.bottom = controlTop + uniformControlHeight
end
end
nextCandidateIndex = nextCandidateIndex + 1
visibleDataIndex = visibleData[nextCandidateIndex]
if dataEntry then
if mode == SCROLL_LIST_UNIFORM then
controlTop = (nextCandidateIndex - 1) * uniformControlHeight
else
controlTop = dataEntry.top
end
end
end
--update positions
local numNowActive = #activeControls
for activeControlIndex = 1, numNowActive do
local currentControl = activeControls[activeControlIndex]
local currentData = currentControl.dataEntry
currentOperation:AddToScrollContents(contents, currentControl, currentData.left, currentData.top, offset)
else
local yOffset = currentData.top - offset
local xOffset = currentData.left
end
end
--reset considered
consideredMap[k] = nil
end
end
end
local scrollValue
else
end
end
end
end
end
--This function actually moves the scroll window. The only thing that should ever call it is the slider's value changed handler.
--All other scrolling behavior should call scroll absolute or scroll relative which moves the slider and activates the value changed handler.
end
-- These functions are used for scrolling through the scroll list as a block of text instead of scrolling though each entry.
end
end
local minIndexData = nil
local currentIndex = currentControl.index
if currentIndex < minIndex then
minIndex = currentIndex
minIndexData = currentData
end
end
end
local maxIndex = 1
local maxIndexData = nil
local currentIndex = currentControl.index
if currentIndex > maxIndex then
maxIndex = currentIndex
maxIndexData = currentData
end
end
end
while checkIndex >= 1 do
return false
end
end
checkIndex = checkIndex - 1
end
return true
end
else
return false
end
end
while checkIndex <= numData do
return false
end
end
checkIndex = checkIndex + 1
end
return true
end
else
return false
end
end
end
return scrollableDistance > 0
end |