From 933efe83a27e1010776a80f911142c527a2b314f Mon Sep 17 00:00:00 2001 From: Kasper Frandsen Date: Wed, 1 Dec 2021 17:10:43 +0000 Subject: [PATCH] docs: add documentation for node --- .../doc/images/node_bevel_samples.png | Bin 0 -> 6418 bytes .../doc/images/node_filter_bevel.png | Bin 0 -> 4041 bytes material_maker/doc/node_filter_bevel.rst | 34 ++++++++++++++++++ material_maker/doc/nodes_filter.rst | 1 + 4 files changed, 35 insertions(+) create mode 100644 material_maker/doc/images/node_bevel_samples.png create mode 100644 material_maker/doc/images/node_filter_bevel.png create mode 100644 material_maker/doc/node_filter_bevel.rst diff --git a/material_maker/doc/images/node_bevel_samples.png b/material_maker/doc/images/node_bevel_samples.png new file mode 100644 index 0000000000000000000000000000000000000000..cfca5e28a701e791918fea46c3a0afc7ca12ee78 GIT binary patch literal 6418 zcmbVxdpy%^`2W4N)f^rsB=KbAP!v)*<=JM4o^q;Kgz1S$i5$`a8--DrRAgyFQDo)N z!D1>;Nag$}3^nDHvoK?R_v-ua@Adk=zJG1I_qnh8y586OI^5SM(aFK~56KOZ0DwRC z+F2g}00F-u0A@A(@CYe9F8&pIz?K9`KB^7_u>SpCYs*9DZjWVqhH5-(`~7QDFPW1ijRMJl>{)UK(iNg-bS!(gcUBiHio zG5;#BZm%rGmx^FAy{-;w;h)_2jg-+Cw^2=PSRgPOend@}cv1P&_( zd-Bqtif_FQbD)Z;si`|}?e{m&ZvE#;&YLepXi+tF<@CkGM|{ssSYs|%diAOe$$NHg zOdTE`PQ1fnoiJv$MB)pcJu}JLul-Bt9?*ZK@!LNaB_0{7%A7D<-yCe34<*aW$|hoh z6&|}kdZ{OMK?|5JPbBg`&8^+wXR6xz^TNGX-Z{z0*M|8S8A=x}UYse>?Y{wN7e5Y` zjcM(C=WY00cq5Nynld~!m3F^v3k1Xoi`pARGe}D_LDJeNsiVl6y9Cyf^)rph*;(ts z8M7CXD9e5qw`LUtxZqKZoP5jm&~G3Vy#UH+2;7x_W1|J%l!D&HdSM_4VIDH!=i3@T z7=$9WB0bjK{%}0ZV&fJJ62dw=)@{;FAn{ENz^A3ple|y6phG;_oy<1Yikm$q#D-?$ z{p4`-=%`-cvm=8PDRTpWQ&CchImh28w_YZ}trN-wJEqpk!B>rN;X zpg{o@@960GG{b4Pvw{|rq9jpBF_NU`(xH9ZG8#42pMO4eYQ--3OF5uL9xuB!rq%vV z5LtZ%976Pa0J(d65J%Uy22|wYF#a5#IaBY9D+pd>PR-37zbH|0rpoIChu12IylD3VGo%iGDl=?N zrR%yd2SD8JQID9^CTvV?Ag_-%AtQQ+Dm{qqF5X7BG@StjEm|Bk=q8+gWGbf5m9oQI zPZ``bQk@$`5%(YhHsbaHp9GvOLO(?|^lv~sv)H?)hIuRD;$xsHlQ5vmxQV^q0X*Fp zd9=+**QSmZbtK^lgzPO+DfFS0QwF&*!HYr(R+lw_jXa~;CWv&XUg(=jG+4QlziV|v zljfoz;tD}0=%gCK>=o8(7CdQDlUphyx`k>=Ba2wIG(j7NyA)K#=+v= z+-YrGudq9svp(yQZy8KDmzXb4k9%Q=fQNW^D^^H$v1S4$r8l zdkG0^n1m3m3o3~I*)`?^n^=wCLJmq^e*tz$GWwWgWyW5s6y&1&x*zv|_spfO=gQvM zKir3T=tdRoVsEYIdg&`c9Q8A##^!}yH_>S*)W=teyT`xsFPiJ1Iyz$yU`p?=c`>Bh z&cT2Jf?>?WLIBAyDOXc{vkA4O6xR~SZ}}FoxAvYR4hcRQZAd=7pV+aPC~4WHf~eS< z`AxSr8X2W4HK&WL8J11L$;aMa(_DcWtppuS%{S1Ar**I_hl1W4=!=_ROy@`k1ktjj z53wOI`yV1l6!{@9nomC)wO63wLI2K6ullu5m_SnFSvt#z^oGlC`Da>Hh}I^5Au26m zvakb!7y|=?^21v%{B+1s61&bRuDmTvK6ZN6b*1Fn4YYE_z^9B-oCfH(2vDfWj#>JL zL6I6UM}?;W>hY|iW*EX0>T<{T)KmKhH-X!t9GP|*OHVwpQ#~_dmD6sN*_V1Y`i)`v z^h{Q)5pHrd{sD`{+9LgiDfiC^wk5ZObi&G-Gp^e{EQYF39y&nF@*{faA@Y3S>*;rp zM}B2FVS;R;9~v;#b|Qif|9tV--0E??m3m^92|c&4&DT;B5kszzK#nXt9uE5(=A^Ev zqX9;SfsyMul2d+VMNZ^l9~7-kZD(TTlQM0InTcaz*)ahmr?YF`UG`S$lfX$}URrCT z1mz{&E_RC&KYrIR>W|&#N@98h=A4u{kO$hPj-GG^a=e$8-t)QoF&J>}%4vGxUbp6U z7dnB{SVGE9f^5BHoTd}u>QduNzWWgaj0ulp%<=o@-J5;M>emr5o%N+S3OX`Gal~4z z(5HNR^4*eTSu0r9c{(T;LQGvcymPE4GD+ z!&1qPsm$oqE^b`olPo)$RfK&<14{`by7@QJZSnMx)rqB;p?G@y(ah(PupTGn)^|0X z+9jq^rFHK~OL?-oM(b0F9iE|zrP^ZtT&XW2x{{g|$?8Hk3^2c}s-{hm3L#Aj1Ok2a z&1^)#KMcZ-4=(;s4j+!%=CAcj(A9BW@2|S~cb2qENS&iMayOT{uCrc?1%JTbZu~dX z9&x6x`!DBgBj5e+7bj%vHxsLe_;$FU$jqgy#jDl3OGuAk?j{V$yE(>(lM#Zb`?7JT zIFjlT7^38D?4i1Z2ANmpo^hwH%AVXNK5`Kgbjpnr^xB2a-cZo?phL_^5aLvq&@rrA z>kM>My3Z;G{8Dc5s{6X)ZkNr0bbpl+(&kl2Z{p1&#$Go=cs5k%tyrNNbeJ=(#Qu3u z2`O2uMzBPMNlm+pU38Eu$!SoxeRjc66M-8oESUF>T_!u%ZPyP32(-@ZhrN;Q*T@f)5OdUR`z_v z+JrbQrw<*)RB4Vc!iE5Fov4H^w6YHWV0q$_b>ij@G0HHa0(|KHW8zrsUlriyv?wvx z;8N&{sQJDI|B6`wZP0$3@I?|3_nMyZ8`0I2kG1iL8(4T;*%(`40|^q73Ozr32Q7c= zg`^zM3q5jHk)({JCHZ{58tUdWsN-#pzq*WqtlA7a1pSPPWZ9x$z(wvcF)K7EA<+RS zM7XUR*i1CW+GbKG+6PWsyHBWHj?j_8y}75rV@l<<}UhDu4}=mXi&`{ zBMy?)1y%R?Z}MvnZIjBC#t`i%u`L$x@u{P3C8WHTq3>E>Bk}BiT?)g*DAF#5kz>kb zUK#P<(5vI)+rQ{u*2IBbd7+BejQJL01@9LOmClQ<|912X%gU_n95`Vc#Fyv4P%S#jIjuTbu#BC&=)i!l5AC~^npOsDt zkZ{4N_eIk0?w-Yr#M4vi_)ILJ$;B>-=t5TKLmzYfaBBefJtqx{O0fA`9>uuCd`+Jk`^5i3`MQv7lmcTp+?h5MbD^J>E- zEX}NEgH6RJ@=j+ku`o6>FWKen^jHU}{I{OexwJKk>U?r~axrz2G zb2}h2VBmmxxam#!uWEQcUJ!Z58gc%4Z*e>oRIR(mG+kp!AwX8|IB-c?FAT=u?M)NH>N z3k!_&wM%a&v$Ojog3X+?SC>iKw72HCuk%6lH&_M*1x2_ZpmTQQ9P+nzb$cuUgFAA4 z$?uET&Q%W7O&adMuE7qq8&UK<~ozIQxz$V8|eyYE3zN)LEegHg3OfQ}F0vK7Uik z9t#(MMbq{(e(0f@=juN+6%d***R4p2<0b@ZL(>3<5EPxF``>8z$UdTmHOP_vv~aKG z#&UZb1&`K#C$l1$e~`!>JIhpF+;J?=_IXmA#k9U(lYa^Cj?xS!d_T zfv?*+E3o;;N0fc`ky)iqLV+aO2g(Ngy*GyY9U_$x`C6j=jnS>4-p{&Q;H~laP}6`U z2tm;3j|FKGB~zrPqf1VU%I~v^IfMjJBz%b5H*uoMtF5js;fek8 zGcv%L=I1@riHul!aF>v<;^xaO=5V`a%eu#|RdOE~;N-5+h--|gfj(7p>Fd5|`x0{5 zUvj2r2b;XuowLirdD5t!CZHoN0F!I%^Vy(iI6>t+{r!<>v#GiQ0%2kM-le@*1ZW1+ z6|AhE?A8ebim>72zsJkqEoT1p=+>=pFR0f^;d7#?qHD{d^AXf7z-UT`t=Kb_@!tf? z<^cw10HS$iH1(DMUQXUFi$;bGtX6QCYo`fqr7TIv@OEjIsIpcqLFC&QUCLzWEIm9{ zo#f;WeGHSH>a6q63YNZDBJ;!B!ajnOHQa%USZa`W*A`7@MYnSZ)cfPJgYT)gYFYW$ z08SEKqKogVwWV;2OVwB+;WA!%*17yg!2vVKNDzE+vEZkWyhYgHSKBk?H{E3*>w$nZ zr-I+)Q}5TyqnPxu99N)m2Yd-P+)=<8Oe&{uhnFwq!00`9M5>E3^oi6|*~O)$V&5@w zwX*9v$-UnbWz4i6E@k~4C=QGTdf0r6mS}*--4emlg?)C8rrS8aXR6?i$oFmJw->@g zcU=)g1rYhVomcQa)8PE0{$|1lUV&tVEx;oBSK0JLy}K-$o;5K4UW9p$1Ww4G(Y@uI zrVCXi+op6*Sc{R#aBhrtn_0fnzSLMLJcN(~0Ns);8aYBe7@?NS-cIr5MLlfJ6r-V^ z8#=$2IYDXX*~W{Y=!XymU^U$n)w;NB4-seO&^eBZ8x(;xqDE^VNA_R@%g74YlE<_X{N(Ov&92|cW zGzZP8{~z@q{@N1jNd5VMJu;p*I`7C4j`l>w;tJtea_*@Bhs=?!kEVXU4e5ThCu&cg z^GGIpX9TPAZKNWC48TsG7sAO*b}@(A3$=iVc-x3Ghkp9^@lCA7k>16Ej^)JGy2y?% z;|I}@SD5|0sIX(z5S#YS=-WSoc2DU%(S{5sDsAD9TlwI>@AJ|-%kkU<`RTn&oZs}* zT<7$@j_=rzY{ZK)E$!bz2n=7k7o!Kjin_gN(yVYWSYp= z@ojul-=fl)`LtuzSz+@JV#5(2M`{S3tIo3FMYV6I*o#>rFGluLZ7okH=zT^*BvtUS z&-Jt8J$X2M+m=)*#44)H{JV@=>Mux!ZW+2NhRfI~A<}qkyzOl!TO(`_phJi}!+g0$ za*Mqi~i&?hv;@lS=zWkbaPYl$LO4OGn)Wi6C_8$TH50B4Zl z*KREA$e!r45$oY4*3I0%m1hfAo9>zhb_Ch{DaZ^~6d0-_sC{+$z)0*>snrMb9X4AkFgb;YpGSOvv7LM{9?TWs;{ zZ@AW<7{^!sc7q_sSR6)r&^Z|GalB1kXOt|qj7KVFt-tOgZ zyuNT~yQw;`#v&+bzFdnS0vQ@@__PXmXBbKc!ZDF~1nbQghOnzC>^->?{?~sUOse4w z3nqNG=Ca7Na=AViF+JENFcZDnf&l-X(YkF9GfoFDVbc|SvOqUB6cRaS{fe*;PK)lY z)6cl_bXcd6SLahr;0Pn5qs`M7(oJ(CB-69bh=B);-N=#*7TJdzS_C`7m?P zgF4TM+2_NbUSVqZa`7B!-+2Ts7UQFyKzY8Wi^sBC>0+}X8zxDx$mO-v!=bDe^xDVy z!8UG?czqAtKct+>6Y1g5w3c5&m0)&yHAaYHTp2|Yt>b#4Jl4;+pypR*(RAeanPthE z=RcsTY!v9>hpct_*9E#~VWwb3EmL*C;1|S=7(k9O@CZb;-o3f(aR#E4fdtj2*$z;D z-RW1dolC-TC;@WGxyCUT_qgh^Ya-ut@6r^*QEftW^%)XGe?2x-R4H7z+9`(jQ4H?> z(X;P3ofR>mmFZPje~Uw$vgJ{0Ymw`!~g&Q literal 0 HcmV?d00001 diff --git a/material_maker/doc/images/node_filter_bevel.png b/material_maker/doc/images/node_filter_bevel.png new file mode 100644 index 0000000000000000000000000000000000000000..f870df9fa403e63b4569e65557da6ca3d6578ede GIT binary patch literal 4041 zcmV;)4>s_LP)Px#1ZP1_K>z@;j|==^1poj532;bRa{vGqB>(^xB>_oNB=7(L4_-+`K~#8N?VR^p zRYxAi_jxqN*s^KH-qMUMYK&k(EW}3aJ+@eg1wjP`L^=Y}i-JfKG+-BLcB8PMNFYW{ zU-N99-A$fnf6BA_54?Nc!MQoydoJD!h;Z-u;eFsvJ!d}io$s8PIp;6^`t^gZ_Aecz zjYtP+BeDqOkRd}ba`;G$8lkJTG-B8Y3>Yv#lZTcxLH6(8A8)<&7IyF2jkuUtWTt1} zQehdcUc9WUm2~k;A(9f45EC7Pl`B_16{;r4_3PK;(&5aPH8(Q|_lJ1-P5t|16__Cth& zAJU%y$ec>3PX{a0u_FXIcq4oJVMMt2BVl5QN!s?L9G66#T%Li`tFp{0e{njprzL3S zZ%o+=%!=5nD7jFK_uqfN0Yu6Ga?qebIFy`%>w!g@1+kIi7lz~Ejr*uR`!}JgQ{{+u z4HnkK_=Ar75$zbDSXmHaCIldUVz7XmqI7~7#qwxDaf5$|G!#!O4zYk$tK}c-PyZX zvwDqrkRwNqMBU|kC|HuNSpY#LEsw$@1!Ua9FhtJ_K}}&5P6p&+*Jw9H&I&;KrbHyI zjDq{<4G5j(i}2}w2p{i@U`KDnFAf*sK`whmx|CH1v2VO5{3dv!uA~~NYvbBINcy$M z*T2WP^~X@K^r(rh`Cr7(SHDw09a1bT0cE?-pgQ#y3YHx;ltGKWd-xX0cAXYhs4kx> z@jQis+Gw3RC-lt z7Rr(e;X7uB$X8Q(2mbTCaQoy9k*@aQUF3MB!F}9Dd{uncWR7tP+MA!(5XH+9iYreQ%)nr zGY+*1G^RVJq^mBjgy$qT)D&0QB}nSz@}mM=T}~Bhvnp{fy&R`jW;DpB7D1L@y^S$r z#%P0Fw{9ICT>MHiGbKSjxLSuWWylPfvKKcqFXL=t0geS{;Me=VpyI?$RDAIzij&S` z*OV=|bFLgm-IA5Cn}~CZK=%G4n(1na>=$I#G$r4b6ZpR9fe`;^m^zP96T z92}Yn@>(4ZC^O8U$$L;5e*wkm7m(r+Cx*wUIe`dq_Cd%rA8Z}D4(AT!<7UQXe63ip z&omDl*^#7JWVIn(fU_62jr&Zo$UAmykr}8yavQaZMb;g=BZgMB&ooxcfLs=d$2C8R zA@$z*N(JiIh+BOC-cH-=t?c+s+*17CN&j4Uj@%?BK7YUWBg%8H!+Z2r#gcs+q|5Wm zP(W@Fe$`e${#x-fDif}wBKoR{zRtZPX08&X^od_7Lo0_^`o(&mS*|>$95E@MYBtD} z$>9ic^ipP@2avq-AQG2H;^3ShgpBt_@HlTo%RTx@jjPm@)XFxs|@;9Fo8ON2LXg(h*&yNX{ zLc}UfvI3v!R=JHb`AhSB^^(&aBSHIR&UWom!Epnb%S^2_!A#=o2fV|I*c(3KDDE zWKh4P*#wZOPEqh5>j{TmV=<^lfAs6#8-2R<($&i9-=i;v{B}CFbnDa=9XoVHhYlT@r7m5%phu4$cCYT;yQ5>rrnM(I^y=CZpATPS8OYiTcQK>i zWX-~ws#jil1%3PWwR^q!=9_rog%>p2$WnFb)CD^ye2&WN6^(;DoqGy@?c77Nkfw?t z)fL*SdiCnnY>?Ej0Yh>9%C*Kp=454SW^Rsjko9UQkUe|$#Ffie8V8w~nQ4-d<2o;( zspGpANS;La;DZnF@y8#FeNcuC95_&HY;W4M3Dc)f7ik6$9*h|?W?=2wwQzNH6^Fpo zWjHxGiL}fs!;QsV0%vDuI669tJPaE?e7HCV!*WND9xcL$4jqbx3m0O|nl+d>aiSqD z#d_z@pD%WZWSF(G2Bd6rt@H$W>Cz?hAbC^9AX)kB*|V{6<3=oBz8vqq`z|_l>eL|3 z)1(EG4I35~hLn^P(SQtN`O(qQ*t&Hq;^N{2AZp*feb}&J10o_KMB~dc*r?3!~PY;Sq{&(@LHK~+qP|RcXtNU}@K_hq z5&EG+hs1TO?}cKXIdkTSa@AqercDzgh72Ly%=%HM>;PDH@`y=c)Q0eZ!X74Y@-6%g1%LqbBtHT(JbVbrKmA}!(Z-Xus` zIW1le)3kWP=KmD)u~QKO>t{V233xrMSEiGC`|Y$Hr%U1jmUMErQqd&O7f2|4F~i;X6M+ zAMx?=4Sc6sv?`XBo}Ml`6w6n~8xO6$d-oRiMmNARUwrXJaecHt<2L6tvEwnH)gWJg z{dI9;Y9Gl0X%*JYU@Za3-|YEp01j;g!C{HRJJZm@*y|Zbp!8J~8<_F*aV(F$mT;Jk zhsjv3F-X=&AIagH2Y#8K4as4fpg8ohF6L)L%evCi(nLp*edx#0KUN$>Ed!i<&oYo)}(ZV`D{!VdrGsSy@?zx|m*F zE@#uTX3c6)wl&fMsU^-(IcmsRD?6F-tko)zQu3L`8Y@)G97u|ds{T!j;V>)134vi! z#_1`oFfFkx^=}TP(g*W5%W14GrZX>yzruVzn5~Rh;HLgtsNx97wL1aNCH>V_fw1@bEBMo8%5YH+i|=D3|csyKD|5 z*EI>z#l=NfBp0x`wkYFitz2W}BD&moR_AZ8vN@349^)?4I&Ahp$IKyqW2fVj`bNe!)& z8_4vX>hH(sAhp$IKyos}OacXKyre^V}Hit(MB!^@YI}Eyse1O&Ncy(zK#BaX>5+38%W;78*jW}_u@-Y z`eerjq|aL0p?GSZ^8!llx9T9 z;u~LFQl$9q$)rh>gcVX;TGT2-2ib~Jzx%-#cBGZ@M1!<2ig8>zl+r58SUSjOD77!+ zD|WOlX=!{5O4AaVQjdYOBklL3~gksK@(a&)gMp{`*ANtZkS}A_^Ma!2_e8*E- znK@tftfYg~klM=BzRcL48T+#5d9+dosfe>iUO3g5FQe2SU}#IS8<1)%BM@GXl-kPZ z%ed)G>ypwcudS)oKyp}WO_20u(#j|vz|!(%R7=bnpSM~PWNB%sm;_;Hi+4Iuf#3_n)KVN9!lrm7_-JGP*f0?F?M(FGcpZvaWsJeo*Z`z@Wu z#7$+b{W*KntFOM=*CmxmI{Dr6P`F&b*uNj(vq&OMj7YR#BO2mitU! v8cY3*r>k|O#lf5`2C1uUO9yEa>WBXWRKJVwL0_mj00000NkvXXu0mjfs8PD- literal 0 HcmV?d00001 diff --git a/material_maker/doc/node_filter_bevel.rst b/material_maker/doc/node_filter_bevel.rst new file mode 100644 index 00000000..c7d01aa9 --- /dev/null +++ b/material_maker/doc/node_filter_bevel.rst @@ -0,0 +1,34 @@ +Bevel node +~~~~~~~~~~ + +The **Bevel** node adds an edge bevel to the input mask based on a customizable curve. + +.. image:: images/node_filter_bevel.png + :align: center + +Inputs +++++++ + +The **Bevel** node accepts: + +* a mask greyscale input whose light parts will be beveled + +Outputs ++++++++ + +The **Bevel** node generates a single greyscale texture. + +Parameters +++++++++++ + +The **Bevel** node accepts the following parameters: + +* *resolution* is the resolution of the effect. +* *distance* is the distance of the bevel effect. +* *profile* is the curve used to shape the bevel. + +Example images +++++++++++++++ + +.. image:: images/node_bevel_samples.png + :align: center diff --git a/material_maker/doc/nodes_filter.rst b/material_maker/doc/nodes_filter.rst index 5544300f..78437f3f 100644 --- a/material_maker/doc/nodes_filter.rst +++ b/material_maker/doc/nodes_filter.rst @@ -35,6 +35,7 @@ The filter nodes accept one or several inputs and generate one or several images node_filter_occlusion node_filter_quantize node_filter_dilate + node_filter_bevel node_filter_fill node_filter_fill_to_position node_filter_fill_to_size