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
|
/*++
Copyright (C) 2018 3MF Consortium
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Abstract: Interface Exports for plain C DLLs.
--*/
#ifndef __NMR_DLLINTERFACES
#define __NMR_DLLINTERFACES
#ifndef NMR_COM_NATIVE
#include "Common/Platform/NMR_COM_Emulation.h"
#else
#include "Common/Platform/NMR_COM_Native.h"
#endif
#include "Common/Platform/NMR_SAL.h"
#include "Common/Platform/NMR_WinTypes.h"
#include "Model/Classes/NMR_ModelTypes.h"
#include "Common/3MF_ProgressTypes.h"
#include "Model/COM/NMR_COMVersion.h"
namespace NMR {
extern "C" {
// Define void "class pointers" for piping through the plain C interface
typedef void * PLib3MFBase;
typedef PLib3MFBase PLib3MFModel;
typedef PLib3MFBase PLib3MFModelWriter;
typedef PLib3MFBase PLib3MFModelReader;
typedef PLib3MFBase PLib3MFModelResource;
typedef PLib3MFBase PLib3MFModelResourceIterator;
typedef PLib3MFBase PLib3MFModelObjectResource;
typedef PLib3MFBase PLib3MFModelMeshObject;
typedef PLib3MFBase PLib3MFModelComponentsObject;
typedef PLib3MFBase PLib3MFModelComponent;
typedef PLib3MFBase PLib3MFModelBuildItem;
typedef PLib3MFBase PLib3MFModelBuildItemIterator;
typedef PLib3MFBase PLib3MFDefaultPropertyHandler;
typedef PLib3MFBase PLib3MFPropertyHandler;
typedef PLib3MFBase PLib3MFModelBaseMaterial;
typedef PLib3MFBase PLib3MFModelTextureAttachment;
typedef PLib3MFBase PLib3MFModelTexture2D;
typedef PLib3MFBase PLib3MFModelAttachment;
typedef PLib3MFBase PLib3MFModelMeshBeamSet;
typedef PLib3MFBase PLib3MFSlice;
typedef PLib3MFBase PLib3MFSliceStack;
typedef PLib3MFBase PLib3mfSlicePolygon;
typedef BOOL(*PLib3MFModelWriterCallback)(_In_ const BYTE * pData, _In_ const DWORD cbBytes, _In_ const void * pUserData);
// Base functions
/**
* retrieves the current version of the 3MF implementation and specification
*
* @param[out] pMajorVersion returns the major version of the Specification
* @param[out] pMinorVersion returns the minor version of the Specification
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_getspecversion(_Out_ DWORD * pMajorVersion, _Out_ DWORD * pMinorVersion);
/**
* retrieves the current interface version of the library (build version)
* this version will increment with each release of the library, and should
* be used to ensure API compatibility.
*
* Lib3MF's API is stable in the following way:
* - Lib3MF-libraries with different major version are not guaranteed to be compatible
* - Lib3MF-libraries with matching major version and different minor versions are backwards compatible:
* A consumer who compiled against the API of version A.B can safely use the binary of version A.C for C>=B.
* I.e., functions will not be removed within the range of a constant major version.
* - Lib3MF-libraries with matching values of both major and minor version have an identical API.
*
* @param[out] pInterfaceVersionMajor returns the major version of the shared library
* @param[out] pInterfaceVersionMinor returns the minor version of the shared library
* @param[out] pInterfaceVersionMicro returns the patch version of the shared library
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_getinterfaceversion(_Out_ DWORD * pInterfaceVersionMajor, _Out_ DWORD * pInterfaceVersionMinor, _Out_ DWORD * pInterfaceVersionMicro);
/**
* checks whether a extension is supported by the DLL and which version of the interface is used
* This extension version will increment with each change of the API of the extension
* and may be used to ensure API compatibility.
*
* @param[in] pwszExtensionUrl URL of extension to check
* @param[out] pbIsSupported returns whether the extension is supported or not
* @param[out] pExtensionInterfaceVersion returns the interface version of of the extensions (if extension is supported)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_queryextension(_In_z_ LPCWSTR pwszExtensionUrl, _Out_ BOOL * pbIsSupported, _Out_opt_ DWORD * pExtensionInterfaceVersion);
/**
* checks whether a extension is supported by the DLL and which version of the interface is used
* This extension version will increment with each change of the API of the extension
* and may be used to ensure API compatibility.
*
* @param[in] pszExtensionUrl URL of extension to check as UTF8 string
* @param[out] pbIsSupported returns whether the extension is supported or not
* @param[out] pExtensionInterfaceVersion returns the interface version of of the extensions (if extension is supported)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_queryextensionutf8(_In_z_ LPCSTR pszExtensionUrl, _Out_ BOOL * pbIsSupported, _Out_opt_ DWORD * pExtensionInterfaceVersion);
/**
* Return an English text for a progress identifier
* Note: this is the only function you can call from your callback function.
*
* @param[in] progressIdentifier the progress identifier that is passed to the callback function
* @param[out] progressMessage English text for the progress identifier
* @return error code or 0 (success)
**/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_retrieveprogressmessage(_In_ ProgressIdentifier progressIdentifier, _Out_ LPCSTR * progressMessage);
/**
* creates an empty model instance
*
* @param[out] ppModel returns created model instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_createmodel(_Outptr_ PLib3MFModel ** ppModel);
/**
* Frees all memory of any object instance.
*
* @param[out] pInstance Object to free memory of.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_release(_In_ PLib3MFBase * pInstance);
/**
* Returns detailed information of the last known error an object method.
* The error information is available for every method returning a LIB3MF_FAILED
* constant.
*
* @param[out] pInstance Object instance.
* @param[out] pErrorCode Error Code
* @param[out] pErrorMessage Returns pointer to the error message string, NULL if no error.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_getlasterror(_In_ PLib3MFBase * pInstance, _Out_ DWORD * pErrorCode, _Outptr_opt_ LPCSTR * pErrorMessage);
// Reader/Writer
/**
* Writes out the model as file. The file type is specified by the Model Writer class
*
* @param[in] pWriter Writer Instance
* @param[in] pwszFilename Filename to write into as UTF16 string
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_writer_writetofile(_In_ PLib3MFModelWriter * pWriter, _In_z_ LPCWSTR pwszFilename);
/**
* Writes out the model as file. The file type is specified by the Model Writer class
*
* @param[in] pWriter Writer Instance
* @param[in] pszFilename Filename to write into as UTF8 string
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_writer_writetofileutf8(_In_ PLib3MFModelWriter * pWriter, _In_z_ LPCSTR pszFilename);
/**
* Retrieves the size of the 3MF stream.
*
* @param[in] pWriter Writer Instance
* @param[out] pcbStreamSize Returns the stream size
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_writer_getstreamsize(_In_ PLib3MFModelWriter * pWriter, _Out_ ULONG64 * pcbStreamSize);
/**
* Writes out the 3mf into a buffer. Buffer size must be at least the size of the stream.
*
* @param[in] pWriter 3MF Writer Instance
* @param[out] pBuffer Buffer to write into
* @param[in] cbBufferSize Size of the buffer in bytes
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_writer_writetobuffer(_In_ PLib3MFModelWriter * pWriter, _Out_ BYTE * pBuffer, _In_ ULONG64 cbBufferSize);
/**
* Writes out the model and passes the data to a provided callback function. The file type is specified by the Model Writer class
*
* @param[in] pWriter Writer Instance
* @param[in] pWriteCallback Callback to call for writing a data chunk.
* @param[in] pSeekCallback Callback to call for seeking in the streamk.
* @param[in] pUserData Userdata that is passed to the callback function
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_writer_writetocallback(_In_ PLib3MFModelWriter * pWriter, _In_ void * pWriteCallback, _In_ void * pSeekCallback, _In_opt_ void * pUserData);
/**
* Set the progress callback for calls to this writer
*
* @param[in] pWriter Writer Instance
* @param[in] callback pointer to the callback function. If the callback returns
* "false" the original function call will be aborted and set the error to
* NMR_USERABORTED.
* @param[in] userData pointer to arbitrary user data that is passed without modification
* to the callback.
* @return error code or 0 (success)
**/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_writer_setprogresscallback(_In_ PLib3MFModelWriter * pWriter, _In_ Lib3MFProgressCallback callback, void* userData);
/**
* Reads a model from a file. The file type is specified by the Model Read class
*
* @param[in] pReader Reader Instance
* @param[in] pwszFilename Filename to read from
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_reader_readfromfile(_In_ PLib3MFModelReader * pReader, _In_z_ LPCWSTR pwszFilename);
/**
* Reads a model from a file. The file type is specified by the Model Read class
*
* @param[in] pReader Reader Instance
* @param[in] pszFilename Filename to read from
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_reader_readfromfileutf8(_In_ PLib3MFModelReader * pReader, _In_z_ LPCSTR pszFilename);
/**
* Adds a relationship type which shall be read as attachment in memory while loading
*
* @param[in] pReader Reader Instance
* @param[in] pwszRelationshipType String of the relationship type (UTF16)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_reader_addrelationtoread (_In_ PLib3MFModelReader * pReader, _In_z_ LPCWSTR pwszRelationshipType);
/**
* Removes a relationship type which shall be read as attachment in memory while loading
*
* @param[in] pReader Reader Instance
* @param[in] pwszRelationshipType String of the relationship type (UTF16)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_reader_removerelationtoread (_In_ PLib3MFModelReader * pReader, _In_z_ LPCWSTR pwszRelationshipType);
/**
* Adds a relationship type which shall be read as attachment in memory while loading
*
* @param[in] pReader Reader Instance
* @param[in] pszRelationshipType String of the relationship type (UTF8)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_reader_addrelationtoreadutf8(_In_ PLib3MFModelReader * pReader, _In_z_ LPCSTR pszRelationshipType);
/**
* Remove a relationship type which shall be read as attachment in memory while loading
*
* @param[in] pReader Reader Instance
* @param[in] pszRelationshipType String of the relationship type (UTF8)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_reader_removerelationtoreadutf8(_In_ PLib3MFModelReader * pReader, _In_z_ LPCSTR pszRelationshipType);
/**
* Activates (deactivates) the strict mode of the reader.
* If active, all warnings are reported as errors. Otherwise, they are reported as warnings. By default, it is deactivated.
*
* @param[in] pReader Reader Instance
* @param[in] bStrictModeActive flag whether strict mode is active or not
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_reader_setstrictmodeactive(_In_ PLib3MFModelReader * pReader, _In_ BOOL bStrictModeActive);
/**
* Queries whether the strict mode of the reader is active or not
*
* @param[in] pReader Reader Instance
* @param[out] pbStrictModeActive flag whether strict mode is active or not
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_reader_getstrictmodeactive(_In_ PLib3MFModelReader * pReader, _In_ BOOL *pbStrictModeActive);
/**
* Reads a model from a memory buffer. The file type is specified by the Model Read class
*
* @param[in] pReader Reader Instance
* @param[in] pBuffer Buffer to read from
* @param[in] cbBufferSize Size of the buffer in bytes
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_reader_readfrombuffer(_In_ PLib3MFModelReader * pReader, _In_ BYTE * pBuffer, _In_ ULONG64 cbBufferSize);
/**
* Reads a model and from the data provided by a callback function. The file type is specified by the Model Writer class
*
* @param[in] pReader Reader Instance
* @param[in] pReadCallback Callback to call for reading a data chunk.
* @param[in] nStreamSize number of bytes the callback returns
* @param[in] pSeekCallback Callback to call for seeking in the stream.
* @param[in] pUserData Userdata that is passed to the callback function
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_reader_readfromcallback(_In_ PLib3MFModelReader * pReader, _In_ ULONG64 nStreamSize, _In_ void * pReadCallback, _In_opt_ void * pSeekCallback, _In_opt_ void * pUserData);
/**
* Returns Warning and Error Count of the read process
*
* @param[in] pReader Reader Instance
* @param[out] pnWarningCount filled with the count of the occurred warnings.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_reader_getwarningcount(_In_ PLib3MFModelReader * pReader, _Out_ DWORD * pnWarningCount);
/**
* Returns Warning and Error Information of the read process
*
* @param[in] pReader Reader Instance
* @param[in] nIndex Index of the Warning. Valid values are 0 to WarningCount - 1
* @param[out] pErrorCode filled with the error code of the warning
* @param[out] pwszBuffer filled with the error message, may be NULL
* @param[in] cbBufferSize size of pwszBuffer (including trailing 0).
* @param[out] pcbNeededChars filled with the count of the written bytes, or needed buffer size.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_reader_getwarning(_In_ PLib3MFModelReader * pReader, _In_ DWORD nIndex, _Out_ DWORD * pErrorCode, _Out_ LPWSTR pwszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* Returns Warning and Error Information of the read process (UTF8)
*
* @param[in] pReader Reader Instance
* @param[in] nIndex Index of the Warning. Valid values are 0 to WarningCount - 1
* @param[out] pErrorCode filled with the error code of the warning
* @param[out] pszBuffer filled with the error message, may be NULL
* @param[in] cbBufferSize size of pszBuffer (including trailing 0).
* @param[out] pcbNeededChars filled with the count of the written bytes, or needed buffer size.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_reader_getwarningutf8(_In_ PLib3MFModelReader * pReader, _In_ DWORD nIndex, _Out_ DWORD * pErrorCode, _Out_opt_ LPSTR pszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* Set the progress callback for calls to this reader
*
* @param[in] pReader Reader Instance
* @param[in] callback pointer to the callback function. If the callback returns
* "false" the original function call will be aborted and set the error to
* NMR_USERABORTED.
* @param[in] userData pointer to arbitrary user data that is passed without modification
* to the callback.
* @return error code or 0 (success)
**/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_reader_setprogresscallback(_In_ PLib3MFModelReader * pReader, _In_ Lib3MFProgressCallback callback, void* userData);
// Resources
/**
* Retrieves the ID of a Model Resource Instance
*@param[in] pResource Resource Instance
* @param[out] pnResourceID Filled with the ID of the Resource Instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_resource_getresourceid(_In_ PLib3MFModelResource * pResource, _Out_ DWORD * pnResourceID);
/**
* Iterates to the next resource in the list.
*
* @param[in] pIterator Iterator Instance
* @param[out] pbHasNext returns, if there is a resource to use.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_resourceiterator_movenext(_In_ PLib3MFModelResourceIterator * pIterator, _Out_ BOOL * pbHasNext);
/**
* Iterates to the previous resource in the list.
*
* @param[in] pIterator Iterator Instance
* @param[out] pbHasPrevious returns, if there is a resource to use.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_resourceiterator_moveprevious(_In_ PLib3MFModelResourceIterator * pIterator, _Out_ BOOL * pbHasPrevious);
/**
* Returns the resource the iterator points at.
*
* @param[in] pIterator Iterator Instance
* @param[out] ppResourceInstance returns the resource instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_resourceiterator_getcurrent(_In_ PLib3MFModelResourceIterator * pIterator, _Outptr_ PLib3MFModelResource ** ppResourceInstance);
/**
* Creates a new resource iterator with the same resource list.
*
* @param[in] pIterator Iterator Instance
* @param[out] ppIterator returns the cloned Iterator instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_resourceiterator_clone(_In_ PLib3MFModelResourceIterator * pIterator, _Outptr_ PLib3MFModelResourceIterator ** ppIterator);
/**
* Removes all properties of a specific triangle.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] nIndex Index of the triangle (0 to trianglecount - 1)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_propertyhandler_removeproperty(_In_ PLib3MFPropertyHandler * pPropertyHandler, _In_ DWORD nIndex);
/**
* Removes all properties of the triangle mesh.
*
* @param[in] pPropertyHandler Property Handler
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_propertyhandler_removeallproperties(_In_ PLib3MFPropertyHandler * pPropertyHandler);
/**
* Returns the property type of the specific triangle
*
* @param[in] pPropertyHandler Property Handler
* @param[in] nIndex Index of the triangle (0 to trianglecount - 1)
* @param[out] pnPropertyType Returns the property type of the triangle
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_propertyhandler_getpropertytype(_In_ PLib3MFPropertyHandler * pPropertyHandler, _In_ DWORD nIndex, _Out_ eModelPropertyType * pnPropertyType);
/**
* Returns the base material of a specific triangle.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] nIndex Index of the triangle (0 to trianglecount - 1)
* @param[out] pnMaterialGroupID returns the material group id, per triangle. A return group id of 0 means either no property at all or a non-material property.
* @param[out] pnMaterialIndex returns the material index, per triangle. Returns 0, if no base material is assigned.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_propertyhandler_getbasematerial(_In_ PLib3MFPropertyHandler * pPropertyHandler, _In_ DWORD nIndex, _Out_ DWORD * pnMaterialGroupID, _Out_ DWORD * pnMaterialIndex);
/**
* Returns the base materials of all triangles.
* If a triangle property is not a material, the returned material group ID will be 0.
*
* @param[in] pPropertyHandler Property Handler
* @param[out] pnMaterialGroupIDs will be filled with the material group ids of the triangles. Array must have trianglecount entries. A return group id of 0 means either no property at all or a non-material property.
* @param[out] pnMaterialIndices will be filled with the material group indices of the triangles. Array must have trianglecount entries.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_propertyhandler_getbasematerialarray(_In_ PLib3MFPropertyHandler * pPropertyHandler, _Out_ DWORD * pnMaterialGroupIDs, _Out_ DWORD * pnMaterialIndices);
/**
* Sets the material of a triangle to a specific single value. All other Triangle properties are removed.
* This must be a base material .
*
* @param[in] pPropertyHandler Property Handler
* @param[in] nIndex Index of the triangle (0 to trianglecount - 1)
* @param[in] nMaterialGroupID Group ID of the Material Group
* @param[in] nMaterialIndex Index of the Material in the Group
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_propertyhandler_setbasematerial(_In_ PLib3MFPropertyHandler * pPropertyHandler, _In_ DWORD nIndex, _In_ ModelResourceID nMaterialGroupID, _In_ DWORD nMaterialIndex);
/**
* Sets the materials of all triangles to specific values.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] pnMaterialGroupIDs array of the material Group IDs. Must have trianglecount entries. If a group ID of 0 is specified.
* @param[in] pnMaterialIndices array of the corresponding material indices. Must have trianglecount entries.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_propertyhandler_setbasematerialarray(_In_ PLib3MFPropertyHandler * pPropertyHandler, _In_ ModelResourceID * pnMaterialGroupIDs, _In_ DWORD * pnMaterialIndices);
/**
* Returns the color of a specific triangle.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] nIndex Index of the triangle (0 to trianglecount - 1)
* @param[out] pColor returns the color values of the three nodes of the triangle. (#00000000) means no property or a different kind of property!
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_propertyhandler_getcolor(_In_ PLib3MFPropertyHandler * pPropertyHandler, _In_ DWORD nIndex, _Out_ MODELMESH_TRIANGLECOLOR_SRGB * pColor);
/**
* Returns the color array of all triangles
*
* @param[in] pPropertyHandler Property Handler
* @param[out] pColors returns the color values of the three nodes of each triangle. Must have at least trianglecount array entries.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_propertyhandler_getcolorarray(_In_ PLib3MFPropertyHandler * pPropertyHandler, _Out_ MODELMESH_TRIANGLECOLOR_SRGB * pColors);
/**
* Sets the specific triangle to a single color. All other properties are removed.
* Mixing properties needs the property extension API.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] nIndex Index of the triangle (0 to trianglecount - 1)
* @param[in] pColor new color value of the triangle. (#00000000) means no color property.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_propertyhandler_setsinglecolor(_In_ PLib3MFPropertyHandler * pPropertyHandler, _In_ DWORD nIndex, _In_ MODELMESHCOLOR_SRGB * pColor);
/**
* Sets the specific triangle to a single color. All other properties are removed.
* Mixing properties needs the property extension API.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] nIndex Index of the triangle (0 to trianglecount - 1)
* @param[in] bRed New red value of the color of the triangle (0-255)
* @param[in] bGreen New red value of the color of the triangle (0-255)
* @param[in] bBlue New red value of the color of the triangle (0-255)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_propertyhandler_setsinglecolorrgb(_In_ PLib3MFPropertyHandler * pPropertyHandler, _In_ DWORD nIndex, _In_ BYTE bRed, _In_ BYTE bGreen, _In_ BYTE bBlue);
/**
* Sets the specific triangle to a single color. All other properties are removed.
* Mixing properties needs the property extension API.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] nIndex Index of the triangle (0 to trianglecount - 1)
* @param[in] bRed New red value of the color of the triangle (0-255)
* @param[in] bGreen New red value of the color of the triangle (0-255)
* @param[in] bBlue New red value of the color of the triangle (0-255)
* @param[in] bAlpha New alpha value of the color of the triangle (0-255)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_propertyhandler_setsinglecolorrgba(_In_ PLib3MFPropertyHandler * pPropertyHandler, _In_ DWORD nIndex, _In_ BYTE bRed, _In_ BYTE bGreen, _In_ BYTE bBlue, _In_ BYTE bAlpha);
/**
* Sets the specific triangle to a single color. All other properties are removed.
* Mixing properties needs the property extension API.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] nIndex Index of the triangle (0 to trianglecount - 1)
* @param[in] fRed New red value of the color of the triangle (0-1)
* @param[in] fGreen New red value of the color of the triangle (0-1)
* @param[in] fBlue New red value of the color of the triangle (0-1)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_propertyhandler_setsinglecolorfloatrgb(_In_ PLib3MFPropertyHandler * pPropertyHandler, _In_ DWORD nIndex, _In_ FLOAT fRed, _In_ FLOAT fGreen, _In_ FLOAT fBlue);
/**
* Sets the specific triangle to a single color. All other properties are removed.
* Mixing properties needs the property extension API.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] nIndex Index of the triangle (0 to trianglecount - 1)
* @param[in] fRed New red value of the color of the triangle (0-1)
* @param[in] fGreen New red value of the color of the triangle (0-1)
* @param[in] fBlue New red value of the color of the triangle (0-1)
* @param[in] fAlpha New alpha value of the color of the triangle (0-1)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_propertyhandler_setsinglecolorfloatrgba(_In_ PLib3MFPropertyHandler * pPropertyHandler, _In_ DWORD nIndex, _In_ FLOAT fRed, _In_ FLOAT fGreen, _In_ FLOAT fBlue, _In_ FLOAT fAlpha);
/**
* Sets the (single) color of all triangles. All other properties are removed.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] pColors new color values for the triangles. (#00000000) means no color property.. Must have at least trianglecount array entries.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_propertyhandler_setsinglecolorarray(_In_ PLib3MFPropertyHandler * pPropertyHandler, _Out_ MODELMESHCOLOR_SRGB * pColors);
/**
* Sets the specific triangle to a color per vertex. All other properties are removed.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] nIndex Index of the triangle (0 to trianglecount - 1)
* @param[in] pColor new color values of the three nodes of the triangle. (#00000000) means no color property is set.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_propertyhandler_setgradientcolor(_In_ PLib3MFPropertyHandler * pPropertyHandler, _In_ DWORD nIndex, _Out_ MODELMESH_TRIANGLECOLOR_SRGB * pColor);
/**
* Sets the (gradient) color of all triangles. All other properties are removed.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] pColors returns the color values of the three nodes of each triangle. Must have at least trianglecount array entries. (#00000000) means no color property is set.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_propertyhandler_setgradientcolorarray(_In_ PLib3MFPropertyHandler * pPropertyHandler, _Out_ MODELMESH_TRIANGLECOLOR_SRGB * pColors);
/**
* Returns the 2D texture information of a specific triangle.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] nIndex Index of the triangle (0 to trianglecount - 1)
* @param[out] pTexture returns the UV texture values of the three nodes of the triangle. texture ID 0 means no property or a different kind of property.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_propertyhandler_gettexture(_In_ PLib3MFPropertyHandler * pPropertyHandler, _In_ DWORD nIndex, _Out_ MODELMESHTEXTURE2D * pTexture);
/**
* Returns the 2D texture information of all triangles.
*
* @param[in] pPropertyHandler Property Handler
* @param[out] pTextures returns the UV texture values of the three nodes of all triangles. Must have at least trianglecount array entries.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_propertyhandler_gettexturearray(_In_ PLib3MFPropertyHandler * pPropertyHandler, _Out_ MODELMESHTEXTURE2D * pTextures);
/**
* Sets the 2D texture information of a specific triangle.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] nIndex Index of the triangle (0 to trianglecount - 1)
* @param[in] pTexture new UV texture values of the three nodes of the triangle. texture ID 0 means no property or a different kind of property.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_propertyhandler_settexture(_In_ PLib3MFPropertyHandler * pPropertyHandler, _In_ DWORD nIndex, _In_ MODELMESHTEXTURE2D * pTexture);
/**
* Sets the 2D texture information of all triangles.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] pTextures new UV texture values of the three nodes of all triangles. Must have at least trianglecount array entries.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_propertyhandler_settexturearray(_In_ PLib3MFPropertyHandler * pPropertyHandler, _In_ MODELMESHTEXTURE2D * pTextures);
/**
* Removes the default property of the object.
*
* @param[in] pPropertyHandler Property Handler
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_defaultpropertyhandler_removeproperty(_In_ PLib3MFDefaultPropertyHandler * pPropertyHandler);
/**
* Returns the property type of the object
*
* @param[in] pPropertyHandler Property Handler
* @param[out] pnPropertyType Returns the property type of the object
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_defaultpropertyhandler_getpropertytype(_In_ PLib3MFDefaultPropertyHandler * pPropertyHandler, _Out_ eModelPropertyType * pnPropertyType);
/**
* Returns the base material the object
*
* @param[in] pPropertyHandler Property Handler
* @param[out] pnMaterialGroupID returns the material group id, per triangle. A return group id of 0 means either no property at all or a non-material property.
* @param[out] pnMaterialIndex returns the material index, per triangle. Returns 0, if no base material is assigned.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_defaultpropertyhandler_getbasematerial(_In_ PLib3MFDefaultPropertyHandler * pPropertyHandler, _Out_ DWORD * pnMaterialGroupID, _Out_ DWORD * pnMaterialIndex);
/**
* Sets the material of an object to a specific single value.
* This must be a base material .
*
* @param[in] pPropertyHandler Property Handler
* @param[in] nMaterialGroupID Group ID of the Material Group
* @param[in] nMaterialIndex Index of the Material in the Group
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_defaultpropertyhandler_setbasematerial(_In_ PLib3MFDefaultPropertyHandler * pPropertyHandler, _In_ DWORD nMaterialGroupID, _In_ DWORD nMaterialIndex);
/**
* Returns the default property color of an object.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] nIndex Index of the triangle (0 to trianglecount - 1)
* @param[out] pColor returns the default color of the object. (#00000000) means no property or a different kind of property!
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_defaultpropertyhandler_getcolor(_In_ PLib3MFDefaultPropertyHandler * pPropertyHandler, _In_ DWORD nIndex, _Out_ MODELMESHCOLOR_SRGB * pColor);
/**
* Sets the default property of an object to a single color.
* Mixing properties needs the property extension API.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] pColor new default color value of the object. (#00000000) means no color property.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_defaultpropertyhandler_setcolor(_In_ PLib3MFDefaultPropertyHandler * pPropertyHandler, _In_ MODELMESHCOLOR_SRGB * pColor);
/**
* Sets the default property of an object to a single color.
* Mixing properties needs the property extension API.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] bRed New red value of the color of the object (0-255)
* @param[in] bGreen New red value of the color of the object (0-255)
* @param[in] bBlue New red value of the color of the object (0-255)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_defaultpropertyhandler_setcolorrgb(_In_ PLib3MFDefaultPropertyHandler * pPropertyHandler, _In_ BYTE bRed, _In_ BYTE bGreen, _In_ BYTE bBlue);
/**
* Sets the default property of an object to a single color.
* Mixing properties needs the property extension API.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] bRed New red value of the color of the object (0-255)
* @param[in] bGreen New red value of the color of the object (0-255)
* @param[in] bBlue New red value of the color of the object (0-255)
* @param[in] bAlpha New alpha value of the color of the object (0-255)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_defaultpropertyhandler_setcolorrgba(_In_ PLib3MFDefaultPropertyHandler * pPropertyHandler, _In_ BYTE bRed, _In_ BYTE bGreen, _In_ BYTE bBlue, _In_ BYTE bAlpha);
/**
* Sets the default property of an object to a single color.
* Mixing properties needs the property extension API.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] fRed New red value of the color of the object (0-1)
* @param[in] fGreen New red value of the color of the object (0-1)
* @param[in] fBlue New red value of the color of the object (0-1)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_defaultpropertyhandler_setfloatcolorrgb(_In_ PLib3MFDefaultPropertyHandler * pPropertyHandler, _In_ FLOAT fRed, _In_ FLOAT fGreen, _In_ FLOAT fBlue);
/**
* Sets the default property of an object to a single color.
* Mixing properties needs the property extension API.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] fRed New red value of the color of the object (0-1)
* @param[in] fGreen New red value of the color of the object (0-1)
* @param[in] fBlue New red value of the color of the object (0-1)
* @param[in] fAlpha New alpha value of the color of the object (0-1)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_defaultpropertyhandler_setfloatcolorrgba(_In_ PLib3MFDefaultPropertyHandler * pPropertyHandler, _In_ FLOAT fRed, _In_ FLOAT fGreen, _In_ FLOAT fBlue, _In_ FLOAT fAlpha);
/**
* Returns the default 2D texture information of an object.
*
* @param[in] pPropertyHandler Property Handler
* @param[out] pnTextureID Returns the default Texture ID of the object. 0 means no property or a different kind of property.
* @param[out] pfU Returns the default U value of the object.
* @param[out] pfV Returns the default V value of the object.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_defaultpropertyhandler_gettexture(_In_ PLib3MFDefaultPropertyHandler * pPropertyHandler, _Out_ ModelResourceID * pnTextureID, _Out_ FLOAT * pfU, _Out_ FLOAT * pfV);
/**
* Sets the default 2D texture information of an object.
*
* @param[in] pPropertyHandler Property Handler
* @param[in] nTextureID Sets the default Texture ID of the object. 0 means not default property.
* @param[in] fU Sets the default U value of the object.
* @param[in] fV Sets the default V value of the object.
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_defaultpropertyhandler_settexture(_In_ PLib3MFDefaultPropertyHandler * pPropertyHandler, _In_ ModelResourceID nTextureID, _In_ FLOAT fU, _In_ FLOAT fV);
/**
* Retrieves a object's type
*
* @param[in] pObject Object Resource Instance
* @param[out] pObjectType returns object type constant. See ModelTypes.h
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_object_gettype(_In_ PLib3MFModelObjectResource * pObject, _Out_ DWORD * pObjectType);
/**
* Sets an object's type
*
* @param[in] pObject Object Resource Instance
* @param[out] ObjectType object type constant. See ModelTypes.h
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_object_settype(_In_ PLib3MFModelObjectResource * pObject, _In_ DWORD ObjectType);
/**
* Retrieves a object's name string
*
* @param[in] pObject Object Resource Instance
* @param[out] pwszBuffer buffer to fill
* @param[in] cbBufferSize size of buffer to fill. needs to be at least string length + 1
* @param[out] pcbNeededChars returns needed characters in buffer
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_object_getname(_In_ PLib3MFModelObjectResource * pObject, _Out_opt_ LPWSTR pwszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* Retrieves a object's name string (UTF8)
*
* @param[in] pObject Object Resource Instance
* @param[out] pszBuffer buffer to fill
* @param[in] cbBufferSize size of buffer to fill. needs to be at least string length + 1
* @param[out] pcbNeededChars returns needed characters in buffer
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_object_getnameutf8(_In_ PLib3MFModelObjectResource * pObject, _Out_opt_ LPSTR pszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* Sets a build object's name string
*
* @param[in] pObject Object Resource Instance
* @param[in] pwszName new name of the object as UTF16 string. (e.g. "Car")
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_object_setname(_In_ PLib3MFModelObjectResource * pObject, _In_z_ LPCWSTR pwszName);
/**
* Sets a build object's name string
*
* @param[in] pObject Object Resource Instance
* @param[in] pszName new name of the object as UTF8 string. (e.g. "Car")
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_object_setnameutf8(_In_ PLib3MFModelObjectResource * pObject, _In_z_ LPCSTR pszName);
/**
* Retrieves a object's part number string
*
* @param[in] pObject Object Resource Instance
* @param[out] pwszBuffer buffer to fill
* @param[in] cbBufferSize size of buffer to fill. needs to be at least string length + 1
* @param[out] pcbNeededChars returns needed characters in buffer
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_object_getpartnumber(_In_ PLib3MFModelObjectResource * pObject, _Out_opt_ LPWSTR pwszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* Retrieves a object's part number string (UTF8)
*
* @param[in] pObject Object Resource Instance
* @param[out] pszBuffer buffer to fill
* @param[in] cbBufferSize size of buffer to fill. needs to be at least string length + 1
* @param[out] pcbNeededChars returns needed characters in buffer
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_object_getpartnumberutf8(_In_ PLib3MFModelObjectResource * pObject, _Out_opt_ LPSTR pszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* Sets a build object's part number string
*
* @param[in] pObject Object Resource Instance
* @param[in] pwszPartNumber new part number (UTF16) string for referencing parts from the outside.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_object_setpartnumber(_In_ PLib3MFModelObjectResource * pObject, _In_z_ LPCWSTR pwszPartNumber);
/**
* Sets a build object's part number string
*
* @param[in] pObject Object Resource Instance
* @param[in] pszPartNumber new part number (UTF8) string for referencing parts from the outside.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_object_setpartnumberutf8(_In_ PLib3MFModelObjectResource * pObject, _In_z_ LPCSTR pszPartNumber);
/**
* Retrieves, if an object is a mesh object
*
* @param[in] pObject Object Resource Instance
* @param[out] pbIsMeshObject returns, if the object is a mesh object
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_object_ismeshobject(_In_ PLib3MFModelObjectResource * pObject, _Out_ BOOL * pbIsMeshObject);
/**
* Retrieves, if an object is a component object
*
* @param[in] pObject Object Resource Instance
* @param[out] pbIsComponentObject returns, if the object is a mesh object
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_object_iscomponentsobject(_In_ PLib3MFModelObjectResource * pObject, _Out_ BOOL * pbIsComponentObject);
/**
* Retrieves, if the object is valid according to the core spec.
* For mesh objects, we distinguish between the type attribute of the object:
* In case of object type "other", this always means "false"
* In case of object type "support", this always means "true"
* In case of object type "model", this means, if the mesh suffices all requirements of the core spec chapter 4.1
* A component objects is valid if and only if it contains at least one component -
* and all child components are valid objects.
*
* @param[in] pObject Object Resource Instance
* @param[out] pbIsValid returns, if the object is a valid object description.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_object_isvalidobject(_In_ PLib3MFModelObjectResource * pObject, _Out_ BOOL * pbIsValid);
/**
* creates a default property handler for the object
*
* @param[in] pObject Object Resource Instance
* @param[out] ppPropertyHandler returns a default property handler instance for the object.
* @return error code or 0 (success)f
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_object_createdefaultpropertyhandler(_In_ PLib3MFModelObjectResource * pObject, _Out_ PLib3MFDefaultPropertyHandler ** ppPropertyHandler);
/**
* creates a default property handler for a specific multiproperty channel of an object
*
* @param[in] pObject Object Resource Instance
* @param[in] nChannel Channel Index
* @param[out] ppPropertyHandler returns a default property handler instance of an object.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_object_createdefaultmultipropertyhandler(_In_ PLib3MFModelObjectResource * pObject, _In_ DWORD nChannel, _Out_ PLib3MFDefaultPropertyHandler ** ppPropertyHandler);
/**
* Retrieves the path used as thumbnail for an object (UTF8). Returns "" if none is set
*
* @param[in] pObject Object Resource Instance
* @param[out] pszBuffer buffer to fill
* @param[in] cbBufferSize size of buffer to fill. needs to be at least string length + 1
* @param[out] pcbNeededChars returns needed characters in buffer
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_object_getthumbnailpathutf8(_In_ PLib3MFModelObjectResource * pObject, _Out_opt_ LPSTR pszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* Sets an object's thumbnail package path (UTF8)
*
* @param[in] pObject Object Instance
* @param[in] pszPath path where to look for the thumbnail (e.g. "/Textures/thumbnail.png"). Call will NULL to clear the thumbnail.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_object_setthumbnailpathutf8(_In_ PLib3MFModelObjectResource * pObject, _In_z_ LPCSTR pszPath);
/**
* returns, whether an object has a UUID and, if true, the object's UUID
*
* @param[in] pObject object instance
* @param[out] pbHasUUID flag whether the object has a UUID
* @param[out] pszBuffer the UUID as string of the form "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx"
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_object_getuuidutf8(_In_ PLib3MFModelObjectResource * pMeshObject, _Out_ BOOL *pbHasUUID, _Out_ LPSTR pszBuffer);
/**
* sets the objects's UUID
*
* @param[in] pObject object instance
* @param[in] pszUUID the UUID as string of the form "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx"
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_object_setuuidutf8(_In_ PLib3MFModelObjectResource * pObject, _In_z_ LPCSTR pszUUID);
/**
* Retrieves the count of base materials in the material group.
*
* @param[in] pBaseMaterial Base Material Resource Instance
* @param[out] pcbCount returns the count of base materials.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_basematerial_getcount(_In_ PLib3MFModelBaseMaterial * pBaseMaterial, _Out_ DWORD * pcbCount);
/**
* Retrieves the resource id of the material group.
*
* @param[in] pBaseMaterial Base Material Resource Instance
* @param[out] pnResourceID returns the id of the material group.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_basematerial_getresourceid(_In_ PLib3MFModelBaseMaterial * pBaseMaterial, _Out_ DWORD * pnResourceID);
/**
* Adds a new material to the material group
*
* @param[in] pBaseMaterial Base Material Resource Instance
* @param[in] pwszName new name of the base material. (UTF16 String, e.g. "ABS red")
* @param[in] bRed New red value of display color (0-255)
* @param[in] bGreen New red value of display color (0-255)
* @param[in] bBlue New red value of display color (0-255)
* @param[out] pnResourceIndex returns new Index of the material in the material group
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_basematerial_addmaterial(_In_ PLib3MFModelBaseMaterial * pBaseMaterial, _In_z_ LPCWSTR pwszName, _In_ BYTE bRed, _In_ BYTE bGreen, _In_ BYTE bBlue, _In_ DWORD * pnResourceIndex);
/**
* Adds a new material to the material group
*
* @param[in] pBaseMaterial Base Material Resource Instance
* @param[in] pszName new name of the base material. (UTF8 String, e.g. "ABS red")
* @param[in] bRed New red value of display color (0-255)
* @param[in] bGreen New red value of display color (0-255)
* @param[in] bBlue New red value of display color (0-255)
* @param[out] pnResourceIndex returns new Index of the material in the material group
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_basematerial_addmaterialutf8(_In_ PLib3MFModelBaseMaterial * pBaseMaterial, _In_z_ LPCSTR pszName, _In_ BYTE bRed, _In_ BYTE bGreen, _In_ BYTE bBlue, _In_ DWORD * pnResourceIndex);
/**
* Removes a material from the material group
*
* @param[in] pBaseMaterial Base Material Resource Instance
* @param[in] nIndex Index of the material in the material group
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_basematerial_removematerial(_In_ PLib3MFModelBaseMaterial * pBaseMaterial, _In_ DWORD nIndex);
/**
* Retrieves a base material's name
*
* @param[in] pBaseMaterial Base Material Resource Instance
* @param[in] nIndex Index of the material in the material group
* @param[out] pwszBuffer buffer to fill
* @param[in] cbBufferSize size of buffer to fill. needs to be at least string length + 1
* @param[out] pcbNeededChars returns needed characters in buffer
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_basematerial_getname(_In_ PLib3MFModelBaseMaterial * pBaseMaterial, _In_ DWORD nIndex, _Out_opt_ LPWSTR pwszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* Retrieves a base material's name (UTF8)
*
* @param[in] pBaseMaterial Base Material Resource Instance
* @param[in] nIndex Index of the material in the material group
* @param[out] pszBuffer buffer to fill
* @param[in] cbBufferSize size of buffer to fill. needs to be at least string length + 1
* @param[out] pcbNeededChars returns needed characters in buffer
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_basematerial_getnameutf8(_In_ PLib3MFModelBaseMaterial * pBaseMaterial, _In_ DWORD nIndex, _Out_opt_ LPSTR pszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* Sets a base material's name (UTF16)
*
* @param[in] pBaseMaterial Base Material Resource Instance
* @param[in] nIndex Index of the material in the material group
* @param[in] pwszName new name of the base material. (e.g. "ABS red")
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_basematerial_setname(_In_ PLib3MFModelBaseMaterial * pBaseMaterial, _In_ DWORD nIndex, _In_z_ LPCWSTR pwszName);
/**
* Sets a base material's name (UTF8)
*
* @param[in] pBaseMaterial Base Material Resource Instance
* @param[in] nIndex Index of the material in the material group
* @param[in] pszName new name of the base material. (e.g. "ABS red")
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_basematerial_setnameutf8(_In_ PLib3MFModelBaseMaterial * pBaseMaterial, _In_ DWORD nIndex, _In_z_ LPCSTR pszName);
/**
* Sets a base material's display color. Alpha is set to 255.
*
* @param[in] pBaseMaterial Base Material Resource Instance
* @param[in] nIndex Index of the material in the material group
* @param[in] bRed New red value (0-255)
* @param[in] bGreen New green value (0-255)
* @param[in] bBlue New blue value (0-255)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_basematerial_setdisplaycolorrgb(_In_ PLib3MFModelBaseMaterial * pBaseMaterial, _In_ DWORD nIndex, _In_ BYTE bRed, _In_ BYTE bGreen, _In_ BYTE bBlue);
/**
* Sets a base material's display color.
*
* @param[in] pBaseMaterial Base Material Resource Instance
* @param[in] nIndex Index of the material in the material group
* @param[in] bRed New red value (0-255)
* @param[in] bGreen New green value (0-255)
* @param[in] bBlue New blue value (0-255)
* @param[in] bAlpha New alpha value (0-255)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_basematerial_setdisplaycolorrgba(_In_ PLib3MFModelBaseMaterial * pBaseMaterial, _In_ DWORD nIndex, _In_ BYTE bRed, _In_ BYTE bGreen, _In_ BYTE bBlue, _In_ BYTE bAlpha);
/**
* Sets a base material's display color. Alpha is set to 1.0.
*
* @param[in] pBaseMaterial Base Material Resource Instance
* @param[in] nIndex Index of the material in the material group
* @param[in] fRed New red value (0.0-1.0)
* @param[in] fGreen New green value (0.0-1.0)
* @param[in] fBlue New blue value (0.0-1.0)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_basematerial_setdisplaycolorfloatrgb(_In_ PLib3MFModelBaseMaterial * pBaseMaterial, _In_ DWORD nIndex, _In_ FLOAT fRed, _In_ FLOAT fGreen, _In_ FLOAT fBlue);
/**
* Sets a base material's display color.
*
* @param[in] pBaseMaterial Base Material Resource Instance
* @param[in] nIndex Index of the material in the material group
* @param[in] fRed New red value (0.0-1.0)
* @param[in] fGreen New green value (0.0-1.0)
* @param[in] fBlue New blue value (0.0-1.0)
* @param[in] fAlpha New alpha value (0.0-1.0)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_basematerial_setdisplaycolorfloatrgba(_In_ PLib3MFModelBaseMaterial * pBaseMaterial, _In_ DWORD nIndex, _In_ FLOAT fRed, _In_ FLOAT fGreen, _In_ FLOAT fBlue, _In_ FLOAT fAlpha);
/**
* Returns a base material's display color.
*
* @param[in] pBaseMaterial Base Material Resource Instance
* @param[in] nIndex Index of the material in the material group
* @param[out] pbRed Returns red value (0-255)
* @param[out] pbGreen Returns green value (0-255)
* @param[out] pbBlue Returns blue value (0-255)
* @param[out] pbAlpha Returns alpha value (0-255)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_basematerial_getdisplaycolor(_In_ PLib3MFModelBaseMaterial * pBaseMaterial, _In_ DWORD nIndex, _Out_ BYTE* pbRed, _Out_ BYTE* pbGreen, _Out_ BYTE* pbBlue, _Out_ BYTE* pbAlpha);
/**
* Retrieves an attachment's package path
*
* @param[in] pAttachment Attachment Instance
* @param[out] pwszBuffer buffer to fill
* @param[in] cbBufferSize size of buffer to fill. needs to be at least string length + 1
* @param[out] pcbNeededChars returns needed characters in buffer
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_attachment_getpath (_In_ PLib3MFModelAttachment * pAttachment, _Out_opt_ LPWSTR pwszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* Retrieves an attachment's package path (UTF8)
*
* @param[in] pAttachment Attachment Instance
* @param[out] pszBuffer buffer to fill
* @param[in] cbBufferSize size of buffer to fill. needs to be at least string length + 1
* @param[out] pcbNeededChars returns needed characters in buffer
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_attachment_getpathutf8 (_In_ PLib3MFModelAttachment * pAttachment, _Out_opt_ LPSTR pszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* Sets an attachment's package path
*
* @param[in] pAttachment Attachment Instance
* @param[in] pwszPath new path of the attachment. (e.g. "/Textures/logo.png")
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_attachment_setpath (_In_ PLib3MFModelAttachment * pAttachment, _In_z_ LPCWSTR pwszPath);
/**
* Sets an attachment's package path (UTF8)
*
* @param[in] pAttachment Attachment Instance
* @param[in] pszPath new path of the attachment. (e.g. "/Textures/logo.png")
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_attachment_setpathutf8 (_In_ PLib3MFModelAttachment * pAttachment, _In_z_ LPCSTR pszPath);
/**
* Retrieves an attachment's package relationship type
*
* @param[in] pAttachment Attachment Instance
* @param[out] pwszBuffer buffer to fill
* @param[in] cbBufferSize size of buffer to fill. needs to be at least string length + 1
* @param[out] pcbNeededChars returns needed characters in buffer
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_attachment_getrelationshiptype(_In_ PLib3MFModelAttachment * pAttachment, _Out_opt_ LPWSTR pwszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* Retrieves an attachment's package relationship type (UTF8)
*
* @param[in] pAttachment Attachment Instance
* @param[out] pszBuffer buffer to fill
* @param[in] cbBufferSize size of buffer to fill. needs to be at least string length + 1
* @param[out] pcbNeededChars returns needed characters in buffer
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_attachment_getrelationshiptypeutf8 (_In_ PLib3MFModelAttachment * pAttachment, _Out_opt_ LPSTR pszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* Sets an attachment's package relationship type
*
* @param[in] pAttachment Attachment Instance
* @param[in] pwszRelationShipType new relationship type attachment. (e.g. "/Data/data.xml")
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_attachment_setrelationshiptype (_In_ PLib3MFModelAttachment * pAttachment, _In_z_ LPCWSTR pwszRelationShipType);
/**
* Sets an attachment's package relationship type (UTF8)
*
* @param[in] pAttachment Attachment Instance
* @param[in] pszRelationShipType new path of the attachment. (e.g. "/Data/data.png")
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_attachment_setrelationshiptypeutf8 (_In_ PLib3MFModelAttachment * pAttachment, _In_z_ LPCSTR pszRelationShipType);
/**
* Retrieves the size of the attachment stream.
*
* @param[in] pAttachment Attachment Instance
* @param[out] pcbStreamSize Returns the stream size
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_attachment_getstreamsize (_In_ PLib3MFModelAttachment * pAttachment, _Out_ ULONG64 * pcbStreamSize);
/**
* Writes out the attachment as file.
*
* @param[in] pAttachment Attachment Instance
* @param[in] pwszFilename Filename to write into
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_attachment_writetofile (_In_ PLib3MFModelAttachment * pAttachment, _In_z_ LPCWSTR pwszFilename);
/**
* Writes out the attachment as file. (UTF8)
*
* @param[in] pAttachment Attachment Instance
* @param[in] pszFilename Filename to write into
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_attachment_writetofileutf8 (_In_ PLib3MFModelAttachment * pAttachment, _In_z_ LPCSTR pszFilename);
/**
* Writes out the attachment into a buffer. Buffer size must be at least the size of the stream.
*
* @param[in] pAttachment Attachment Instance
* @param[out] pBuffer Buffer to write into
* @param[in] cbBufferSize Size of the buffer in bytes
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_attachment_writetobuffer (_In_ PLib3MFModelAttachment * pAttachment, _Out_ BYTE * pBuffer, _In_ ULONG64 cbBufferSize);
/**
* Writes out the attachment and passes the data to a provided callback function. The file type is specified by the Model Writer class
*
* @param[in] pAttachment Attachment Instance
* @param[in] pWriteCallback Callback to call for writing a data chunk.
* @param[in] pUserData Userdata that is passed to the callback function
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_attachment_writetocallback (_In_ PLib3MFModelAttachment * pAttachment, _In_ void * pWriteCallback, _In_opt_ void * pUserData);
/**
* Reads an attachment from a file.
*
* @param[in] pAttachment Attachment Instance
* @param[in] pwszFilename Filename to read from
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_attachment_readfromfile (_In_ PLib3MFModelAttachment * pAttachment, _In_z_ LPCWSTR pwszFilename);
/**
* Reads an attachment from a file.
*
* @param[in] pAttachment Attachment Instance
* @param[in] pszFilename Filename to read from
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_attachment_readfromfileutf8 (_In_ PLib3MFModelAttachment * pAttachment, _In_z_ LPCSTR pszFilename);
/**
* Reads an attachment from a memory buffer.
*
* @param[in] pAttachment Attachment Instance
* @param[in] pBuffer Buffer to read from
* @param[in] cbBufferSize Size of the buffer in bytes
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_attachment_readfrombuffer (_In_ PLib3MFModelAttachment * pAttachment, _In_ BYTE * pBuffer, _In_ ULONG64 cbBufferSize);
/**
* Retrieves the attachment located at the path of the texture
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[out] ppTextureAttachment attachment that holds the texture's image information
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_getattachment(_In_ PLib3MFModelTexture2D * pTexture2D, _Out_ PLib3MFModelAttachment ** ppTextureAttachment);
/**
* Sets the texture's package path to the path of the attachment
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[out] pTextureAttachment attachment that holds the texture's image information
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_setattachment(_In_ PLib3MFModelTexture2D * pTexture2D, _In_ PLib3MFModelAttachment * pTextureAttachment);
/**
* Retrieves a texture's package path
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[out] pwszBuffer buffer to fill
* @param[in] cbBufferSize size of buffer to fill. needs to be at least string length + 1
* @param[out] pcbNeededChars returns needed characters in buffer
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_getpath(_In_ PLib3MFModelTexture2D * pTexture2D, _Out_opt_ LPWSTR pwszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* Retrieves a texture's package path (UTF8)
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[out] pszBuffer buffer to fill
* @param[in] cbBufferSize size of buffer to fill. needs to be at least string length + 1
* @param[out] pcbNeededChars returns needed characters in buffer
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_getpathutf8(_In_ PLib3MFModelTexture2D * pTexture2D, _Out_opt_ LPSTR pszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* Sets a texture's package path
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[in] pwszPath new path of the texture resource. (e.g. "/Textures/logo.png")
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_setpath(_In_ PLib3MFModelTexture2D * pTexture2D, _In_z_ LPCWSTR pwszPath);
/**
* Sets a texture's package path (UTF8)
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[in] pszPath new path of the texture resource. (e.g. "/Textures/logo.png")
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_setpathutf8(_In_ PLib3MFModelTexture2D * pTexture2D, _In_z_ LPCSTR pszPath);
/**
* Retrieves a texture's content type
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[out] peContentType returns content type enum
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_getcontenttype(_In_ PLib3MFModelTexture2D * pTexture2D, _Out_ eModelTexture2DType * peContentType);
/**
* Sets a texture's content type
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[in] eContentType new Content Type
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_setcontenttype(_In_ PLib3MFModelTexture2D * pTexture2D, _In_ eModelTexture2DType eContentType);
/**
* Retrieves a texture's tilestyle type
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[out] peTileStyleU returns tilestyle type enum
* @param[out] peTileStyleV returns tilestyle type enum
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_gettilestyleuv(_In_ PLib3MFModelTexture2D * pTexture2D, _Out_ eModelTextureTileStyle * peTileStyleU, _Out_ eModelTextureTileStyle * peTileStyleV);
/**
* Sets a texture's tilestyle type
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[in] eTileStyleU new tilestyle type enum
* @param[in] eTileStyleV new tilestyle type enum
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_settilestyleuv(_In_ PLib3MFModelTexture2D * pTexture2D, _In_ eModelTextureTileStyle eTileStyleU, _In_ eModelTextureTileStyle eTileStyleV);
/**
* Retrieves a texture's filter
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[out] peFilter returns filter enum
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_getfilter(_In_ PLib3MFModelTexture2D * pTexture2D, _Out_ eModelTextureFilter * peFilter);
/**
* Sets a texture's filter type
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[in] eFilter returns filter enum
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_setfilter(_In_ PLib3MFModelTexture2D * pTexture2D, _In_ eModelTextureFilter eFilter);
/**
* Retrieves a texture's box2D coordinates.
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[out] pfU returns the U value of the texture
* @param[out] pfV returns the V value of the texture
* @param[out] pfWidth returns the Width value of the texture
* @param[out] pfHeight returns the Height value of the texture
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_getbox2d(_In_ PLib3MFModelTexture2D * pTexture2D, _Out_ FLOAT * pfU, _Out_ FLOAT * pfV, _Out_ FLOAT * pfWidth, _Out_ FLOAT * pfHeight);
/**
* Sets a texture's box2D coordinates.
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[out] fU the new U value of the texture
* @param[out] fV the new V value of the texture
* @param[out] fWidth the new Width value of the texture
* @param[out] fHeight the new Height value of the texture
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_setbox2d(_In_ PLib3MFModelTexture2D * pTexture2D, _In_ FLOAT fU, _In_ FLOAT fV, _In_ FLOAT fWidth, _In_ FLOAT fHeight);
/**
* Clears a texture's box2D coordinates.
*
* @param[in] pTexture2D Texture2D Resource Instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_clearbox2d(_In_ PLib3MFModelTexture2D * pTexture2D);
/**
* Retrieves the size of the texture stream.
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[out] pcbStreamSize Returns the stream size
* @return error code or 0 (success)
*/
LIB3MFDEPRECATED( LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_getstreamsize(_In_ PLib3MFModelTexture2D * pTexture2D, _Out_ ULONG64 * pcbStreamSize) );
/**
* Writes out the texture as file.
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[in] pwszFilename Filename to write into
* @return error code or 0 (success)
*/
LIB3MFDEPRECATED(LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_writetofile(_In_ PLib3MFModelTexture2D * pTexture2D, _In_z_ LPCWSTR pwszFilename) );
/**
* Writes out the texture as file. (UTF8)
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[in] pszFilename Filename to write into
* @return error code or 0 (success)
*/
LIB3MFDEPRECATED(LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_writetofileutf8(_In_ PLib3MFModelTexture2D * pTexture2D, _In_z_ LPCSTR pszFilename) );
/**
* Writes out the texture into a buffer. Buffer size must be at least the size of the stream.
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[out] pBuffer Buffer to write into
* @param[in] cbBufferSize Size of the buffer in bytes
* @return error code or 0 (success)
*/
LIB3MFDEPRECATED(LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_writetobuffer(_In_ PLib3MFModelTexture2D * pTexture2D, _Out_ BYTE * pBuffer, _In_ ULONG64 cbBufferSize) );
/**
* Writes out the texture and passes the data to a provided callback function. The file type is specified by the Model Writer class
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[in] pWriteCallback Callback to call for writing a data chunk.
* @param[in] pUserData Userdata that is passed to the callback function
* @return error code or 0 (success)
*/
LIB3MFDEPRECATED(LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_writetocallback(_In_ PLib3MFModelTexture2D * pTexture2D, _In_ void * pWriteCallback, _In_opt_ void * pUserData) );
/**
* Reads a texture from a file.
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[in] pwszFilename Filename to read from
* @return error code or 0 (success)
*/
LIB3MFDEPRECATED(LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_readfromfile(_In_ PLib3MFModelTexture2D * pTexture2D, _In_z_ LPCWSTR pwszFilename) );
/**
* Reads a texture from a file.
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[in] pszFilename Filename to read from
* @return error code or 0 (success)
*/
LIB3MFDEPRECATED(LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_readfromfileutf8(_In_ PLib3MFModelTexture2D * pTexture2D, _In_z_ LPCSTR pszFilename) );
/**
* Reads a texture from a memory buffer.
*
* @param[in] pTexture2D Texture2D Resource Instance
* @param[in] pBuffer Buffer to read from
* @param[in] cbBufferSize Size of the buffer in bytes
* @return error code or 0 (success)
*/
LIB3MFDEPRECATED(LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_texture2d_readfrombuffer(_In_ PLib3MFModelTexture2D * pTexture2D, _In_ BYTE * pBuffer, _In_ ULONG64 cbBufferSize) );
// Mesh Object
/**
* Returns the vertex count of a mesh object
*
* @param[in] pMeshObject Mesh Object Instance
* @param[out] pnVertexCount filled with the vertex count
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_getvertexcount(_In_ PLib3MFModelMeshObject * pMeshObject, _Out_ DWORD * pnVertexCount);
/**
* Returns the triangle count of a mesh object
*
* @param[in] pMeshObject Mesh Object Instance
* @param[out] pnTriangleCount filled with the triangle count
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_gettrianglecount(_In_ PLib3MFModelMeshObject * pMeshObject, _Out_ DWORD * pnTriangleCount);
/**
* Returns coordinates of a single vertex of a mesh object
*
* @param[in] pMeshObject Mesh Object Instance
* @param[in] nIndex Index of the vertex (0 to vertexcount - 1)
* @param[out] pVertex filled with the vertex coordinates
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_getvertex(_In_ PLib3MFModelMeshObject * pMeshObject, _In_ DWORD nIndex, _Out_ MODELMESHVERTEX * pVertex);
/**
* Sets the coordinates of a single vertex of a mesh object
*
* @param[in] pMeshObject Mesh Object Instance
* @param[in] nIndex Index of the vertex (0 to vertexcount - 1)
* @param[in] pVertex contains the vertex coordinates
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_setvertex(_In_ PLib3MFModelMeshObject * pMeshObject, _In_ DWORD nIndex, _In_ MODELMESHVERTEX * pVertex);
/**
* Adds a single vertex to a mesh object
*
* @param[in] pMeshObject Mesh Object Instance
* @param[in] pVertex contains the vertex coordinates
* @param[out] pnIndex filled with the new Index of the vertex
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_addvertex(_In_ PLib3MFModelMeshObject * pMeshObject, _In_ MODELMESHVERTEX * pVertex, _Out_opt_ DWORD * pnIndex);
/**
* Returns indices of a single triangle of a mesh object
*
* @param[in] pMeshObject Mesh Object Instance
* @param[in] nIndex Index of the triangle (0 to trianglecount - 1)
* @param[out] pTriangle filled with the triangle indices
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_gettriangle(_In_ PLib3MFModelMeshObject * pMeshObject, _In_ DWORD nIndex, _Out_ MODELMESHTRIANGLE * pTriangle);
/**
* Sets the indices of a single triangle of a mesh object
*
* @param[in] pMeshObject Mesh Object Instance
* @param[in] nIndex Index of the triangle (0 to trianglecount - 1)
* @param[in] pTriangle contains the triangle indices
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_settriangle(_In_ PLib3MFModelMeshObject * pMeshObject, _In_ DWORD nIndex, _In_ MODELMESHTRIANGLE * pTriangle);
/**
* Adds a single triangle to a mesh object
*
* @param[in] pMeshObject Mesh Object Instance
* @param[in] pTriangle contains the triangle indices
* @param[out] pnIndex filled with the new Index of the vertex
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_addtriangle(_In_ PLib3MFModelMeshObject * pMeshObject, _In_ MODELMESHTRIANGLE * pTriangle, _Out_opt_ DWORD * pnIndex);
/**
* Retrieves all vertex coordinates of a mesh object
*
* @param[in] pMeshObject Mesh Object Instance
* @param[out] pVertices buffer filled with the vertex coordinates
* @param[in] nBufferSize size of the buffer in elements, must be at least vertexcount
* @param[out] pnVertexCount returns how many vertices have been written
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_getvertices(_In_ PLib3MFModelMeshObject * pMeshObject, _Out_ MODELMESHVERTEX * pVertices, _In_ DWORD nBufferSize, _Out_opt_ DWORD * pnVertexCount);
/**
* Retrieves all triangle indices of a mesh object
*
* @param[in] pMeshObject Mesh Object Instance
* @param[out] pIndices buffer filled with the triangle indices
* @param[in] nBufferSize size of the buffer in elements, must be at least triangle count
* @param[out] pnTriangleCount returns how many triangles have been written
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_gettriangleindices(_In_ PLib3MFModelMeshObject * pMeshObject, _Out_ MODELMESHTRIANGLE * pIndices, _In_ DWORD nBufferSize, _Out_opt_ DWORD * pnTriangleCount);
/**
* Sets the whole geometry of a mesh object
*
* @param[in] pMeshObject Mesh Object Instance
* @param[in] pVertices Array of vertex coordinates
* @param[in] nVertexCount Size of the vertex array
* @param[in] pTriangles Array of triangle indices
* @param[in] nTriangleCount Size of the triangle array
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_setgeometry(_In_ PLib3MFModelMeshObject * pMeshObject, _In_ MODELMESHVERTEX * pVertices, _In_ DWORD nVertexCount, _In_ MODELMESHTRIANGLE * pTriangles, _In_ DWORD nTriangleCount);
// API for beamlattice extension
/**
* Returns the minimal length of beams for the beamlattice
*
* @param[in] pMeshObject Mesh Object Instance
* @param[out] pdMinLength minimal length of beams for the beamlattice
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_getbeamlattice_minlength(_In_ PLib3MFModelMeshObject * pMeshObject, _Out_ DOUBLE *pdMinLength);
/**
* Sets the minimal length of beams for the beamlattice
*
* @param[in] pMeshObject Mesh Object Instance
* @param[in] dMinLength minimal length of beams for the beamlattice
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_setbeamlattice_minlength(_In_ PLib3MFModelMeshObject * pMeshObject, _In_ DOUBLE dMinLength);
/**
* Returns the default radius for the beamlattice
*
* @param[in] pMeshObject Mesh Object Instance
* @param[out] pdRadius precission of the beams in the beamlattice
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_getbeamlattice_radius(_In_ PLib3MFModelMeshObject * pMeshObject, _Out_ DOUBLE *pdRadius);
/**
* Sets the default radius for the beamlattice
*
* @param[in] pMeshObject Mesh Object Instance
* @param[in] dRadius default radius of the beams in the beamlattice
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_setbeamlattice_radius(_In_ PLib3MFModelMeshObject * pMeshObject, _In_ DOUBLE dRadius);
/**
* Returns the default capping mode for the beamlattice
*
* @param[in] pMeshObject Mesh Object Instance
* @param[out] peCapMode default eModelBeamLatticeCapMode of the beamlattice
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_getbeamlattice_capmode(_In_ PLib3MFModelMeshObject * pMeshObject, _Out_ eModelBeamLatticeCapMode *peCapMode);
/**
* Sets the default capping mode for the beamlattice
*
* @param[in] pMeshObject Mesh Object Instance
* @param[in] eCapMode default eModelBeamLatticeCapMode of the beamlattice
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_setbeamlattice_capmode(_In_ PLib3MFModelMeshObject * pMeshObject, _In_ eModelBeamLatticeCapMode eCapMode);
/**
* Returns the clipping mode and the clipping-mesh for the beamlattice of this mesh
*
* @param[in] pMeshObject Mesh Object Instance
* @param[out] pClipMode contains the clip mode of this mesh
* @param[out] pnResourceID filled with the resourceID of the clipping mesh-object or an undefined value if pClipMode is MODELBEAMLATTICECLIPMODE_NONE
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_getbeamlattice_clipping(_In_ PLib3MFModelMeshObject * pMeshObject, _Out_ eModelBeamLatticeClipMode * peClipMode, _Out_ DWORD *pnResourceID);
/**
* Sets the clipping mode and the clipping-mesh for the beamlattice of this mesh
*
* @param[in] pMeshObject Mesh Object Instance
* @param[in] eClipMode contains the clip mode of this mesh
* @param[in] nResourceID the resourceID of the clipping mesh-object. This mesh-object has to be defined before setting the Clipping
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_setbeamlattice_clipping(_In_ PLib3MFModelMeshObject * pMeshObject, _In_ eModelBeamLatticeClipMode eClipMode, _In_ DWORD nResourceID);
/**
* Returns the representation-mesh for the beamlattice of this mesh
*
* @param[in] pMeshObject Mesh Object Instance
* @param[out] pbHasRepresentation flag whether the beamlattice has a representation mesh.
* @param[out] pnResourceID filled with the resourceID of the clipping mesh-object.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_getbeamlattice_representation(_In_ PLib3MFModelMeshObject * pMeshObject, _Out_ BOOL *pbHasRepresentation, _Out_ DWORD *pnResourceID);
/**
* Sets the representation-mesh for the beamlattice of this mesh
*
* @param[in] pMeshObject Mesh Object Instance
* @param[in] nResourceID the resourceID of the representation mesh-object. This mesh-object has to be defined before setting the representation.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_setbeamlattice_representation(_In_ PLib3MFModelMeshObject * pMeshObject, _In_ DWORD nResourceID);
/**
* Returns the beam count of a mesh object
*
* @param[in] pMeshObject Mesh Object Instance
* @param[out] pnBeamCount filled with the beam count
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_getbeamcount(_In_ PLib3MFModelMeshObject * pMeshObject, _Out_ DWORD * pnBeamCount);
/**
* Returns indices, radii and capmodes of a single beam of a mesh object
*
* @param[in] pMeshObject Mesh Object Instance
* @param[in] nIndex Index of the beam (0 to beamcount - 1)
* @param[out] pBeam filled with the beam indices, radii and capmodes
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_getbeam(_In_ PLib3MFModelMeshObject * pMeshObject, _In_ DWORD nIndex, _Out_ MODELMESHBEAM * pBeam);
/**
* Adds a single beam to a mesh object
*
* @param[in] pMeshObject Mesh Object Instance
* @param[in] pBeam contains the node indices, radii and capmodes
* @param[out] pnIndex filled with the new Index of the beam
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_addbeam(_In_ PLib3MFModelMeshObject * pMeshObject, _In_ MODELMESHBEAM * pBeam, _Out_opt_ DWORD * pnIndex);
/**
* Sets the indices, radii and capmodes of a single beam of a mesh object
*
* @param[in] pMeshObject Mesh Object Instance
* @param[in] nIndex Index of the beam (0 to beamcount - 1)
* @param[in] pBeam contains the node indices, radii and capmodes
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_setbeam(_In_ PLib3MFModelMeshObject * pMeshObject, _In_ DWORD nIndex, _In_ MODELMESHBEAM * pBeam);
/**
* Sets all beam indices, radii and capmodes of a mesh object
*
* @param[in] pMeshObject Mesh Object Instance
* @param[in] pIndices buffer with the beam indices
* @param[in] nBufferSize size of the buffer in elements
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_setbeamindices(_In_ PLib3MFModelMeshObject * pMeshObject, _In_ MODELMESHBEAM * pIndices, _In_ DWORD nBufferSize);
/**
* Retrieves all beam indices of a mesh object
*
* @param[in] pMeshObject Mesh Object Instance
* @param[out] pIndices buffer filled with the beam indices
* @param[in] nBufferSize size of the buffer in elements, must be at least beam count
* @param[out] pnBeamCount returns how many beams have been written
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_getbeamindices(_In_ PLib3MFModelMeshObject * pMeshObject, _Out_ MODELMESHBEAM * pIndices, _In_ DWORD nBufferSize, _Out_opt_ DWORD * pnBeamCount);
/**
* Returns the number of beamsets of a mesh object
*
* @param[in] pMeshObject Mesh Object Instance
* @param[out] pnCount filled with the beamset count
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_getbeamsetcount(_In_ PLib3MFModelMeshObject * pMeshObject, _Out_ DWORD * pnCount);
/**
* Adds an empty beamset to a mesh object
*
* @param[in] pMeshObject Mesh Object Instance
* @param[out] ppBeamSet pointer to the new beamset
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_addbeamset(_In_ PLib3MFModelMeshObject * pMeshObject, _Out_ PLib3MFModelMeshBeamSet** ppBeamSet);
/**
* Returns a beamset of a mesh object
*
* @param[in] pMeshObject Mesh Object Instance
* @param[in] nIndex index of the requested beamset (0 ... beamsetcount-1)
* @param[out] ppBeamSet pointer to the requested beamset
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_getbeamset(_In_ PLib3MFModelMeshObject * pMeshObject, _In_ DWORD nIndex, _Out_ PLib3MFModelMeshBeamSet** ppBeamSet);
/**
* Sets a beamset's name string
*
* @param[in] pModelMeshBeamSet BeamSet Instance
* @param[in] pwszName new name of the BeamSet as UTF16 string. (e.g. "Car")
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_beamset_setname(_In_ PLib3MFModelMeshBeamSet * pModelMeshBeamSet, _In_z_ LPCWSTR pwszName);
/**
* Sets a beamset's identifier string
*
* @param[in] pModelMeshBeamSet BeamSet Instance
* @param[in] pwszIdentifier new identifier of the BeamSet as UTF16 string. (e.g. "Car")
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_beamset_setidentifier(_In_ PLib3MFModelMeshBeamSet * pModelMeshBeamSet, _In_z_ LPCWSTR pwszIdentifier);
/**
* Sets a beamset's name string
*
* @param[in] pModelMeshBeamSet BeamSet Instance
* @param[in] pwszName new name of the BeamSet as UTF8 string. (e.g. "Car")
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_beamset_setnameutf8(_In_ PLib3MFModelMeshBeamSet * pModelMeshBeamSet, _In_z_ LPCSTR pszName);
/**
* Sets a beamset's identifier string
*
* @param[in] pModelMeshBeamSet BeamSet Instance
* @param[in] pszIdentifier new id of the BeamSet as UTF8 string. (e.g. "Car")
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_beamset_setidentifierutf8(_In_ PLib3MFModelMeshBeamSet * pModelMeshBeamSet, _In_z_ LPCSTR pszIdentifier);
/**
* Retrieves a BeamSet's name string (UTF8)
*
* @param[in] pModelMeshBeamSet BeamSet Instance
* @param[out] pwszBuffer buffer to fill
* @param[in] cbBufferSize size of buffer to fill. needs to be at least string length + 1
* @param[out] pcbNeededChars returns needed characters in buffer
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_beamset_getnameutf8(_In_ PLib3MFModelMeshBeamSet * pModelMeshBeamSet, _Out_opt_ LPSTR pszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* Retrieves a BeamSet's identifier string (UTF8)
*
* @param[in] pModelMeshBeamSet BeamSet Instance
* @param[out] pwszBuffer buffer to fill
* @param[in] cbBufferSize size of buffer to fill. needs to be at least string length + 1
* @param[out] pcbNeededChars returns needed characters in buffer
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_beamset_getidentifierutf8(_In_ PLib3MFModelMeshBeamSet * pModelMeshBeamSet, _Out_opt_ LPSTR pszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* Retrieves the reference count of a BeamSet
*
* @param[in] pBeamSet beamset instance
* @param[out] pnCount returns the reference count
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_beamset_getrefcount(_In_ PLib3MFModelMeshBeamSet * pBeamSet, _Out_ DWORD * pnCount);
/**
* Sets the references in a BeamSet
*
* @param[in] pBeamSet beamset instance
* @param[in] pRefs buffer filled with beam references (indices of beams)
* @param[in] nRefCount number of references to be set
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_beamset_setrefs(_In_ PLib3MFModelMeshBeamSet * pBeamSet, _In_ DWORD * pRefs, _In_ DWORD nRefCount);
/**
* Retrieves all references of a BeamSet
*
* @param[in] pBeamSet beamset instance
* @param[in] pRefs buffer filled with beam references (indices of beams)
* @param[in] nBufferSize size of the buffer in elements, must be at least refcount
* @param[out] pnRefCount returns how many references have been written
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_beamset_getrefs(_In_ PLib3MFModelMeshBeamSet * pBeamSet, _Out_ DWORD * pRefs, _In_ DWORD nBufferSize, _Out_opt_ DWORD * pnRefCount);
/**
* creates a property handler for the mesh
*
* @param[in] pMeshObject Mesh Object Instance
* @param[out] ppPropertyHandler returns a property handler instance for the mesh.
* @param[in] pMeshObject Mesh Object Instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_createpropertyhandler(_In_ PLib3MFModelMeshObject * pMeshObject, _In_ PLib3MFPropertyHandler ** ppPropertyHandler);
/**
* creates a property handler for a specific multiproperty channel of a mesh
*
* @param[in] pMeshObject Mesh Object Instance
* @param[in] nChannel Channel Index
* @param[out] ppPropertyHandler returns a property handler instance for the mesh.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_createmultipropertyhandler(_In_ PLib3MFModelMeshObject * pMeshObject, _In_ DWORD nChannel, _In_ PLib3MFPropertyHandler ** ppPropertyHandler);
/**
* Retrieves, if an object describes a topologically oriented and manifold mesh, according to the core spec
*
* @param[in] pMeshObject Mesh Object Instance
* @param[out] pbIsOrientedAndManifold returns, if the object is oriented and manifold
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_ismanifoldandoriented(_In_ PLib3MFModelMeshObject * pMeshObject, _Out_ BOOL * pbIsOrientedAndManifold);
/**
* Link a slicestack to the mesh object
*
* @param[in] pMeshObject mesh object to link with the slicestack
* @param[in] pSliceStack slice stack to link the meshobject to
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_setslicestack(_In_ PLib3MFModelMeshObject *pMeshObject, _In_ PLib3MFSliceStack *pSliceStack);
/**
* Get the linked slicestack tof a the mesh object
*
* @param[in] pMeshObject mesh object to link with the slicestack
* @param[out] pSliceStack slice stack to link the meshobject to
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_getslicestackid(_In_ PLib3MFModelMeshObject *pMeshObject, _Out_ DWORD *pSliceStackId);
/**
* Set the mesh resolution of a mesh that has sliceinformation
*
* @param[in] pMeshObject mesh object for which the meshresolution is set
* @param[in] eSlicesMeshResolution mesh resolution of the mesh object
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_setslicesmeshresolution(_In_ PLib3MFModelMeshObject *pMeshObject, _In_ eModelSlicesMeshResolution eSlicesMeshResolution);
/**
* Get the mesh resolution of a mesh that has sliceinformation
*
* @param[in] pMeshObject mesh object for which the meshresolution is queried
* @param[out] peSlicesMeshResolution mesh resolution of the mesh object
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_meshobject_getslicesmeshresolution(_In_ PLib3MFModelMeshObject *pMeshObject, _Out_ eModelSlicesMeshResolution *eSlicesMeshResolution);
// Component
/**
* Returns the Resource Instance of the component.
*
* @param[in] pComponent component instance
* @param[out] ppObjectResource filled with the Resource Instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_component_getobjectresource(_In_ PLib3MFModelComponent * pComponent, _Outptr_ PLib3MFModelObjectResource ** ppObjectResource);
/**
* returns, whether a component has a UUID and, if true, the component's UUID
*
* @param[in] pBuildItem component instance
* @param[out] pbHasUUID flag whether the build item has a UUID
* @param[out] pszBuffer the UUID as string of the form "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx"
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_component_getuuidutf8(_In_ PLib3MFModelComponent * pComponent, _Out_ BOOL *pbHasUUID, _Out_ LPSTR pszBuffer);
/**
* sets the component's UUID
*
* @param[in] pComponent component instance
* @param[in] pszUUID the UUID as string of the form "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx"
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_component_setuuidutf8(_In_ PLib3MFModelComponent * pComponent, _In_z_ LPCSTR pszUUID);
/**
* Returns the transformation matrix of the component.
*
* @param[in] pComponent component instance
* @param[out] pTransformation filled with the component transformation matrix
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_component_gettransform(_In_ PLib3MFModelComponent * pComponent, _Out_ MODELTRANSFORM * pTransformation);
/**
* Sets the transformation matrix of the component.
*
* @param[in] pComponent component instance
* @param[in] pTransformation new transformation matrix
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_component_settransform(_In_ PLib3MFModelComponent * pComponent, _In_ MODELTRANSFORM * pTransformation);
/**
* Returns the Resource ID of the component.
*
* @param[in] pComponent component instance
* @param[out] pnResourceID returns the Resource ID
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_component_getobjectresourceid(_In_ PLib3MFModelComponent * pComponent, _Out_ DWORD * pnResourceID);
/**
* Returns, if the component has a different transformation than the identity matrix
*
* @param[in] pComponent component instance
* @param[out] pbHasTransform if true is returned, the transformation is not equal than the identity
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_component_hastransform(_In_ PLib3MFModelComponent * pComponent, _Out_ BOOL * pbHasTransform);
// Component Object
/**
* Adds a new component to a component object
*
* @param[in] pComponentsObject component object instance
* @param[in] pObject object to add as component. May not lead to circular references!
* @param[in] pmTransform optional transform matrix for the component
* @param[out] ppComponent new component instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_componentsobject_addcomponent(_In_ PLib3MFModelComponentsObject * pComponentsObject, _In_ PLib3MFModelObjectResource * pObject, _In_opt_ MODELTRANSFORM * pmTransform, _Outptr_ PLib3MFModelComponent ** ppComponent);
/**
* Retrieves a component from a component object
*
* @param[in] pComponentsObject component object instance
* @param[in] nIndex index of the component to retrieve (0 to componentcount - 1)
* @param[out] ppComponent retrieved component instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_componentsobject_getcomponent(_In_ PLib3MFModelComponentsObject * pComponentsObject, _In_ DWORD nIndex, _Outptr_ PLib3MFModelComponent ** ppComponent);
/**
* Retrieves a component count of a component object
*
* @param[in] pComponentsObject component object instance
* @param[out] pComponentCount returns the component count
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_componentsobject_getcomponentcount(_In_ PLib3MFModelComponentsObject * pComponentsObject, _Out_ DWORD * pComponentCount);
/**
* Link a slicestack to the components object
*
* @param[in] pComponentsObject components object to link with the slicestack
* @param[in] pSliceStack slice stack to link the meshobject to
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_componentsobject_setslicestack(_In_ PLib3MFModelComponentsObject *pComponentsObject, _In_ PLib3MFSliceStack *pSliceStack);
/**
* Get the linked slicestack tof a the components object
*
* @param[in] pComponentsObject components object to link with the slicestack
* @param[out] pSliceStack slice stack to link the meshobject to
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_componentsobject_getslicestackid(_In_ PLib3MFModelComponentsObject *pComponentsObject, _Out_ DWORD *pSliceStackId);
/**
* Set the mesh resolution of a components object that has sliceinformation
*
* @param[in] pComponentsObject components object for which the meshresolution is set
* @param[in] eSlicesMeshResolution mesh resolution of the components object
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_componentsobject_setslicesmeshresolution(_In_ PLib3MFModelComponentsObject *pComponentsObject, _In_ eModelSlicesMeshResolution eSlicesMeshResolution);
/**
* Get the mesh resolution of a components object that has sliceinformation
*
* @param[in] pComponentsObject components object for which the meshresolution is queried
* @param[out] peSlicesMeshResolution mesh resolution of the components object
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_componentsobject_getslicesmeshresolution(_In_ PLib3MFModelComponentsObject *pComponentsObject, _Out_ eModelSlicesMeshResolution *eSlicesMeshResolution);
// Build Item
/**
* Retrieves the object resource associated to a build item
*
* @param[in] pBuildItem build item instance
* @param[out] ppObject returns the object resource instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_builditem_getobjectresource(_In_ PLib3MFModelBuildItem * pBuildItem, _Outptr_ PLib3MFModelObjectResource ** ppObject);
/**
* returns, whether a build item has a UUID and, if true, the build item's UUID
*
* @param[in] pBuildItem build item instance
* @param[out] pbHasUUID flag whether the build item has a UUID
* @param[out] pszBuffer the UUID as string of the form "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx"
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_builditem_getuuidutf8(_In_ PLib3MFModelBuildItem * pBuildItem, _Out_ BOOL *pbHasUUID, _Out_ LPSTR pszBuffer);
/**
* sets the build item's UUID
*
* @param[in] pBuildItem build item instance
* @param[in] pszUUID the UUID as string of the form "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx"
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_builditem_setuuidutf8(_In_ PLib3MFModelBuildItem * pBuildItem, _In_z_ LPCSTR pszUUID);
/**
* Retrieves the object resource id associated to a build item
*
* @param[in] pBuildItem build item instance
* @param[out] pnID returns the ID of the object
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_builditem_getobjectresourceid(_In_ PLib3MFModelBuildItem * pBuildItem, _Out_ DWORD * pnID);
/**
* Checks, if a build item has a non-identity transformation matrix
*
* @param[in] pBuildItem build item instance
* @param[out] pbHasTransform returns true, if the transformation matrix is not the identity
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_builditem_hasobjecttransform(_In_ PLib3MFModelBuildItem * pBuildItem, _Out_ BOOL * pbHasTransform);
/**
* Retrieves a build item's transformation matrix
*
* @param[in] pBuildItem build item instance
* @param[out] pmTransform returns the transformation matrix
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_builditem_getobjecttransform(_In_ PLib3MFModelBuildItem * pBuildItem, _Out_ MODELTRANSFORM * pmTransform);
/**
* Sets a build item's transformation matrix
*
* @param[in] pBuildItem build item instance
* @param[in] pmTransform new transformation matrix
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_builditem_setobjecttransform(_In_ PLib3MFModelBuildItem * pBuildItem, _In_ MODELTRANSFORM * pmTransform);
/**
* Retrieves a build item's part number string
*
* @param[in] pBuildItem build item instance
* @param[out] pwszBuffer buffer to fill
* @param[in] cbBufferSize size of buffer to fill. needs to be at least string length + 1
* @param[out] pcbNeededChars returns needed characters in buffer
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_builditem_getpartnumber(_In_ PLib3MFModelBuildItem * pBuildItem, _Out_opt_ LPWSTR pwszBuffer, _In_ ULONG cbBufferSize, _Out_opt_ ULONG * pcbNeededChars);
/**
* Retrieves a build item's part number string (UTF8)
*
* @param[in] pBuildItem build item instance
* @param[out] pszBuffer buffer to fill
* @param[in] cbBufferSize size of buffer to fill. needs to be at least string length + 1
* @param[out] pcbNeededChars returns needed characters in buffer
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_builditem_getpartnumberutf8(_In_ PLib3MFModelBuildItem * pBuildItem, _Out_opt_ LPSTR pszBuffer, _In_ ULONG cbBufferSize, _Out_opt_ ULONG * pcbNeededChars);
/**
* Sets a build item's part number string
*
* @param[in] pBuildItem build item instance
* @param[in] pwszPartNumber new part number string for referencing parts from the outside.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_builditem_setpartnumber(_In_ PLib3MFModelBuildItem * pBuildItem, _In_z_ LPCWSTR pwszPartNumber);
/**
* Sets a build item's part number string (UTF8)
*
* @param[in] pBuildItem build item instance
* @param[in] pszPartNumber new part number string for referencing parts from the outside.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_builditem_setpartnumberutf8(_In_ PLib3MFModelBuildItem * pBuildItem, _In_z_ LPCSTR pszPartNumber);
/**
* Retrieves an internal handle of the build item. This 32bit number is unique throughout the model, but only valid
* for in-memory use of this instance.
*
* @param[in] pBuildItem build item instance
* @param[out] pHandle returns the handle
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_builditem_gethandle(_In_ PLib3MFModelBuildItem * pBuildItem, _Out_ DWORD * pHandle);
// Build Item Iterator
/**
* Iterates to the next build item in the list.
*
* @param[in] pIterator Iterator Instance
* @param[out] pbHasNext returns, if there is a build item to use.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_builditemiterator_movenext(_In_ PLib3MFModelBuildItemIterator * pIterator, _Out_ BOOL * pbHasNext);
/**
* Iterates to the previous build item in the list.
*
* @param[in] pIterator Iterator Instance
* @param[out] pbHasPrevious returns, if there is a resource to use.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_builditemiterator_moveprevious(_In_ PLib3MFModelBuildItemIterator * pIterator, _Out_ BOOL * pbHasPrevious);
/**
* Returns the build item the iterator points at.
*
* @param[in] pIterator Iterator Instance
* @param[out] ppResultBuildItem returns the build item instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_builditemiterator_getcurrent(_In_ PLib3MFModelBuildItemIterator * pIterator, _Outptr_ PLib3MFModelBuildItem ** ppResultBuildItem);
/**
* Creates a new build item iterator with the same build item list.
*
* @param[in] pIterator Iterator Instance
* @param[out] ppIterator returns the cloned Iterator instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_builditemiterator_clone(_In_ PLib3MFModelBuildItemIterator * pIterator, _Outptr_ PLib3MFModelBuildItemIterator ** ppIterator);
// Model
/**
* sets the units of a model
*
* @param[in] pModel Model instance
* @param[in] Unit enum value for the model unit (see NMR_ModelTypes.h for details)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_setunit(_In_ PLib3MFModel * pModel, _In_ DWORD Unit);
/**
* sets the units of a model
*
* @param[in] pModel Model instance
* @param[out] pUnit return enum value for of model's unit (see NMR_ModelTypes.h for details)
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getunit(_In_ PLib3MFModel * pModel, _Out_ DWORD * pUnit);
/**
* sets the language of a model
*
* @param[in] pModel Model instance
* @param[in] pwszLanguage Language string identifier
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_setlanguage(_In_ PLib3MFModel * pModel, _In_z_ LPCWSTR pwszLanguage);
/**
* sets the language of a model (UTF8)
*
* @param[in] pModel Model instance
* @param[in] pwszLanguage Language string identifier
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_setlanguageutf8(_In_ PLib3MFModel * pModel, _In_z_ LPCSTR pwszLanguage);
/**
* retrieves the language of a model
*
* @param[in] pModel Model instance
* @param[out] pwszBuffer Buffer to write into
* @param[in] cbBufferSize Buffer size
* @param[out] pcbNeededChars returns chars which are necessary to store the language string
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getlanguage(_In_ PLib3MFModel * pModel, _Out_opt_ LPWSTR pwszBuffer, _In_ ULONG cbBufferSize, _Out_opt_ ULONG * pcbNeededChars);
/**
* retrieves the language of a model (UTF8)
*
* @param[in] pModel Model instance
* @param[out] pszBuffer Buffer to write into
* @param[in] cbBufferSize Buffer size
* @param[out] pcbNeededChars returns chars which are necessary to store the language string
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getlanguageutf8(_In_ PLib3MFModel * pModel, _Out_opt_ LPSTR pszBuffer, _In_ ULONG cbBufferSize, _Out_opt_ ULONG * pcbNeededChars);
/**
* creates a model writer instance for a specific file type
*
* @param[in] pModel Model instance
* @param[in] pszWriterClass string identifier for the file (ASCII, currently "stl" and "3mf")
* @param[out] ppWriter returns the writer instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_querywriter(_In_ PLib3MFModel * pModel, _In_z_ LPCSTR pszWriterClass, _Outptr_ PLib3MFModelWriter ** ppWriter);
/**
* creates a model reader instance for a specific file type
*
* @param[in] pModel Model instance
* @param[in] pszReaderClass string identifier for the file (ASCII, currently "stl" and "3mf")
* @param[out] ppReader returns the reader instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_queryreader(_In_ PLib3MFModel * pModel, _In_z_ LPCSTR pszReaderClass, _Outptr_ PLib3MFModelReader ** ppReader);
/**
* finds a model resource by its id
*
* @param[in] pModel Model instance
* @param[in] nResourceID Resource ID
* @param[out] ppResource returns the resource instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getresourcebyid(_In_ PLib3MFModel * pModel, _In_ DWORD nResourceID, _Outptr_ PLib3MFModelResource ** ppResource);
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getslicestackById(_In_ PLib3MFModel *pModel, _In_ DWORD nSliceStackId, _Out_ PLib3MFSliceStack **ppSliceStack);
/**
* finds a model 2d texture by its id
*
* @param[in] pModel Model instance
* @param[in] nResourceID Resource ID
* @param[out] ppTexture returns the texture resource instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_gettexture2dbyid(_In_ PLib3MFModel * pModel, _In_ DWORD nResourceID, _Outptr_ PLib3MFModelTexture2D ** ppTexture);
/**
* finds a base material by its id
*
* @param[in] pModel Model instance
* @param[in] nResourceID Resource ID
* @param[out] ppMaterial returns the base material resource instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getbasematerialbyid(_In_ PLib3MFModel * pModel, _In_ DWORD nResourceID, _Outptr_ PLib3MFModelBaseMaterial ** ppMaterial);
/**
* finds a mesh object resource by its id
*
* @param[in] pModel Model instance
* @param[in] nResourceID Resource ID
* @param[out] ppMeshObject returns the resource instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getmeshobjectbyid(_In_ PLib3MFModel * pModel, _In_ DWORD nResourceID, _Outptr_ PLib3MFModelMeshObject ** ppMeshObject);
/**
* finds a components object resource by its id
*
* @param[in] pModel Model instance
* @param[in] nResourceID Resource ID
* @param[out] ppComponentsObject returns the resource instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getcomponentsobjectbyid(_In_ PLib3MFModel * pModel, _In_ DWORD nResourceID, _Outptr_ PLib3MFModelComponentsObject ** ppComponentsObject);
/**
* returns, whether the build has a UUID and, if true, the build's UUID
*
* @param[in] pModel Model instance
* @param[out] pbHasUUID flag whether the build has a UUID
* @param[out] pszBuffer the UUID as string of the form "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx"
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getbuilduuidutf8(_In_ PLib3MFModel * pModel, _Out_ BOOL *pbHasUUID, _Out_ LPSTR pszBuffer);
/**
* sets the build's UUID
*
* @param[in] pModel Model instance
* @param[in] pszBuffer the UUID as string of the form "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx"
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_setbuilduuidutf8(_In_ PLib3MFModel * pModel, _In_z_ LPCSTR pszBuildUUID);
/**
* creates a build item iterator instance with all build items
*
* @param[in] pModel Model instance
* @param[out] ppIterator returns the iterator instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getbuilditems(_In_ PLib3MFModel * pModel, _Outptr_ PLib3MFModelBuildItemIterator ** ppIterator);
/**
* creates a resource iterator instance with all resources
*
* @param[in] pModel Model instance
* @param[out] ppIterator returns the iterator instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getresources(_In_ PLib3MFModel * pModel, _Outptr_ PLib3MFModelResourceIterator ** ppIterator);
/**
* creates a resource iterator instance with all object resources
*
* @param[in] pModel Model instance
* @param[out] ppIterator returns the iterator instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getobjects(_In_ PLib3MFModel * pModel, _Outptr_ PLib3MFModelResourceIterator ** ppIterator);
/**
* creates a resource iterator instance with all mesh object resources
*
* @param[in] pModel Model instance
* @param[out] ppIterator returns the iterator instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getmeshobjects(_In_ PLib3MFModel * pModel, _Outptr_ PLib3MFModelResourceIterator ** ppIterator);
/**
* creates a resource iterator instance with all component object resources
*
* @param[in] pModel Model instance
* @param[out] ppIterator returns the iterator instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getcomponentsobjects(_In_ PLib3MFModel * pModel, _Outptr_ PLib3MFModelResourceIterator ** ppIterator);
/**
* creates a resource iterator instance with all 2D texture resources
*
* @param[in] pModel Model instance
* @param[out] ppIterator returns the iterator instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_get2dtextures(_In_ PLib3MFModel * pModel, _Outptr_ PLib3MFModelResourceIterator ** ppIterator);
/**
* creates a resource iterator instance with all base materials
*
* @param[in] pModel Model instance
* @param[out] ppIterator returns the iterator instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getbasematerials(_In_ PLib3MFModel * pModel, _Outptr_ PLib3MFModelResourceIterator ** ppIterator);
/**
* merges all components and objects which are referenced by a build item. The memory is duplicated and a
* new model is created.
*
* @param[in] pModel Model instance
* @param[out] ppMergedModel returns the merged model instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_mergetomodel(_In_ PLib3MFModel * pModel, _Outptr_ PLib3MFModel ** ppMergedModel);
/**
* adds an empty mesh object to the model
*
* @param[in] pModel Model instance
* @param[out] ppMeshObject returns the mesh object instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_addmeshobject(_In_ PLib3MFModel * pModel, _Outptr_ PLib3MFModelMeshObject ** ppMeshObject);
/**
* adds an empty component object to the model
*
* @param[in] pModel Model instance
* @param[out] ppComponentsObject returns the component object instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_addcomponentsobject(_In_ PLib3MFModel * pModel, _Outptr_ PLib3MFModelComponentsObject ** ppComponentsObject);
/**
* * adds a texture2d resource to the model. Its path is given by that of an existing attachment.
*
* @param[in] pModel Model instance
* @param[in] pTextureAttachment attachment containing the image data
* @param[out] ppTextureInstance returns the new texture instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_addtexture2dfromattachment(_In_ PLib3MFModel * pModel, _In_ PLib3MFModelAttachment pTextureAttachment, _Outptr_ PLib3MFModelTexture2D ** ppTextureInstance);
/**
* adds a texture2d resource to the model
*
* @param[in] pModel Model instance
* @param[in] pwszPath Package path of the texture
* @param[out] ppTextureInstance returns the new texture instance
* @return error code or 0 (success)
*/
LIB3MFDEPRECATED(LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_addtexture2d(_In_ PLib3MFModel * pModel, _In_z_ LPCWSTR pwszPath, _Outptr_ PLib3MFModelTexture2D ** ppTextureInstance) );
/**
* adds a texture2d resource to the model (UTF8)
*
* @param[in] pModel Model instance
* @param[in] pszPath Package path of the texture
* @param[out] ppTextureInstance returns the new texture instance
* @return error code or 0 (success)
*/
LIB3MFDEPRECATED(LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_addtexture2dutf8(_In_ PLib3MFModel * pModel, _In_z_ LPCSTR pszPath, _Outptr_ PLib3MFModelTexture2D ** ppTextureInstance) );
/**
* adds an empty basematerials resource to the model
*
* @param[in] pModel Model instance
* @param[out] ppBaseMaterialInstance returns the new base material instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_addbasematerialgroup(_In_ PLib3MFModel * pModel, _Outptr_ PLib3MFModelBaseMaterial ** ppBaseMaterialInstance);
/**
* adds a build item to the model
*
* @param[in] pModel Model instance
* @param[in] pObject Object instance
* @param[in] pTransform Transformation matrix
* @param[out] ppBuildItem returns the build iteminstance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_addbuilditem(_In_ PLib3MFModel * pModel, _In_ PLib3MFModelObjectResource * pObject, _In_opt_ MODELTRANSFORM * pTransform, _Outptr_ PLib3MFModelBuildItem ** ppBuildItem);
/**
* removes a build item from the model
*
* @param[in] pModel Model instance
* @param[in] pBuildItem Build item instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_removebuilditem(_In_ PLib3MFModel * pModel, _In_ PLib3MFModelBuildItem * pBuildItem);
/**
* returns the number of metadata strings of a model
*
* @param[in] pModel Model instance
* @param[out] pnCount returns the number metadata strings.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getmetadatacount(_In_ PLib3MFModel * pModel, _Out_ DWORD * pnCount);
/**
* returns a metadata key of a model
*
* @param[in] pModel Model instance
* @param[in] nIndex Index of the Metadata
* @param[out] pwszBuffer filled with the key of the Metadata
* @param[in] cbBufferSize size of pwszBuffer (including trailing 0).
* @param[out] pcbNeededChars filled with the count of the written bytes, or needed buffer size.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getmetadatakey(_In_ PLib3MFModel * pModel, _In_ DWORD nIndex, _Out_opt_ LPWSTR pwszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* returns a metadata key of a model (UTF8)
*
* @param[in] pModel Model instance
* @param[in] nIndex Index of the Metadata
* @param[out] pszBuffer filled with the key of the Metadata
* @param[in] cbBufferSize size of pwszBuffer (including trailing 0).
* @param[out] pcbNeededChars filled with the count of the written bytes, or needed buffer size.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getmetadatakeyutf8(_In_ PLib3MFModel * pModel, _In_ DWORD nIndex, _Out_opt_ LPSTR pszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* returns a metadata value of a model
*
* @param[in] pModel Model instance
* @param[in] nIndex Index of the Metadata
* @param[out] pwszBuffer filled with the value of the Metadata
* @param[in] cbBufferSize size of pwszBuffer (including trailing 0).
* @param[out] pcbNeededChars filled with the count of the written bytes, or needed buffer size.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getmetadatavalue(_In_ PLib3MFModel * pModel, _In_ DWORD nIndex, _Out_opt_ LPWSTR pwszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* returns a metadata value of a model (UTF8)
*
* @param[in] pModel Model instance
* @param[in] nIndex Index of the Metadata
* @param[out] pszBuffer filled with the value of the Metadata
* @param[in] cbBufferSize size of pwszBuffer (including trailing 0).
* @param[out] pcbNeededChars filled with the count of the written bytes, or needed buffer size.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getmetadatavalueutf8(_In_ PLib3MFModel * pModel, _In_ DWORD nIndex, _Out_opt_ LPSTR pszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* adds a new metadata to the model
*
* @param[in] pModel Model instance
* @param[in] pszwKey Metadata Key.
* @param[in] pszwValue Metadata Value.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_addmetadata(_In_ PLib3MFModel * pModel, _In_ LPCWSTR pszwKey, _In_ LPCWSTR pszwValue);
/**
* adds a new metadata to the model
*
* @param[in] pModel Model instance
* @param[in] pszKey Metadata Key.
* @param[in] pszValue Metadata Value.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_addmetadatautf8(_In_ PLib3MFModel * pModel, _In_ LPCSTR pszKey, _In_ LPCSTR pszValue);
/**
* removes a metadata from the model
*
* @param[in] pModel Model instance
* @param[in] nIndex Index of the metadata
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_removemetadata(_In_ PLib3MFModel * pModel, _In_ DWORD nIndex);
/**
* adds an attachment stream to the model. The OPC part will be related to the model stream with a certain relationship type.
*
* @param[in] pModel Model instance
* @param[in] pwszURI Path of the attachment
* @param[in] pwszRelationShipType Relationship type of the attachment
* @param[out] ppAttachmentInstance Instance of the attachment object
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_addattachment (_In_ PLib3MFModel * pModel, _In_z_ LPWSTR pwszURI, _In_z_ LPWSTR pwszRelationShipType, _Outptr_ PLib3MFModelAttachment ** ppAttachmentInstance);
/**
* adds an attachment stream to the model. The OPC part will be related to the model stream with a certain relationship type.
*
* @param[in] pModel Model instance
* @param[in] pszURI Path of the attachment (UTF8)
* @param[in] pszRelationShipType Relationship type of the attachment (UTF8)
* @param[out] ppAttachmentInstance Instance of the attachment object
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_addattachmentutf8(_In_ PLib3MFModel * pModel, _In_z_ LPSTR pszURI, _In_z_ LPSTR pszRelationShipType, _Outptr_ PLib3MFModelAttachment ** ppAttachmentInstance);
/**
* retrieves an attachment stream object from the model.
*
* @param[in] pModel Model instance
* @param[in] nIndex Index of the attachment stream
* @param[out] ppAttachmentInstance Instance of the attachment object
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getattachment (_In_ PLib3MFModel * pModel, _In_ DWORD nIndex, _Outptr_ PLib3MFModelAttachment ** ppAttachmentInstance);
/**
* retrieves an attachment stream object from the model.
*
* @param[in] pModel Model instance
* @param[in] pwszURI Path URI in the package
* @param[out] ppAttachmentInstance Instance of the attachment object
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_findattachment (_In_ PLib3MFModel * pModel, _In_z_ LPWSTR pwszURI, _Outptr_ PLib3MFModelAttachment ** ppAttachmentInstance);
/**
* retrieves an attachment stream object from the model.
*
* @param[in] pModel Model instance
* @param[in] pszURI Path URI in the package (UTF8)
* @param[out] ppAttachmentInstance Instance of the attachment object
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_findattachmentutf8 (_In_ PLib3MFModel * pModel, _In_z_ LPSTR pszURI, _Outptr_ PLib3MFModelAttachment ** ppAttachmentInstance);
/**
* retrieves the number of attachments of the model.
*
* @param[in] pModel Model instance
* @param[out] pnCount Returns the number of attachments
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getattachmentcount (_In_ PLib3MFModel * pModel, _Out_ DWORD * pnCount);
/**
* retrieves the size of an attachment in bytes
*
* @param[in] pModel Model instance
* @param[in] nIndex Index of the attachment stream
* @param[out] pnSize Returns the size of the attachment
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getattachmentsize (_In_ PLib3MFModel * pModel, _In_ DWORD nIndex, _Out_ UINT64 * pnSize);
/**
* retrieves the path URI of an attachment
*
* @param[in] pModel Model instance
* @param[in] nIndex Index of the attachment stream
* @param[out] pwszBuffer Buffer to write into, may be null to determine needed length
* @param[in] cbBufferSize Size of the given buffer
* @param[out] pcbNeededChars Returns number of bytes written or number of bytes needed to write.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getattachmentpath (_In_ PLib3MFModel * pModel, _In_ DWORD nIndex, _Out_opt_ LPWSTR pwszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* retrieves the path URI of an attachment (UTF8)
*
* @param[in] pModel Model instance
* @param[in] nIndex Index of the attachment stream
* @param[out] pszBuffer Buffer to write into, may be null to determine needed length
* @param[in] cbBufferSize Size of the given buffer
* @param[out] pcbNeededChars Returns number of bytes written or number of bytes needed to write.
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getattachmentpathutf8 (_In_ PLib3MFModel * pModel, _In_ DWORD nIndex, _Out_opt_ LPSTR pszBuffer, _In_ ULONG cbBufferSize, _Out_ ULONG * pcbNeededChars);
/**
* Get the attachment to the OPC package containing the package thumbnail
*
* @param[in] pModel Model instance
* @param[in] bCreateIfNotExisting create the attachment if it does not exist
* @param[out] ppAttachmentInstance Instance of the thumbnailattachment object
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_getpackagethumbnailattachment(_In_ PLib3MFModel * pModel, _In_ BOOL bCreateIfNotExisting, _Outptr_ PLib3MFModelAttachment ** ppAttachmentInstance);
/**
* Remove the attachment to the OPC package containing the package thumbnail
*
* @param[in] pModel Model instance
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_removepackagethumbnailattachment(_In_ PLib3MFModel * pModel);
/**
* adds a new Content Type to the model
*
* @param[in] pModel Model instance
* @param[in] pszwExtension File Extension
* @param[in] pszwContentType Content Type Identifier
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_addcustomcontenttype(_In_ PLib3MFModel * pModel, _In_ LPCWSTR pszwExtension, _In_ LPCWSTR pszwContentType);
/**
* adds a new Content Type to the model (UTF8 version)
*
* @param[in] pModel Model instance
* @param[in] pszExtension File Extension
* @param[in] pszContentType Content Type Identifier
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_addcustomcontenttypeutf8(_In_ PLib3MFModel * pModel, _In_ LPCSTR pszExtension, _In_ LPCSTR pszContentType);
/**
* removes a custom Content Type from the model
*
* @param[in] pModel Model instance
* @param[in] pszwExtension File Extension
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_removecustomcontenttype(_In_ PLib3MFModel * pModel, _In_ LPCWSTR pszwExtension);
/**
* removes a custom Content Type from the model (UTF8 version)
*
* @param[in] pModel Model instance
* @param[in] pszExtension File Extension
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_removecustomcontenttypeutf8(_In_ PLib3MFModel * pModel, _In_ LPCSTR pszExtension);
/**
* Adds a slicestack to a model
* @param[in] pModel Model instance to add slicestack to
* @param[in] nBottomZ Bottom Z value of the slicestack
* @param[out] ppSliceStackObject returns the new slice stack object
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_model_addslicestack(_In_ PLib3MFModel * pModel, _In_ float nBottomZ, PLib3MFSliceStack **ppSliceStackObject);
/**
* Adds a slice to a slicestack
* @param[in] pStack the slicestack to add the slice to
* @param[in] nTopZ upper Z value of the slice
* @param[out] pSliceObject returns the new slice object
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_slicestack_addslice(_In_ PLib3MFSliceStack *pStack, _In_ float nTopZ, PLib3MFSlice **pSliceObject);
/**
* Returns the number of slices stored in a slicestack
* @param[in] pStack slicestack to query
* @param[out] pnSliceCount returns the number of slices on the stack
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_slicestack_getslicecount(_In_ PLib3MFSliceStack *pStack, _Out_ DWORD *pnSliceCount);
/**
* Query a slice of a slicestack
* @param[in] pStack slicestack to get the slice from
* @param[in] nSliceIndex index of the slice (0 to slicecount - 1)
* @param[out] pSlice returns the slice
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_slicestack_getslice(_In_ PLib3MFSliceStack *pStack, _In_ DWORD nSliceIndex, _Out_ PLib3MFSlice **pSlice);
/**
* Specify whether the slice stack should be stored in a separate model file within the 3MF-file as a slice ref
* @param[in] pStack slicestack to set the reference
* @param[in] bUsesSliceRef flag whether to use a slice-ref or not
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_slicestack_setusessliceref(_In_ PLib3MFSliceStack *pStack, _In_ BOOL bUsesSliceRef);
/**
* Returns the slice reference of a slicestack, i.e. the slicestack is stored in a seperate entity within the 3mf file
* Get the specification, whether the slice stack should be stored in a separate model file within the 3MF-file as a slice ref
* @param[in] pStack the slice stack
* @param[out] pbUsesSliceRef string for the slice reference
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_slicestack_getusessliceref(_In_ PLib3MFSliceStack *pStack, _Out_ BOOL *pbUsesSliceRef);
/**
* Returns the top Z of a slice
* @param[in] pSlice the slice to query
* @param[out] nTopZ returns the upper Z value of the slice
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_slice_gettopz(_In_ PLib3MFSlice *pSlice, _Out_ float *pTopZ);
/**
* Add an array of vertices to a slice
* @param[in] pSlice the slice to add vertices to
* @param[in] pVertices array of MODELSLICEVERTEX structures
* @param[in] nCount number of MODELSLICEVERTEX strucutres in the array
* @param[out] returns the start index of the slice, i.e. for the first vertex array this is "0" but later calls to the function append the vertices to the internal array so the value returned here must be added as an offset if accessing the vertices
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_slice_addvertices(_In_ PLib3MFSlice *pSlice, _In_ MODELSLICEVERTEX *pVertices, _In_ DWORD nCount, _Out_ DWORD *pStartIndex);
/**
* Add a polygon to a slice
* @param[in] pSlice the slice to add the polygon to
* @param[in] pPolygonIndices an array of indices refering the slice vertices. If more than one call to "lib3mf_addvertices" was done the offset (pStartIndex) must be considered when adding a polygon
* @param[out] pPolygonIndex returns index of the newly created polygon
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_slice_addpolygon(_In_ PLib3MFSlice *pSlice, _In_ DWORD *pPolygonIndices, _In_ DWORD nCount, _Out_ DWORD *pPolygonIndex);
/**
* Add a new (empty) polygon to a slice
* @param[in] pSlice the slice to add the polygon to
* @param[out] pPolygonIndex returns index of the newly created polygon
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_slice_startpolygon(_In_ PLib3MFSlice *pSlice, _Out_ DWORD *pPolygonIndex);
/**
* Add a vertex index to a polygon created with lib3mf_slice_startpolygon
* @param[in] pSlice the slice with the polygon
* @param[in] nPolygon the polygon index
* @param[in] nIndex the vertex index to add to the polygon
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_slice_addindextopolygon(_In_ PLib3MFSlice *pSlice, _In_ DWORD nPolygon, _In_ DWORD nIndex);
/**
* Returns the number of vertices in a slice
* @param[in] pSlice the slice to obtain the number of vertices from
* @param[out] pVertexCount returns the number of vertices in the slice
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_slice_getvertexcount(_In_ PLib3MFSlice *pSlice, _Out_ DWORD *pVertexCount);
/**
* Returns the number of polgons in a slice
* @param[in] pSlice the slice to get the number of polygons from
* @param[out] pPolygonCount returns the number of polygons in a slice
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_slice_getpolygoncount(_In_ PLib3MFSlice *pSlice, _Out_ DWORD *pPolygonCount);
/**
* Returns the vertices of a slice
* @param[in] pSlice the slice to query the vertices from
* @param[out] pVertices the array of MODELSLICEVERTEX to be filled
* @param[in] nBufferSize the number of elements in the pVertices array. Should equal the number of vertices in the slice (lib3mf_slice_getvertexcount), if smaller not all vertices are returned, if bigger memory is wasted
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_slice_getvertices(_In_ PLib3MFSlice *pSlice, _Out_ MODELSLICEVERTEX *pVertices, _In_ DWORD nBufferSize);
/**
* Returns the number of indices of a polygon in a slice
* @param[in] pSlice the slice to query
* @param[in] nPolygonIndex the index of the polygon to query
* @param[out] npIndexCount returns the number of polygon indices of the polygon
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_slice_getpolygonindexcount(_In_ PLib3MFSlice *pSlice, _In_ DWORD nPolygonIndex, _Out_ DWORD *npIndexCount);
/**
* Fills a list of polygon indices with the indices of the desired polygon
* @param[in] pSlice the slice to query
* @param[in] nPolygonIndex the index of the polygon
* @param[out] pIndices an array of polygon indices to be filled
* @param[in] nBufferSize size of the pIndices array. Should equal the number of indices in the polygon (lib3mf_slice_getpolygonindexcount), if smaller not all indices are returned, if bigger memory is wasted
* @return error code or 0 (success)
*/
LIB3MF_DECLSPEC LIB3MFRESULT lib3mf_slice_getpolygonindices(_In_ PLib3MFSlice *pSlice, _In_ DWORD nPolygonIndex, _Out_ DWORD *pIndices, _In_ DWORD nBuffersize);
};
};
#endif //__NMR_DLLINTERFACES
|