Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 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 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 360x 360x 360x 360x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 288x 288x 23x 23x 288x 288x 288x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 1x 1x 1x 3x 1x 4115x 4115x 4115x 4115x 4115x 4115x 4115x 4115x 4115x 4115x 4115x 4115x 4115x 4103x 1505x 4115x 2629x 4102x 1486x 1486x 4115x 627x 627x 627x 627x 627x 627x 627x 4115x 4115x 1x 69x 69x 69x 125x 1742x 1742x 277x 277x 277x 277x 277x 277x 277x 1742x 125x 69x 69x 69x 69x 1x 26583x 26583x 26583x 26583x 24513x 24513x 26583x 1313x 1313x 26583x 6952x 6952x 26583x 4754x 4754x 26583x 26583x 26583x 1x 2x 2x 1x 449x 449x 1x 56x 56x 56x 56x 47x 47x 47x 47x 47x 56x 56x 56x 1x 437x 437x 1x 1219x 1219x 1x 1x 1x 1x 180x 180x 180x 180x 180x 180x 180x 2113x 2113x 180x 40x 27x 27x 27x 40x 180x 1x 1x 1x 1x 1x 1x 912x 36x 36x 36x 36x 36x 36x 36x 912x 1x 57x 57x 57x 1x 1691x 62x 62x 62x 1688x 1691x 1x 53x 3x 3x 3x 53x 53x 1x 84x 84x 84x 84x 84x 1x 1x 417x 417x 1x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 1x 412x 412x 412x 1x 4x 4x 1x 537x 537x 537x 537x 1x 44x 44x 1x 542x 542x 1x 71x 71x 71x 1x 861x 861x 861x 1x 1x 1x 1x 1x 1x 1x 1x 108x 812x 812x 108x 1x 1x 1x 3647x 3647x 3647x 3647x 3647x 1399x 2248x 3647x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 839x 839x 837x 837x 839x 1x 5622x 5622x 1x 5613x 5613x 5613x 5613x 5613x 5613x 5613x 5613x 2106x 2106x 2106x 2106x 2106x 2106x 5613x 5613x 5613x 5613x 5613x 3429x 3042x 3042x 3429x 3429x 3429x 3429x 3429x 3429x 3507x 3507x 3507x 3507x 5613x 1x 881x 850x 31x 15x 16x 881x 881x 881x 1x 1x 6450x 4893x 4893x 1435x 1435x 1435x 4893x 1927x 1927x 1927x 4893x 6450x 1x 11908x 11908x 1057x 1057x 1359x 1359x 746x 746x 746x 1359x 1057x 11908x 1x 842x 842x 842x 842x 842x 842x 842x 1932x 1932x 1917x 1917x 1917x 1917x 1917x 1917x 1917x 1917x 1932x 842x 842x 842x 842x 842x 1x 1x 1x 1x 1x 1x 31x 31x 1x 19x 19x 19x 1x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 1x 12x 12x 12x 12x 1x 10x 10x 10x 10x 10x 10x 10x 10x 3x 3x 1x 1x 3x 3x 10x 7x 7x 7x 7x 7x 7x 7x 7x 10x 10x 10x 10x 10x 10x 1x 423x 423x 1x 7x 7x 7x 1x 320x 320x 257x 257x 257x 14x 1x 1x 1x 1x 13x 13x 13x 257x 320x 64x 64x 64x 64x 320x 320x 1x 31x 31x 1x 83x 83x 1x 979x 979x 1x 1x 1x 1x 1x 3x 3x 1x 7024x 4120x 4120x 4120x 4120x 4120x 4120x 7024x 7024x 1x 336x 336x 1x 10549x 10549x 10549x 10549x 1x 2x 2x 2x 2x 2x 1x 5675x 5675x 1x 2x 2x 1x 1x 439x 439x 1x 308x 308x 308x 1x 36x 36x 1x 5x 5x 1x 97x 97x 97x 1x 86x 86x 86x 1x 1003x 1003x 1x 2x 2x 2x 2x 2x 2x 1x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 1x 1x 558x 558x 558x 558x 558x 558x 558x 558x 558x 558x 558x 558x 558x 558x 1x 1x 1x 1x 1x 1x 558x 558x 1x 52x 52x 114x 114x 52x 1x 855x 855x 855x 5130x 5130x 5130x 855x 855x 855x 855x 855x 855x 855x 855x 855x 1x 363x 363x 8x 8x 8x 363x 355x 355x 355x 363x 362x 362x 363x 363x 363x 363x 363x 363x 363x 363x 363x 363x 363x 363x 363x 363x 363x 363x 363x 363x 363x 363x 363x 14x 14x 363x 363x 1x 679x 679x 679x 1x 12x 12x 2x 2x 2x 2x 2x 10x 12x 1x 1x 1x 1x 1x 1x 1x 1x 1x 5x 5x 5x 1x 1x 36x 256x 256x 256x 36x 8x 8x 8x 8x 8x 8x 8x 36x 769x 769x 504x 695x 695x 695x 695x 504x 317x 769x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 1x 1x 1x 714x 167x 167x 547x 547x 283x 264x 714x 714x 714x 714x 714x 714x 714x 546x 288x 288x 288x 714x 17x 17x 530x 714x 527x 525x 525x 714x 714x 714x 714x 714x 299x 299x 299x 299x 714x 8x 8x 7x 7x 7x 7x 7x 8x 714x 714x 714x 714x 8x 4x 4x 8x 8x 8x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 8x 8x 714x 523x 523x 294x 291x 291x 291x 291x 291x 291x 291x 291x 55x 523x 714x 50x 50x 530x 714x 1x 6x 6x 1x 121x 121x 121x 58x 63x 63x 23x 121x 63x 63x 63x 3x 60x 8x 52x 63x 16x 63x 3x 63x 43x 8x 43x 43x 36x 36x 121x 1x 2x 2x 1x 1x 1x 80x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 3x 3x 3x 3x 22x 22x 22x 22x 22x 22x 22x 22x 22x 80x 80x 80x 80x 80x 59x 59x 59x 59x 9x 9x 8x 8x 8x 4x 9x 9x 59x 22x 22x 22x 58x 58x 58x 59x 59x 80x 80x 1x 1x 1x 1x 2x 2x 2x 1x 739x 739x 1x 2770x 2770x 2770x 1x 801x 801x 1x 3574x 3574x 3380x 3380x 3380x 3871x 3871x 3871x 19x 3871x 3852x 3852x 3852x 3871x 3380x 3380x 3380x 3380x 3852x 3852x 3852x 3852x 3852x 3852x 3852x 3380x 3574x 194x 194x 3574x 3574x 1x 1x 420x 420x 420x 312x 312x 312x 420x 420x 1x 336x 336x 1x 84x 84x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 2x 1x 2x 2x 1x 276x 276x 95x 95x 95x 95x 95x 95x 95x 181x 276x 1x 41x 41x 41x 41x 41x 41x 41x 41x 24x 24x 24x 7x 23x 17x 17x 24x 41x 41x 1x 5242x 5242x 5242x 5242x 5242x 1594x 1594x 1365x 1365x 1365x 1594x 1594x 1594x 1594x 1594x 1594x 3648x 5242x 1x 307x 307x 1x 60x 60x 60x 60x 1x 500x 500x 500x 500x 500x 229x 229x 500x 500x 500x 1x 1x 1x 1x 1x 1x 1x 1x 1x 433x 433x 433x 170x 165x 161x 161x 165x 9x 9x 263x 433x 1x 1x 9x 9x 1x 3x 3x 1x 1x 9x 18x 18x 40x 18x 18x 18x 9x 9x 9x 18x 7x 7x 18x 2x 9x 1x 1x 12x 12x 1x 5x 5x 1x 4x 4x 1x 2x 2x 1x 2x 2x 1x 17x 17x 14x 14x 11x 17x 1x 4x 4x 1x 180x 180x 1x 6x 6x 9x 9x 8x 8x 5x 6x 1x 1x 1x 1x 144x 144x 128x 128x 128x 128x 128x 144x 1x 1x 80x 80x 80x 1x 2006x 2006x 2006x 2006x 1515x 1435x 1286x 1270x 2006x 1979x 222x 222x 222x 222x 222x 222x 222x 222x 2006x 861x 861x 861x 861x 861x 934x 934x 2006x 934x 934x 2006x 2006x 87x 97x 97x 8x 97x 88x 88x 88x 97x 87x 87x 87x 77x 77x 2001x 4x 4x 934x 2006x 1x 268x 268x 268x 485x 485x 268x 268x 268x 1x 1x 2x 2x 1x 1x 1x 1x 1x 1x 1x 712x 712x 712x 700x 700x 712x 335x 335x 335x 335x 335x 335x 335x 335x 335x 335x 335x 335x 335x 335x 712x 712x 1x 1471x 1471x 1470x 1470x 1470x 1470x 1470x 1471x 1471x 1471x 12x 12x 1470x 1470x 1470x 1470x 1470x 1471x 5x 5x 5x 1471x 1471x 1471x 1471x 1471x 2x 2x 2x 2x 2x 2x 1468x 1468x 1468x 1471x 1471x 1471x 1468x 1468x 1471x 1468x 1468x 1468x 1471x 1471x 1468x 1468x 1468x 1471x 4x 4x 1471x 1471x 1x 1x 1x 1x 1x 1x 1x 1x 1x 144x 144x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | /*
* Paper.js - The Swiss Army Knife of Vector Graphics Scripting.
* http://paperjs.org/
*
* Copyright (c) 2011 - 2020, Jürg Lehni & Jonathan Puckey
* http://juerglehni.com/ & https://puckey.studio/
*
* Distributed under the MIT license. See LICENSE file for details.
*
* All rights reserved.
*/
// TODO: remove eslint-disable comment and deal with errors over time
/* eslint-disable */
import { Base } from '~/straps';
import { ref } from '~/globals';
import { Project } from './Project';
import { Emitter } from '~/core/Emitter';
import { Matrix } from '~/basic/Matrix';
import { Point, LinkedPoint } from '~/basic/Point';
import { Rectangle, LinkedRectangle } from '~/basic/Rectangle';
import { Size } from '~/basic/Size';
import { Numerical } from '~/util/Numerical';
import { UID } from '~/util/UID';
import { Change, ChangeFlag } from '~/item/ChangeFlag';
import { ItemSelection } from './ItemSelection';
/**
* @name Item
*
* @class The Item type allows you to access and modify the items in
* Paper.js projects. Its functionality is inherited by different project
* item types such as {@link Path}, {@link CompoundPath}, {@link Group},
* {@link Layer} and {@link Raster}. They each add a layer of functionality that
* is unique to their type, but share the underlying properties and functions
* that they inherit from Item.
*/
export const Item = Base.extend(
Emitter,
/** @lends Item# */ {
statics: /** @lends Item */ {
/**
* Override Item.extend() to merge the subclass' _serializeFields with
* the parent class' _serializeFields.
*
* @private
*/
extend: function extend(src) {
if (src._serializeFields)
src._serializeFields = Base.set({}, this.prototype._serializeFields, src._serializeFields);
return (extend as any).base.apply(this, arguments);
},
/**
* Two object constants that can be passed to Item#initialize() to
* control insertion into the scene graph in a performative way.
*
* @private
*/
INSERT: { insert: true },
NO_INSERT: { insert: false },
},
_class: 'Item',
_name: null,
// All items apply their matrix by default.
// Exceptions are Raster, SymbolItem, Clip and Shape.
_applyMatrix: true,
_canApplyMatrix: true,
_canScaleStroke: false,
_pivot: null,
_visible: true,
_blendMode: 'normal',
_opacity: 1,
_locked: false,
_guide: false,
_clipMask: false,
_selection: 0,
// Controls whether bounds should appear selected when the item is selected.
// This is only turned off for Group, Layer and PathItem, where it can be
// selected separately by setting item.bounds.selected = true;
_selectBounds: true,
_selectChildren: false,
// Provide information about fields to be serialized, with their defaults
// that can be omitted.
_serializeFields: {
name: null,
applyMatrix: null,
matrix: new Matrix(),
pivot: null,
visible: true,
blendMode: 'normal',
opacity: 1,
locked: false,
guide: false,
clipMask: false,
selected: false,
data: {},
},
// Prioritize `applyMatrix` over `matrix`:
_prioritize: ['applyMatrix'],
},
// @ts-expect-error = 'new' expression, whose target lacks a construct signature
new (function () {
// Injection scope for various item event handlers
var handlers = [
'onMouseDown',
'onMouseUp',
'onMouseDrag',
'onClick',
'onDoubleClick',
'onMouseMove',
'onMouseEnter',
'onMouseLeave',
];
return Base.each(
handlers,
function (name) {
this._events[name] = {
install: function (type) {
this.getView()._countItemEvent(type, 1);
},
uninstall: function (type) {
this.getView()._countItemEvent(type, -1);
},
};
},
{
_events: {
onFrame: {
install: function () {
this.getView()._animateItem(this, true);
},
uninstall: function () {
this.getView()._animateItem(this, false);
},
},
// Only for external sources, e.g. Raster
onLoad: {},
onError: {},
},
statics: {
_itemHandlers: handlers,
},
}
);
})(),
/** @lends Item# */ {
initialize: function Item() {
// Do nothing, but declare it for named constructors.
},
/**
* Private helper for #initialize() that tries setting properties from the
* passed props object, and apply the point translation to the internal
* matrix.
*
* @param {Object} props the properties to be applied to the item
* @param {Point} point the point by which to transform the internal matrix
* @return {Boolean} {@true if the properties were successfully be applied,
* or if none were provided}
*/
_initialize: function (props, point) {
// Define this Item's unique id. But allow the creation of internally
// used paths with no ids.
var hasProps = props && Base.isPlainObject(props),
internal = hasProps && props.internal === true,
matrix = (this._matrix = new Matrix()),
// Allow setting another project than the currently active one.
project = (hasProps && props.project) || ref.paper.project,
settings = ref.paper.settings;
// @ts-expect-error = Expected 1 arguments, but got 0
this._id = internal ? null : UID.get();
this._parent = this._index = null;
// Inherit the applyMatrix setting from settings.applyMatrix
this._applyMatrix = this._canApplyMatrix && settings.applyMatrix;
// Handle matrix before everything else, to avoid issues with
// #addChild() calling _changed() and accessing _matrix already.
if (point) matrix.translate(point);
matrix._owner = this;
this._style = new ref.Style(project._currentStyle, this, project);
// Do not add to the project if it's an internal path, or if
// props.insert or settings.insertItems is false.
if (
internal ||
(hasProps && props.insert == false) ||
(!settings.insertItems && !(hasProps && props.insert == true))
) {
this._setProject(project);
} else {
((hasProps && props.parent) || project)._insertItem(undefined, this, true); // _created = true
}
// Filter out Item.*INSERT before _set(), for performance reasons.
if (hasProps && props !== Item.NO_INSERT && props !== Item.INSERT) {
this.set(props, {
// Filter out these properties as they were handled above:
internal: true,
insert: true,
project: true,
parent: true,
});
}
return hasProps;
},
_serialize: function (options, dictionary) {
var props = {},
that = this;
function serialize(fields) {
for (var key in fields) {
// value is the default value, only serialize if the current
// value is different from it.
var value = that[key];
// Style#leading is a special case, as its default value is
// dependent on the fontSize. Handle this here separately.
if (!Base.equals(value, key === 'leading' ? fields.fontSize * 1.2 : fields[key])) {
props[key] = Base.serialize(
value,
options,
// Do not use compact mode for data
key !== 'data',
dictionary
);
}
}
}
// Serialize fields that this Item subclass defines first
serialize(this._serializeFields);
// Serialize style fields, but only if they differ from defaults.
// Do not serialize styles on Groups and Layers, since they just unify
// their children's own styles.
if (!(this instanceof ref.Group)) serialize(this._style._defaults);
// There is no compact form for Item serialization, we always keep the
// class.
return [this._class, props];
},
/**
* Private notifier that is called whenever a change occurs in this item or
* its sub-elements, such as Segments, Curves, Styles, etc.
*
* @param {ChangeFlag} flags describes what exactly has changed
*/
_changed: function (flags) {
var symbol = this._symbol,
cacheParent = this._parent || symbol,
project = this._project;
if (flags & /*#=*/ ChangeFlag.GEOMETRY) {
// Clear cached bounds, position and decomposed matrix whenever
// geometry changes.
this._bounds = this._position = this._decomposed = undefined;
}
if (flags & /*#=*/ ChangeFlag.MATRIX) {
this._globalMatrix = undefined;
}
if (cacheParent && flags & /*#=*/ (ChangeFlag.GEOMETRY | ChangeFlag.STROKE)) {
// Clear cached bounds of all items that this item contributes to.
// We call this on the parent, since the information is cached on
// the parent, see getBounds().
Item._clearBoundsCache(cacheParent);
}
if (flags & /*#=*/ ChangeFlag.CHILDREN) {
// Clear cached bounds of all items that this item contributes to.
// Here we don't call this on the parent, since adding / removing a
// child triggers this notification on the parent.
Item._clearBoundsCache(this);
}
if (project) project._changed(flags, this);
// If this item is a symbol's definition, notify it of the change too
if (symbol) symbol._changed(flags);
},
/**
* Sets the properties of the passed object literal on this item to the
* values defined in the object literal, if the item has property of the
* given name (or a setter defined for it).
*
* @name Item#set
* @function
* @param {Object} props
* @return {Item} the item itself
* @chainable
*
* @example {@paperscript}
* // Setting properties through an object literal
* var circle = new Path.Circle({
* center: [80, 50],
* radius: 35
* });
*
* circle.set({
* strokeColor: 'red',
* strokeWidth: 10,
* fillColor: 'black',
* selected: true
* });
*/
/**
* The unique id of the item.
*
* @bean
* @type Number
*/
getId: function () {
return this._id;
},
/**
* The class name of the item as a string.
*
* @name Item#className
* @type String
* @values 'Group', 'Layer', 'Path', 'CompoundPath', 'Shape', 'Raster',
* 'SymbolItem', 'PointText'
*/
/**
* The name of the item. If the item has a name, it can be accessed by name
* through its parent's children list.
*
* @bean
* @type String
*
* @example {@paperscript}
* var path = new Path.Circle({
* center: [80, 50],
* radius: 35
* });
* // Set the name of the path:
* path.name = 'example';
*
* // Create a group and add path to it as a child:
* var group = new Group();
* group.addChild(path);
*
* // The path can be accessed by name:
* group.children['example'].fillColor = 'red';
*/
getName: function () {
return this._name;
},
setName: function (name) {
// NOTE: Don't check if the name has changed and bail out if it has not,
// because setName is used internally also to update internal structures
// when an item is moved from one parent to another.
// If the item already had a name, remove the reference to it from the
// parent's children object:
if (this._name) this._removeNamed();
// See if the name is a simple number, which we cannot support due to
// the named lookup on the children array.
if (name === +name + '') throw new Error('Names consisting only of numbers are not supported.');
var owner = this._getOwner();
if (name && owner) {
var children = owner._children,
namedChildren = owner._namedChildren;
(namedChildren[name] = namedChildren[name] || []).push(this);
// Only set this item if there isn't one under the same name already
if (!(name in children)) children[name] = this;
}
this._name = name || undefined;
this._changed(/*#=*/ ChangeFlag.ATTRIBUTE);
},
/**
* The path style of the item.
*
* @bean
* @name Item#getStyle
* @type Style
*
* @example {@paperscript}
* // Applying several styles to an item in one go, by passing an object
* // to its style property:
* var circle = new Path.Circle({
* center: [80, 50],
* radius: 30
* });
* circle.style = {
* fillColor: 'blue',
* strokeColor: 'red',
* strokeWidth: 5
* };
*
* @example {@paperscript split=true height=100}
* // Copying the style of another item:
* var path = new Path.Circle({
* center: [50, 50],
* radius: 30,
* fillColor: 'red'
* });
*
* var path2 = new Path.Circle({
* center: new Point(180, 50),
* radius: 20
* });
*
* // Copy the path style of path:
* path2.style = path.style;
*
* @example {@paperscript}
* // Applying the same style object to multiple items:
* var myStyle = {
* fillColor: 'red',
* strokeColor: 'blue',
* strokeWidth: 4
* };
*
* var path = new Path.Circle({
* center: [50, 50],
* radius: 30
* });
* path.style = myStyle;
*
* var path2 = new Path.Circle({
* center: new Point(150, 50),
* radius: 20
* });
* path2.style = myStyle;
*/
getStyle: function () {
return this._style;
},
setStyle: function (style) {
// Don't access _style directly so Path#getStyle() can be overridden for
// CompoundPaths.
this.getStyle().set(style);
},
},
Base.each(
['locked', 'visible', 'blendMode', 'opacity', 'guide'],
// Produce getter/setters for properties. We need setters because we want to
// call _changed() if a property was modified.
function (name) {
var part = Base.capitalize(name),
key = '_' + name,
flags = {
// #locked does not change appearance, all others do:
locked: /*#=*/ ChangeFlag.ATTRIBUTE,
// #visible changes appearance
visible: /*#=*/ Change.ATTRIBUTE | Change.GEOMETRY,
};
this['get' + part] = function () {
return this[key];
};
this['set' + part] = function (value) {
if (value != this[key]) {
this[key] = value;
this._changed(flags[name] || /*#=*/ Change.ATTRIBUTE);
}
};
},
{}
),
/** @lends Item# */ {
// Enforce creation of beans, as bean getters have hidden parameters.
// See #getPosition() below.
beans: true,
// NOTE: These properties have their getter / setters produced in the
// injection scope above.
/**
* Specifies whether the item is locked. When set to `true`, item
* interactions with the mouse are disabled.
*
* @name Item#locked
* @type Boolean
* @default false
*
* @example {@paperscript}
* var unlockedItem = new Path.Circle({
* center: view.center - [35, 0],
* radius: 30,
* fillColor: 'springgreen',
* onMouseDown: function() {
* this.fillColor = Color.random();
* }
* });
*
* var lockedItem = new Path.Circle({
* center: view.center + [35, 0],
* radius: 30,
* fillColor: 'crimson',
* locked: true,
* // This event won't be triggered because the item is locked.
* onMouseDown: function() {
* this.fillColor = Color.random();
* }
* });
*
* new PointText({
* content: 'Click on both circles to see which one is locked.',
* point: view.center - [0, 35],
* justification: 'center'
* });
*/
/**
* Specifies whether the item is visible. When set to `false`, the item
* won't be drawn.
*
* @name Item#visible
* @type Boolean
* @default true
*
* @example {@paperscript}
* // Hiding an item:
* var path = new Path.Circle({
* center: [50, 50],
* radius: 20,
* fillColor: 'red'
* });
*
* // Hide the path:
* path.visible = false;
*/
/**
* The blend mode with which the item is composited onto the canvas. Both
* the standard canvas compositing modes, as well as the new CSS blend modes
* are supported. If blend-modes cannot be rendered natively, they are
* emulated. Be aware that emulation can have an impact on performance.
*
* @name Item#blendMode
* @type String
* @values 'normal', 'multiply', 'screen', 'overlay', 'soft-light', 'hard-
* light', 'color-dodge', 'color-burn', 'darken', 'lighten',
* 'difference', 'exclusion', 'hue', 'saturation', 'luminosity',
* 'color', 'add', 'subtract', 'average', 'pin-light', 'negation',
* 'source-over', 'source-in', 'source-out', 'source-atop',
* 'destination-over', 'destination-in', 'destination-out',
* 'destination-atop', 'lighter', 'darker', 'copy', 'xor'
* @default 'normal'
*
* @example {@paperscript}
* // Setting an item's blend mode:
*
* // Create a white rectangle in the background
* // with the same dimensions as the view:
* var background = new Path.Rectangle(view.bounds);
* background.fillColor = 'white';
*
* var circle = new Path.Circle({
* center: [80, 50],
* radius: 35,
* fillColor: 'red'
* });
*
* var circle2 = new Path.Circle({
* center: new Point(120, 50),
* radius: 35,
* fillColor: 'blue'
* });
*
* // Set the blend mode of circle2:
* circle2.blendMode = 'multiply';
*/
/**
* The opacity of the item as a value between `0` and `1`.
*
* @name Item#opacity
* @type Number
* @default 1
*
* @example {@paperscript}
* // Making an item 50% transparent:
* var circle = new Path.Circle({
* center: [80, 50],
* radius: 35,
* fillColor: 'red'
* });
*
* var circle2 = new Path.Circle({
* center: new Point(120, 50),
* radius: 35,
* fillColor: 'blue',
* strokeColor: 'green',
* strokeWidth: 10
* });
*
* // Make circle2 50% transparent:
* circle2.opacity = 0.5;
*/
// TODO: Implement guides
/**
* Specifies whether the item functions as a guide. When set to `true`, the
* item will be drawn at the end as a guide.
*
* @name Item#guide
* @type Boolean
* @default true
* @ignore
*/
getSelection: function () {
return this._selection;
},
setSelection: function (selection) {
if (selection !== this._selection) {
this._selection = selection;
var project = this._project;
if (project) {
project._updateSelection(this);
this._changed(/*#=*/ Change.ATTRIBUTE);
}
}
},
_changeSelection: function (flag, selected) {
var selection = this._selection;
this.setSelection(selected ? selection | flag : selection & ~flag);
},
/**
* Specifies whether the item is selected. This will also return `true` for
* {@link Group} items if they are partially selected, e.g. groups
* containing selected or partially selected paths.
*
* Paper.js draws the visual outlines of selected items on top of your
* project. This can be useful for debugging, as it allows you to see the
* construction of paths, position of path curves, individual segment points
* and bounding boxes of symbol and raster items.
*
* @bean
* @type Boolean
* @default false
* @see Project#selectedItems
* @see Segment#selected
* @see Curve#selected
* @see Point#selected
*
* @example {@paperscript}
* // Selecting an item:
* var path = new Path.Circle({
* center: [80, 50],
* radius: 35
* });
* path.selected = true; // Select the path
*/
isSelected: function () {
if (this._selectChildren) {
var children = this._children;
for (var i = 0, l = children.length; i < l; i++) if (children[i].isSelected()) return true;
}
return !!(this._selection & /*#=*/ ItemSelection.ITEM);
},
setSelected: function (selected) {
if (this._selectChildren) {
var children = this._children;
for (var i = 0, l = children.length; i < l; i++) children[i].setSelected(selected);
}
this._changeSelection(/*#=*/ ItemSelection.ITEM, selected);
},
isFullySelected: function () {
var children = this._children,
selected = !!(this._selection & /*#=*/ ItemSelection.ITEM);
if (children && selected) {
for (var i = 0, l = children.length; i < l; i++) if (!children[i].isFullySelected()) return false;
return true;
}
// If there are no children, this is the same as #selected
return selected;
},
setFullySelected: function (selected) {
var children = this._children;
if (children) {
for (var i = 0, l = children.length; i < l; i++) children[i].setFullySelected(selected);
}
this._changeSelection(/*#=*/ ItemSelection.ITEM, selected);
},
/**
* Specifies whether the item defines a clip mask. This can only be set on
* paths and compound paths, and only if the item is already contained
* within a clipping group.
*
* @bean
* @type Boolean
* @default false
*/
isClipMask: function () {
return this._clipMask;
},
setClipMask: function (clipMask) {
// On-the-fly conversion to boolean:
if (this._clipMask != (clipMask = !!clipMask)) {
this._clipMask = clipMask;
if (clipMask) {
this.setFillColor(null);
this.setStrokeColor(null);
}
this._changed(/*#=*/ Change.ATTRIBUTE);
// Tell the parent the clipping mask has changed
if (this._parent) this._parent._changed(/*#=*/ ChangeFlag.CLIPPING);
}
},
// TODO: get/setIsolated (print specific feature)
// TODO: get/setKnockout (print specific feature)
// TODO: get/setAlphaIsShape
/**
* A plain javascript object which can be used to store
* arbitrary data on the item.
*
* @bean
* @type Object
*
* @example
* var path = new Path();
* path.data.remember = 'milk';
*
* @example
* var path = new Path();
* path.data.malcolm = new Point(20, 30);
* console.log(path.data.malcolm.x); // 20
*
* @example
* var path = new Path();
* path.data = {
* home: 'Omicron Theta',
* found: 2338,
* pets: ['Spot']
* };
* console.log(path.data.pets.length); // 1
*
* @example
* var path = new Path({
* data: {
* home: 'Omicron Theta',
* found: 2338,
* pets: ['Spot']
* }
* });
* console.log(path.data.pets.length); // 1
*/
getData: function () {
if (!this._data) this._data = {};
return this._data;
},
setData: function (data) {
this._data = data;
},
/**
* {@grouptitle Position and Bounding Boxes}
*
* The item's position within the parent item's coordinate system. By
* default, this is the {@link Rectangle#center} of the item's
* {@link #bounds} rectangle.
*
* @bean
* @type Point
*
* @example {@paperscript}
* // Changing the position of a path:
*
* // Create a circle at position { x: 10, y: 10 }
* var circle = new Path.Circle({
* center: new Point(10, 10),
* radius: 10,
* fillColor: 'red'
* });
*
* // Move the circle to { x: 20, y: 20 }
* circle.position = new Point(20, 20);
*
* // Move the circle 100 points to the right and 50 points down
* circle.position += new Point(100, 50);
*
* @example {@paperscript split=true height=100}
* // Changing the x coordinate of an item's position:
*
* // Create a circle at position { x: 20, y: 20 }
* var circle = new Path.Circle({
* center: new Point(20, 20),
* radius: 10,
* fillColor: 'red'
* });
*
* // Move the circle 100 points to the right
* circle.position.x += 100;
*/
getPosition: function (_dontLink) {
// Cache position value.
// Pass true for _dontLink in getCenter(), so receive back a normal point
var ctor = _dontLink ? Point : LinkedPoint;
// Do not cache LinkedPoints directly, since we would not be able to
// use them to calculate the difference in #setPosition, as when it is
// modified, it would hold new values already and only then cause the
// calling of #setPosition.
var position = this._position || (this._position = this._getPositionFromBounds());
return new ctor(position.x, position.y, this, 'setPosition');
},
setPosition: function (/* point */) {
// Calculate the distance to the current position, by which to
// translate the item. Pass true for _dontLink, as we do not need a
// LinkedPoint to simply calculate this distance.
this.translate(Point.read(arguments).subtract(this.getPosition(true)));
},
/**
* Internal method used to calculate position either from pivot point or
* bounds.
* @param {Rectangle} bounds if provided, these bounds are used instead of
* calling getBounds()
* @return {Point} the transformed pivot point or the center of the bounds
* @private
*/
_getPositionFromBounds: function (bounds) {
// If an pivot point is provided, use it to determine position
// based on the matrix. Otherwise use the center of the bounds.
return this._pivot ? this._matrix._transformPoint(this._pivot) : (bounds || this.getBounds()).getCenter(true);
},
/**
* The item's pivot point specified in the item coordinate system, defining
* the point around which all transformations are hinging. This is also the
* reference point for {@link #position}. By default, it is set to `null`,
* meaning the {@link Rectangle#center} of the item's {@link #bounds}
* rectangle is used as pivot.
*
* @bean
* @type Point
* @default null
*/
getPivot: function () {
var pivot = this._pivot;
return pivot ? new LinkedPoint(pivot.x, pivot.y, this, 'setPivot') : null;
},
setPivot: function (/* point */) {
// Clone existing points since we're caching internally.
this._pivot = Point.read(arguments, 0, { clone: true, readNull: true });
// No need for _changed() since the only thing this affects is _position
this._position = undefined;
},
},
Base.each(
{
// Produce getters for bounds properties:
getStrokeBounds: { stroke: true },
getHandleBounds: { handle: true },
getInternalBounds: { internal: true },
},
function (options, key) {
this[key] = function (matrix) {
return this.getBounds(matrix, options);
};
},
/** @lends Item# */ {
// Enforce creation of beans, as bean getters have hidden parameters.
// See _matrix parameter above.
beans: true,
getBounds: function (matrix, options) {
var hasMatrix = options || matrix instanceof Matrix,
opts = Base.set({}, hasMatrix ? options : matrix, this._boundsOptions);
// We can only cache the bounds if the path uses stroke-scaling, or if
// no stroke is involved in the calculation of the bounds.
// When strokeScaling is false, the bounds are affected by the zoom
// level of the view, hence we can't cache.
// TODO: Look more into handling of stroke-scaling, e.g. on groups with
// some children that have strokeScaling, as well as SymbolItem with
// SymbolDefinition that have strokeScaling!
// TODO: Once that is resolved, we should be able to turn off
// opts.stroke if a resolved item definition does not have a stroke,
// allowing the code to share caches between #strokeBounds and #bounds.
if (!opts.stroke || this.getStrokeScaling()) opts.cacheItem = this;
// If we're caching bounds, pass on this item as cacheItem, so
// the children can setup _boundsCache structures for it.
var rect = this._getCachedBounds(hasMatrix && matrix, opts).rect;
// If we're returning '#bounds', create a LinkedRectangle that uses
// the setBounds() setter to update the Item whenever the bounds are
// changed:
return !arguments.length
? new LinkedRectangle(rect.x, rect.y, rect.width, rect.height, this, 'setBounds')
: rect;
},
setBounds: function (/* rect */) {
var rect = Rectangle.read(arguments),
bounds = this.getBounds(),
_matrix = this._matrix,
matrix = new Matrix(),
center = rect.getCenter();
// Read this from bottom to top:
// Translate to new center:
matrix.translate(center);
// Scale to new Size, if size changes and avoid divisions by 0:
if (rect.width != bounds.width || rect.height != bounds.height) {
// If a previous transformation resulted in a non-invertible matrix,
// Restore to the last revertible matrix stored in _backup, and get
// the bounds again. That way, we can prevent collapsing to 0-size.
if (!_matrix.isInvertible()) {
_matrix.set(_matrix._backup || new Matrix().translate(_matrix.getTranslation()));
bounds = this.getBounds();
}
matrix.scale(
bounds.width !== 0 ? rect.width / bounds.width : 0,
bounds.height !== 0 ? rect.height / bounds.height : 0
);
}
// Translate to bounds center:
center = bounds.getCenter();
matrix.translate(-center.x, -center.y);
// Now execute the transformation
this.transform(matrix);
},
/**
* Protected method used in all the bounds getters. It loops through all the
* children, gets their bounds and finds the bounds around all of them.
* Subclasses override it to define calculations for the various required
* bounding types.
*/
_getBounds: function (matrix, options) {
// NOTE: We cannot cache these results here, since we do not get
// _changed() notifications here for changing geometry in children.
// But cacheName is used in sub-classes such as SymbolItem and Raster.
var children = this._children;
// TODO: What to return if nothing is defined, e.g. empty Groups?
// Scriptographer behaves weirdly then too.
if (!children || !children.length) return new Rectangle();
// Call _updateBoundsCache() even when the group only holds empty /
// invisible items), so future changes in these items will cause right
// handling of _boundsCache.
Item._updateBoundsCache(this, options.cacheItem);
return Item._getBounds(children, matrix, options);
},
_getBoundsCacheKey: function (options, internal) {
return [options.stroke ? 1 : 0, options.handle ? 1 : 0, internal ? 1 : 0].join('');
},
/**
* Private method that deals with the calling of _getBounds, recursive
* matrix concatenation and handles all the complicated caching mechanisms.
*/
_getCachedBounds: function (matrix, options, noInternal) {
// See if we can cache these bounds. We only cache the bounds
// transformed with the internally stored _matrix, (the default if no
// matrix is passed).
matrix = matrix && matrix._orNullIfIdentity();
// Do not transform by the internal matrix for internal, untransformed
// bounds.
var internal = options.internal && !noInternal,
cacheItem = options.cacheItem,
_matrix = internal ? null : this._matrix._orNullIfIdentity(),
// Create a key for caching, reflecting all bounds options.
cacheKey = cacheItem && (!matrix || matrix.equals(_matrix)) && this._getBoundsCacheKey(options, internal),
bounds = this._bounds;
// NOTE: This needs to happen before returning cached values, since even
// then, _boundsCache needs to be kept up-to-date.
Item._updateBoundsCache(this._parent || this._symbol, cacheItem);
if (cacheKey && bounds && cacheKey in bounds) {
var cached = bounds[cacheKey];
return {
rect: cached.rect.clone(),
nonscaling: cached.nonscaling,
};
}
var res = this._getBounds(matrix || _matrix, options),
// Support two versions of _getBounds(): One that directly returns a
// Rectangle, and one that returns a bounds object with nonscaling.
rect = res.rect || res,
style = this._style,
nonscaling = res.nonscaling || (style.hasStroke() && !style.getStrokeScaling());
// If we can cache the result, update the _bounds cache structure
// before returning
if (cacheKey) {
if (!bounds) {
this._bounds = bounds = {};
}
// @ts-expect-error = Item.ts(1017, 15): 'cached' was also declared here.
var cached = (bounds[cacheKey] = {
rect: rect.clone(),
nonscaling: nonscaling,
// Mark as internal, so Item#transform() won't transform it
internal: internal,
});
}
return {
rect: rect,
nonscaling: nonscaling,
};
},
/**
* Returns to correct matrix to use to transform stroke related geometries
* when calculating bounds: the item's matrix if {@link #strokeScaling} is
* `true`, otherwise the parent's inverted view matrix. The returned matrix
* is always shiftless, meaning its translation vector is reset to zero.
*/
_getStrokeMatrix: function (matrix, options) {
var parent = this.getStrokeScaling()
? null
: options && options.internal
? this
: this._parent || (this._symbol && this._symbol._item),
mx = parent ? parent.getViewMatrix().invert() : matrix;
return mx && mx._shiftless();
},
statics: /** @lends Item */ {
/**
* Set up a boundsCache structure that keeps track of items that keep
* cached bounds that depend on this item. We store this in the parent,
* for multiple reasons:
* The parent receives CHILDREN change notifications for when its
* children are added or removed and can thus clear the cache, and we
* save a lot of memory, e.g. when grouping 100 items and asking the
* group for its bounds. If stored on the children, we would have 100
* times the same structure.
*/
_updateBoundsCache: function (parent, item) {
if (parent && item) {
// Set-up the parent's boundsCache structure if it does not
// exist yet and add the item to it.
var id = item._id,
ref = (parent._boundsCache = parent._boundsCache || {
// Use a hash-table for ids and an array for the list,
// so we can keep track of items that were added already
ids: {},
list: [],
});
if (!ref.ids[id]) {
ref.list.push(item);
ref.ids[id] = item;
}
}
},
/**
* Clears cached bounds of all items that the children of this item are
* contributing to. See _updateBoundsCache() for an explanation why this
* information is stored on parents, not the children themselves.
*/
_clearBoundsCache: function (item) {
// This is defined as a static method so Symbol can used it too.
// Clear the position as well, since it's depending on bounds.
var cache = item._boundsCache;
if (cache) {
// Erase cache before looping, to prevent circular recursion.
item._bounds = item._position = item._boundsCache = undefined;
for (var i = 0, list = cache.list, l = list.length; i < l; i++) {
var other = list[i];
if (other !== item) {
other._bounds = other._position = undefined;
// We need to recursively call _clearBoundsCache, as
// when the cache for the other item's children is not
// valid anymore, that propagates up the scene graph.
if (other._boundsCache) Item._clearBoundsCache(other);
}
}
}
},
/**
* Gets the combined bounds of all specified items.
*/
_getBounds: function (items, matrix, options) {
var x1 = Infinity,
x2 = -x1,
y1 = x1,
y2 = x2,
nonscaling = false;
// NOTE: As soon as one child-item has non-scaling strokes, the full
// bounds need to be considered non-scaling for caching purposes.
options = options || {};
for (var i = 0, l = items.length; i < l; i++) {
var item = items[i];
// Item is handled if it is visible and not recursively empty.
// This avoid errors with nested empty groups (#1467).
if (item._visible && !item.isEmpty(true)) {
// Pass true for noInternal, since even when getting
// internal bounds for this item, we need to apply the
// matrices to its children.
var bounds = item._getCachedBounds(matrix && matrix.appended(item._matrix), options, true),
rect = bounds.rect;
x1 = Math.min(rect.x, x1);
y1 = Math.min(rect.y, y1);
x2 = Math.max(rect.x + rect.width, x2);
y2 = Math.max(rect.y + rect.height, y2);
if (bounds.nonscaling) nonscaling = true;
}
}
return {
rect: isFinite(x1) ? new Rectangle(x1, y1, x2 - x1, y2 - y1) : new Rectangle(),
nonscaling: nonscaling,
};
},
},
/**
* The bounding rectangle of the item excluding stroke width.
*
* @name Item#bounds
* @type Rectangle
*/
/**
* The bounding rectangle of the item including stroke width.
*
* @name Item#strokeBounds
* @type Rectangle
*/
/**
* The bounding rectangle of the item including handles.
*
* @name Item#handleBounds
* @type Rectangle
*/
/**
* The bounding rectangle of the item without any matrix transformations.
*
* Typical use case would be drawing a frame around the object where you
* want to draw something of the same size, position, rotation, and scaling,
* like a selection frame.
*
* @name Item#internalBounds
* @type Rectangle
*/
/**
* The rough bounding rectangle of the item that is sure to include all of
* the drawing, including stroke width.
*
* @name Item#roughBounds
* @type Rectangle
* @ignore
*/
}
),
/** @lends Item# */ {
// Enforce creation of beans, as bean getters have hidden parameters.
// See #getGlobalMatrix() below.
beans: true,
_decompose: function () {
// Only decompose if the item isn't directly baking transformations into
// its content.
return this._applyMatrix ? null : this._decomposed || (this._decomposed = this._matrix.decompose());
},
/**
* The current rotation angle of the item, as described by its
* {@link #matrix}.
* Please note that this only returns meaningful values for items with
* {@link #applyMatrix} set to `false`, meaning they do not directly bake
* transformations into their content.
*
* @bean
* @type Number
*/
getRotation: function () {
var decomposed = this._decompose();
// Return 0 if matrix wasn't decomposed, e.g. on items with #applyMatrix
return decomposed ? decomposed.rotation : 0;
},
setRotation: function (rotation) {
var current = this.getRotation();
if (current != null && rotation != null) {
// Preserve the cached _decomposed values over rotation, and only
// update the rotation property on it.
var decomposed = this._decomposed;
this.rotate(rotation - current);
if (decomposed) {
decomposed.rotation = rotation;
this._decomposed = decomposed;
}
}
},
/**
* The current scale factor of the item, as described by its
* {@link #matrix}.
* Please note that this only returns meaningful values for items with
* {@link #applyMatrix} set to `false`, meaning they do not directly bake
* transformations into their content.
*
* @bean
* @type Point
*/
getScaling: function () {
var decomposed = this._decompose(),
s = decomposed && decomposed.scaling;
// Return [1, 1] if matrix wasn't decomposed, e.g. with #applyMatrix.
return new LinkedPoint(s ? s.x : 1, s ? s.y : 1, this, 'setScaling');
},
setScaling: function (/* scaling */) {
var current = this.getScaling(),
// Clone existing points since we're caching internally.
scaling = Point.read(arguments, 0, { clone: true, readNull: true });
if (current && scaling && !current.equals(scaling)) {
// See #setRotation() for preservation of _decomposed.
var rotation = this.getRotation(),
decomposed = this._decomposed,
matrix = new Matrix(),
isZero = Numerical.isZero;
// Create a matrix in which the scaling is applied in the non-
// rotated state, so it is always applied before the rotation.
// TODO: What about skewing? Do we need separately stored values for
// these properties, and apply them separately from the matrix?
if (isZero(current.x) || isZero(current.y)) {
// If current scaling is destructive (at least one axis is 0),
// create a new matrix that applies the desired rotation,
// translation and scaling, without also preserving skewing.
matrix.translate(decomposed.translation);
if (rotation) {
matrix.rotate(rotation);
}
matrix.scale(scaling.x, scaling.y);
this._matrix.set(matrix);
} else {
var center = this.getPosition(true);
matrix.translate(center);
if (rotation) matrix.rotate(rotation);
matrix.scale(scaling.x / current.x, scaling.y / current.y);
if (rotation) matrix.rotate(-rotation);
matrix.translate(center.negate());
this.transform(matrix);
}
if (decomposed) {
decomposed.scaling = scaling;
this._decomposed = decomposed;
}
}
},
/**
* The item's transformation matrix, defining position and dimensions in
* relation to its parent item in which it is contained.
*
* @bean
* @type Matrix
*/
getMatrix: function () {
return this._matrix;
},
setMatrix: function () {
// Use Matrix#initialize to easily copy over values.
// NOTE: calling initialize() also calls #_changed() for us, through its
// call to #set() / #reset(), and this also handles _applyMatrix for us.
var matrix = this._matrix;
matrix.set.apply(matrix, arguments);
},
/**
* The item's global transformation matrix in relation to the global project
* coordinate space. Note that the view's transformations resulting from
* zooming and panning are not factored in.
*
* @bean
* @type Matrix
*/
getGlobalMatrix: function (_dontClone) {
var matrix = this._globalMatrix;
if (matrix) {
// If there's a cached global matrix for this item, check if all its
// parents also have one. If it's missing in any of its parents, it
// means the child's cached version isn't valid anymore.
// For better performance, we also use the occasion of this loop to
// clear cached version of items parents.
var parent = this._parent;
var parents = [];
while (parent) {
if (!parent._globalMatrix) {
matrix = null;
// Also clear global matrix of item's parents.
for (var i = 0, l = parents.length; i < l; i++) {
parents[i]._globalMatrix = null;
}
break;
}
parents.push(parent);
parent = parent._parent;
}
}
if (!matrix) {
matrix = this._globalMatrix = this._matrix.clone();
var parent = this._parent;
if (parent) matrix.prepend(parent.getGlobalMatrix(true));
}
return _dontClone ? matrix : matrix.clone();
},
/**
* The item's global matrix in relation to the view coordinate space. This
* means that the view's transformations resulting from zooming and panning
* are factored in.
*
* @bean
* @type Matrix
*/
getViewMatrix: function () {
return this.getGlobalMatrix().prepend(this.getView()._matrix);
},
/**
* Controls whether the transformations applied to the item (e.g. through
* {@link #transform(matrix)}, {@link #rotate(angle)},
* {@link #scale(scale)}, etc.) are stored in its {@link #matrix} property,
* or whether they are directly applied to its contents or children (passed
* on to the segments in {@link Path} items, the children of {@link Group}
* items, etc.).
*
* @bean
* @type Boolean
* @default true
*/
getApplyMatrix: function () {
return this._applyMatrix;
},
setApplyMatrix: function (apply) {
// Tell #transform() to apply the internal matrix if _applyMatrix
// can be set to true.
if ((this._applyMatrix = this._canApplyMatrix && !!apply)) this.transform(null, true);
},
/**
* @bean
* @deprecated use {@link #applyMatrix} instead.
*/
getTransformContent: '#getApplyMatrix',
setTransformContent: '#setApplyMatrix',
},
/** @lends Item# */ {
/**
* {@grouptitle Project Hierarchy}
* The project that this item belongs to.
*
* @type Project
* @bean
*/
getProject: function () {
return this._project;
},
_setProject: function (project, installEvents) {
if (this._project !== project) {
// Uninstall events before switching project, then install them
// again.
// NOTE: _installEvents handles all children too!
if (this._project) this._installEvents(false);
this._project = project;
var children = this._children;
for (var i = 0, l = children && children.length; i < l; i++) children[i]._setProject(project);
// We need to call _installEvents(true) again, but merge it with
// handling of installEvents argument below.
installEvents = true;
}
if (installEvents) this._installEvents(true);
},
/**
* The view that this item belongs to.
* @type View
* @bean
*/
getView: function () {
return this._project._view;
},
/**
* Overrides Emitter#_installEvents to also call _installEvents on all
* children.
*/
_installEvents: function _installEvents(install) {
(_installEvents as any).base.call(this, install);
var children = this._children;
for (var i = 0, l = children && children.length; i < l; i++) children[i]._installEvents(install);
},
/**
* The layer that this item is contained within.
*
* @type Layer
* @bean
*/
getLayer: function () {
var parent = this;
while ((parent = parent._parent)) {
if (parent instanceof ref.Layer) return parent;
}
return null;
},
/**
* The item that this item is contained within.
*
* @type Item
* @bean
*
* @example
* var path = new Path();
*
* // New items are placed in the active layer:
* console.log(path.parent == project.activeLayer); // true
*
* var group = new Group();
* group.addChild(path);
*
* // Now the parent of the path has become the group:
* console.log(path.parent == group); // true
*
* @example // Setting the parent of the item to another item
* var path = new Path();
*
* // New items are placed in the active layer:
* console.log(path.parent == project.activeLayer); // true
*
* var group = new Group();
* path.parent = group;
*
* // Now the parent of the path has become the group:
* console.log(path.parent == group); // true
*
* // The path is now contained in the children list of group:
* console.log(group.children[0] == path); // true
*
* @example // Setting the parent of an item in the constructor
* var group = new Group();
*
* var path = new Path({
* parent: group
* });
*
* // The parent of the path is the group:
* console.log(path.parent == group); // true
*
* // The path is contained in the children list of group:
* console.log(group.children[0] == path); // true
*/
getParent: function () {
return this._parent;
},
setParent: function (item) {
return item.addChild(this);
},
/**
* Private helper to return the owner, either the parent, or the project
* for top-level layers. See Layer#_getOwner()
*/
_getOwner: '#getParent',
/**
* The children items contained within this item. Items that define a
* {@link #name} can also be accessed by name.
*
* <b>Please note:</b> The children array should not be modified directly
* using array functions. To remove single items from the children list, use
* {@link Item#remove()}, to remove all items from the children list, use
* {@link Item#removeChildren()}. To add items to the children list, use
* {@link Item#addChild(item)} or {@link Item#insertChild(index,item)}.
*
* @type Item[]
* @bean
*
* @example {@paperscript}
* // Accessing items in the children array:
* var path = new Path.Circle({
* center: [80, 50],
* radius: 35
* });
*
* // Create a group and move the path into it:
* var group = new Group();
* group.addChild(path);
*
* // Access the path through the group's children array:
* group.children[0].fillColor = 'red';
*
* @example {@paperscript}
* // Accessing children by name:
* var path = new Path.Circle({
* center: [80, 50],
* radius: 35
* });
* // Set the name of the path:
* path.name = 'example';
*
* // Create a group and move the path into it:
* var group = new Group();
* group.addChild(path);
*
* // The path can be accessed by name:
* group.children['example'].fillColor = 'orange';
*
* @example {@paperscript}
* // Passing an array of items to item.children:
* var path = new Path.Circle({
* center: [80, 50],
* radius: 35
* });
*
* var group = new Group();
* group.children = [path];
*
* // The path is the first child of the group:
* group.firstChild.fillColor = 'green';
*/
getChildren: function () {
return this._children;
},
setChildren: function (items) {
this.removeChildren();
this.addChildren(items);
},
/**
* The first item contained within this item. This is a shortcut for
* accessing `item.children[0]`.
*
* @type Item
* @bean
*/
getFirstChild: function () {
return (this._children && this._children[0]) || null;
},
/**
* The last item contained within this item.This is a shortcut for
* accessing `item.children[item.children.length - 1]`.
*
* @type Item
* @bean
*/
getLastChild: function () {
return (this._children && this._children[this._children.length - 1]) || null;
},
/**
* The next item on the same level as this item.
*
* @type Item
* @bean
*/
getNextSibling: function () {
var owner = this._getOwner();
return (owner && owner._children[this._index + 1]) || null;
},
/**
* The previous item on the same level as this item.
*
* @type Item
* @bean
*/
getPreviousSibling: function () {
var owner = this._getOwner();
return (owner && owner._children[this._index - 1]) || null;
},
/**
* The index of this item within the list of its parent's children.
*
* @type Number
* @bean
*/
getIndex: function () {
return this._index;
},
setIndex: function (index) {
var parent = this._parent,
children = parent && parent._children;
if (children) {
parent.insertChildren(index in children ? index : undefined, [this]);
}
},
equals: function (item) {
// NOTE: We do not compare name and selected state.
// TODO: Consider not comparing locked and visible also?
return (
item === this ||
(item &&
this._class === item._class &&
this._style.equals(item._style) &&
this._matrix.equals(item._matrix) &&
this._locked === item._locked &&
this._visible === item._visible &&
this._blendMode === item._blendMode &&
this._opacity === item._opacity &&
this._clipMask === item._clipMask &&
this._guide === item._guide &&
this._equals(item)) ||
false
);
},
/**
* A private helper for #equals(), to be overridden in sub-classes. When it
* is called, item is always defined, of the same class as `this` and has
* equal general state attributes such as matrix, style, opacity, etc.
*/
_equals: function (item) {
return Base.equals(this._children, item._children);
},
/**
* Clones the item within the same project and places the copy above the
* item.
*
* @option [insert=true] specifies whether the copy should be
* inserted into the scene graph. When set to `true`, it is inserted
* above the original
* @option [deep=true] specifies whether the item's children should also be
* cloned
*
* @param {Object} [options={ insert: true, deep: true }]
*
* @return {Item} the newly cloned item
* @chainable
*
* @example {@paperscript}
* // Cloning items:
* var circle = new Path.Circle({
* center: [50, 50],
* radius: 10,
* fillColor: 'red'
* });
*
* // Make 20 copies of the circle:
* for (var i = 0; i < 20; i++) {
* var copy = circle.clone();
*
* // Distribute the copies horizontally, so we can see them:
* copy.position.x += i * copy.bounds.width;
* }
*/
clone: function (options) {
var copy = new this.constructor(Item.NO_INSERT),
children = this._children,
// Both `insert` and `deep` are true by default:
insert = Base.pick(
options ? options.insert : undefined,
// Also support boolean parameter for insert, default: true.
options === undefined || options === true
),
deep = Base.pick(options ? options.deep : undefined, true);
// On items with children, for performance reasons due to the way that
// styles are currently "flattened" into existing children, we need to
// clone attributes first, then content.
// For all other items, it's the other way around, since applying
// attributes might have an impact on their content.
if (children) copy.copyAttributes(this);
// Only copy content if we don't have children or if we're ask to create
// a deep clone, which is the default.
if (!children || deep) copy.copyContent(this);
if (!children) copy.copyAttributes(this);
if (insert) copy.insertAbove(this);
// Make sure we're not overriding the original name in the same parent
var name = this._name,
parent = this._parent;
if (name && parent) {
var children = parent._children,
orig = name,
i = 1;
while (children[name]) name = orig + ' ' + i++;
if (name !== orig) copy.setName(name);
}
return copy;
},
/**
* Copies the content of the specified item over to this item.
*
* @param {Item} source the item to copy the content from
*/
copyContent: function (source) {
var children = source._children;
// Clone all children and add them to the copy. tell #addChild we're
// cloning, as needed by CompoundPath#insertChild().
for (var i = 0, l = children && children.length; i < l; i++) {
this.addChild(children[i].clone(false), true);
}
},
/**
* Copies all attributes of the specified item over to this item. This
* includes its style, visibility, matrix, pivot, blend-mode, opacity,
* selection state, data, name, etc.
*
* @param {Item} source the item to copy the attributes from
* @param {Boolean} excludeMatrix whether to exclude the transformation
* matrix when copying all attributes
*/
copyAttributes: function (source, excludeMatrix) {
// Copy over style
this.setStyle(source._style);
// Only copy over these fields if they are actually defined in 'source',
// meaning the default value has been overwritten (default is on
// prototype).
var keys = ['_locked', '_visible', '_blendMode', '_opacity', '_clipMask', '_guide'];
for (var i = 0, l = keys.length; i < l; i++) {
var key = keys[i];
if (source.hasOwnProperty(key)) this[key] = source[key];
}
// Use Matrix#initialize to easily copy over values.
if (!excludeMatrix) this._matrix.set(source._matrix, true);
// We can't just set _applyMatrix as many item types won't allow it,
// e.g. creating a Shape in Path#toShape().
// Using the setter instead takes care of it.
// NOTE: This will also bake in the matrix that we just initialized,
// in case #applyMatrix is true.
this.setApplyMatrix(source._applyMatrix);
this.setPivot(source._pivot);
// Copy over the selection state, use setSelection so the item
// is also added to Project#_selectionItems if it is selected.
this.setSelection(source._selection);
// Copy over data and name as well.
var data = source._data,
name = source._name;
this._data = data ? Base.clone(data) : null;
if (name) this.setName(name);
},
/**
* @name Item#rasterize
* @function
* @param {Number} [resolution=view.resolution]
* @param {Boolean} [insert=true]
* @deprecated use {@link #rasterize(options)} instead.
*/
/**
* Rasterizes the item into a newly created Raster object. The item itself
* is not removed after rasterization.
*
* @option [resolution=view.resolution] {Number} the desired resolution to
* be used when rasterizing, in pixels per inch (DPI). If not specified,
* the value of `view.resolution` is used by default.
* @option [raster=null] {Raster} specifies a raster to be reused when
* rasterizing. If the raster has the desired size already, then the
* underlying canvas is reused and no new memory needs to be allocated.
* If no raster is provided, a new raster item is created and returned
* instead.
* @option [insert=true] {Boolean} specifies whether the raster should be
* inserted into the scene graph. When set to `true`, it is inserted
* above the rasterized item.
*
* @name Item#rasterize
* @function
* @param {Object} [options={}] the rasterization options
* @return {Raster} the reused raster or the newly created raster item
*
* @example {@paperscript}
* // Rasterizing an item:
* var circle = new Path.Circle({
* center: [50, 50],
* radius: 5,
* fillColor: 'red'
* });
*
* // Create a rasterized version of the path:
* var raster = circle.rasterize();
*
* // Move it 100pt to the right:
* raster.position.x += 100;
*
* // Scale the path and the raster by 300%, so we can compare them:
* circle.scale(5);
* raster.scale(5);
*/
rasterize: function (arg0, arg1) {
var resolution, insert, raster;
if (Base.isPlainObject(arg0)) {
resolution = arg0.resolution;
insert = arg0.insert;
raster = arg0.raster;
} else {
resolution = arg0;
insert = arg1;
}
if (!raster) {
raster = new ref.Raster(Item.NO_INSERT);
}
var bounds = this.getStrokeBounds(),
scale = (resolution || this.getView().getResolution()) / 72,
// Floor top-left corner and ceil bottom-right corner, to never
// blur or cut pixels.
topLeft = bounds.getTopLeft().floor(),
bottomRight = bounds.getBottomRight().ceil(),
boundsSize = new Size(bottomRight.subtract(topLeft)),
rasterSize = boundsSize.multiply(scale);
// Pass `true` for clear, so reused rasters don't draw over old pixels.
raster.setSize(rasterSize, true);
if (!rasterSize.isZero()) {
var ctx = raster.getContext(true),
matrix = new Matrix().scale(scale).translate(topLeft.negate());
ctx.save();
matrix.applyToContext(ctx);
// See Project#draw() for an explanation of new Base()
this.draw(ctx, new Base({ matrices: [matrix] }));
ctx.restore();
}
raster._matrix.set(
new Matrix()
.translate(topLeft.add(boundsSize.divide(2)))
// Take resolution into account and scale back to original size.
.scale(1 / scale)
);
if (insert === undefined || insert) {
raster.insertAbove(this);
}
return raster;
},
/**
* {@grouptitle Geometric Tests}
*
* Checks whether the item's geometry contains the given point.
*
* @example {@paperscript} // Click within and outside the star below
* // Create a star shaped path:
* var path = new Path.Star({
* center: [50, 50],
* points: 12,
* radius1: 20,
* radius2: 40,
* fillColor: 'black'
* });
*
* // Whenever the user presses the mouse:
* function onMouseDown(event) {
* // If the position of the mouse is within the path,
* // set its fill color to red, otherwise set it to
* // black:
* if (path.contains(event.point)) {
* path.fillColor = 'red';
* } else {
* path.fillColor = 'black';
* }
* }
*
* @param {Point} point the point to check for
* @return {Boolean}
*/
contains: function (/* point */) {
// See CompoundPath#_contains() for the reason for !!
var matrix = this._matrix;
return matrix.isInvertible() && !!this._contains(matrix._inverseTransform(Point.read(arguments)));
},
_contains: function (point) {
var children = this._children;
if (children) {
for (var i = children.length - 1; i >= 0; i--) {
if (children[i].contains(point)) return true;
}
return false;
}
// We only implement it here for items with rectangular content,
// for anything else we need to override #contains()
return point.isInside(this.getInternalBounds());
},
// DOCS:
// TEST:
/**
* @param {Rectangle} rect the rectangle to check against
* @return {Boolean}
*/
isInside: function (/* rect */) {
return Rectangle.read(arguments).contains(this.getBounds());
},
// Internal helper function, used at the moment for intersects check only.
// TODO: Move #getIntersections() to Item, make it handle all type of items
// through _asPathItem(), and support Group items as well, taking nested
// matrices into account properly!
_asPathItem: function () {
// Creates a temporary rectangular path item with this item's bounds.
return new ref.Path.Rectangle({
rectangle: this.getInternalBounds(),
matrix: this._matrix,
insert: false,
});
},
// DOCS:
// TEST:
/**
* @param {Item} item the item to check against
* @return {Boolean}
*/
intersects: function (item, _matrix) {
if (!(item instanceof Item)) return false;
// Tell getIntersections() to return as soon as some intersections are
// found, because all we care for here is there are some or none:
return this._asPathItem().getIntersections(item._asPathItem(), null, _matrix, true).length > 0;
},
},
// @ts-expect-error = 'new' expression, whose target lacks a construct signature
new (function () {
// Injection scope for hit-test functions shared with project
function hitTest(/* point, options */) {
var args = arguments;
return this._hitTest(Point.read(args), ref.HitResult.getOptions(args));
}
function hitTestAll(/* point, options */) {
var args = arguments,
point = Point.read(args),
options = ref.HitResult.getOptions(args),
all = [];
this._hitTest(point, new Base({ all: all }, options));
return all;
}
function hitTestChildren(point, options, viewMatrix, _exclude) {
// NOTE: _exclude is only used in Group#_hitTestChildren()
// to exclude #clipItem
var children = this._children;
if (children) {
// Loop backwards, so items that get drawn last are tested first.
for (var i = children.length - 1; i >= 0; i--) {
var child = children[i];
var res = child !== _exclude && child._hitTest(point, options, viewMatrix);
// Only return the found result if we're not asked to collect
// all matches through hitTestAll()
if (res && !options.all) return res;
}
}
return null;
}
Project.inject({
hitTest: hitTest,
hitTestAll: hitTestAll,
_hitTest: hitTestChildren,
});
return {
// NOTE: Documentation is in the scope that follows.
hitTest: hitTest,
hitTestAll: hitTestAll,
_hitTestChildren: hitTestChildren,
};
})(),
/** @lends Item# */ {
/**
* {@grouptitle Hit-testing, Fetching and Matching Items}
*
* Performs a hit-test on the item and its children (if it is a {@link
* Group} or {@link Layer}) at the location of the specified point,
* returning the first found hit.
*
* The options object allows you to control the specifics of the hit-
* test and may contain a combination of the following values:
*
* @name Item#hitTest
* @function
*
* @option [options.tolerance={@link PaperScope#settings}.hitTolerance]
* {Number} the tolerance of the hit-test
* @option options.class {Function} only hit-test against a specific item
* class, or any of its sub-classes, by providing the constructor
* function against which an `instanceof` check is performed:
* {@values Group, Layer, Path, CompoundPath, Shape, Raster,
* SymbolItem, PointText, ...}
* @option options.match {Function} a match function to be called for each
* found hit result: Return `true` to return the result, `false` to keep
* searching
* @option [options.fill=true] {Boolean} hit-test the fill of items
* @option [options.stroke=true] {Boolean} hit-test the stroke of path
* items, taking into account the setting of stroke color and width
* @option [options.segments=true] {Boolean} hit-test for {@link
* Segment#point} of {@link Path} items
* @option options.curves {Boolean} hit-test the curves of path items,
* without taking the stroke color or width into account
* @option options.handles {Boolean} hit-test for the handles ({@link
* Segment#handleIn} / {@link Segment#handleOut}) of path segments.
* @option options.ends {Boolean} only hit-test for the first or last
* segment points of open path items
* @option options.position {Boolean} hit-test the {@link Item#position} of
* of items, which depends on the setting of {@link Item#pivot}
* @option options.center {Boolean} hit-test the {@link Rectangle#center} of
* the bounding rectangle of items ({@link Item#bounds})
* @option options.bounds {Boolean} hit-test the corners and side-centers of
* the bounding rectangle of items ({@link Item#bounds})
* @option options.guides {Boolean} hit-test items that have {@link
* Item#guide} set to `true`
* @option options.selected {Boolean} only hit selected items
*
* @param {Point} point the point where the hit-test should be performed
* (in global coordinates system).
* @param {Object} [options={ fill: true, stroke: true, segments: true,
* tolerance: settings.hitTolerance }]
* @return {HitResult} a hit result object describing what exactly was hit
* or `null` if nothing was hit
*/
/**
* Performs a hit-test on the item and its children (if it is a {@link
* Group} or {@link Layer}) at the location of the specified point,
* returning all found hits.
*
* The options object allows you to control the specifics of the hit-
* test. See {@link #hitTest(point[, options])} for a list of all options.
*
* @name Item#hitTestAll
* @function
* @param {Point} point the point where the hit-test should be performed
* (in global coordinates system).
* @param {Object} [options={ fill: true, stroke: true, segments: true,
* tolerance: settings.hitTolerance }]
* @return {HitResult[]} hit result objects for all hits, describing what
* exactly was hit or `null` if nothing was hit
* @see #hitTest(point[, options]);
*/
_hitTest: function (point, options, parentViewMatrix) {
if (this._locked || !this._visible || (this._guide && !options.guides) || this.isEmpty()) {
return null;
}
// Check if the point is withing roughBounds + tolerance, but only if
// this item does not have children, since we'd have to travel up the
// chain already to determine the rough bounds.
var matrix = this._matrix,
// Keep the accumulated matrices up to this item in options, so we
// can keep calculating the correct _tolerancePadding values.
viewMatrix = parentViewMatrix
? parentViewMatrix.appended(matrix)
: // If this is the first one in the recursion, factor in the
// zoom of the view and the globalMatrix of the item.
this.getGlobalMatrix().prepend(this.getView()._matrix),
// Calculate the transformed padding as 2D size that describes the
// transformed tolerance circle / ellipse. Make sure it's never 0
// since we're using it for division (see checkBounds()).
tolerance = Math.max(options.tolerance, /*#=*/ Numerical.EPSILON),
// Hit-tests are performed in the item's local coordinate space.
// To calculate the correct 2D padding for tolerance, we therefore
// need to apply the inverted item matrix.
tolerancePadding = (options._tolerancePadding = new Size(
ref.Path._getStrokePadding(tolerance, matrix._shiftless().invert())
));
// Transform point to local coordinates.
point = matrix._inverseTransform(point);
// If the matrix is non-reversible, point will now be `null`:
if (
!point ||
(!this._children &&
!this.getBounds({ internal: true, stroke: true, handle: true })
.expand(tolerancePadding.multiply(2))
._containsPoint(point))
) {
return null;
}
// See if we should check self (own content), by filtering for type,
// guides and selected items if that's required.
var checkSelf = !(
(options.guides && !this._guide) ||
(options.selected && !this.isSelected()) ||
// Support legacy Item#type property to match hyphenated
// class-names.
(options.type && options.type !== Base.hyphenate(this._class)) ||
(options.class && !(this instanceof options.class))
),
match = options.match,
that = this,
bounds,
res;
function filter(hit) {
if (hit && match && !match(hit)) hit = null;
// If we're collecting all matches, add it to options.all
if (hit && options.all) options.all.push(hit);
return hit;
}
function checkPoint(type, part) {
var pt = part ? bounds['get' + part]() : that.getPosition();
// Since there are transformations, we cannot simply use a numerical
// tolerance value. Instead, we divide by a padding size, see above.
if (point.subtract(pt).divide(tolerancePadding).length <= 1) {
return new ref.HitResult(type, that, {
name: part ? Base.hyphenate(part) : type,
point: pt,
});
}
}
var checkPosition = options.position,
checkCenter = options.center,
checkBounds = options.bounds;
// Ignore top level layers by checking for _parent:
if (checkSelf && this._parent && (checkPosition || checkCenter || checkBounds)) {
if (checkCenter || checkBounds) {
// Get the internal, untransformed bounds, as we check against
// transformed points.
bounds = this.getInternalBounds();
}
res =
// @ts-expect-error = Expected 2 arguments, but got 1
(checkPosition && checkPoint('position')) || (checkCenter && checkPoint('center', 'Center'));
if (!res && checkBounds) {
// TODO: Move these into a static property on Rectangle?
var points = [
'TopLeft',
'TopRight',
'BottomLeft',
'BottomRight',
'LeftCenter',
'TopCenter',
'RightCenter',
'BottomCenter',
];
for (var i = 0; i < 8 && !res; i++) {
res = checkPoint('bounds', points[i]);
}
}
res = filter(res);
}
if (!res) {
res =
this._hitTestChildren(point, options, viewMatrix) ||
// NOTE: We don't call match on _hitTestChildren() because
// it is already called internally.
(checkSelf &&
filter(
this._hitTestSelf(
point,
options,
viewMatrix,
// If the item has a non-scaling stroke, we need to
// apply the inverted viewMatrix to stroke dimensions.
this.getStrokeScaling() ? null : viewMatrix._shiftless().invert()
)
)) ||
null;
}
// Transform the point back to the outer coordinate system.
if (res && res.point) {
res.point = matrix.transform(res.point);
}
return res;
},
_hitTestSelf: function (point, options) {
// The default implementation honly handles 'fill' through #_contains()
if (options.fill && this.hasFill() && this._contains(point)) return new ref.HitResult('fill', this);
},
/**
* Checks whether the item matches the criteria described by the given
* object, by iterating over all of its properties and matching against
* their values through {@link #matches(name, compare)}.
*
* See {@link Project#getItems(options)} for a selection of illustrated
* examples.
*
* @name Item#matches
* @function
*
* @param {Object|Function} options the criteria to match against
* @return {Boolean} {@true if the item matches all the criteria}
* @see #getItems(options)
*/
/**
* Checks whether the item matches the given criteria. Extended matching is
* possible by providing a compare function or a regular expression.
* Matching points, colors only work as a comparison of the full object, not
* partial matching (e.g. only providing the x-coordinate to match all
* points with that x-value). Partial matching does work for
* {@link Item#data}.
*
* See {@link Project#getItems(options)} for a selection of illustrated
* examples.
*
* @name Item#matches
* @function
*
* @param {String} name the name of the state to match against
* @param {Object} compare the value, function or regular expression to
* compare against
* @return {Boolean} {@true if the item matches the state}
* @see #getItems(options)
*/
matches: function (name, compare) {
// matchObject() is used to match against objects in a nested manner.
// This is useful for matching against Item#data.
function matchObject(obj1, obj2) {
for (var i in obj1) {
if (obj1.hasOwnProperty(i)) {
var val1 = obj1[i],
val2 = obj2[i];
if (Base.isPlainObject(val1) && Base.isPlainObject(val2)) {
if (!matchObject(val1, val2)) return false;
} else if (!Base.equals(val1, val2)) {
return false;
}
}
}
return true;
}
var type = typeof name;
if (type === 'object') {
// `name` is the match object, not a string
for (var key in name) {
if (name.hasOwnProperty(key) && !this.matches(key, name[key])) return false;
}
return true;
} else if (type === 'function') {
return name(this);
} else if (name === 'match') {
return compare(this);
} else {
var value = /^(empty|editable)$/.test(name)
? // Handle boolean test functions separately, by calling them
// to get the value.
this['is' + Base.capitalize(name)]()
: // Support legacy Item#type property to match hyphenated
// class-names.
// TODO: Remove after December 2016.
name === 'type'
? Base.hyphenate(this._class)
: this[name];
if (name === 'class') {
if (typeof compare === 'function') return this instanceof compare;
// Compare further with the _class property value instead.
value = this._class;
}
if (typeof compare === 'function') {
return !!compare(value);
} else if (compare) {
if (compare.test) {
// RegExp-ish
return compare.test(value);
} else if (Base.isPlainObject(compare)) {
return matchObject(compare, value);
}
}
return Base.equals(value, compare);
}
},
/**
* Fetch the descendants (children or children of children) of this item
* that match the properties in the specified object. Extended matching is
* possible by providing a compare function or regular expression. Matching
* points, colors only work as a comparison of the full object, not partial
* matching (e.g. only providing the x- coordinate to match all points with
* that x-value). Partial matching does work for {@link Item#data}.
*
* Matching items against a rectangular area is also possible, by setting
* either `options.inside` or `options.overlapping` to a rectangle
* describing the area in which the items either have to be fully or partly
* contained.
*
* See {@link Project#getItems(options)} for a selection of illustrated
* examples.
*
* @option [options.recursive=true] {Boolean} whether to loop recursively
* through all children, or stop at the current level
* @option options.match {Function} a match function to be called for each
* item, allowing the definition of more flexible item checks that are
* not bound to properties. If no other match properties are defined,
* this function can also be passed instead of the `options` object
* @option options.class {Function} the constructor function of the item
* type to match against
* @option options.inside {Rectangle} the rectangle in which the items need
* to be fully contained
* @option options.overlapping {Rectangle} the rectangle with which the
* items need to at least partly overlap
*
* @param {Object|Function} options the criteria to match against
* @return {Item[]} the list of matching descendant items
* @see #matches(options)
*/
getItems: function (options) {
return Item._getItems(this, options, this._matrix);
},
/**
* Fetch the first descendant (child or child of child) of this item
* that matches the properties in the specified object.
* Extended matching is possible by providing a compare function or
* regular expression. Matching points, colors only work as a comparison
* of the full object, not partial matching (e.g. only providing the x-
* coordinate to match all points with that x-value). Partial matching
* does work for {@link Item#data}.
* See {@link Project#getItems(match)} for a selection of illustrated
* examples.
*
* @param {Object|Function} options the criteria to match against
* @return {Item} the first descendant item matching the given criteria
* @see #getItems(options)
*/
getItem: function (options) {
return Item._getItems(this, options, this._matrix, null, true)[0] || null;
},
statics: /** @lends Item */ {
// NOTE: We pass children instead of item as first argument so the
// method can be used for Project#layers as well in Project.
_getItems: function _getItems(item, options, matrix, param, firstOnly) {
if (!param) {
// Set up a couple of "side-car" values for the recursive calls
// of _getItems below, mainly related to the handling of
// inside / overlapping:
var obj = typeof options === 'object' && options,
overlapping = obj && obj.overlapping,
inside = obj && obj.inside,
// If overlapping is set, we also perform the inside check:
bounds = overlapping || inside,
rect = bounds && Rectangle.read([bounds]);
param = {
items: [], // The list to contain the results.
recursive: obj && obj.recursive !== false,
inside: !!inside,
overlapping: !!overlapping,
rect: rect,
path:
overlapping &&
new ref.Path.Rectangle({
rectangle: rect,
insert: false,
}),
};
if (obj) {
// Create a copy of the options object that doesn't contain
// these special properties:
options = Base.filter({}, options, {
recursive: true,
inside: true,
overlapping: true,
});
}
}
var children = item._children,
items = param.items,
rect = param.rect;
matrix = rect && (matrix || new Matrix());
for (var i = 0, l = children && children.length; i < l; i++) {
var child = children[i],
childMatrix = matrix && matrix.appended(child._matrix),
add = true;
if (rect) {
var bounds = child.getBounds(childMatrix);
// Regardless of the setting of inside / overlapping, if the
// bounds don't even intersect, we can skip this child.
if (!rect.intersects(bounds)) continue;
if (
!(
rect.contains(bounds) ||
// First check the bounds, if the rect is fully
// contained, we are always overlapping, and don't
// need to perform further checks, otherwise perform
// a proper #intersects() check:
(param.overlapping && (bounds.contains(rect) || param.path.intersects(child, childMatrix)))
)
)
add = false;
}
if (add && child.matches(options)) {
items.push(child);
if (firstOnly) break;
}
if (param.recursive !== false) {
_getItems(child, options, childMatrix, param, firstOnly);
}
if (firstOnly && items.length > 0) break;
}
return items;
},
},
},
/** @lends Item# */ {
/**
* {@grouptitle Importing / Exporting JSON and SVG}
*
* Exports (serializes) the item with its content and child items to a JSON
* data string.
*
* @name Item#exportJSON
* @function
*
* @option [options.asString=true] {Boolean} whether the JSON is returned as
* a `Object` or a `String`
* @option [options.precision=5] {Number} the amount of fractional digits in
* numbers used in JSON data
*
* @param {Object} [options] the serialization options
* @return {String} the exported JSON data
*/
/**
* Imports (deserializes) the stored JSON data into this item. If the data
* describes an item of the same class or a parent class of the item, the
* data is imported into the item itself. If not, the imported item is added
* to this item's {@link Item#children} list. Note that not all type of
* items can have children.
*
* @param {String} json the JSON data to import from
* @return {Item}
*/
importJSON: function (json) {
// Try importing into `this`. If another item is returned, try adding
// it as a child (this won't be successful on some classes, returning
// null).
var res = Base.importJSON(json, this);
return res !== this ? this.addChild(res) : res;
},
/**
* Exports the item with its content and child items as an SVG DOM.
*
* @name Item#exportSVG
* @function
*
* @option [options.bounds='view'] {String|Rectangle} the bounds of the area
* to export, either as a string ({@values 'view', content'}), or a
* {@link Rectangle} object: `'view'` uses the view bounds,
* `'content'` uses the stroke bounds of all content
* @option [options.matrix=paper.view.matrix] {Matrix} the matrix with which
* to transform the exported content: If `options.bounds` is set to
* `'view'`, `paper.view.matrix` is used, for all other settings of
* `options.bounds` the identity matrix is used.
* @option [options.asString=false] {Boolean} whether a SVG node or a
* `String` is to be returned
* @option [options.precision=5] {Number} the amount of fractional digits in
* numbers used in SVG data
* @option [options.matchShapes=false] {Boolean} whether path items should
* tried to be converted to SVG shape items (rect, circle, ellipse,
* line, polyline, polygon), if their geometries match
* @option [options.embedImages=true] {Boolean} whether raster images should
* be embedded as base64 data inlined in the xlink:href attribute, or
* kept as a link to their external URL.
* @option [options.reduceAttributes=true] {Boolean} wether to only include
* style attributes in the SVG output that differ from their parents,
* or to always include them (much faster but leading to redundancies).
*
* @param {Object} [options] the export options
* @return {SVGElement|String} the item converted to an SVG node or a
* `String` depending on `option.asString` value
*/
/**
* Converts the provided SVG content into Paper.js items and adds them to
* the this item's children list. Note that the item is not cleared first.
* You can call {@link Item#removeChildren()} to do so.
*
* @name Item#importSVG
* @function
*
* @option [options.expandShapes=false] {Boolean} whether imported shape
* items should be expanded to path items
* @option options.onLoad {Function} the callback function to call once the
* SVG content is loaded from the given URL receiving two arguments: the
* converted `item` and the original `svg` data as a string. Only
* required when loading from external resources.
* @option options.onError {Function} the callback function to call if an
* error occurs during loading. Only required when loading from external
* resources.
* @option [options.insert=true] {Boolean} whether the imported items should
* be added to the item that `importSVG()` is called on
* @option [options.applyMatrix={@link PaperScope#settings}.applyMatrix]
* {Boolean} whether the imported items should have their transformation
* matrices applied to their contents or not
*
* @param {SVGElement|String} svg the SVG content to import, either as a SVG
* DOM node, a string containing SVG content, or a string describing the
* URL of the SVG file to fetch.
* @param {Object} [options] the import options
* @return {Item} the newly created Paper.js item containing the converted
* SVG content
*/
/**
* Imports the provided external SVG file, converts it into Paper.js items
* and adds them to the this item's children list. Note that the item is not
* cleared first. You can call {@link Item#removeChildren()} to do so.
*
* @name Item#importSVG
* @function
*
* @param {SVGElement|String} svg the URL of the SVG file to fetch.
* @param {Function} onLoad the callback function to call once the SVG
* content is loaded from the given URL receiving two arguments: the
* converted `item` and the original `svg` data as a string. Only
* required when loading from external files.
* @return {Item} the newly created Paper.js item containing the converted
* SVG content
*/
/**
* {@grouptitle Hierarchy Operations}
*
* Adds the specified item as a child of this item at the end of the its
* {@link #children} list. You can use this function for groups, compound
* paths and layers.
*
* @param {Item} item the item to be added as a child
* @return {Item} the added item, or `null` if adding was not possible
*/
addChild: function (item) {
return this.insertChild(undefined, item);
},
/**
* Inserts the specified item as a child of this item at the specified index
* in its {@link #children} list. You can use this function for groups,
* compound paths and layers.
*
* @param {Number} index the index at which to insert the item
* @param {Item} item the item to be inserted as a child
* @return {Item} the inserted item, or `null` if inserting was not possible
*/
insertChild: function (index, item) {
var res = item ? this.insertChildren(index, [item]) : null;
return res && res[0];
},
/**
* Adds the specified items as children of this item at the end of the its
* children list. You can use this function for groups, compound paths and
* layers.
*
* @param {Item[]} items the items to be added as children
* @return {Item[]} the added items, or `null` if adding was not possible
*/
addChildren: function (items) {
return this.insertChildren(this._children.length, items);
},
/**
* Inserts the specified items as children of this item at the specified
* index in its {@link #children} list. You can use this function for
* groups, compound paths and layers.
*
* @param {Number} index
* @param {Item[]} items the items to be appended as children
* @return {Item[]} the inserted items, or `null` if inserted was not
* possible
*/
insertChildren: function (index, items) {
var children = this._children;
if (children && items && items.length > 0) {
// We need to clone items because it may be an Item#children array.
// Also, we're removing elements if they don't match _type.
// Use Base.slice() because items can be an arguments object.
items = Base.slice(items);
// Remove the items from their parents first, since they might be
// inserted into their own parents, affecting indices.
// Use the loop also to filter invalid items.
var inserted = {};
for (var i = items.length - 1; i >= 0; i--) {
var item = items[i],
id = item && item._id;
// If an item was inserted already, it must be included multiple
// times in the items array. Only insert once.
if (!item || inserted[id]) {
items.splice(i, 1);
} else {
// Notify parent of change. Don't notify item itself yet,
// as we're doing so when adding it to the new owner below.
item._remove(false, true);
inserted[id] = true;
}
}
Base.splice(children, items, index, 0);
var project = this._project,
// See #_remove() for an explanation of this:
notifySelf = project._changes;
for (var i = 0, l = items.length; i < l; i++) {
var item = items[i],
name = item._name;
item._parent = this;
item._setProject(project, true);
// Set the name again to make sure all name lookup structures
// are kept in sync.
if (name) item.setName(name);
if (notifySelf) item._changed(/*#=*/ Change.INSERTION);
}
this._changed(/*#=*/ Change.CHILDREN);
} else {
items = null;
}
return items;
},
// Internal alias, so both Project and Item can be used in #copyTo(), and
// through _getOwner() in the various Item#insert*() methods.
_insertItem: '#insertChild',
/**
* Private helper method used by {@link #insertAbove(item)} and
* {@link #insertBelow(item)}, to insert this item in relation to a
* specified other item.
*
* @param {Item} item the item in relation to which which it should be
* inserted
* @param {Number} offset the offset at which the item should be inserted
* @return {Item} the inserted item, or `null` if inserting was not possible
*/
_insertAt: function (item, offset) {
var owner = item && item._getOwner(),
// Only insert if the item is not the same as `this`, and if it
// actually has an owner into which we can insert.
res = item !== this && owner ? this : null;
if (res) {
// Notify parent of change. Don't notify item itself yet,
// as we're doing so when adding it to the new owner below.
res._remove(false, true);
owner._insertItem(item._index + offset, res);
}
return res;
},
/**
* Inserts this item above the specified item.
*
* @param {Item} item the item above which it should be inserted
* @return {Item} the inserted item, or `null` if inserting was not possible
*/
insertAbove: function (item) {
return this._insertAt(item, 1);
},
/**
* Inserts this item below the specified item.
*
* @param {Item} item the item below which it should be inserted
* @return {Item} the inserted item, or `null` if inserting was not possible
*/
insertBelow: function (item) {
return this._insertAt(item, 0);
},
/**
* Sends this item to the back of all other items within the same parent.
*/
sendToBack: function () {
var owner = this._getOwner();
return owner ? owner._insertItem(0, this) : null;
},
/**
* Brings this item to the front of all other items within the same parent.
*/
bringToFront: function () {
var owner = this._getOwner();
return owner ? owner._insertItem(undefined, this) : null;
},
/**
* Inserts the specified item as a child of this item by appending it to
* the list of children and moving it above all other children. You can
* use this function for groups, compound paths and layers.
*
* @function
* @param {Item} item the item to be appended as a child
* @deprecated use {@link #addChild(item)} instead.
*/
appendTop: '#addChild',
/**
* Inserts the specified item as a child of this item by appending it to
* the list of children and moving it below all other children. You can
* use this function for groups, compound paths and layers.
*
* @param {Item} item the item to be appended as a child
* @deprecated use {@link #insertChild(index, item)} instead.
*/
appendBottom: function (item) {
return this.insertChild(0, item);
},
/**
* Moves this item above the specified item.
*
* @function
* @param {Item} item the item above which it should be moved
* @return {Boolean} {@true if it was moved}
* @deprecated use {@link #insertAbove(item)} instead.
*/
moveAbove: '#insertAbove',
/**
* Moves the item below the specified item.
*
* @function
* @param {Item} item the item below which it should be moved
* @return {Boolean} {@true if it was moved}
* @deprecated use {@link #insertBelow(item)} instead.
*/
moveBelow: '#insertBelow',
/**
* Adds it to the specified owner, which can be either a {@link Item} or a
* {@link Project}.
*
* @param {Project|Layer|Group|CompoundPath} owner the item or project to
* add the item to
* @return {Item} the item itself, if it was successfully added
* @chainable
*/
addTo: function (owner) {
return owner._insertItem(undefined, this);
},
/**
* Clones the item and adds it to the specified owner, which can be either
* a {@link Item} or a {@link Project}.
*
* @param {Project|Layer|Group|CompoundPath} owner the item or project to
* copy the item to
* @return {Item} the new copy of the item, if it was successfully added
* @chainable
*/
copyTo: function (owner) {
return this.clone(false).addTo(owner);
},
/**
* If this is a group, layer or compound-path with only one child-item,
* the child-item is moved outside and the parent is erased. Otherwise, the
* item itself is returned unmodified.
*
* @return {Item} the reduced item
*/
reduce: function (options) {
var children = this._children;
if (children && children.length === 1) {
var child = children[0].reduce(options);
// Make sure the reduced item has the same parent as the original.
if (this._parent) {
child.insertAbove(this);
this.remove();
} else {
child.remove();
}
return child;
}
return this;
},
/**
* Removes the item from its parent's named children list.
*/
_removeNamed: function () {
var owner = this._getOwner();
if (owner) {
var children = owner._children,
namedChildren = owner._namedChildren,
name = this._name,
namedArray = namedChildren[name],
index = namedArray ? namedArray.indexOf(this) : -1;
if (index !== -1) {
// Remove the named reference
if (children[name] == this) delete children[name];
// Remove this entry
namedArray.splice(index, 1);
// If there are any items left in the named array, set the first
// of them to be children[this.name]
if (namedArray.length) {
children[name] = namedArray[0];
} else {
// Otherwise delete the empty array
delete namedChildren[name];
}
}
}
},
/**
* Removes the item from its parent's children list.
*/
_remove: function (notifySelf, notifyParent) {
var owner = this._getOwner(),
project = this._project,
index = this._index;
if (this._style) this._style._dispose();
if (owner) {
// Handle named children separately from index:
if (this._name) this._removeNamed();
// Handle index separately from owner: There are situations where
// the item is already removed from its list through Base.splice()
// and index set to undefined, but the owner is still set,
// e.g. in #removeChildren():
if (index != null) {
// Only required for layers but not enough to merit an override.
if (project._activeLayer === this) project._activeLayer = this.getNextSibling() || this.getPreviousSibling();
Base.splice(owner._children, null, index, 1);
}
this._installEvents(false);
// Notify self of the insertion change. We only need this
// notification if we're tracking changes for now.
if (notifySelf && project._changes) this._changed(/*#=*/ Change.INSERTION);
// Notify owner of changed children (this can be the project too).
if (notifyParent) owner._changed(/*#=*/ Change.CHILDREN, this);
this._parent = null;
return true;
}
return false;
},
/**
* Removes the item and all its children from the project. The item is not
* destroyed and can be inserted again after removal.
*
* @return {Boolean} {@true if the item was removed}
*/
remove: function () {
// Notify self and parent of change:
return this._remove(true, true);
},
/**
* Replaces this item with the provided new item which will takes its place
* in the project hierarchy instead.
*
* @param {Item} item the item that will replace this item
* @return {Boolean} {@true if the item was replaced}
*/
replaceWith: function (item) {
var ok = item && item.insertBelow(this);
if (ok) this.remove();
return ok;
},
/**
* Removes all of the item's {@link #children} (if any).
*
* @name Item#removeChildren
* @alias Item#clear
* @function
* @return {Item[]} an array containing the removed items
*/
/**
* Removes the children from the specified `start` index to and excluding
* the `end` index from the parent's {@link #children} array.
*
* @name Item#removeChildren
* @function
* @param {Number} start the beginning index, inclusive
* @param {Number} [end=children.length] the ending index, exclusive
* @return {Item[]} an array containing the removed items
*/
removeChildren: function (start, end) {
if (!this._children) return null;
start = start || 0;
end = Base.pick(end, this._children.length);
// Use Base.splice(), which adjusts #_index for the items above, and
// deletes it for the removed items. Calling #_remove() afterwards is
// fine, since it only calls Base.splice() if #_index is set.
var removed = Base.splice(this._children, null, start, end - start);
for (var i = removed.length - 1; i >= 0; i--) {
// Don't notify parent each time, notify it separately after.
removed[i]._remove(true, false);
}
if (removed.length > 0) this._changed(/*#=*/ Change.CHILDREN);
return removed;
},
// DOCS Item#clear()
clear: '#removeChildren',
/**
* Reverses the order of the item's children
*/
reverseChildren: function () {
if (this._children) {
this._children.reverse();
// Adjust indices
for (var i = 0, l = this._children.length; i < l; i++) this._children[i]._index = i;
this._changed(/*#=*/ Change.CHILDREN);
}
},
/**
* {@grouptitle Tests}
* Specifies whether the item has any content or not. The meaning of what
* content is differs from type to type. For example, a {@link Group} with
* no children, a {@link TextItem} with no text content and a {@link Path}
* with no segments all are considered empty.
*
* @param {Boolean} [recursively=false] whether an item with children should be
* considered empty if all its descendants are empty
* @return {Boolean}
*/
isEmpty: function (recursively) {
var children = this._children;
var numChildren = children ? children.length : 0;
if (recursively) {
// In recursive check, item is empty if all its children are empty.
for (var i = 0; i < numChildren; i++) {
if (!children[i].isEmpty(recursively)) {
return false;
}
}
return true;
}
return !numChildren;
},
/**
* Checks whether the item is editable.
*
* @return {Boolean} {@true when neither the item, nor its parents are
* locked or hidden}
* @ignore
*/
// TODO: Item#isEditable is currently ignored in the documentation, as
// locking an item currently has no effect
isEditable: function () {
var item = this;
while (item) {
if (!item._visible || item._locked) return false;
item = item._parent;
}
return true;
},
/**
* Checks whether the item is valid, i.e. it hasn't been removed.
*
* @return {Boolean} {@true if the item is valid}
*/
// TODO: isValid / checkValid
/**
* {@grouptitle Style Tests}
*
* Checks whether the item has a fill.
*
* @return {Boolean} {@true if the item has a fill}
*/
hasFill: function () {
return this.getStyle().hasFill();
},
/**
* Checks whether the item has a stroke.
*
* @return {Boolean} {@true if the item has a stroke}
*/
hasStroke: function () {
return this.getStyle().hasStroke();
},
/**
* Checks whether the item has a shadow.
*
* @return {Boolean} {@true if the item has a shadow}
*/
hasShadow: function () {
return this.getStyle().hasShadow();
},
/**
* Returns -1 if 'this' is above 'item', 1 if below, 0 if their order is not
* defined in such a way, e.g. if one is a descendant of the other.
*/
_getOrder: function (item) {
// Private method that produces a list of ancestors, starting with the
// root and ending with the actual element as the last entry.
function getList(item) {
var list = [];
do {
list.unshift(item);
} while ((item = item._parent));
return list;
}
var list1 = getList(this),
list2 = getList(item);
for (var i = 0, l = Math.min(list1.length, list2.length); i < l; i++) {
if (list1[i] != list2[i]) {
// Found the position in the parents list where the two start
// to differ. Look at who's above who.
return list1[i]._index < list2[i]._index ? 1 : -1;
}
}
return 0;
},
/**
* {@grouptitle Hierarchy Tests}
*
* Checks if the item contains any children items.
*
* @return {Boolean} {@true it has one or more children}
*/
hasChildren: function () {
return this._children && this._children.length > 0;
},
/**
* Checks whether the item and all its parents are inserted into scene graph
* or not.
*
* @return {Boolean} {@true if the item is inserted into the scene graph}
*/
isInserted: function () {
return this._parent ? this._parent.isInserted() : false;
},
/**
* Checks if this item is above the specified item in the stacking order
* of the project.
*
* @param {Item} item the item to check against
* @return {Boolean} {@true if it is above the specified item}
*/
isAbove: function (item) {
return this._getOrder(item) === -1;
},
/**
* Checks if the item is below the specified item in the stacking order of
* the project.
*
* @param {Item} item the item to check against
* @return {Boolean} {@true if it is below the specified item}
*/
isBelow: function (item) {
return this._getOrder(item) === 1;
},
/**
* Checks whether the specified item is the parent of the item.
*
* @param {Item} item the item to check against
* @return {Boolean} {@true if it is the parent of the item}
*/
isParent: function (item) {
return this._parent === item;
},
/**
* Checks whether the specified item is a child of the item.
*
* @param {Item} item the item to check against
* @return {Boolean} {@true it is a child of the item}
*/
isChild: function (item) {
return item && item._parent === this;
},
/**
* Checks if the item is contained within the specified item.
*
* @param {Item} item the item to check against
* @return {Boolean} {@true if it is inside the specified item}
*/
isDescendant: function (item) {
var parent = this;
while ((parent = parent._parent)) {
if (parent === item) return true;
}
return false;
},
/**
* Checks if the item is an ancestor of the specified item.
*
* @param {Item} item the item to check against
* @return {Boolean} {@true if the item is an ancestor of the specified
* item}
*/
isAncestor: function (item) {
return item ? item.isDescendant(this) : false;
},
/**
* Checks if the item is an a sibling of the specified item.
*
* @param {Item} item the item to check against
* @return {Boolean} {@true if the item is aa sibling of the specified item}
*/
isSibling: function (item) {
return this._parent === item._parent;
},
/**
* Checks whether the item is grouped with the specified item.
*
* @param {Item} item
* @return {Boolean} {@true if the items are grouped together}
*/
isGroupedWith: function (item) {
var parent = this._parent;
while (parent) {
// Find group parents. Check for parent._parent, since don't want
// top level layers, because they also inherit from Group
if (parent._parent && /^(Group|Layer|CompoundPath)$/.test(parent._class) && item.isDescendant(parent))
return true;
// Keep walking up otherwise
parent = parent._parent;
}
return false;
},
// Document all style properties which get injected into Item by Style:
/**
* {@grouptitle Stroke Style}
*
* The color of the stroke.
*
* @name Item#strokeColor
* @property
* @type ?Color
*
* @example {@paperscript}
* // Setting the stroke color of a path:
*
* // Create a circle shaped path at { x: 80, y: 50 }
* // with a radius of 35:
* var circle = new Path.Circle({
* center: [80, 50],
* radius: 35
* });
*
* // Set its stroke color to RGB red:
* circle.strokeColor = new Color(1, 0, 0);
*/
/**
* The width of the stroke.
*
* @name Item#strokeWidth
* @property
* @type Number
*
* @example {@paperscript}
* // Setting an item's stroke width:
*
* // Create a circle shaped path at { x: 80, y: 50 }
* // with a radius of 35:
* var circle = new Path.Circle({
* center: [80, 50],
* radius: 35,
* strokeColor: 'red'
* });
*
* // Set its stroke width to 10:
* circle.strokeWidth = 10;
*/
/**
* The shape to be used at the beginning and end of open {@link Path} items,
* when they have a stroke.
*
* @name Item#strokeCap
* @property
* @type String
* @values 'round', 'square', 'butt'
* @default 'butt'
*
* @example {@paperscript height=200}
* // A look at the different stroke caps:
*
* var line = new Path({
* segments: [[80, 50], [420, 50]],
* strokeColor: 'black',
* strokeWidth: 20,
* selected: true
* });
*
* // Set the stroke cap of the line to be round:
* line.strokeCap = 'round';
*
* // Copy the path and set its stroke cap to be square:
* var line2 = line.clone();
* line2.position.y += 50;
* line2.strokeCap = 'square';
*
* // Make another copy and set its stroke cap to be butt:
* var line2 = line.clone();
* line2.position.y += 100;
* line2.strokeCap = 'butt';
*/
/**
* The shape to be used at the segments and corners of {@link Path} items
* when they have a stroke.
*
* @name Item#strokeJoin
* @property
* @type String
* @values 'miter', 'round', 'bevel'
* @default 'miter'
*
* @example {@paperscript height=120}
* // A look at the different stroke joins:
* var path = new Path({
* segments: [[80, 100], [120, 40], [160, 100]],
* strokeColor: 'black',
* strokeWidth: 20,
* // Select the path, in order to see where the stroke is formed:
* selected: true
* });
*
* var path2 = path.clone();
* path2.position.x += path2.bounds.width * 1.5;
* path2.strokeJoin = 'round';
*
* var path3 = path2.clone();
* path3.position.x += path3.bounds.width * 1.5;
* path3.strokeJoin = 'bevel';
*/
/**
* The dash offset of the stroke.
*
* @name Item#dashOffset
* @property
* @type Number
* @default 0
*/
/**
* Specifies whether the stroke is to be drawn taking the current affine
* transformation into account (the default behavior), or whether it should
* appear as a non-scaling stroke.
*
* @name Item#strokeScaling
* @property
* @type Boolean
* @default true
*/
/**
* Specifies an array containing the dash and gap lengths of the stroke.
*
* @example {@paperscript}
* var path = new Path.Circle({
* center: [80, 50],
* radius: 40,
* strokeWidth: 2,
* strokeColor: 'black'
* });
*
* // Set the dashed stroke to [10pt dash, 4pt gap]:
* path.dashArray = [10, 4];
*
* @name Item#dashArray
* @property
* @type Number[]
* @default []
*/
/**
* The miter limit of the stroke.
* When two line segments meet at a sharp angle and miter joins have been
* specified for {@link Item#strokeJoin}, it is possible for the miter to
* extend far beyond the {@link Item#strokeWidth} of the path. The
* miterLimit imposes a limit on the ratio of the miter length to the
* {@link Item#strokeWidth}.
*
* @name Item#miterLimit
* @property
* @type Number
* @default 10
*/
/**
* {@grouptitle Fill Style}
*
* The fill color of the item.
*
* @name Item#fillColor
* @property
* @type ?Color
*
* @example {@paperscript}
* // Setting the fill color of a path to red:
*
* // Create a circle shaped path at { x: 80, y: 50 }
* // with a radius of 35:
* var circle = new Path.Circle({
* center: [80, 50],
* radius: 35
* });
*
* // Set the fill color of the circle to RGB red:
* circle.fillColor = new Color(1, 0, 0);
*/
/**
* The fill-rule with which the shape gets filled. Please note that only
* modern browsers support fill-rules other than `'nonzero'`.
*
* @name Item#fillRule
* @property
* @type String
* @values 'nonzero', 'evenodd'
* @default 'nonzero'
*/
/**
* {@grouptitle Shadow Style}
*
* The shadow color.
*
* @property
* @name Item#shadowColor
* @type ?Color
*
* @example {@paperscript}
* // Creating a circle with a black shadow:
*
* var circle = new Path.Circle({
* center: [80, 50],
* radius: 35,
* fillColor: 'white',
* // Set the shadow color of the circle to RGB black:
* shadowColor: new Color(0, 0, 0),
* // Set the shadow blur radius to 12:
* shadowBlur: 12,
* // Offset the shadow by { x: 5, y: 5 }
* shadowOffset: new Point(5, 5)
* });
*/
/**
* The shadow's blur radius.
*
* @property
* @name Item#shadowBlur
* @type Number
* @default 0
*/
/**
* The shadow's offset.
*
* @property
* @name Item#shadowOffset
* @type Point
* @default 0
*/
// TODO: Find a better name than selectedColor. It should also be used for
// guides, etc.
/**
* {@grouptitle Selection Style}
*
* The color the item is highlighted with when selected. If the item does
* not specify its own color, the color defined by its layer is used instead.
*
* @name Item#selectedColor
* @property
* @type ?Color
*/
},
Base.each(
['rotate', 'scale', 'shear', 'skew'],
function (key) {
var rotate = key === 'rotate';
this[key] = function (/* value, center */) {
var args = arguments,
value = (rotate ? Base : Point).read(args),
center = Point.read(args, 0, { readNull: true });
return this.transform(new Matrix()[key](value, center || this.getPosition(true)));
};
},
/** @lends Item# */ {
/**
* {@grouptitle Transform Functions}
*
* Translates (moves) the item by the given offset views.
*
* @param {Point} delta the offset to translate the item by
*/
translate: function (/* delta */) {
var mx = new Matrix();
return this.transform(mx.translate.apply(mx, arguments));
},
/**
* Rotates the item by a given angle around the given center point.
*
* Angles are oriented clockwise and measured in degrees.
*
* @name Item#rotate
* @function
* @param {Number} angle the rotation angle
* @param {Point} [center={@link Item#position}]
* @see Matrix#rotate(angle[, center])
*
* @example {@paperscript}
* // Rotating an item:
*
* // Create a rectangle shaped path with its top left
* // point at {x: 80, y: 25} and a size of {width: 50, height: 50}:
* var path = new Path.Rectangle(new Point(80, 25), new Size(50, 50));
* path.fillColor = 'black';
*
* // Rotate the path by 30 degrees:
* path.rotate(30);
*
* @example {@paperscript height=200}
* // Rotating an item around a specific point:
*
* // Create a rectangle shaped path with its top left
* // point at {x: 175, y: 50} and a size of {width: 100, height: 100}:
* var topLeft = new Point(175, 50);
* var size = new Size(100, 100);
* var path = new Path.Rectangle(topLeft, size);
* path.fillColor = 'black';
*
* // Draw a circle shaped path in the center of the view,
* // to show the rotation point:
* var circle = new Path.Circle({
* center: view.center,
* radius: 5,
* fillColor: 'white'
* });
*
* // Each frame rotate the path 3 degrees around the center point
* // of the view:
* function onFrame(event) {
* path.rotate(3, view.center);
* }
*/
/**
* Scales the item by the given value from its center point, or optionally
* from a supplied point.
*
* @name Item#scale
* @function
* @param {Number} scale the scale factor
* @param {Point} [center={@link Item#position}]
*
* @example {@paperscript}
* // Scaling an item from its center point:
*
* // Create a circle shaped path at { x: 80, y: 50 }
* // with a radius of 20:
* var circle = new Path.Circle({
* center: [80, 50],
* radius: 20,
* fillColor: 'red'
* });
*
* // Scale the path by 150% from its center point
* circle.scale(1.5);
*
* @example {@paperscript}
* // Scaling an item from a specific point:
*
* // Create a circle shaped path at { x: 80, y: 50 }
* // with a radius of 20:
* var circle = new Path.Circle({
* center: [80, 50],
* radius: 20,
* fillColor: 'red'
* });
*
* // Scale the path 150% from its bottom left corner
* circle.scale(1.5, circle.bounds.bottomLeft);
*/
/**
* Scales the item by the given values from its center point, or optionally
* from a supplied point.
*
* @name Item#scale
* @function
* @param {Number} hor the horizontal scale factor
* @param {Number} ver the vertical scale factor
* @param {Point} [center={@link Item#position}]
*
* @example {@paperscript}
* // Scaling an item horizontally by 300%:
*
* // Create a circle shaped path at { x: 100, y: 50 }
* // with a radius of 20:
* var circle = new Path.Circle({
* center: [100, 50],
* radius: 20,
* fillColor: 'red'
* });
*
* // Scale the path horizontally by 300%
* circle.scale(3, 1);
*/
// TODO: Add test for item shearing, as it might be behaving oddly.
/**
* Shears the item by the given value from its center point, or optionally
* by a supplied point.
*
* @name Item#shear
* @function
* @param {Point} shear the horizontal and vertical shear factors as a point
* @param {Point} [center={@link Item#position}]
* @see Matrix#shear(shear[, center])
*/
/**
* Shears the item by the given values from its center point, or optionally
* by a supplied point.
*
* @name Item#shear
* @function
* @param {Number} hor the horizontal shear factor
* @param {Number} ver the vertical shear factor
* @param {Point} [center={@link Item#position}]
* @see Matrix#shear(hor, ver[, center])
*/
/**
* Skews the item by the given angles from its center point, or optionally
* by a supplied point.
*
* @name Item#skew
* @function
* @param {Point} skew the horizontal and vertical skew angles in degrees
* @param {Point} [center={@link Item#position}]
* @see Matrix#shear(skew[, center])
*/
/**
* Skews the item by the given angles from its center point, or optionally
* by a supplied point.
*
* @name Item#skew
* @function
* @param {Number} hor the horizontal skew angle in degrees
* @param {Number} ver the vertical sskew angle in degrees
* @param {Point} [center={@link Item#position}]
* @see Matrix#shear(hor, ver[, center])
*/
/**
* Transform the item.
*
* @param {Matrix} matrix the matrix by which the item shall be transformed
*/
// TODO: Implement flags:
// @param {String[]} flags array of any of the following: 'objects',
// 'children', 'fill-gradients', 'fill-patterns', 'stroke-patterns',
// 'lines'. Default: ['objects', 'children']
transform: function (matrix, _applyRecursively, _setApplyMatrix) {
var _matrix = this._matrix,
transformMatrix = matrix && !matrix.isIdentity(),
// If no matrix is provided, or the matrix is the identity, we might
// still have some work to do: _setApplyMatrix or _applyRecursively.
applyMatrix =
(_setApplyMatrix && this._canApplyMatrix) ||
(this._applyMatrix &&
// Don't apply _matrix if the result of concatenating with
// matrix would be identity.
(transformMatrix ||
!_matrix.isIdentity() ||
// Even if it's an identity matrix, we may still need to
// recursively apply the matrix to children.
(_applyRecursively && this._children)));
// Bail out if there is nothing to do.
if (!transformMatrix && !applyMatrix) return this;
// Simply prepend the internal matrix with the passed one:
if (transformMatrix) {
// Keep a backup of the last valid state before the matrix becomes
// non-invertible. This is then used again in setBounds to restore.
if (!matrix.isInvertible() && _matrix.isInvertible()) _matrix._backup = _matrix.getValues();
// Pass `true` for _dontNotify, as we're handling this after.
_matrix.prepend(matrix, true);
// When a new matrix was applied, we also need to transform gradient
// color points. These always need transforming, regardless of
// #applyMatrix, as they are defined in the parent's coordinate
// system.
// TODO: Introduce options to control whether fills should be
// transformed or not.
var style = this._style,
// Pass true for _dontMerge so we don't recursively transform
// styles on groups' children.
fillColor = style.getFillColor(true),
strokeColor = style.getStrokeColor(true);
if (fillColor) fillColor.transform(matrix);
if (strokeColor) strokeColor.transform(matrix);
}
// Call #_transformContent() now, if we need to directly apply the
// internal _matrix transformations to the item's content.
// Application is not possible on Raster, PointText, SymbolItem, since
// the matrix is where the actual transformation state is stored.
if (applyMatrix && (applyMatrix = this._transformContent(_matrix, _applyRecursively, _setApplyMatrix))) {
// Pivot is provided in the parent's coordinate system, so transform
// it along too.
var pivot = this._pivot;
if (pivot) _matrix._transformPoint(pivot, pivot, true);
// Reset the internal matrix to the identity transformation if
// it was possible to apply it, but do not notify owner of change.
_matrix.reset(true);
// Set the internal _applyMatrix flag to true if we're told to
// do so
if (_setApplyMatrix && this._canApplyMatrix) this._applyMatrix = true;
}
// Calling _changed will clear _bounds and _position, but depending
// on matrix we can calculate and set them again, so preserve them.
var bounds = this._bounds,
position = this._position;
if (transformMatrix || applyMatrix) {
this._changed(/*#=*/ Change.MATRIX);
}
// Detect matrices that contain only translations and scaling
// and transform the cached _bounds and _position without having to
// fully recalculate each time.
var decomp = transformMatrix && bounds && matrix.decompose();
if (decomp && decomp.skewing.isZero() && decomp.rotation % 90 === 0) {
// Transform the old bound by looping through all the cached
// bounds in _bounds and transform each.
for (var key in bounds) {
var cache = bounds[key];
// If any item involved in the determination of these bounds has
// non-scaling strokes, delete the cache now as it can't be
// preserved through the transformation.
if (cache.nonscaling) {
delete bounds[key];
} else if (applyMatrix || !cache.internal) {
// If these are internal bounds, only transform them if this
// item applied its matrix.
var rect = cache.rect;
matrix._transformBounds(rect, rect);
}
}
this._bounds = bounds;
// If we have cached bounds, try to determine _position as its
// center. Use _boundsOptions do get the cached default bounds.
var cached = bounds[this._getBoundsCacheKey(this._boundsOptions || {})];
if (cached) {
// use this method to handle pivot case (see #1503)
this._position = this._getPositionFromBounds(cached.rect);
}
} else if (transformMatrix && position && this._pivot) {
// If the item has a pivot defined, it means that the default
// position defined as the center of the bounds won't shift with
// arbitrary transformations and we can therefore update _position:
this._position = matrix._transformPoint(position, position);
}
// Allow chaining here, since transform() is related to Matrix functions
return this;
},
_transformContent: function (matrix, applyRecursively, setApplyMatrix) {
var children = this._children;
if (children) {
for (var i = 0, l = children.length; i < l; i++) {
children[i].transform(matrix, applyRecursively, setApplyMatrix);
}
return true;
}
},
/**
* Converts the specified point from global project coordinate space to the
* item's own local coordinate space.
*
* @param {Point} point the point to be transformed
* @return {Point} the transformed point as a new instance
*/
globalToLocal: function (/* point */) {
return this.getGlobalMatrix(true)._inverseTransform(Point.read(arguments));
},
/**
* Converts the specified point from the item's own local coordinate space
* to the global project coordinate space.
*
* @param {Point} point the point to be transformed
* @return {Point} the transformed point as a new instance
*/
localToGlobal: function (/* point */) {
return this.getGlobalMatrix(true)._transformPoint(Point.read(arguments));
},
/**
* Converts the specified point from the parent's coordinate space to
* item's own local coordinate space.
*
* @param {Point} point the point to be transformed
* @return {Point} the transformed point as a new instance
*/
parentToLocal: function (/* point */) {
return this._matrix._inverseTransform(Point.read(arguments));
},
/**
* Converts the specified point from the item's own local coordinate space
* to the parent's coordinate space.
*
* @param {Point} point the point to be transformed
* @return {Point} the transformed point as a new instance
*/
localToParent: function (/* point */) {
return this._matrix._transformPoint(Point.read(arguments));
},
/**
* Transform the item so that its {@link #bounds} fit within the specified
* rectangle, without changing its aspect ratio.
*
* @param {Rectangle} rectangle
* @param {Boolean} [fill=false]
*
* @example {@paperscript height=100}
* // Fitting an item to the bounding rectangle of another item's bounding
* // rectangle:
*
* // Create a rectangle shaped path with its top left corner
* // at {x: 80, y: 25} and a size of {width: 75, height: 50}:
* var path = new Path.Rectangle({
* point: [80, 25],
* size: [75, 50],
* fillColor: 'black'
* });
*
* // Create a circle shaped path with its center at {x: 80, y: 50}
* // and a radius of 30.
* var circlePath = new Path.Circle({
* center: [80, 50],
* radius: 30,
* fillColor: 'red'
* });
*
* // Fit the circlePath to the bounding rectangle of
* // the rectangular path:
* circlePath.fitBounds(path.bounds);
*
* @example {@paperscript height=100}
* // Fitting an item to the bounding rectangle of another item's bounding
* // rectangle with the fill parameter set to true:
*
* // Create a rectangle shaped path with its top left corner
* // at {x: 80, y: 25} and a size of {width: 75, height: 50}:
* var path = new Path.Rectangle({
* point: [80, 25],
* size: [75, 50],
* fillColor: 'black'
* });
*
* // Create a circle shaped path with its center at {x: 80, y: 50}
* // and a radius of 30.
* var circlePath = new Path.Circle({
* center: [80, 50],
* radius: 30,
* fillColor: 'red'
* });
*
* // Fit the circlePath to the bounding rectangle of
* // the rectangular path:
* circlePath.fitBounds(path.bounds, true);
*
* @example {@paperscript height=200}
* // Fitting an item to the bounding rectangle of the view
* var path = new Path.Circle({
* center: [80, 50],
* radius: 30,
* fillColor: 'red'
* });
*
* // Fit the path to the bounding rectangle of the view:
* path.fitBounds(view.bounds);
*/
fitBounds: function (rectangle, fill) {
// TODO: Think about passing options with various ways of defining
// fitting. Compare with InDesign fitting to see possible options.
rectangle = Rectangle.read(arguments);
var bounds = this.getBounds(),
itemRatio = bounds.height / bounds.width,
rectRatio = rectangle.height / rectangle.width,
scale = (fill ? itemRatio > rectRatio : itemRatio < rectRatio)
? rectangle.width / bounds.width
: rectangle.height / bounds.height,
newBounds = new Rectangle(new Point(), new Size(bounds.width * scale, bounds.height * scale));
newBounds.setCenter(rectangle.getCenter());
this.setBounds(newBounds);
},
}
),
/** @lends Item# */ {
/**
* {@grouptitle Event Handlers}
*
* Item level handler function to be called on each frame of an animation.
* The function receives an event object which contains information about
* the frame event:
*
* @option event.count {Number} the number of times the frame event was
* fired
* @option event.time {Number} the total amount of time passed since the
* first frame event in seconds
* @option event.delta {Number} the time passed in seconds since the last
* frame event
*
* @name Item#onFrame
* @property
* @type ?Function
* @see View#onFrame
*
* @example {@paperscript}
* // Creating an animation:
*
* // Create a rectangle shaped path with its top left point at:
* // {x: 50, y: 25} and a size of {width: 50, height: 50}
* var path = new Path.Rectangle(new Point(50, 25), new Size(50, 50));
* path.fillColor = 'black';
*
* path.onFrame = function(event) {
* // Every frame, rotate the path by 3 degrees:
* this.rotate(3);
* }
*/
/**
* The function to be called when the mouse button is pushed down on the
* item. The function receives a {@link MouseEvent} object which contains
* information about the mouse event.
* Note that such mouse events bubble up the scene graph hierarchy and will
* reach the view, unless they are stopped with {@link
* Event#stopPropagation()} or by returning `false` from the handler.
*
* @name Item#onMouseDown
* @property
* @type ?Function
* @see View#onMouseDown
*
* @example {@paperscript}
* // Press the mouse button down on the circle shaped path, to make it red:
*
* // Create a circle shaped path at the center of the view:
* var path = new Path.Circle({
* center: view.center,
* radius: 25,
* fillColor: 'black'
* });
*
* // When the mouse is pressed on the item,
* // set its fill color to red:
* path.onMouseDown = function(event) {
* this.fillColor = 'red';
* }
*
* @example {@paperscript}
* // Press the mouse on the circle shaped paths to remove them:
*
* // Loop 30 times:
* for (var i = 0; i < 30; i++) {
* // Create a circle shaped path at a random position
* // in the view:
* var path = new Path.Circle({
* center: Point.random() * view.size,
* radius: 25,
* fillColor: 'black',
* strokeColor: 'white'
* });
*
* // When the mouse is pressed on the item, remove it:
* path.onMouseDown = function(event) {
* this.remove();
* }
* }
*/
/**
* The function to be called when the mouse position changes while the mouse
* is being dragged over the item. The function receives a {@link
* MouseEvent} object which contains information about the mouse event.
* Note that such mouse events bubble up the scene graph hierarchy and will
* reach the view, unless they are stopped with {@link
* Event#stopPropagation()} or by returning `false` from the handler.
*
* @name Item#onMouseDrag
* @property
* @type ?Function
* @see View#onMouseDrag
*
* @example {@paperscript height=240}
* // Press and drag the mouse on the blue circle to move it:
*
* // Create a circle shaped path at the center of the view:
* var path = new Path.Circle({
* center: view.center,
* radius: 50,
* fillColor: 'blue'
* });
*
* // Install a drag event handler that moves the path along.
* path.onMouseDrag = function(event) {
* path.position += event.delta;
* }
*/
/**
* The function to be called when the mouse button is released over the item.
* The function receives a {@link MouseEvent} object which contains
* information about the mouse event.
* Note that such mouse events bubble up the scene graph hierarchy and will
* reach the view, unless they are stopped with {@link
* Event#stopPropagation()} or by returning `false` from the handler.
*
* @name Item#onMouseUp
* @property
* @type ?Function
* @see View#onMouseUp
*
* @example {@paperscript}
* // Release the mouse button over the circle shaped path, to make it red:
*
* // Create a circle shaped path at the center of the view:
* var path = new Path.Circle({
* center: view.center,
* radius: 25,
* fillColor: 'black'
* });
*
* // When the mouse is released over the item,
* // set its fill color to red:
* path.onMouseUp = function(event) {
* this.fillColor = 'red';
* }
*/
/**
* The function to be called when the mouse clicks on the item. The function
* receives a {@link MouseEvent} object which contains information about the
* mouse event.
* Note that such mouse events bubble up the scene graph hierarchy and will
* reach the view, unless they are stopped with {@link
* Event#stopPropagation()} or by returning `false` from the handler.
*
* @name Item#onClick
* @property
* @type ?Function
* @see View#onClick
*
* @example {@paperscript}
* // Click on the circle shaped path, to make it red:
*
* // Create a circle shaped path at the center of the view:
* var path = new Path.Circle({
* center: view.center,
* radius: 25,
* fillColor: 'black'
* });
*
* // When the mouse is clicked on the item,
* // set its fill color to red:
* path.onClick = function(event) {
* this.fillColor = 'red';
* }
*
* @example {@paperscript}
* // Click on the circle shaped paths to remove them:
*
* // Loop 30 times:
* for (var i = 0; i < 30; i++) {
* // Create a circle shaped path at a random position
* // in the view:
* var path = new Path.Circle({
* center: Point.random() * view.size,
* radius: 25,
* fillColor: 'black',
* strokeColor: 'white'
* });
*
* // When the mouse clicks on the item, remove it:
* path.onClick = function(event) {
* this.remove();
* }
* }
*/
/**
* The function to be called when the mouse double clicks on the item. The
* function receives a {@link MouseEvent} object which contains information
* about the mouse event.
* Note that such mouse events bubble up the scene graph hierarchy and will
* reach the view, unless they are stopped with {@link
* Event#stopPropagation()} or by returning `false` from the handler.
*
* @name Item#onDoubleClick
* @property
* @type ?Function
* @see View#onDoubleClick
*
* @example {@paperscript}
* // Double click on the circle shaped path, to make it red:
*
* // Create a circle shaped path at the center of the view:
* var path = new Path.Circle({
* center: view.center,
* radius: 25,
* fillColor: 'black'
* });
*
* // When the mouse is double clicked on the item,
* // set its fill color to red:
* path.onDoubleClick = function(event) {
* this.fillColor = 'red';
* }
*
* @example {@paperscript}
* // Double click on the circle shaped paths to remove them:
*
* // Loop 30 times:
* for (var i = 0; i < 30; i++) {
* // Create a circle shaped path at a random position
* // in the view:
* var path = new Path.Circle({
* center: Point.random() * view.size,
* radius: 25,
* fillColor: 'black',
* strokeColor: 'white'
* });
*
* // When the mouse is double clicked on the item, remove it:
* path.onDoubleClick = function(event) {
* this.remove();
* }
* }
*/
/**
* The function to be called repeatedly while the mouse moves over the item.
* The function receives a {@link MouseEvent} object which contains
* information about the mouse event.
* Note that such mouse events bubble up the scene graph hierarchy and will
* reach the view, unless they are stopped with {@link
* Event#stopPropagation()} or by returning `false` from the handler.
*
* @name Item#onMouseMove
* @property
* @type ?Function
* @see View#onMouseMove
*
* @example {@paperscript}
* // Move over the circle shaped path, to change its opacity:
*
* // Create a circle shaped path at the center of the view:
* var path = new Path.Circle({
* center: view.center,
* radius: 25,
* fillColor: 'black'
* });
*
* // When the mouse moves on top of the item, set its opacity
* // to a random value between 0 and 1:
* path.onMouseMove = function(event) {
* this.opacity = Math.random();
* }
*/
/**
* The function to be called when the mouse moves over the item. This
* function will only be called again, once the mouse moved outside of the
* item first. The function receives a {@link MouseEvent} object which
* contains information about the mouse event.
* Note that such mouse events bubble up the scene graph hierarchy and will
* reach the view, unless they are stopped with {@link
* Event#stopPropagation()} or by returning `false` from the handler.
*
* @name Item#onMouseEnter
* @property
* @type ?Function
* @see View#onMouseEnter
*
* @example {@paperscript}
* // When you move the mouse over the item, its fill color is set to red.
* // When you move the mouse outside again, its fill color is set back
* // to black.
*
* // Create a circle shaped path at the center of the view:
* var path = new Path.Circle({
* center: view.center,
* radius: 25,
* fillColor: 'black'
* });
*
* // When the mouse enters the item, set its fill color to red:
* path.onMouseEnter = function(event) {
* this.fillColor = 'red';
* }
*
* // When the mouse leaves the item, set its fill color to black:
* path.onMouseLeave = function(event) {
* this.fillColor = 'black';
* }
* @example {@paperscript}
* // When you click the mouse, you create new circle shaped items. When you
* // move the mouse over the item, its fill color is set to red. When you
* // move the mouse outside again, its fill color is set back
* // to black.
*
* function enter(event) {
* this.fillColor = 'red';
* }
*
* function leave(event) {
* this.fillColor = 'black';
* }
*
* // When the mouse is pressed:
* function onMouseDown(event) {
* // Create a circle shaped path at the position of the mouse:
* var path = new Path.Circle(event.point, 25);
* path.fillColor = 'black';
*
* // When the mouse enters the item, set its fill color to red:
* path.onMouseEnter = enter;
*
* // When the mouse leaves the item, set its fill color to black:
* path.onMouseLeave = leave;
* }
*/
/**
* The function to be called when the mouse moves out of the item.
* The function receives a {@link MouseEvent} object which contains
* information about the mouse event.
* Note that such mouse events bubble up the scene graph hierarchy and will
* reach the view, unless they are stopped with {@link
* Event#stopPropagation()} or by returning `false` from the handler.
*
* @name Item#onMouseLeave
* @property
* @type ?Function
* @see View#onMouseLeave
*
* @example {@paperscript}
* // Move the mouse over the circle shaped path and then move it out
* // of it again to set its fill color to red:
*
* // Create a circle shaped path at the center of the view:
* var path = new Path.Circle({
* center: view.center,
* radius: 25,
* fillColor: 'black'
* });
*
* // When the mouse leaves the item, set its fill color to red:
* path.onMouseLeave = function(event) {
* this.fillColor = 'red';
* }
*/
/**
* {@grouptitle Event Handling}
*
* Attaches an event handler to the item.
*
* @name Item#on
* @function
* @param {String} type the type of event: {@values 'frame', mousedown',
* 'mouseup', 'mousedrag', 'click', 'doubleclick', 'mousemove',
* 'mouseenter', 'mouseleave'}
* @param {Function} function the function to be called when the event
* occurs, receiving a {@link MouseEvent} or {@link Event} object as its
* sole argument
* @return {Item} this item itself, so calls can be chained
* @chainable
*
* @example {@paperscript}
* // Change the fill color of the path to red when the mouse enters its
* // shape and back to black again, when it leaves its shape.
*
* // Create a circle shaped path at the center of the view:
* var path = new Path.Circle({
* center: view.center,
* radius: 25,
* fillColor: 'black'
* });
*
* // When the mouse enters the item, set its fill color to red:
* path.on('mouseenter', function() {
* this.fillColor = 'red';
* });
*
* // When the mouse leaves the item, set its fill color to black:
* path.on('mouseleave', function() {
* this.fillColor = 'black';
* });
*/
/**
* Attaches one or more event handlers to the item.
*
* @name Item#on
* @function
* @param {Object} object an object containing one or more of the following
* properties: {@values frame, mousedown, mouseup, mousedrag, click,
* doubleclick, mousemove, mouseenter, mouseleave}
* @return {Item} this item itself, so calls can be chained
* @chainable
*
* @example {@paperscript}
* // Change the fill color of the path to red when the mouse enters its
* // shape and back to black again, when it leaves its shape.
*
* // Create a circle shaped path at the center of the view:
* var path = new Path.Circle({
* center: view.center,
* radius: 25
* });
* path.fillColor = 'black';
*
* // When the mouse enters the item, set its fill color to red:
* path.on({
* mouseenter: function(event) {
* this.fillColor = 'red';
* },
* mouseleave: function(event) {
* this.fillColor = 'black';
* }
* });
* @example {@paperscript}
* // When you click the mouse, you create new circle shaped items. When you
* // move the mouse over the item, its fill color is set to red. When you
* // move the mouse outside again, its fill color is set black.
*
* var pathHandlers = {
* mouseenter: function(event) {
* this.fillColor = 'red';
* },
* mouseleave: function(event) {
* this.fillColor = 'black';
* }
* }
*
* // When the mouse is pressed:
* function onMouseDown(event) {
* // Create a circle shaped path at the position of the mouse:
* var path = new Path.Circle({
* center: event.point,
* radius: 25,
* fillColor: 'black'
* });
*
* // Attach the handers inside the object literal to the path:
* path.on(pathHandlers);
* }
*/
/**
* Detach an event handler from the item.
*
* @name Item#off
* @function
* @param {String} type the type of event: {@values 'frame', mousedown',
* 'mouseup', 'mousedrag', 'click', 'doubleclick', 'mousemove',
* 'mouseenter', 'mouseleave'}
* @param {Function} function the function to be detached
* @return {Item} this item itself, so calls can be chained
* @chainable
*/
/**
* Detach one or more event handlers to the item.
*
* @name Item#off
* @function
* @param {Object} object an object containing one or more of the following
* properties: {@values frame, mousedown, mouseup, mousedrag, click,
* doubleclick, mousemove, mouseenter, mouseleave}
* @return {Item} this item itself, so calls can be chained
* @chainable
*/
/**
* Emit an event on the item.
*
* @name Item#emit
* @function
* @param {String} type the type of event: {@values 'frame', mousedown',
* 'mouseup', 'mousedrag', 'click', 'doubleclick', 'mousemove',
* 'mouseenter', 'mouseleave'}
* @param {Object} event an object literal containing properties describing
* the event
* @return {Boolean} {@true if the event had listeners}
*/
/**
* Check if the item has one or more event handlers of the specified type.
*
* @name Item#responds
* @function
* @param {String} type the type of event: {@values 'frame', mousedown',
* 'mouseup', 'mousedrag', 'click', 'doubleclick', 'mousemove',
* 'mouseenter', 'mouseleave'}
* @return {Boolean} {@true if the item has one or more event handlers of
* the specified type}
*/
/**
* Private method that sets Path related styles on the canvas context.
* Not defined in Path as it is required by other classes too,
* e.g. PointText.
*/
_setStyles: function (ctx, param, viewMatrix) {
// We can access internal properties since we're only using this on
// items without children, where styles would be merged.
var style = this._style,
matrix = this._matrix;
if (style.hasFill()) {
ctx.fillStyle = style.getFillColor().toCanvasStyle(ctx, matrix);
}
if (style.hasStroke()) {
ctx.strokeStyle = style.getStrokeColor().toCanvasStyle(ctx, matrix);
ctx.lineWidth = style.getStrokeWidth();
var strokeJoin = style.getStrokeJoin(),
strokeCap = style.getStrokeCap(),
miterLimit = style.getMiterLimit();
if (strokeJoin) ctx.lineJoin = strokeJoin;
if (strokeCap) ctx.lineCap = strokeCap;
if (miterLimit) ctx.miterLimit = miterLimit;
if (ref.paper.support.nativeDash) {
var dashArray = style.getDashArray(),
dashOffset = style.getDashOffset();
if (dashArray && dashArray.length) {
if ('setLineDash' in ctx) {
ctx.setLineDash(dashArray);
ctx.lineDashOffset = dashOffset;
} else {
ctx.mozDash = dashArray;
ctx.mozDashOffset = dashOffset;
}
}
}
}
if (style.hasShadow()) {
// In Canvas, shadows unfortunately ignore all transformations
// completely. As almost no browser supports ctx.currentTransform,
// we need to calculate our own here, and then use it to transform
// the shadow-blur and offset accordingly.
var pixelRatio = param.pixelRatio || 1,
mx = viewMatrix._shiftless().prepend(new Matrix().scale(pixelRatio, pixelRatio)),
// Transform the blur value as a vector and use its new length:
blur = mx.transform(new Point(style.getShadowBlur(), 0)),
offset = mx.transform(this.getShadowOffset());
ctx.shadowColor = style.getShadowColor().toCanvasStyle(ctx);
ctx.shadowBlur = blur.getLength();
ctx.shadowOffsetX = offset.x;
ctx.shadowOffsetY = offset.y;
}
},
draw: function (ctx, param, parentStrokeMatrix) {
// Each time the project gets drawn, it's _updateVersion is increased.
// Keep the _updateVersion of drawn items in sync, so we have an easy
// way to know for which selected items we need to draw selection info.
var updateVersion = (this._updateVersion = this._project._updateVersion);
// Now bail out if no actual drawing is required.
if (!this._visible || this._opacity === 0) return;
// Keep calculating the current global matrix, by keeping a history
// and pushing / popping as we go along.
var matrices = param.matrices,
viewMatrix = param.viewMatrix,
matrix = this._matrix,
globalMatrix = matrices[matrices.length - 1].appended(matrix);
// If this item is not invertible, do not draw it. It appears to be a
// good idea generally to not draw in such circumstances, e.g. SVG
// handles it the same way.
if (!globalMatrix.isInvertible()) return;
// Since globalMatrix does not take the view's matrix into account (we
// could have multiple views with different zooms), we may have to
// prepend the view's matrix.
// NOTE: viewMatrix is only provided if it isn't the identity matrix.
viewMatrix = viewMatrix ? viewMatrix.appended(globalMatrix) : globalMatrix;
// Only keep track of transformation if told so. See Project#draw()
matrices.push(globalMatrix);
if (param.updateMatrix) {
this._globalMatrix = globalMatrix;
}
// If the item has a blendMode or is defining an opacity, draw it on
// a temporary canvas first and composite the canvas afterwards.
// Paths with an opacity < 1 that both define a fillColor
// and strokeColor also need to be drawn on a temporary canvas
// first, since otherwise their stroke is drawn half transparent
// over their fill.
// Exclude Raster items since they never draw a stroke and handle
// opacity by themselves (they also don't call _setStyles)
var blendMode = this._blendMode,
opacity = Numerical.clamp(this._opacity, 0, 1),
normalBlend = blendMode === 'normal',
nativeBlend = ref.BlendMode.nativeModes[blendMode],
// Determine if we can draw directly, or if we need to draw into a
// separate canvas and then composite onto the main canvas.
direct =
(normalBlend && opacity === 1) ||
param.dontStart || // e.g. CompoundPath
param.clip ||
// If native blending is possible, see if the item allows it
((nativeBlend || (normalBlend && opacity < 1)) && this._canComposite()),
pixelRatio = param.pixelRatio || 1,
mainCtx,
itemOffset,
prevOffset;
if (!direct) {
// Apply the parent's global matrix to the calculation of correct
// bounds.
var bounds = this.getStrokeBounds(viewMatrix);
if (!bounds.width || !bounds.height) {
// Item won't be drawn so its global matrix need to be removed
// from the stack (#1561).
matrices.pop();
return;
}
// Store previous offset and save the main context, so we can
// draw onto it later.
prevOffset = param.offset;
// Floor the offset and ceil the size, so we don't cut off any
// antialiased pixels when drawing onto the temporary canvas.
itemOffset = param.offset = bounds.getTopLeft().floor();
// Set ctx to the context of the temporary canvas, so we draw onto
// it, instead of the mainCtx.
mainCtx = ctx;
// @ts-expect-error = Expected 3 arguments, but got 1
ctx = ref.CanvasProvider.getContext(bounds.getSize().ceil().add(1).multiply(pixelRatio));
if (pixelRatio !== 1) ctx.scale(pixelRatio, pixelRatio);
}
ctx.save();
// Get the transformation matrix for non-scaling strokes.
var strokeMatrix = parentStrokeMatrix
? parentStrokeMatrix.appended(matrix)
: // pass `true` for dontMerge
this._canScaleStroke && !this.getStrokeScaling(true) && viewMatrix,
// If we're drawing into a separate canvas and a clipItem is defined
// for the current rendering loop, we need to draw the clip item
// again.
clip = !direct && param.clipItem,
// If we're drawing with a strokeMatrix, the CTM is reset either way
// so we don't need to set it, except when we also have to draw a
// clipItem.
transform = !strokeMatrix || clip;
// If drawing directly, handle opacity and native blending now,
// otherwise we will do it later when the temporary canvas is composited.
if (direct) {
ctx.globalAlpha = opacity;
if (nativeBlend) ctx.globalCompositeOperation = blendMode;
} else if (transform) {
// Translate the context so the topLeft of the item is at (0, 0)
// on the temporary canvas.
ctx.translate(-itemOffset.x, -itemOffset.y);
}
if (transform) {
// Apply viewMatrix when drawing into temporary canvas.
(direct ? matrix : viewMatrix).applyToContext(ctx);
}
if (clip) {
param.clipItem.draw(ctx, param.extend({ clip: true }));
}
if (strokeMatrix) {
// Reset the transformation but take HiDPI pixel ratio into account.
ctx.setTransform(pixelRatio, 0, 0, pixelRatio, 0, 0);
// Also offset again when drawing non-directly.
// NOTE: Don't use itemOffset since offset might be from the parent,
// e.g. CompoundPath
var offset = param.offset;
if (offset) ctx.translate(-offset.x, -offset.y);
}
this._draw(ctx, param, viewMatrix, strokeMatrix);
ctx.restore();
matrices.pop();
if (param.clip && !param.dontFinish) {
// Pass fill-rule to handle clipping with compound-paths (#1361).
ctx.clip(this.getFillRule());
}
// If a temporary canvas was created, composite it onto the main canvas:
if (!direct) {
// Use BlendMode.process even for processing normal blendMode with
// opacity.
ref.BlendMode.process(
blendMode,
ctx,
mainCtx,
opacity,
// Calculate the pixel offset of the temporary canvas to the
// main canvas. We also need to factor in the pixel-ratio.
itemOffset.subtract(prevOffset).multiply(pixelRatio)
);
// Return the temporary context, so it can be reused
ref.CanvasProvider.release(ctx);
// Restore previous offset.
param.offset = prevOffset;
}
},
/**
* Checks the _updateVersion of the item to see if it got drawn in the draw
* loop. If the version is out of sync, the item is either not in the scene
* graph anymore or is invisible.
*/
_isUpdated: function (updateVersion) {
var parent = this._parent;
// For compound-paths, use the _updateVersion of the parent, because the
// shape gets drawn at once at might get cached (e.g. Path2D soon).
if (parent instanceof ref.CompoundPath) return parent._isUpdated(updateVersion);
// In case a parent is visible but isn't drawn (e.g. opacity == 0), the
// _updateVersion of all its children will not be updated, but the
// children should still be considered updated, and selections should be
// drawn for them. Excluded are only items with _visible == false:
var updated = this._updateVersion === updateVersion;
if (!updated && parent && parent._visible && parent._isUpdated(updateVersion)) {
this._updateVersion = updateVersion;
updated = true;
}
return updated;
},
_drawSelection: function (ctx, matrix, size, selectionItems, updateVersion) {
var selection = this._selection,
itemSelected = selection & /*#=*/ ItemSelection.ITEM,
boundsSelected = selection & /*#=*/ ItemSelection.BOUNDS || (itemSelected && this._selectBounds),
positionSelected = selection & /*#=*/ ItemSelection.POSITION;
// @ts-expect-error = 'boolean' is not assignable to type 'number'
if (!this._drawSelected) itemSelected = false;
if ((itemSelected || boundsSelected || positionSelected) && this._isUpdated(updateVersion)) {
// Allow definition of selected color on a per item and per
// layer level, with a fallback to #009dec
var layer,
color = this.getSelectedColor(true) || ((layer = this.getLayer()) && layer.getSelectedColor(true)),
mx = matrix.appended(this.getGlobalMatrix(true)),
half = size / 2;
ctx.strokeStyle = ctx.fillStyle = color ? color.toCanvasStyle(ctx) : '#009dec';
if (itemSelected) this._drawSelected(ctx, mx, selectionItems);
if (positionSelected) {
// Convert position from the parent's coordinates system to the
// global one:
var pos = this.getPosition(true),
parent = this._parent,
point = parent ? parent.localToGlobal(pos) : pos,
x = point.x,
y = point.y;
ctx.beginPath();
ctx.arc(x, y, half, 0, Math.PI * 2, true);
ctx.stroke();
var deltas = [
[0, -1],
[1, 0],
[0, 1],
[-1, 0],
],
start = half,
end = size + 1;
for (var i = 0; i < 4; i++) {
var delta = deltas[i],
dx = delta[0],
dy = delta[1];
ctx.moveTo(x + dx * start, y + dy * start);
ctx.lineTo(x + dx * end, y + dy * end);
ctx.stroke();
}
}
if (boundsSelected) {
var coords = mx._transformCorners(this.getInternalBounds());
// Now draw a rectangle that connects the transformed
// bounds corners, and draw the corners.
ctx.beginPath();
for (var i = 0; i < 8; i++) {
ctx[!i ? 'moveTo' : 'lineTo'](coords[i], coords[++i]);
}
ctx.closePath();
ctx.stroke();
for (var i = 0; i < 8; i++) {
ctx.fillRect(coords[i] - half, coords[++i] - half, size, size);
}
}
}
},
_canComposite: function () {
return false;
},
},
Base.each(
['down', 'drag', 'up', 'move'],
function (key) {
this['removeOn' + Base.capitalize(key)] = function () {
var hash = {};
hash[key] = true;
return this.removeOn(hash);
};
},
/** @lends Item# */ {
/**
* {@grouptitle Remove On Event}
*
* Removes the item when the events specified in the passed options object
* occur.
*
* @option options.move {Boolean) remove the item when the next {@link
* Tool#onMouseMove} event is fired.
*
* @option options.drag {Boolena) remove the item when the next {@link
* Tool#onMouseDrag} event is fired.
*
* @option options.down {Boolean) remove the item when the next {@link
* Tool#onMouseDown} event is fired.
*
* @option options.up {Boolean) remove the item when the next {@link
* Tool#onMouseUp} event is fired.
*
* @name Item#removeOn
* @function
* @param {Object} options
*
* @example {@paperscript height=200}
* // Click and drag below:
* function onMouseDrag(event) {
* // Create a circle shaped path at the mouse position,
* // with a radius of 10:
* var path = new Path.Circle({
* center: event.point,
* radius: 10,
* fillColor: 'black'
* });
*
* // Remove the path on the next onMouseDrag or onMouseDown event:
* path.removeOn({
* drag: true,
* down: true
* });
* }
*/
/**
* Removes the item when the next {@link Tool#onMouseMove} event is fired.
*
* @name Item#removeOnMove
* @function
*
* @example {@paperscript height=200}
* // Move your mouse below:
* function onMouseMove(event) {
* // Create a circle shaped path at the mouse position,
* // with a radius of 10:
* var path = new Path.Circle({
* center: event.point,
* radius: 10,
* fillColor: 'black'
* });
*
* // On the next move event, automatically remove the path:
* path.removeOnMove();
* }
*/
/**
* Removes the item when the next {@link Tool#onMouseDown} event is fired.
*
* @name Item#removeOnDown
* @function
*
* @example {@paperscript height=200}
* // Click a few times below:
* function onMouseDown(event) {
* // Create a circle shaped path at the mouse position,
* // with a radius of 10:
* var path = new Path.Circle({
* center: event.point,
* radius: 10,
* fillColor: 'black'
* });
*
* // Remove the path, next time the mouse is pressed:
* path.removeOnDown();
* }
*/
/**
* Removes the item when the next {@link Tool#onMouseDrag} event is fired.
*
* @name Item#removeOnDrag
* @function
*
* @example {@paperscript height=200}
* // Click and drag below:
* function onMouseDrag(event) {
* // Create a circle shaped path at the mouse position,
* // with a radius of 10:
* var path = new Path.Circle({
* center: event.point,
* radius: 10,
* fillColor: 'black'
* });
*
* // On the next drag event, automatically remove the path:
* path.removeOnDrag();
* }
*/
/**
* Removes the item when the next {@link Tool#onMouseUp} event is fired.
*
* @name Item#removeOnUp
* @function
*
* @example {@paperscript height=200}
* // Click a few times below:
* function onMouseDown(event) {
* // Create a circle shaped path at the mouse position,
* // with a radius of 10:
* var path = new Path.Circle({
* center: event.point,
* radius: 10,
* fillColor: 'black'
* });
*
* // Remove the path, when the mouse is released:
* path.removeOnUp();
* }
*/
// TODO: implement Item#removeOnFrame
removeOn: function (obj) {
for (var name in obj) {
if (obj[name]) {
var key = 'mouse' + name,
project = this._project,
sets = (project._removeSets = project._removeSets || {});
sets[key] = sets[key] || {};
sets[key][this._id] = this;
}
}
return this;
},
}
),
/** @lends Item# */ {
/**
* {@grouptitle Tweening Functions}
*
* Tween item between two states.
*
* @name Item#tween
*
* @option options.duration {Number} the duration of the tweening
* @option [options.easing='linear'] {Function|String} an easing function or the type
* of the easing: {@values 'linear' 'easeInQuad' 'easeOutQuad'
* 'easeInOutQuad' 'easeInCubic' 'easeOutCubic' 'easeInOutCubic'
* 'easeInQuart' 'easeOutQuart' 'easeInOutQuart' 'easeInQuint'
* 'easeOutQuint' 'easeInOutQuint'}
* @option [options.start=true] {Boolean} whether to start tweening automatically
*
* @function
* @param {Object} from the state at the start of the tweening
* @param {Object} to the state at the end of the tweening
* @param {Object|Number} options the options or the duration
* @return {Tween}
*
* @example {@paperscript height=100}
* // Tween fillColor:
* var path = new Path.Circle({
* radius: view.bounds.height * 0.4,
* center: view.center
* });
* path.tween(
* { fillColor: 'blue' },
* { fillColor: 'red' },
* 3000
* );
* @example {@paperscript height=100}
* // Tween rotation:
* var path = new Shape.Rectangle({
* fillColor: 'red',
* center: [50, view.center.y],
* size: [60, 60]
* });
* path.tween({
* rotation: 180,
* 'position.x': view.bounds.width - 50,
* 'fillColor.hue': '+= 90'
* }, {
* easing: 'easeInOutCubic',
* duration: 2000
* });
*/
/**
* Tween item to a state.
*
* @name Item#tween
*
* @function
* @param {Object} to the state at the end of the tweening
* @param {Object|Number} options the options or the duration
* @return {Tween}
*
* @example {@paperscript height=200}
* // Tween a nested property with relative values
* var path = new Path.Rectangle({
* size: [100, 100],
* position: view.center,
* fillColor: 'red',
* });
*
* var delta = { x: path.bounds.width / 2, y: 0 };
*
* path.tween({
* 'segments[1].point': ['+=', delta],
* 'segments[2].point.x': '-= 50'
* }, 3000);
*
* @see Item#tween(from, to, options)
*/
/**
* Tween item.
*
* @name Item#tween
*
* @function
* @param {Object|Number} options the options or the duration
* @return {Tween}
*
* @see Item#tween(from, to, options)
*
* @example {@paperscript height=100}
* // Start an empty tween and just use the update callback:
* var path = new Path.Circle({
* fillColor: 'blue',
* radius: view.bounds.height * 0.4,
* center: view.center,
* });
* var pathFrom = path.clone({ insert: false })
* var pathTo = new Path.Rectangle({
* position: view.center,
* rectangle: path.bounds,
* insert: false
* });
* path.tween(2000).onUpdate = function(event) {
* path.interpolate(pathFrom, pathTo, event.factor)
* };
*/
tween: function (from, to, options) {
if (!options) {
// If there are only two or one arguments, shift arguments to the
// left by one (omit `from`):
options = to;
to = from;
from = null;
if (!options) {
options = to;
to = null;
}
}
var easing = options && options.easing,
start = options && options.start,
duration = options != null && (typeof options === 'number' ? options : options.duration),
tween = new ref.Tween(this, from, to, duration, easing, start);
function onFrame(event) {
tween._handleFrame(event.time * 1000);
if (!tween.running) {
this.off('frame', onFrame);
}
}
if (duration) {
this.on('frame', onFrame);
}
return tween;
},
/**
*
* Tween item to a state.
*
* @function
* @param {Object} to the state at the end of the tweening
* @param {Object|Number} options the options or the duration
* @return {Tween}
*
* @see Item#tween(to, options)
*/
tweenTo: function (to, options) {
return this.tween(null, to, options);
},
/**
*
* Tween item from a state to its state before the tweening.
*
* @function
* @param {Object} from the state at the start of the tweening
* @param {Object|Number} options the options or the duration
* @return {Tween}
*
* @see Item#tween(from, to, options)
*
* @example {@paperscript height=100}
* // Tween fillColor from red to the path's initial fillColor:
* var path = new Path.Circle({
* fillColor: 'blue',
* radius: view.bounds.height * 0.4,
* center: view.center
* });
* path.tweenFrom({ fillColor: 'red' }, { duration: 1000 });
*/
tweenFrom: function (from, options) {
return this.tween(from, null, options);
},
}
);
ref.Item = Item;
|