From 9a2d39600eeecb0cbff482da565f637df8b0f5da Mon Sep 17 00:00:00 2001 From: Kieran Wood Date: Sat, 21 Nov 2020 10:00:26 -0700 Subject: [PATCH 01/14] Added mouse_down(), mouse_is_pressed and mouse_up docs --- docs/img/mouse_down.png | Bin 0 -> 9730 bytes docs/img/mouse_is_pressed.png | Bin 0 -> 9820 bytes docs/img/mouse_up.png | Bin 0 -> 9093 bytes docs/input.md | 105 ++++++++++++++++++++++++++++++++++ 4 files changed, 105 insertions(+) create mode 100644 docs/img/mouse_down.png create mode 100644 docs/img/mouse_is_pressed.png create mode 100644 docs/img/mouse_up.png diff --git a/docs/img/mouse_down.png b/docs/img/mouse_down.png new file mode 100644 index 0000000000000000000000000000000000000000..231c2e5085b8f818b8515fd373e98e0640adb24f GIT binary patch literal 9730 zcmeHtdsvd&)-SbeSGu|{wK8>;+J(GimS&)?u$G#sl$aM(Dl#iWQW8Z(x@hjTEG^B{ zye%sg^FnHhh(b3tuT)+LQK`HTS5p)e1P-pV&w2LV&)(13-#_O$=Xt(AfH^1gedl<` zoZ~lsV~qDVsJGi1-L1L+0AP)W`_WSXz_Kju=i92kXh&}FqRq8G%P^GW(q~yansgoju*mi}dIT01Djq>qhOt7pQ4F^k z&!ZNWIqq3Q?gk}~PmRp3I3xXIRclE!?3_7mr_H@9=Z_uR|M2Vk-R7@;AAbA$nBjVh z$5{pYe%hgT3$|^q@n3&9+K7F*R`-xMyx6aru$~#`b+MAecCo#x zgc5RZU^;#ZGZo0FljWwQh9)jd{AS*v}}zK$6WJPZUEkwv|G+d#v>(-7`81n_Og?;^GwTzU1biTH+*RVz0d5 zQKB%W?;4Y#CibyR4pT|^Sr#HcQ8R<~@zE@Fv?7Omvm0hTxOXZXM^%zoAOBF?#O!#c zk7U5Of734S6YXinaBy#Z=6Lcqx@%Zq4(!n4xKeXXq2Lz9*ULbQt(!FaR7!c`g%5@8 z5AgdFuaOp24&FASEPCy#JM-*3L}*gml;#`7FumMU$xWObpY71hi}^-~xU*y;h)Ml1 zE4&bQq3O$Qqog$*dLOqJXDD=DJFO##4;E+e{6`i(hu#~vop6rpJw{5HGz@h#JD`B# zzWav;J+P}T-~|I=?xFA2a>|o*Tup(hoCkGC5AMS-?MHMoaw_}P)2b8PJHI(_6Qr*%SKK4Lzo=v-#E!(U zLN&EheI^)5zWYo<(;U=8bEkqAHlWYZ&Dy{0W6G})k$2}PEuA_L#`Rr*XVo_!-+c0V z_p;|#5+X}NFg*vub$%7`F8A1u)$aEwL^C}|ixii*gbkZfjaRk;m1q4(<_Btx_>7!% zcF*~hnH=OLA^HYtE3p3MuH73q&l#UUq$$^AJwwOZ*4#`rUw4Z)F7v1LxnDE~D+=1} zT}vQl6o#NnAquL+mm7B@2%^?jBq5Ni=98(=@{xDLU+GoQ4)F`Ri-*ZhiV09ACfoUxv7sGj+`c%z+s7**9T=N-vN>DXR;N{<*}v>v4l z{v!#MbX>(J>$r8UzAuycpKzSJ+)WlxKT zQE>6Op_;Cncg>k8uCc(CX9G#16hChHod&Mg`7gx2ywPjF9=bPv(wCHM{mzRVd(G2aigVqxdeMa|loQF`ik7Lc-(@l#|p6`dR^?CKxF`Ypi?~J@S zb4W=G!S6Kby!?KM`#`vV#)yXtmQkDmZTvP{0Z*KLVk4<1NHDv~JZ)66Q1}XW#S7#) zMG0|;JDrx@n^R`RTbLdzE8SZi7iMdn?gO5F9m=J0LaSD1CUp*@p6h(@S$ymBspDR- zkUtR~o1>Sdn_Q77eRhn>Eq_XnMESjZn^F`Pw_%^YeOOOjr^tR(){rfG{l`H)0(M9J zXZeI5C@ZG87I=N50lOTA>rHA8HZ6uk`^GxMYTsOB1fyL`=r;UYPgLshE3v@9{yOAE zL)oXPGv|!{vT}7+gVmU?|Afw)S~y~2=PTEY3UJF)@!D`BUz0ky- z6+VJt^$zN9AXA_%=zddu%*d{4xX61W@KVIB(knlVUx8R~)B6o4RpP3E8_=DAjXDFN zulmwaLc7T{P$<|8Hsq*;&Kz^?Nt~pZ%_n#II`R`XWp#UeBCoBdxOJj zed5CX@dkY$=FI^F=WAfBHWRFD&UxQm+&8rM;hGuf2L9#2si+lf4mhRi$J0b~53daH?Z{6p)71yq) zd#^?79xcS8Z+?9gQ60$U$v9}2Cr+>9o@3Glbn3KfEZ3Y;24!c|Ke=eA8jLB z-Og-*gmvxQrf7Ak*3C-t;1V-On9rd6A4;ks(Ax)g6h7-9aPqHsPfCS^DZPzZ|CNj75I_I zml^k_I72cjJXrjRDw7$oYi$H|n^~rBtTW&mT@%ObkAsMOt(q|Yq%7NTQF-~5?z!Nc!H;%8M8le zPb42?HT0~V*jKO)*Z&g`bP)@5o0c(8wnWbC`zLDiUxDWTGg11-yG`EL%c7am@lD?f z46RIfLp<!!Zesg^h`@aKYclw?>k#%%s^Pvm!XVDtb>dHdKvxJ_k#J4Fua6fC zK~zNuJffdM!tU04QYSJg-3{okRNXAmiCWjd2D4nwt9#?_=|@Q~DCADzvyq4zP{p*`W$C|8XDrYV+6Mr;V3#*uZITf=RI5!E<^3R-Gzui@BJHisd_< z7vH`~yv-@9R_h632ADEfyOI^rG_v=rIuPsy@*{nE5=9-jw6m&Ejk!iqtQ+AY6UHEz0llwxFeA{cR0_nC%;Vxe{1y zUdO!dJ%(CnSPGKFMJe8=Xd(3Cer%@ASl?)hu1DG_QvTX3KUz9w3-A&XReRafacn<* zqwP^I z2H}iNr}y|@9f-A#>f;~?rWA&IS~Snq;=-;|l!j{M+nCf54~PW{_5K0sdcGIwt>t`- z61eOXm!Rd0eq-k%QT2$oWmT{D#2k#h+hcv+ZyzjfmbOLfxgNOffTjK31$h!|c-R~V zP3}zN+qh(ai?oJtP0}^*MSr`iwC`vQ~MkQq#dvTf`3wRstQn4hgvIsA(|#b2gkYIwJo;- zEfgwc-MFrH7y6<0ehTjq^0Wp_Mh-O6)Zf?1LvN`M57pEV*SvdD3T1DvyWVE02>j6@ zaQLGOfzuS!zZZJ>Y<09%^8nd2n}?A`o@)z>s;<%Bk1K3l?CeX$S_yDhVgqYj$^v*H zH||A?zwMVfF{Ge6WJGXpS<7U6VY_qwN0+h7YiCG%VA!|V;yVj4XBL?fVve+WTArtO zJ17owCo%lJHE9d?_M6fR5^UiEBtCS&Ar+@obp#jX$n5VZqHK}Exd`EYL>gC~3p(9m z@3%AkF(hndH)POS5=J}3bfh$1xL@hRRqbHQd>Ap(_Sr7#m5tV227(9K1rhkQ{LE;R z3T7~)`vY+*qp6#lCKk>FNGZ$;D>57}89xalUHQNqU7VSPlk-a5h^ivBS(Vq&DQ#%Q z=RC}9t#tk%FKWzY+dRrOTL#rb8q5Z$IMIqL3e^!sL#krGoxjmGlp~XKjAqlWj_+)? z7RSs^d@4lJT|2g^aFmG`ENV%eA7lv!;;RM21=hVUEMp_k}HaP@1*^H zc*gp&;WTncPZKViodQ8fcwSUvL@K_XwJ;7AE(AMH2E>5KLo=U3F^EXA#)+Zg7%?Q{ z)_Y;^mdS3on)oH_;tVci!$6NjPZjW}@snDX9sZ>jjv7Dd|9^*XFM)cunISONB|(1e z1IQ*w8+tNvUsHFLrgHJq=Ymaq3xyQDC0gq}71!=rhvIy{vC$;+>##KWsKp7%vt#59`66{^$peQ{J_rc93zd7aKxxlY^y%mQt{MkFlvdJ*H`U7a%$|Hk(NswBnWW1(u5_rH^GaNTc^=2b48Oq zwnKCkiaaVhRSW0G+UoyW(Ut)w7ADfB)?$iJ6<-}dht}_wgR=TrRaLq<^WQhEvsqsH zy0j8^I(LPGUZTN>jweCEL<)xXy@MnyOmJ7HY3WXl_$K!em6J@fv9Tiz0ghACY6QU% z>K9=NCc?!T@YvSj&?GCLHU0`N~!LGgoQS;tb8)z3I?U3&m+y-;-{Y@|VQtv7 zxhs;8m8Y|=<4pa`|Ki+m%syyJ4u4S>;NasJGVz;6kCvk$yg}P~2b*;g4eBlZgJt7yKwZ%{h z#?*uIV|b5#_Iy5$YlA&6X|{&huf9Y59HmSJ4{L*nx1yth!NHiK#>g6w2kB|mnn$&3 z?tLiEkbwuSo;e>FYDi#nCBF!*A|T*{MhIJ_WW@wV0}?0SDF4 z%RoaQowO^qug|kp^4t;@H(z-*0IO$7+f00#)BOD>AQ-LaN*|YKQEgcLFfan2CrrpK zI8HO`Sli~(2MKK~3=P7r)TV-X{{J!`l=8lAK`%Q`LGw{dW}AE%k@4efH-iZtLovYb zb5T6$Lo#F$eVOtR2ZCTF@v4HBViMnTD7s+5SdofQl&~A5;wG+iuUhmwzt?62*S5K^ z05Y*YzM(inU7#$Q%k5E`CCV5= z8t?nGrik(7P80S+_f1)ui>fa?>A1mfLH%lhjKkzFrgsTm9y z8kM_E!9~A*98~)%#SGum8t1^=hHiFxMS<7dy_^DXA}3;#v`sTJ5^M9?9Q_j9uszcu zTv>iN)m6~vfF253rHpQQl}$L+W2=o(&U`ccJs)WmOn}3C9a%MKn$v@JMRE`JjuhL7R)pPPkJr#O&9LBBDG!y zQApYTF`H+QQagz_9eQCh((o~M+LNOtPE%ZL03)fiDLO99q(3!~5yg zC24`FVfaW~Xlg{;+=L=w_Y)K3Ka6nJK3_w*fR*-Z5F60%jHCDyD5VDt(V$hp&7JB)mV_IZwyATy!AZ zSjx6ZI9p@Zky4P4H#)#)rAP3Bcfs>&g7CJ1uS1mj3s+XS zavj>Q5KYRv9MOuVEAe*;3~co$=Kbilr-%Zdk%v9VIdY<^5r}>ab!^neX0qaptM2aR zmJM5g;;3iU!&7+{=+9dGRLJa)!K+)#4f30{5dDl|@O!*7<#UxChLRdJS>ZD(rVcD0 zBmxojfS&pRupc*DniDm^u(7FQqzxYawdHix+#@;9FkcxbpA8u?Wog@2k$klsP zn@;BiBQ-(exZYhXmb&ueV7AoBPf->u?LSCi@;dY4>_PE`0;R#adlWA z2?ke&;VbDvNQo)8K`c*IG{4GDK0aEB3)S;rTVwhDb5y?%y#o!ck8B2Cvm2OJk6UtS zEh;<1tpg8zD5}RpX;VL34TQJx4jn|}jm5$P{@UZ{oCp0)jBATuGuTpEk!Vsw5T8?& z(OcBrngP6o{cS7D7(FoMrx=VGm^+Oh5)4mv3TKb0HfxPT6bnpg6~Pj8&3Il*S(lam zS}1t46^PMhU7j))51rCx3)V%D-Zo#dR*J%$@7}-5ZdE=%`0Kw!)&G@ckG0m4cpkGr zS0C_l;n@Gq+^+`$uAg0{9ov_r3pleGvI4O0$N!n&-_ng?Iyr>k#r1t0u3E+)@5m$% zE`RyqOc}%?HO@eaY)=y}yjqv|eP9rC3%cy;19pctk^O3=;Y85qDJrk<*cQO^5bR;t zv*6;4d(`PRqq25WV#3L_><$>d&5w#bjQV*3ccSPr8JUa?X1E49#9riu46X#MwF4Og zSEoDBr|;q?ydV~OxD}92HvfDu=@*h3mrv`-Qc$6R2V>#Y!f!ml^*6oV#IlTEF8y#m z6MD(@@f0`Zn4mB871UBM%MVjV1YHO`v+U*B3*oWAx#s0&+a{qMIf-Q-3qgS3Riarj z8Qeh0Q6z)6J%oDT#m~=i3<1_Zr41X-tNKUGKsQU9VSI|MAvfuQ z0gda|15>Vxf`&NJ#aIihKET>MsdIaAWJta4PXNQMf2aF@D6ahbE&7LPpZHM67(xH+ zqLk^wU7U32sIzCdE`%(9URbbJ|HkW+ld-E`#%uRu(qQGxl@-rTiXoA^ug|U0k9J*F z=|;L|qhq8|_7AI_c(6}ym>6DT_1)oQ{$dG-m>zod7vh(z` z)5F>;f1wJiX)?ja-7Zo)mpVhsOUhQnVkH0fS~*j-m6*%@S2DeNC1c8)&p2vpwT|N3{hl?->ZVB)#K~otuH~ zLr}i!IcwNu!%drIBqt7ypZ2HGNH$+9s@G)M zAN^=AFF2n3F8JLxi$6vFLw`pXy^{R7{P{PfKUeoYLOp>9o%MkypX`Zwprcji>k=6) z=ZW=_O0E4!`FsAM@o$y9-QlM{ccqZ1USPN07$*O1$Fh9OyjL5Td|F&P@wa^g0C)!f zqV)D3o{s;X_D?0t|5nKVrwX}VHSMGk75NYqY>o8tYPV&@%g;oZ!>k#LUN8r>&UcjXGVD9ZMI5 zEj1(mZ2A>P3tF>RbglhcZ==>aHM$RtwFU1_TZIq{uxggO`k^soshgK{d_IqXJGa5I z@%x6QbxeVp`Se`~f~>$sfRFlOwsdcM*v8%5xe%`1h!QWi>GThdnz%OAqKTN^M$@{^ z=Ldl>Aatgsqa<6+ITjL$8^DOxE(z*RdU0c8qM%IOH|s{6Ww-FKduho_^JknqjCOBl zYFZhK4yioiLN+2N@$*Xc$X7?~55>zr=VuxpUv9DZex2(3*A28ATIbx0n<*z-VfVVo zF^qjqv)>WTL8&3X{0A)HA6(4;8#eRl`byJ;tMN(>*SP?Un;F;&z=&WZuzG&1&xkwU z#xKN6aP=1+InTdZ=gkVmi)V*1%$6X`p$?phHpXMB3NZ#W%lN>>$#)T$vAYh1Qr4G0 zSTO;gd`RPRa?50+h__s{6{HWujfHA!-hFP)Gxv`;90o zMpgD6TTDtOL`q_2Q_*;9En}?Acbj7(@!nyI@vXIgm7{QL1WgKORRpxXnpK5DxDi8Q zD!W;s{vodT(Cw(0Py+lDllf#_ow~`+-_u22$|{H=aOsh394|_8h+o9|_J_;5GaRin z<9D+i&J+?C$4rapvn4j-6|S^Dl7VH!Z`}8nrhd3IP^Q8z>(M4eCqvyp_WdzQk1BdW z{X2ZS=Pm_eB`Vx$>SQ&GWH1i20eSlnL&WokPaCuyPUN`o@(aRS)LVRc8wOQi1&dU| zkf@s!$dY{Z7D`$-TaM!8<>w$;ASKpOY*fAw6{ z6B;9yzE4|&>&_!e*5uQ-qx8@F5VZJ5yrV?Q*biB z&&Q?ZVgz~bcw>1NwbUtHY|D||S_EH5)nyicwAR(8Zq3lIFQYGU8&$7u<$v)mq9(f# z1lXeyoN#?dvTQiIy8h=22_Zfo5M9AV4}<#mBRq*c#bW&XW0r*M787AF)fC>Kk~RyJ z!d2pJVn@nYP#;m!Jd+Tqc8t!aquY4Az~Ya+#)5-AISN8g%Hw`s_`UW!j^CI+e6j}_ z0#$hxAwN%!icleptKBU(;4>Gh)nZ73{rT#E7wwVc;&(WTil@~Ch%r0m(nE<6<9<>G zzEub>2gdd)9lhN(G9D{K`0n69g5zW@9mA`CM)XmF{Q9XAU~O{L-%3RVPaD?vE zL?%RuH;f)mCy0=#XF76pj!$|jj}T2>Hn7W~xp>T+p1;-l7}}GmBFAS{noJ}gj;aY+ z1u?D=*YWdOoFYZMNG7QL-Q!GKD}GVbK{ukP`7he?ZM3QpJ9^9d9G_DZ{y}qP@*>l* zf!y`1sC}4uZbYar3?6C#m(n$BFKiJe`an2ks=%Zdejy=l-O_F|*wq~E+RFg>h<}cD h{&So=_ekyXqw(HZ(ayv3+V{2q9>=_oRzuF*{2#5k^{@Z{ literal 0 HcmV?d00001 diff --git a/docs/img/mouse_is_pressed.png b/docs/img/mouse_is_pressed.png new file mode 100644 index 0000000000000000000000000000000000000000..b5f37608357fdf70439cceae6776206879274276 GIT binary patch literal 9820 zcmeHtd011)wl6rf0}g0pun{yWCdyz$1r$iDAjnK;L>dAbAhgY72s4D(dQ?adL<1p$ zM!|qGMP|Yf90&meq=h3v!q6QiAp{I#AS8L4KBv#Q_jcbt|J?h%d*Ao|$hWhr)~>Z` z)f#@Qs*;=?t+#I8vsp<=Y3oHBON5e=GD}Hm&83YSfEFk}dk%OgV-eQpluA0Z#(|f0 z0cRb~Dk+twZdtjy9(dn$-Npl}q_pkb>Q9*+`od31>5%xM<=Jney+!?@FM>xN>wF2k zCe7P5s80Icd&6HkqfkCJ53jUtxh?o6r|HD=L*LqMJa~D(?tx1;RUX)C`D8wefq8NI zBJckczAyM7_Ke2oZxSyyq@U2dn0LwdQJ|pWV!duJ63-utitiZejickHECT5b-D7Kg zIy~@;jhxvA?rG^H7OkwL2endykibeHTUDjaw2ex)5$kT8gRc4J8A$nQW)M^^VZ+r_ zRX-hhXu$H3O}K->;D%g~m8GREDJL<}CJ6yjRfW0`faXKCE|!+hEun#$CD?C?* z&(IBcNXbkf5sn-Dnn-3YPRs-brACzMFC^iHYRuScx0}7H8OiWeGpzse_CqbFeQ9<~ zo#!1VnhE4Zs;X-0=3gQd+KNhN;TA`j_&JuMRxZl}FCQ-WfJZ$T99E{{O{mP=KM=7%>CpTIkS4?1%c9+w-&6!cr<&ec z(NQc^j_~5k9b{8oC5X09SKLh>UxGG|^hDxSRT=e@#US5EjnLX8oM&N5>O2{{RKX0| zQ~s_BG+TD9MCeIyxfzV{H^>Jaz)Y2Ja!Q#EIsnrc%?eQY#@wFTgp5qbT+nQPzDsu=>CpUOoAVUYJ?T#3`j{(k_$34GW9J47C5L*z8;X-RF?f6 zbo7jUHMIJnHqXC>g2E-0H?%>);JXi9p)8n28Q?E|d;Zu-9(a%iLr!p}33iY&!YdIW zO%>!Zb@zl{-j86!Co}36&iuuz=K594*yAVz?|3mQH)6Z_+)sj+`A<$)Q4?FdazND( zmX3VxF0rsNdS0*$uTKzn8hTIk1&|rhVs~OHex;gtm^vvB)FwZKyyb^B%J#0;5avR1 zj|u0&U~D3yF9(Fph@Li{67?~K*=T5U@|Qja_Ax&PGR>4uu{ef}eGH_fUjYRP?Iy#G zJP0r;(c?-ju~ZG7KqeHNtBDAb~hLXRI2!QJNjraxH z5mnk3n({c`J7t>txUM2vA@%XmR`;Re<;C3ad*R4a#k>49Xgv{{CkbOI zw(rM2sK{hC;u8d6KgpYKLMvU(S1 zuDN5HPm`Uj0FAl<)Vi7E3-E;|c1HO-2&?Ckx__R*>xU%NO8l|GFP+}n_xzsu=e*8o z35!z;hzn}4NQoIvHq-C+ zMe>8$3GlF`P3Q69GC|v|fDFbWcR+sd8M|>&@?qJ&h#1V_mg43neEA_bfh3@}MEYfo zDkYR8fLcSfo!p@%%a<9DH+pYpxsQFk=0Ce}=%rfgHEvVzZ=O4n1aXZk1G%_5!THU9 zW4!B@!hEr>JbJQ}t+tvGj=Ox%Fem8qtUIW1i~Br&C}SieH>}tW7BY0_>yXQR5j-T3 zsBUPmYmhhA?pw`(&xCj!BQAYqgkox_C;Jik^eFPEj~HrlyOOK zO!hLB*klnSolg*9(jW~bIIL#|PLH>Ec;`sPI06mw0wF=(devkn;msgJs`nD>=$S3Y z(MduJ4W#9$IxYJBHO@iX0|Z06{e;5-&S}|?BhsxOo0U9i_wPj%*}ZIlQx*~`rB&>Y zoU~oyvuxc#7eal!g6)=)QwoO zobd2&2z8J7Ybyn1p2Z1vv5ff8Y{4jI-t$t|41|UpX|e|m79fHGD4IZK4+fSfU;kn4 zL4hqEIliOoHj&woF zYvvd)cNp&uAo;srjl}J%O>8>@D09~>Jn5T`-ic1mgO*_Nh4jnbl?@hE2CS;*y%f~J z03rr|DIFCTC&m?VM3^{+DCzJMlUjP38%=|Q;m7px8s+m*q=f?GUdyzPaO31*?lwLZ z+I>6o5QTrKec!6L^g>ukhlu(F7_ZW(v(*11-7gz0c<|Dvbw}DMTMQ~mKwMJ<1oj_9 zMWI1SVL#ww6eorN_W_I=bMu-ZH6Ad%^A zjT-RVMbc;!)wG9}(3E}oKqzRG@)CC1KbN1#l&F008kAqlTj{CnshTi!s%YIV?7&7o zu9go!TIdSs4xZg20hb8@(a|6Cn=F;9Xca$r%J%ccAFj<0LcHep^MlJkLP2p?!u_at z9pR~9j(v=-9{8O#bld#}^7t&)M#$Y03_n;W)9SR5+DYaE(yFMJ%M0`XZF+h$vhiUr z^DqQUL_=M3K>4q{~(zdRhKsMRt~M`b~pR$}}Ph8hJtXBgO(26}oD#3t!EiIZSk%xgD8}h;}v|@aD$y=8IsrKKG1|s3P$vdk2 zI%Zy-?(L^{9cEu`}Jo#5QwV3=z@h zA!rz^sm8`pRonOTiKZ-pgszL?SWfHO1l#YQ)Rx}p3B@k=Ke z8Z*^L%N6M;B%x&CPz`{9Dsz3orCLI2{LDwzn8jk2Z*|%jflnB5pj8)~z&5-ErJ0Vl zKa2d=xW;w@HytN?Q8Yn8fjmf8)UFy>k5`T*$$UNI?_n*Ko8>MkrT7N(1$fj{-*HjQ zMAL#~3Dw{T0G;eV0y?esFm%*>QAr`F&i2?&p^$=V(;brNz1CUznMbtNjtLfjh5yo9 znv?7+t*7W#RRaP3_!xwh2jaEM@9435w8PE} zQ#Tx5L>6`iVILrp1@Ec*(H}m-UA^20E(!DgJP0ov+B|b>JJYSIG@F$L$0pA;#P?1O z&Ad!(Gc7*?q|RBQrx>q;2KTx{ zpC<)-l$089AG4eFt|LqRmnzFI0&-wGCT%eW9&WJ|2O1Q7oDE@ZVjE5q6NA)gCgSi0 zN**`sx~1i)20#i%{AUJ@dHPpsUROvU{KOUh_ODF-Vm8}mMEp9W<|<}k@>7Qh`yQw~ ze~#Iqd5t9a1_&-<=oz7fcgSWJLMQ+*lZ|aL+*S|NLFRO?b>40o0{;5ncugKq~p6f&^>E@X`c3t$KITw2(hA zXClxN;o6G$YSlX9-=z#qur&sG(j!)BVoT^YQVAkCJ3LQgy~f&@ZLb(pp8}}nr&_F0 z`?xm~aYE%kK)FkS(w0%CWtcy5ihCvmvzPpxck9FiNFl+Iuj_d_qnJfx+sC~hjg*(-W}%N zE8WYU(`Q+v9#|l}_2=~8{SG{Rir@`9m-S^Cz` zY&A>jy;~l;1H=GdX^9=I+X~ga`&Q_4gVb2SagB3_7a#;P-Og<@SyfSo?4DT|JfM*d zrM;XM))t*H2*tXIi(|Erizm6IA^bd%M^mYRk0D@59S|$i7R#4&`p&9pOcz4feV~>M z0}9G8k86e>yT_$@loHEdA|4w(AnUAVz|()c6Z4zdC+j+y&y#$vkRKnEZ|%n`WW+7% z2H_#<9)Qv2+NgL}_eW-(wLguWruNsF%>GPa4GqRgeRpD!qwfv9877K8KJ_?Akug<2 z+rc6lGNUUT{ai^oljcjX0GR7!ufeP%=$BPs4q(#y`6SO&5q}gYD2YJ)eu2%haVH7Z zbtP;ISP8?eJivvd`oz=mnilv?OxbNoBtv$4dAS@81i6$SWQ>BCERmsv9Wz^F!}ITw z&=eBRt~AMx8w=Z^Y>Ro>%TT&ptEXgSq1;I*Egxq_9!kANEnH?kIfzM-oPRH_8Is1= zFV$D49^kQMN$f10?4JxmmlxBjca6_#%!qjkZGm*5{_w?>;17^@betlPC{%o228si8 z63jDv{ki1}P{(7ieXQ5rmHHc&VxJZg>2hWu!!hF$(s_O#fH~uX=!zmlomP^f-8#&4 zCqGwZ#$xzs)`*&LLaHVm86x<)r=xhHfaN}(TM~8*m+Td?|H1?t30D`N?Ec7&>SF`D z3NcG3yNi#qOsW#5CYl%r3NzdfExhDX7Rv|54kmRHXFLc99NxFlVKD+ZBUy-nU+Y~JjM7(~5bWF715Y6ai)IR> zl(Fx1@O|j1@*|ihCa0L)gHa;BvC9nrIne+lOmc_E&X+;>!AQmUPQZLjerb9NTI-{7 z1GdB45!x&^-PJl$_5H-z)4QZrKNe@5+=?VnOajb5vlFtWgtbj#ouwA*6muu?!vzeF zYo)u`p9eB3Wy%&mM4|iA>q9X*Gp6R(%GL=fS9H6hWR%Kmw<=+JPS7rz$*m@(bSsU) zu^YRE6Np4*{SDn3TE173-;@nhKh~_`%1b!&-DU!UXk1%8>c-VWW z&Etx9N&Qq881%xOY_zxuo6hwO;TrGiPmqcl2DdUMFznie`4{9_OjE6ylbR1sZXZNn z44#e~Y+4%XvEc=?0^gXeYjb%eEIn=z%?x56f?3+z!hlFyo^-ouVz(g6GiWD}7Lh^9Z9rL+c%O=g%E zW?&b3%X-3n>K=?00V|LY7o^f*+#l{bZHx;ypIVMdp%-dfH|P%(xpI|+!D%J|+B^$- znqHejt1q7i-bKff1Q*f4SqXVP^3xXp+~~)LuqcN&w8T31S&z;f)f7vrC{XS1%0T56 z{HCE4Hhfs9wO&i1Io_+=2`uDn@-xr@F?{Kzd?q2|4QUIk)4Q{H7c0EeF8{E@isuYR zS_Tw=ZAKZ0@&5Dm>BOjI@pwRu?i9FK6gTTk!_)#Oy*j0P3l^5;{EHv!Fzeb-A z4OVxJgO7g#cA$g*WLMgmkpEe|QNj}B>c~C|%BiwR!AEx={Xk`n!qyBF$(iILV>>s_ z(G1gz-#HVM?)uNrB%)A!93y-E{6~611Vcrs_!9|b5CFY!F=6H*)$7;fH?qU1wNINp z64r4-c<$cxfl{XsE`RepMx+wa#W;@}aFZ&%@+^n4AdTA-zTC3r;A~+8$QJz!-#ktB zZM}*n`i?%X>Nt5MEJJ zJ&hJa%GuRLT$N z4y{Of&?YLi*!=wcqe=JqmRnj z1~ij%G2`Va=hm6v{@`Q)(5o}#PYwXTiJ}YT#W2No@!T-gy7bQbW{iUfXfrAr0FmT zd`uINDQS(cw%$Yis;q&6QYdvj2OZ9aRM&j_9d~Nx-U&vD0jqYMuO|=Sy{^tS%yE^U zqnXFe!hxWNEQ&vGiYi5KT2-^pln%ele%1@Sc~yzAw8vH*=BpYU-%X1)`*(l-rc+4R z%~fVrjytYABIUGfTJzgNJaT|CXWk!u46II765j6hiS|5@A+q+l#z@&N#T~)m&SMVc zfQR;2{{5inUzo%H@BYK%wf_ROu$23w2610~eZ$n5u$B;JiXClxV+CD-dzPQ#dHvX8d$Scom=8(Y;YeI&sR68Loul%)){x`A;etVIx%hVuT~ zKEyN%Fj_y{xC&t@vwrS&JMGK;c7s0`{tBo~?w^fmG*i6R1q9nLBAZ!Rn*|VQk`_6$ z+kx?82*nS99>x%j2^o8)z=yiRyEp3XOK}m23wof^3$p^1qo2r)NHD$ZQ8R{ zrLtrQLjRZ!mIOZkt8%3@P#qUO3bDHLtCAP(ppjI3n+rh&SS84Y>htZOrlHS!qS;T7 zW(r%?Wfwx*9mJ%CA~P4H`3T{6iiBERVr#9k0+&Dg=SY;Tv>u!sW(_@lg4PlQ`G){j z==1*^|M=IorP3AO6olXRwrQW7|0&l0d=>}Zk2qr)B=B4==<0_5OOG6{Z6}W%{11oY zzw=%j!^YW?#yUy9Vv=e&RX5GNwdETh+cfVS5WPkar4~>k@qDbqKG_Yiy7Kj}&F`M= z&PA-NdIlOlWCzniz>fT_V*;Ua7m;kM+H(i-oLmKZw;%L(Dq11vT@TR(x`yvem@6v) zz03T^O9{xZVS)ca?eCQSNa!7R@1@3Ey$iG+A2av6dwO=$Yz%=N*7~_lg*Fnl=a`f@ zRvyTCQCQt`< zWg#DQ7TW2GB)B97bkqlmD;1LAu%%+~3V&LosCma)G~QN~1UC1FqW3p*x8|z6>oK5o z|Kl?f3YiGguu_#TQ5CE(>E!_8hBi3~46%xh<;Io7VU=R*cC7A+MDxO=<=g~3sod(f z5sUX6%iWl}wudczi%W!$mh3C68_Bvkl)$(zrP>yyY89;Nc@n%EO>d#-Gti3J( zdUyI?`DveH-_$+hf#~~UolThrt24r!xw{;1MFQKCS7%+bm$orE?Z5M1ng(S1N$HMi zzMIM2`#AG}*W<2)N#Jr%vkkON-BwlO0IkIvh(yUGaNIM{k1)jllbtSlz#0sly#Re1 u{-*`ypB6K}v+{r81b^6l`8z#1ym$ZbrX`#M2DlNXbkWMuvgF*AoBs!tk*K)< literal 0 HcmV?d00001 diff --git a/docs/img/mouse_up.png b/docs/img/mouse_up.png new file mode 100644 index 0000000000000000000000000000000000000000..85571e61d5c5b590a27f26eef1297f62c2f4003b GIT binary patch literal 9093 zcmeHtX;_k5+cphuQ!BH*b1J1_*Urk+Z4O~dIaX#lG&z@+CW>T+8VT&mDN}4$Tg@?Y zA{B80N2F4r9;XZh1(BUrC`d$#D2TlH{QQph{l543-s63KJwNV~d#z*L_jRpnt@~W( zx)u+;&w6aqHr56J0Gm#oboB)Q)KKK0L}927@u-IaXu+TR2-TW^yN-E68N6=>X(CY z<)_V`{8f3n!WZ#p&ma)H!R{}gbteFyv&KBWFF=NiJ^&CDwNeK{c z8zXCmbnRsPSs8xF4OhB2*`~1zgGC8yV9Y-D5HQkgFC&8+|2~4@++gwxL`0Z!EpUcf z!yPw=eZc3Ga*38b1m!~Z1YXxIpn=5M^W%AB$*aR1vyF(aHAx3vlDr_5cxWXR0&GJn z76LdCpNLx&l7vofN1}{c7?%Z(oGI86CqJVH;R-&O=b&U*+BS%v4`$bbfON9+%hdyo zR+*XA_@>2xEc5S~5c*1cc4OQWRYNaVayg{f&(?g;IAz?{34s>PKbLp7ATch3_1elY%&`nEmc&|!*qLsbl^6xFjjy%F( zNr9%MIw)@2S3|$KFlTf4>__uW_#D=~47&J93Oh_doR%x-jb`&x8;D9qdRXoC)G?m? zaR3tmW!a;JF1r?5jLK7e?@6s8QB49AHdpQgri3o1VZkI`L=%((qZ{bB7MbSVc1Kzr zNktgSxn-urIA%?LNL=qWo%@e6M%|qqe}YB`UGUFEIJDVMdL5tMxj0ViQ|m|Zn~r)} zL(q43PrN+tx`X;>8py%Z2;$n~a|)-Y_tf)W0uSzP{`TtPc=JotA*jVs#c~Ys2k9>< z3cTA)JN~CVU(B7x5_QH}4RPX|E{5-bqW^xx!41!ZHu}H(d`Tj5S3J$MLSZ;6K#mqh$k{ zruH1p!aO~Gq`(FyBl$nGp^Ep|oSh;nsoQx$H+N8K`PSBv)o|h9h+;pv zG$|yYn+z@!CSMsfxg9wyEA-LThEs3{Ul;grZk^I-JCf$T2g4dn53s(f+H@QU=}_$m zpA~ypB)H?fArZoGv#B$I^4B3}a7tSd0ZytNwdF2Ya(Z^?d5DvLYVQtn;lgq|N4*O( ztHNT2v({v9h4g$ITk=*|Dip)0vGikz25fGDx$t7f?pl7qi9F{R>a<*{A1WeP04lum z!gvcz53{cUG`wz)ME#iOK)#4XCF+I-4!zt4fzC;6k9gvSbpKdj621ucM0j0-idE2{aY_t3o1E4?IYllbbBK$xJS&- z5Y#6PtE!atJtQsS`7Bu1(pL@Z$bn{cV7J6Y{mRJ5c(3N7{{&7I7Z>9%5<-H(xunpn zVCC~0eta3n;4Z$AXCd7g@t1evyUNgYytyVv^4}w>EhFR_ z0h~0Td2ZKyxW&@fy<~f#Pu~hp7?K4_@Aao8^T=Xhad&B`pev_Q!9q0P3$;f5fc%@uAGF;|yH$1lOOYVei_J|V+FEZDC zR5}o2&L-79K1j7n31FUKQgfWqn^LhUzADKpfuMW-y|PG0lOE2hC8MnIv|A0F&Brt0`0WnriB$WenAvR zI*X1&^P;6RMoc>od^|PZ%h_=k^sCTCu*&{?acEuy$Cuw=^#HYPJOZm9phLVL*#e9y zE;;y*KvlT#KGNL?qEk2U1b()|w9t$L(t*>7@~HzKL26;~PmJt7NC4Muy@GYj{a(KBCRP4h42!gU2Nz#ss4r#wK?4er)>krgr z)>2Bxe}UjHl`Aj%38#=zFgjjW=StMRT6n=;P9t~X!_!Z|3~GQkWK3$O~yFf0CI)Wi1{BUC(i^ z$8wsVJGEvO<8wawo$*xUXTDsiTHBpGH&{BW* zp2N@fbKqNA3*xFdCd)~tXA4u>!w+~@geDoKXU^5PI8yNuAD`E0He{!?KY+M%dsXvd zfsi_r=e=k5zJDQT%65$V;aj8J)Jh}d*22;lc)UKI0SA3TAT6a~Ni^?0lh^h#%$-+h`Wcp)z}?*d z4Pc_!yrFV9#}&&g1M6bli_WU803*;~wuR!chnjGE8Q)F?CMz8UmEH&6t>iwu53`1t z^H2(hP(X7`=*C%7Qp{c99?U1E=HxX|GOi+`KOu06old|<4r>!hOG$-J|9GUPSyvG= z^<|9gi6&QGuPl#^UWDmG3N=E7v!f(JM4vJ&`UIvacD0jQ@bnn%hNJsGXRNX{?XyA1 zma22k+!LNW%b2-rch{n<6k|QBw*MUBCipp~_&Ty|Lf+6EJRyCzXQT>7CbCttP3pyX z>WO#anO=92*3)CCAJ-hemDzC_eu_Nm*#`*nB`#8?(STh14g4y!DufU!-pjBzQ~Pp0 z#g>;CYGRx^Q`#lPPudfx2V%5~a;1xjiQ`tp2BvWM?v@9&Ec#dF@uC#th{fcg=N$g|6tXP}X&6oV7rgF0x{Vq=pX& z67~@0o?6p!^^nQs5jhocK0wo`xR33=G3F5kBiYgm*!iU5irFz+&#X_9DVx|2 zk_zff0DFCh87d&Q{UUmkaoKf8cK%0ulRXnOCdh;*-p-mC#)wNfwq)1}TaR-Z_uKSS z4zIdv?oBmlejrg5r?TZVpXD6c7aQ$+ul{*tk&&&DOL_SIYW?kQzU(AQtrb*EgVgF? ze+tUYX$WP;1K+kDni5(`yB1k`c@-3Q?o+1KBwTSF+7eA~WYQF@4Cr3Q&$rE7@PQ_o zDOpXu`?i^a*X4W~iN`mItYQNe6r9<+AL0tLu-Sc*R&_DZ650`*Q%5h!%dHr^-f}CZ z&{P?X>06QV2C&EEUf4z!ZpE|hyVK~t3l(REkV%2>SYQRDE;8H(k87j2T>D)NaY zbD8xw`W|>}W)747C`>3q9k`u|TU&cMaCsgFcdF0)#3qV+lDu(5LQeH1+JatopBLl| z#hYWWJ&-9KB_8Z**Twr2MZgP>ZPZ`)2Aj!_1Sdv;mI4Nldvlb0!*Dbh(O?bH7)l>t zKDT8?ywCjp!aLA@>I`VG*$ephK4kvXt&L5CWk#gnoUod)TQj8ev3*}Ng7dsvHoz(V zw<^600|=K7vf29UKv_=xabuyBTrHc)q}gN~GGD2@L78IZxL7krtNm0~dwB$1Ek7oEPvPQ*)oOZ`tu4+vbK|B&TL~1nZzB{}aep>)upnyg z;O7ick;*Xgstx(-v&m8_gp~Tr>&eIl}4VER#TPS$cvLxqHIz^H#m@dn?n1f#I z9uaTe(Ru~kFCL;Se-R9i)I>`o{f({7q=|y6Qe})%=GE8ERIytdKuhECWD44r^ayO_ zimUq2n-(yoP(*zz+x?dm_nDsJvt3HaS>mWrx^gWbd=u|cJm|A z^6yb(s=(!ysN%ZfCL4uf9)@q`Fl~LU*0;NxR5cG+2n$3(l>=c4C_Qdc_?=aaEL93F z30aj;iH)s4!UPoxm5J|c4DwrSrUXA~1|KxaG2+Fm_@6>4^J1UmY)LDWx2|c1_s}1+ zRiJg_Q}Y-;*J4S&R|>9ys5U%vW9A~Cc?!!hRa1hb3M*vryY0fj%fhwWMFtSCC#Fy7j1M%GkZ3za>xAH1{lUduLEmq`wl%wsZFlZyucZ4b6>fJ9QU!nh;Er zi63QIkAIX>!wYQP2`9vV@hXK<&g7l)x&iT?!Vq-w5C`}C_N5i`c=b@{x!|N%4-T}? zuX!eaO#6PrpEG}T{wk&~BI`K)CcV1Z%+|%Oe2J7Q> Jbz-t(5`!11IV#v ztQ;c^?pR=^JLRkUEtPOvXu5M!a--?S&=% zJ>5O6YGTn&OvNZI#O={<8kTKm)q}d}lHy12ZsEm0N}54FC6%H#eWZX_@&gF4`vQcb_#CGk9a!s_j@t=NLXLI;XI;KlQ^ zsR38d@4Q3^;m(!Z{dSZBkJ`xqSRN|gDD^w%c)=p@i0m6T&|)3nS~(p{x~@ZfONI-X zf>eVLTwZF#I4M{$);RDE`B@qS$%3}TYf(ar-s^%$-)T_eb%4H{v*`gRx|VzO`q>X^fCAa0K#NDE@@qG-Z&bZ`_^~~sw zUgiyTUMM`elUFtK2mm+)204_G`1)7>Jj!7IHi%Oa*S-ExL2q%IpN3iV*k>M6ZzU8K zYi4L`U;jvh?HjZR%-H6U${|IQU)s-j(}c0k;cy2UkXELYA|~55;aLkO_-p>CsGwu@ z5#PiY0{ai$xb=&AWH}AWqdhOe6~f=cA8XmX{!#9SExCB;htmtvU{?m<^^a8Vb88BM z6@kCMjTq`jt;q$aAWqkF^h0)U`mkw(4dD2#{|SIh1lEy*=c~?@)`i>^+4Q*8P+a64 z>n#t1Odz|n%Y4y!0IFM+OR)U)uEQ7qh&zGP^Z503>rO_-o~>7cwm^FHv@8#+r9j4d zLj$!KbX}XJqu#QFCQEt+)irh16RH&%3pM$3DQ@!)d+!~OL>lU5?co9C>J$w(u<9iG zTYRaoH-OVMUtw{{-QCZ9cN+BXA{VeERH36p`8o-frz$;1O+>Bn( z#DQUTg5NfKj2L|hb~kUG?rIZFsnxE;b6SQo@2|L-cxp974!G2|neCbS@j5qm zz{1V@Lzn(>Ng!cI+-nJk|Fc2dFm)_}wHga!19NQ1{?&lC-q4aduc2yS-FN&6n7Xgd zNS^#J!mS=Mdeu1t@Xd_wYKkXd>LnfP6#sQ&1NG5GbozXv)|H^!AO-+H2Vj2!oZS3x z_;(Ec_vS&`pkxBPL>E+@Tahj8{bP9xWO|3Tluf*}B|6`DgU#*DsR8Oc{na}i;!dXJ zrqu>cjQf{e64Z4VL&%BRUDheaAoVejy6)m?U8T29*e0W0j1NcUsq+4@mJFNn2i`9H zX#+@{d|tIR`lJRnZP02zV{%c#(~Ca2PF)(_$C$LE9QCCcU-`Idz>0xho*G|@6en9- zXXiejB z95#MG!|CIsb?H*NzypkElok2gT)VIKg)tA`lDsHHC>Iu@NbQJzlU+V~|9@dTNl2S_XP!!kAffj3n5hBZ$D6Ohx^ zWy151`>zu2#KzXOe@fe4T~&e*EEl9slgHZO!Y346c~fgXYwwW|)>+)uwvVs85BhGm zi>>`eQLP~Sfj4`jx85_>M}DZ#%hOa#2nl=!1SdmxG3v)>f^d`tB4Gq*jBF(?t2cRv z7at3Knqmt-EoI#3%sFYcB`$5c`$oedle=4tIk(L#HYfms;n1hAtPqPd5+tf^X)X*5FppLbZVI;?pL<-A1?I`I`u*31~AOnco380}P zdK#Nv9jcPE$hvJvOYF!t0iOwSMXG!_8dL)?8qSHFr^gp3jCXDrH8fmG;622 zW}-6A{TQjlPPsJiKx&rJJ}i>NTF1+uVi$%##`hiv*7>eKLUpQLY1@zdZd3V-U$&&> z{ONExR``Qe8BP2{eSqueo@`!WRpJ}unmq6}$DFJQf^qgQ2^sO|!>SO3QnTzRTKpW^B#Zsfa6Q=~{mwbS?qVJIa{XxfS>Rhk?N6-U8-K0+G@MSS<~enC zzX)H-Sd3S&u1vRk4og-8StW^c7qOOvmT3>4P|lio(umQFGBl-de{lB;Ry6+y%ZO*4 zgMq4u&H1uh`LgvpopIdsLA0Tp*$(~voS~r)yFq!WRH|L-l`ZTcaUh69whgX|NRk9e z3`-URvJIP)4nu(#aH+W>cyGL&Py0_;+oxt(>bbG~x_KLC{zaryuN literal 0 HcmV?d00001 diff --git a/docs/input.md b/docs/input.md index 33963ec..1da9381 100644 --- a/docs/input.md +++ b/docs/input.md @@ -108,6 +108,107 @@ which results in: ![Ask circle diameter](img/circle_radius.png){: loading=lazy } + +### Check for mouse presses + +Spark features multiple ways to check for user mouse presses: + +| Name | Type | Description | +|---------------------------------------|-----------------------|------------------------------------------------------------------------| +| [mouse_is_pressed](#mouse_is_pressed) | Variable | A boolean variable that is True when a mouse button is pressed | +| [mouse_down()](#mouse_down) | User defined function | A definable function that activates when a mousebutton is pressed down | +| [mouse_up()](#mouse_up) | User defined function | A definable function that activates when a mousebutton is released | + +**Notes** + +- All of these variables fire on **any** mouse button press (left mouse click, right mouse click, or scroll wheel click) +- Mouse events are only captured when the mouse is **inside** the canvas boundary + + +#### mouse_is_pressed +A boolean that is True when **any** mouse button is pressed + +**Example(s):** + +*Draw a square at the (mouse_x, mouse_y) position when the mouse is pressed* + + +```python hl_lines="7" +%%ignite +def setup(): + background(255) + size(500,500) + +def draw(): + if mouse_is_pressed: + square(mouse_x, mouse_y, 45) +``` + +Results in: + +![mouse_is_pressed example](img/mouse_is_pressed.png){: loading=lazy } + +#### mouse_down() + +```python +def mouse_down(): + # Your code goes here +``` + +This is a user definable function that activates when **any** mouse button is pressed down. + +Example(s): + +*Print "Mouse Button Pressed Down" if a mouse button is pressed down* + +```python hl_lines="9 10" +%%ignite + +def setup(): + size(200, 200) + +def draw(): + ... # Does nothing + +def mouse_down(): + print("Mouse Button Pressed Down") +``` + +Results in: + +![mouse_down() example](img/mouse_down.png){: loading=lazy } + + +#### mouse_up() + +```python +def mouse_up(): + # Your code goes here +``` + +This is a user definable function that activates when **any** mouse button is released after being pressed down. + +Example(s): + +*Print "Mouse Button Released" if a mouse button is released after being pressed down* + +```python hl_lines="9 10" +%%ignite + +def setup(): + size(200, 200) + +def draw(): + ... # Does nothing + +def mouse_up(): + print("Mouse Button Released") +``` + +Results in: + +![mouse_up() example](img/mouse_up.png){: loading=lazy } + ### Check for key presses Spark features multiple ways to check for user key presses: @@ -120,6 +221,10 @@ Spark features multiple ways to check for user key presses: | [key_released()](#key_released) | User defined function | A definable function that activates when any key is released | | [key_repeated()](#key_repeated) | User defined function | A definable function that activates when any key is held | +**Notes** + +- Key events **only** trigger when the mouse is **inside** the canvas + #### key A string that is the last key event (a key being pressed, released, or held down). So for example if you press, hold or release ++shift++ then `#!python key == "Shift"`. From 19fd2465cfc175c028c26624fba7ffd9b960ab8e Mon Sep 17 00:00:00 2001 From: Kieran Wood Date: Sat, 21 Nov 2020 10:05:10 -0700 Subject: [PATCH 02/14] Added info about mouse_down() and mouse_up() only firing once in draw loop --- docs/input.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/input.md b/docs/input.md index 1da9381..dce0ad2 100644 --- a/docs/input.md +++ b/docs/input.md @@ -157,6 +157,10 @@ def mouse_down(): This is a user definable function that activates when **any** mouse button is pressed down. +##### Notes + +- This function is handy when you want to do something in a ```#!python draw()``` loop **one time** on mouse press. ```#!python mouse_is_pressed``` will constantly fire in a ```#!python draw()``` loop, whereas ```#!python mouse_down()``` will fire once per event + Example(s): *Print "Mouse Button Pressed Down" if a mouse button is pressed down* @@ -188,6 +192,10 @@ def mouse_up(): This is a user definable function that activates when **any** mouse button is released after being pressed down. +##### Notes + +- This function is handy when you want to do something in a ```#!python draw()``` loop **one time** on mouse release. ```#!python mouse_is_pressed``` will constantly fire in a ```#!python draw()``` loop, whereas ```#!python mouse_up()``` will fire once per event + Example(s): *Print "Mouse Button Released" if a mouse button is released after being pressed down* From ccf5e61fb09fe24cf3bfbf92352e914ff07d393a Mon Sep 17 00:00:00 2001 From: Kieran Wood Date: Sat, 21 Nov 2020 10:49:39 -0700 Subject: [PATCH 03/14] Changes mousebutton to mouse button in docs --- docs/input.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/input.md b/docs/input.md index dce0ad2..a8da2cc 100644 --- a/docs/input.md +++ b/docs/input.md @@ -113,11 +113,11 @@ which results in: Spark features multiple ways to check for user mouse presses: -| Name | Type | Description | -|---------------------------------------|-----------------------|------------------------------------------------------------------------| -| [mouse_is_pressed](#mouse_is_pressed) | Variable | A boolean variable that is True when a mouse button is pressed | -| [mouse_down()](#mouse_down) | User defined function | A definable function that activates when a mousebutton is pressed down | -| [mouse_up()](#mouse_up) | User defined function | A definable function that activates when a mousebutton is released | +| Name | Type | Description | +|---------------------------------------|-----------------------|-------------------------------------------------------------------------| +| [mouse_is_pressed](#mouse_is_pressed) | Variable | A boolean variable that is True when a mouse button is pressed | +| [mouse_down()](#mouse_down) | User defined function | A definable function that activates when a mouse button is pressed down | +| [mouse_up()](#mouse_up) | User defined function | A definable function that activates when a mouse button is released | **Notes** From d36c23ec1047600bf8a77a57b6f771b6adcb7dc8 Mon Sep 17 00:00:00 2001 From: R Lee Date: Sat, 6 Feb 2021 17:34:21 -0700 Subject: [PATCH 04/14] Bumped test run --- test/SyntaxError.ipynb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/test/SyntaxError.ipynb b/test/SyntaxError.ipynb index 951bdc8..60ff6d8 100644 --- a/test/SyntaxError.ipynb +++ b/test/SyntaxError.ipynb @@ -116,7 +116,7 @@ { "data": { "application/vnd.jupyter.widget-view+json": { - "model_id": "dc9380c179a44ca1aa449f95a515d032", + "model_id": "808deebe81c54d0e9eaa18a98ed583c5", "version_major": 2, "version_minor": 0 }, @@ -250,7 +250,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.8.5" + "version": "3.8.6" } }, "nbformat": 4, From 2705f8a2bc318c3d5fc934e0e9eeb94e038e9239 Mon Sep 17 00:00:00 2001 From: R Lee Date: Wed, 17 Feb 2021 22:25:31 -0700 Subject: [PATCH 05/14] Fixed rotation_explanation.png link --- docs/utilities.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/utilities.md b/docs/utilities.md index 767e1af..d523224 100644 --- a/docs/utilities.md +++ b/docs/utilities.md @@ -60,7 +60,7 @@ Results in: ### Rotation -![rotation explanation](rotation_explanation.png) +![rotation explanation](img/rotation_explanation.png) Transformations are always done to the **canvas**, not the individual shapes themselves. Rotation is done around the origin, point (0, 0) and affects all shapes drawn afterwards. You can use our built-in `pi` variable to express radians, or convert from degrees to radians by multiplying your number of degrees by `pi / 180`. From 1ea80fd2ca6d8fa6fc3f07ea06358ad4a9a3a986 Mon Sep 17 00:00:00 2001 From: Tim Date: Mon, 22 Feb 2021 17:27:24 -0700 Subject: [PATCH 06/14] Added a FRAME_RATE variable to global_constants{} Not sure if this is the right place to put it but I was getting a key error trying to put it as property --- spark/core.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/spark/core.py b/spark/core.py index 46ba78b..acf64e2 100644 --- a/spark/core.py +++ b/spark/core.py @@ -31,7 +31,8 @@ class Core: # All constants that will be injected into global scope in the user"s cell global_constants = { - "pi": pi + "pi": pi, + "FRAME_RATE": FRAME_RATE } ignite_globals = _ignite_globals From 43b4432e3041891ac4e0e2e78f383b21297ac0a1 Mon Sep 17 00:00:00 2001 From: Tim Date: Sat, 27 Feb 2021 21:31:58 -0700 Subject: [PATCH 07/14] Added documentation mentioning the frame rate --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 1a9d138..335b753 100644 --- a/docs/index.md +++ b/docs/index.md @@ -102,7 +102,7 @@ def setup(): size(200, 200) # You can change 200, 200 to any integers ``` -You can also use the draw() function, which will execute the code constantly that is inside it. This makes it ideal for things like animation, and any code that will update itself over time. **Most of the time this will be the setup you want**: +You can also use the draw() function, which will execute the code constantly that is inside it. The draw function executes 30 times per second. This makes it ideal for things like animation, and any code that will update itself over time. **Most of the time this will be the setup you want**: ```python %%ignite From 3631226f018308eb9263e1b5c148994ebc754a04 Mon Sep 17 00:00:00 2001 From: Tim Date: Sat, 27 Feb 2021 21:35:55 -0700 Subject: [PATCH 08/14] Unit test for for frame rate tests different cases of trying to re-assign FRAME_RATE --- FrameRateTest.ipynb | 685 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 685 insertions(+) create mode 100644 FrameRateTest.ipynb diff --git a/FrameRateTest.ipynb b/FrameRateTest.ipynb new file mode 100644 index 0000000..9e67f0c --- /dev/null +++ b/FrameRateTest.ipynb @@ -0,0 +1,685 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": 45, + "id": "difficult-membership", + "metadata": {}, + "outputs": [], + "source": [ + "import spark\n", + "%reload_ext spark\n", + "\n", + "# 'Unit test' for FRAME_RATE" + ] + }, + { + "cell_type": "code", + "execution_count": 47, + "id": "cooperative-galaxy", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "
Done drawing.\n",
+       "
\n" + ], + "text/latex": [ + "\\begin{Verbatim}[commandchars=\\\\\\{\\}]\n", + "\\PY{err}{D}\\PY{err}{o}\\PY{err}{n}\\PY{err}{e}\\PY{err}{ }\\PY{err}{d}\\PY{err}{r}\\PY{err}{a}\\PY{err}{w}\\PY{err}{i}\\PY{err}{n}\\PY{err}{g}\\PY{err}{.}\n", + "\\end{Verbatim}\n" + ], + "text/plain": [ + "Done drawing." + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "application/vnd.jupyter.widget-view+json": { + "model_id": "b979b65b533c4dd1bc4871df23cb73fe", + "version_major": 2, + "version_minor": 0 + }, + "text/plain": [ + "Canvas(height=100, width=100)" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "text/html": [ + "
frame rate: 30\n",
+       "
\n" + ], + "text/latex": [ + "\\begin{Verbatim}[commandchars=\\\\\\{\\}]\n", + "\\PY{err}{f}\\PY{err}{r}\\PY{err}{a}\\PY{err}{m}\\PY{err}{e}\\PY{err}{ }\\PY{err}{r}\\PY{err}{a}\\PY{err}{t}\\PY{err}{e}\\PY{err}{:}\\PY{err}{ }\\PY{err}{3}\\PY{err}{0}\n", + "\\end{Verbatim}\n" + ], + "text/plain": [ + "frame rate: 30" + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "%%ignite\n", + "\n", + "def setup():\n", + " size(200, 100)\n", + " background(\"light blue\")\n", + " print(\"frame rate:\", FRAME_RATE)\n", + " # this prints 30, the actual frame rate" + ] + }, + { + "cell_type": "code", + "execution_count": 46, + "id": "monetary-killer", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "
Done drawing.\n",
+       "
\n" + ], + "text/latex": [ + "\\begin{Verbatim}[commandchars=\\\\\\{\\}]\n", + "\\PY{err}{D}\\PY{err}{o}\\PY{err}{n}\\PY{err}{e}\\PY{err}{ }\\PY{err}{d}\\PY{err}{r}\\PY{err}{a}\\PY{err}{w}\\PY{err}{i}\\PY{err}{n}\\PY{err}{g}\\PY{err}{.}\n", + "\\end{Verbatim}\n" + ], + "text/plain": [ + "Done drawing." + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "application/vnd.jupyter.widget-view+json": { + "model_id": "768bb7ac20e843528a812a505ad79625", + "version_major": 2, + "version_minor": 0 + }, + "text/plain": [ + "Canvas(height=100, width=100)" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "text/html": [ + "
frame rate: 1\n",
+       "
\n" + ], + "text/latex": [ + "\\begin{Verbatim}[commandchars=\\\\\\{\\}]\n", + "\\PY{err}{f}\\PY{err}{r}\\PY{err}{a}\\PY{err}{m}\\PY{err}{e}\\PY{err}{ }\\PY{err}{r}\\PY{err}{a}\\PY{err}{t}\\PY{err}{e}\\PY{err}{:}\\PY{err}{ }\\PY{err}{1}\n", + "\\end{Verbatim}\n" + ], + "text/plain": [ + "frame rate: 1" + ] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "%%ignite\n", + "\n", + "def setup():\n", + " size(200, 100)\n", + " background(\"light blue\")\n", + " FRAME_RATE = 1\n", + " print(\"frame rate:\", FRAME_RATE)\n", + " # this prints 1, not what I want\n" + ] + }, + { + "cell_type": "code", + "execution_count": 48, + "id": "insured-amino", + "metadata": {}, + "outputs": [ + { + "data": { + "text/html": [ + "
Error in setup() function: local variable 'FRAME_RATE' referenced before assignment\n",
+       "
\n" + ], + "text/latex": [ + "\\begin{Verbatim}[commandchars=\\\\\\{\\}]\n", + "\\PY{n}{Error} \\PY{o+ow}{in} \\PY{n}{setup}\\PY{p}{(}\\PY{p}{)} \\PY{n}{function}\\PY{p}{:} \\PY{n}{local} \\PY{n}{variable} \\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{FRAME\\PYZus{}RATE}\\PY{l+s+s1}{\\PYZsq{}} \\PY{n}{referenced} \\PY{n}{before} \\PY{n}{assignment}\n", + "\\end{Verbatim}\n" + ], + "text/plain": [ + "Error in setup() function: local variable 'FRAME_RATE' referenced before assignment" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "application/vnd.jupyter.widget-view+json": { + "model_id": "62bace9c8b6a472b8eda88eb47e25ec0", + "version_major": 2, + "version_minor": 0 + }, + "text/plain": [ + "Canvas(height=100, width=100)" + ] + }, + "metadata": {}, + "output_type": "display_data" + }, + { + "data": { + "text/html": [ + "
\n",
+       "
\n" + ], + "text/latex": [ + "\\begin{Verbatim}[commandchars=\\\\\\{\\}]\n", + "\n", + "\\end{Verbatim}\n" + ], + "text/plain": [] + }, + "metadata": {}, + "output_type": "display_data" + } + ], + "source": [ + "%%ignite\n", + "\n", + "def setup():\n", + " size(200, 100)\n", + " background(\"light blue\")\n", + " print(\"frame rate:\", FRAME_RATE)\n", + " FRAME_RATE = 10\n", + " # this gives an error, FRAME_RATE is referenced before assignment" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "mediterranean-limit", + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.9.1" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} From 626bad0bf9e673e9bb31941558cadd355009c5dc Mon Sep 17 00:00:00 2001 From: Tim Date: Sat, 27 Feb 2021 21:38:57 -0700 Subject: [PATCH 09/14] Added FRAME_RATE variable FRAME_RATE is a @property and an @ignite_global. @FRAME_RATE.setter is supposed to prevent the user from re-assigning. --- spark/core.py | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/spark/core.py b/spark/core.py index acf64e2..20c9035 100644 --- a/spark/core.py +++ b/spark/core.py @@ -31,8 +31,7 @@ class Core: # All constants that will be injected into global scope in the user"s cell global_constants = { - "pi": pi, - "FRAME_RATE": FRAME_RATE + "pi": pi } ignite_globals = _ignite_globals @@ -140,6 +139,18 @@ def height(self, val): self._globals_dict["height"] = val self.canvas.height = val + # this is working + @property + @ignite_global + def FRAME_RATE(self, mutable=False): + return FRAME_RATE + + # this is not working + @FRAME_RATE.setter + def FRAME_RATE(self, val): + raise RuntimeError("FRAME_RATE cannot be reassigned") + + ### Library init ### # Updates last activity time From 8fa33fe019f7738fbd18851efc27490c80e23daf Mon Sep 17 00:00:00 2001 From: Tim Date: Sun, 28 Feb 2021 21:21:28 -0700 Subject: [PATCH 10/14] Moved FrameRateTest.ipynb to the correct folder (test) --- FrameRateTest.ipynb => test/FrameRateTest.ipynb | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename FrameRateTest.ipynb => test/FrameRateTest.ipynb (100%) diff --git a/FrameRateTest.ipynb b/test/FrameRateTest.ipynb similarity index 100% rename from FrameRateTest.ipynb rename to test/FrameRateTest.ipynb From 00356c518015281d1047786d991a658c4f68abbc Mon Sep 17 00:00:00 2001 From: Tim Date: Tue, 2 Mar 2021 07:30:43 -0700 Subject: [PATCH 11/14] Removed non-functional code --- spark/core.py | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/spark/core.py b/spark/core.py index df5b2c4..7c8f58f 100644 --- a/spark/core.py +++ b/spark/core.py @@ -139,17 +139,11 @@ def height(self, val): self._globals_dict["height"] = val self.canvas.height = val - # this is working @property @ignite_global - def FRAME_RATE(self, mutable=False): + def FRAME_RATE(self): return FRAME_RATE - # this is not working - @FRAME_RATE.setter - def FRAME_RATE(self, val): - raise RuntimeError("FRAME_RATE cannot be reassigned") - ### Library init ### From 1e896e9f89f2b25bdee7726c3e30d3d487fe14f2 Mon Sep 17 00:00:00 2001 From: Tim Date: Tue, 2 Mar 2021 07:35:43 -0700 Subject: [PATCH 12/14] Just adjusted a comment --- test/FrameRateTest.ipynb | 33 ++++++++++++++++++++------------- 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/test/FrameRateTest.ipynb b/test/FrameRateTest.ipynb index 9e67f0c..e1cf320 100644 --- a/test/FrameRateTest.ipynb +++ b/test/FrameRateTest.ipynb @@ -2,21 +2,31 @@ "cells": [ { "cell_type": "code", - "execution_count": 45, - "id": "difficult-membership", + "execution_count": 1, "metadata": {}, - "outputs": [], + "outputs": [ + { + "ename": "ModuleNotFoundError", + "evalue": "No module named 'spark'", + "output_type": "error", + "traceback": [ + "\u001b[1;31m---------------------------------------------------------------------------\u001b[0m", + "\u001b[1;31mModuleNotFoundError\u001b[0m Traceback (most recent call last)", + "\u001b[1;32m\u001b[0m in \u001b[0;36m\u001b[1;34m\u001b[0m\n\u001b[1;32m----> 1\u001b[1;33m \u001b[1;32mimport\u001b[0m \u001b[0mspark\u001b[0m\u001b[1;33m\u001b[0m\u001b[1;33m\u001b[0m\u001b[0m\n\u001b[0m\u001b[0;32m 2\u001b[0m \u001b[0mget_ipython\u001b[0m\u001b[1;33m(\u001b[0m\u001b[1;33m)\u001b[0m\u001b[1;33m.\u001b[0m\u001b[0mrun_line_magic\u001b[0m\u001b[1;33m(\u001b[0m\u001b[1;34m'reload_ext'\u001b[0m\u001b[1;33m,\u001b[0m \u001b[1;34m'spark'\u001b[0m\u001b[1;33m)\u001b[0m\u001b[1;33m\u001b[0m\u001b[1;33m\u001b[0m\u001b[0m\n\u001b[0;32m 3\u001b[0m \u001b[1;33m\u001b[0m\u001b[0m\n\u001b[0;32m 4\u001b[0m \u001b[1;31m# Unit test for FRAME_RATE\u001b[0m\u001b[1;33m\u001b[0m\u001b[1;33m\u001b[0m\u001b[1;33m\u001b[0m\u001b[0m\n", + "\u001b[1;31mModuleNotFoundError\u001b[0m: No module named 'spark'" + ] + } + ], "source": [ - "import spark\n", - "%reload_ext spark\n", - "\n", - "# 'Unit test' for FRAME_RATE" + "import spark\r\n", + "%reload_ext spark\r\n", + "\r\n", + "# Unit test for FRAME_RATE" ] }, { "cell_type": "code", "execution_count": 47, - "id": "cooperative-galaxy", "metadata": {}, "outputs": [ { @@ -229,7 +239,6 @@ { "cell_type": "code", "execution_count": 46, - "id": "monetary-killer", "metadata": {}, "outputs": [ { @@ -443,7 +452,6 @@ { "cell_type": "code", "execution_count": 48, - "id": "insured-amino", "metadata": {}, "outputs": [ { @@ -655,7 +663,6 @@ { "cell_type": "code", "execution_count": null, - "id": "mediterranean-limit", "metadata": {}, "outputs": [], "source": [] @@ -677,9 +684,9 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.9.1" + "version": "3.9.1-final" } }, "nbformat": 4, "nbformat_minor": 5 -} +} \ No newline at end of file From 36b6aec9c38fb2b63bdf236f47b26d0f19f25d74 Mon Sep 17 00:00:00 2001 From: Tim Date: Mon, 8 Mar 2021 11:22:45 -0700 Subject: [PATCH 13/14] Cleaned up unit test for FRAME_RATE --- test/FrameRateTest.ipynb | 290 ++++++++------------------------------- 1 file changed, 55 insertions(+), 235 deletions(-) diff --git a/test/FrameRateTest.ipynb b/test/FrameRateTest.ipynb index e1cf320..bd52172 100644 --- a/test/FrameRateTest.ipynb +++ b/test/FrameRateTest.ipynb @@ -2,21 +2,10 @@ "cells": [ { "cell_type": "code", - "execution_count": 1, + "execution_count": 4, + "id": "turned-warrior", "metadata": {}, - "outputs": [ - { - "ename": "ModuleNotFoundError", - "evalue": "No module named 'spark'", - "output_type": "error", - "traceback": [ - "\u001b[1;31m---------------------------------------------------------------------------\u001b[0m", - "\u001b[1;31mModuleNotFoundError\u001b[0m Traceback (most recent call last)", - "\u001b[1;32m\u001b[0m in \u001b[0;36m\u001b[1;34m\u001b[0m\n\u001b[1;32m----> 1\u001b[1;33m \u001b[1;32mimport\u001b[0m \u001b[0mspark\u001b[0m\u001b[1;33m\u001b[0m\u001b[1;33m\u001b[0m\u001b[0m\n\u001b[0m\u001b[0;32m 2\u001b[0m \u001b[0mget_ipython\u001b[0m\u001b[1;33m(\u001b[0m\u001b[1;33m)\u001b[0m\u001b[1;33m.\u001b[0m\u001b[0mrun_line_magic\u001b[0m\u001b[1;33m(\u001b[0m\u001b[1;34m'reload_ext'\u001b[0m\u001b[1;33m,\u001b[0m \u001b[1;34m'spark'\u001b[0m\u001b[1;33m)\u001b[0m\u001b[1;33m\u001b[0m\u001b[1;33m\u001b[0m\u001b[0m\n\u001b[0;32m 3\u001b[0m \u001b[1;33m\u001b[0m\u001b[0m\n\u001b[0;32m 4\u001b[0m \u001b[1;31m# Unit test for FRAME_RATE\u001b[0m\u001b[1;33m\u001b[0m\u001b[1;33m\u001b[0m\u001b[1;33m\u001b[0m\u001b[0m\n", - "\u001b[1;31mModuleNotFoundError\u001b[0m: No module named 'spark'" - ] - } - ], + "outputs": [], "source": [ "import spark\r\n", "%reload_ext spark\r\n", @@ -26,7 +15,8 @@ }, { "cell_type": "code", - "execution_count": 47, + "execution_count": 9, + "id": "commercial-islam", "metadata": {}, "outputs": [ { @@ -105,16 +95,30 @@ ".output_html .vg { color: #19177C } /* Name.Variable.Global */\n", ".output_html .vi { color: #19177C } /* Name.Variable.Instance */\n", ".output_html .vm { color: #19177C } /* Name.Variable.Magic */\n", - ".output_html .il { color: #666666 } /* Literal.Number.Integer.Long */
Done drawing.\n",
+       ".output_html .il { color: #666666 } /* Literal.Number.Integer.Long */
Stopped\n",
        "
\n"
       ],
       "text/latex": [
        "\\begin{Verbatim}[commandchars=\\\\\\{\\}]\n",
-       "\\PY{err}{D}\\PY{err}{o}\\PY{err}{n}\\PY{err}{e}\\PY{err}{ }\\PY{err}{d}\\PY{err}{r}\\PY{err}{a}\\PY{err}{w}\\PY{err}{i}\\PY{err}{n}\\PY{err}{g}\\PY{err}{.}\n",
+       "\\PY{err}{S}\\PY{err}{t}\\PY{err}{o}\\PY{err}{p}\\PY{err}{p}\\PY{err}{e}\\PY{err}{d}\n",
        "\\end{Verbatim}\n"
       ],
       "text/plain": [
-       "Done drawing."
+       "Stopped"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    },
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "e90b48a28d754b98a473c7ceef8ca21e",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "Button(description='Stop', style=ButtonStyle())"
       ]
      },
      "metadata": {},
@@ -123,7 +127,7 @@
     {
      "data": {
       "application/vnd.jupyter.widget-view+json": {
-       "model_id": "b979b65b533c4dd1bc4871df23cb73fe",
+       "model_id": "840a907740a1451cb8e72795767c686e",
        "version_major": 2,
        "version_minor": 0
       },
@@ -229,16 +233,19 @@
    "source": [
     "%%ignite\n",
     "\n",
+    "# The FRAME_RATE variable is accessible to the user\n",
+    "# It's value should not be changed.\n",
+    "\n",
     "def setup():\n",
     "    size(200, 100)\n",
     "    background(\"light blue\")\n",
-    "    print(\"frame rate:\", FRAME_RATE)\n",
-    "    # this prints 30, the actual frame rate"
+    "    print(\"frame rate:\", FRAME_RATE)"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 46,
+   "execution_count": 19,
+   "id": "norwegian-estonia",
    "metadata": {},
    "outputs": [
     {
@@ -317,16 +324,16 @@
        ".output_html .vg { color: #19177C } /* Name.Variable.Global */\n",
        ".output_html .vi { color: #19177C } /* Name.Variable.Instance */\n",
        ".output_html .vm { color: #19177C } /* Name.Variable.Magic */\n",
-       ".output_html .il { color: #666666 } /* Literal.Number.Integer.Long */
Done drawing.\n",
+       ".output_html .il { color: #666666 } /* Literal.Number.Integer.Long */
Stopped\n",
        "
\n"
       ],
       "text/latex": [
        "\\begin{Verbatim}[commandchars=\\\\\\{\\}]\n",
-       "\\PY{err}{D}\\PY{err}{o}\\PY{err}{n}\\PY{err}{e}\\PY{err}{ }\\PY{err}{d}\\PY{err}{r}\\PY{err}{a}\\PY{err}{w}\\PY{err}{i}\\PY{err}{n}\\PY{err}{g}\\PY{err}{.}\n",
+       "\\PY{err}{S}\\PY{err}{t}\\PY{err}{o}\\PY{err}{p}\\PY{err}{p}\\PY{err}{e}\\PY{err}{d}\n",
        "\\end{Verbatim}\n"
       ],
       "text/plain": [
-       "Done drawing."
+       "Stopped"
       ]
      },
      "metadata": {},
@@ -335,211 +342,12 @@
     {
      "data": {
       "application/vnd.jupyter.widget-view+json": {
-       "model_id": "768bb7ac20e843528a812a505ad79625",
+       "model_id": "7ccab1ce0b2b4ef8ab1db8ea85bfa5e7",
        "version_major": 2,
        "version_minor": 0
       },
       "text/plain": [
-       "Canvas(height=100, width=100)"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    },
-    {
-     "data": {
-      "text/html": [
-       "
frame rate: 1\n",
-       "
\n"
-      ],
-      "text/latex": [
-       "\\begin{Verbatim}[commandchars=\\\\\\{\\}]\n",
-       "\\PY{err}{f}\\PY{err}{r}\\PY{err}{a}\\PY{err}{m}\\PY{err}{e}\\PY{err}{ }\\PY{err}{r}\\PY{err}{a}\\PY{err}{t}\\PY{err}{e}\\PY{err}{:}\\PY{err}{ }\\PY{err}{1}\n",
-       "\\end{Verbatim}\n"
-      ],
-      "text/plain": [
-       "frame rate: 1"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    }
-   ],
-   "source": [
-    "%%ignite\n",
-    "\n",
-    "def setup():\n",
-    "    size(200, 100)\n",
-    "    background(\"light blue\")\n",
-    "    FRAME_RATE = 1\n",
-    "    print(\"frame rate:\", FRAME_RATE)\n",
-    "    # this prints 1, not what I want\n"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 48,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/html": [
-       "
Error in setup() function: local variable 'FRAME_RATE' referenced before assignment\n",
-       "
\n"
-      ],
-      "text/latex": [
-       "\\begin{Verbatim}[commandchars=\\\\\\{\\}]\n",
-       "\\PY{n}{Error} \\PY{o+ow}{in} \\PY{n}{setup}\\PY{p}{(}\\PY{p}{)} \\PY{n}{function}\\PY{p}{:} \\PY{n}{local} \\PY{n}{variable} \\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{FRAME\\PYZus{}RATE}\\PY{l+s+s1}{\\PYZsq{}} \\PY{n}{referenced} \\PY{n}{before} \\PY{n}{assignment}\n",
-       "\\end{Verbatim}\n"
-      ],
-      "text/plain": [
-       "Error in setup() function: local variable 'FRAME_RATE' referenced before assignment"
+       "Button(description='Stop', style=ButtonStyle())"
       ]
      },
      "metadata": {},
@@ -548,7 +356,7 @@
     {
      "data": {
       "application/vnd.jupyter.widget-view+json": {
-       "model_id": "62bace9c8b6a472b8eda88eb47e25ec0",
+       "model_id": "d4a8b0faf6a54cf995b9fc7b6ecd7c49",
        "version_major": 2,
        "version_minor": 0
       },
@@ -635,15 +443,17 @@
        ".output_html .vg { color: #19177C } /* Name.Variable.Global */\n",
        ".output_html .vi { color: #19177C } /* Name.Variable.Instance */\n",
        ".output_html .vm { color: #19177C } /* Name.Variable.Magic */\n",
-       ".output_html .il { color: #666666 } /* Literal.Number.Integer.Long */
\n",
+       ".output_html .il { color: #666666 } /* Literal.Number.Integer.Long */
frame rate: 30\n",
        "
\n"
       ],
       "text/latex": [
        "\\begin{Verbatim}[commandchars=\\\\\\{\\}]\n",
-       "\n",
+       "\\PY{err}{f}\\PY{err}{r}\\PY{err}{a}\\PY{err}{m}\\PY{err}{e}\\PY{err}{ }\\PY{err}{r}\\PY{err}{a}\\PY{err}{t}\\PY{err}{e}\\PY{err}{:}\\PY{err}{ }\\PY{err}{3}\\PY{err}{0}\n",
        "\\end{Verbatim}\n"
       ],
-      "text/plain": []
+      "text/plain": [
+       "frame rate: 30"
+      ]
      },
      "metadata": {},
      "output_type": "display_data"
@@ -652,17 +462,27 @@
    "source": [
     "%%ignite\n",
     "\n",
+    "# An example use-case is to set speeds in pixels/second using FRAME_RATE\n",
+    "\n",
     "def setup():\n",
-    "    size(200, 100)\n",
+    "    size(500, 300)\n",
     "    background(\"light blue\")\n",
     "    print(\"frame rate:\", FRAME_RATE)\n",
-    "    FRAME_RATE = 10\n",
-    "    # this gives an error, FRAME_RATE is referenced before assignment"
+    "\n",
+    "x = 0\n",
+    "speed = 250/FRAME_RATE # this speed will be 200 pixels/second\n",
+    "\n",
+    "def draw():\n",
+    "    background(\"light blue\")\n",
+    "    global x, speed\n",
+    "    circle(x, 50, 30)\n",
+    "    x += speed"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
+   "id": "married-fabric",
    "metadata": {},
    "outputs": [],
    "source": []
@@ -684,9 +504,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1-final"
+   "version": "3.9.1"
   }
  },
  "nbformat": 4,
  "nbformat_minor": 5
-}
\ No newline at end of file
+}

From a1b9122a4819f8c0f94f57e6e9926accd49b1653 Mon Sep 17 00:00:00 2001
From: Tim 
Date: Mon, 8 Mar 2021 11:41:56 -0700
Subject: [PATCH 14/14] Added FRAME_RATE docs

Added a description of FRAME_RATE to utilities.md
---
 docs/img/frame_rate.png | Bin 0 -> 5585 bytes
 docs/utilities.md       |  38 +++++++++++++++++++++++++++++++++++++-
 2 files changed, 37 insertions(+), 1 deletion(-)
 create mode 100644 docs/img/frame_rate.png

diff --git a/docs/img/frame_rate.png b/docs/img/frame_rate.png
new file mode 100644
index 0000000000000000000000000000000000000000..e71495973ce4340d68ac5873a9083fbe12aada40
GIT binary patch
literal 5585
zcmeHLX*8Q%yNG}1Yb=LRqtn=fn^W$32v-f(QwePj}zOVbb?sOX~QxV|b
zKmY(BVs_)Y9RR>*%)?PZ0p3h$xj3Hp;ES*`H3VP=PtNlO`~9z3UIPFcvV^w1`FZ1m
z;Wu0&007bMKj7;LtMcJZo{luW6=`(e*E=#WEcBE^V2Cf^vg&0uUDYePs@kX2)O4??
z>t4~xeN^}Z0FclzyME0f#*;-C`p1D%+_SO=0DjjN*zaJXDtP3BX{q-G6Y(>0-y+n$
z-)$-jzN(0E1!WAF+&$>@H0Ow=(oNN_JEtWi?`7tl&3L?DXrEyAbH}r*!o7F*d+q1<
ze(+#%+iGTHo6$L>YM`{90CvPLeV>Xao6DK&vkOPLqjM68;l5$WmSK#Xlxu_YGstD
z2I{!=kw~omD`epaKw71MbA~@M^65b9asncJZPIDzvV`I)Nm3H^(3&)DjKVi@5-B~2
z92L|Bw?==4Qh|#4s$S$S2R@(
zm56}Q??N2|Zlbb_y_J9e{=G3*o|S4wnzVCwhX_e3|7Xx92aO$5&SF?Hd0Bduui0~v
zPir^tnBOA5Zvofgrq9k&(CpDQ*Em|lFlQ&&(GRRNryaP6>f2s!!9~wnj0H0$1l7=LB708
z_9o7H!Pt)4=bcg#_ipqkoI_a^2R%F>hQVeH9wxsrPDJS^41cYa|gl_?|Kj-53;hryDcKpy6PSxgGD-5AX&MLBAtku;Bkz%n}eNQHfa3O!J}Ob
zBPeSzhC{(K83XD~bMx*f7OGXu5im)qDy`ys5%1*=kwktT99+0n0HNdE64yNtJ0wpo
z)WRbV9DBV=V2>kd>LhjRun5`#LvE_uEByO~LPwi#i%e^WqM~B9T+?Zz)C%IqV!ddb
zW3?0f=f2l~5`%c0$Z^$E4(Ym_H8MC%N)vKp1Mp8s=CKUmd%cpKdbAC#BKv
zKl`yVI$zM$bJ%(7
zl9L3ITG6QEpa8T^qP~6M#oa7}v12NpkdaDDa~vQ5!aE?94$d3c7CTDnN(6K(SSLTT
zNVco7;f>Jt_*YY^+6-6I{o?4mzWkp9kPU3D;UNrSOur_WNX5?dlkCp+F9b0Or37?$
zniziNdr#U=?JxH!j?R-ioEfCd`mYdn`a?NM_wZ{3J@<%r#tfM&eiqvPkYG9i+EQ{H
zAH2Fx8_-yHEqZ!v9CE(h-rIUA+zGoZ?}sk!A$7i8!~JD54!oQ1()s$I^@o=LqG6e!
zt)h$SM{1JAtoO;p#>SQ+gidLxx7cly!OB3=7Aeo-V*5S=jPijdI|ttwW-XpdfHJ${
zY;B)sO6%n*9_~G@-vR`jB#;4L4rTn$LOtCkA$F4F^oy3FN_NmU8428j7S?jlvu}-b
ze~w>n^A`hcz6zn?E=}Ii^y@FEm%a*h$biawd4=NJ5)mHpR4neNq#NW@he|_P`IGFi
z#p)V$A`^2qWcuymUUb6tO3%iR9BZnj7Tu@T6?+p`=#jL;)(jl37!tiLX4oK#gzUc8
zWKH=6K0<@PP6g<8pF9mLg
zvzhrpSv|Wu%dwgPHl+2~APkdTX%QIe>_NGF64knq&bwtNXX(Ufv9-c)8!bpJ-#&5T
z)MDwC{GZ+ldzSV-`=6E%X2
z6{IDt<`jP|IBgU~eR_fxBu!L#{n~V5IgyhUJ{8M=1t)FUuT{K8f7|(SlsVbtj}2`?
zv4WBq#nIW90QWD8`zPq1?O)zRIc&zF1sQdSur<(2{|owwh6T+^GvKdW-0l*4{t(5z
zG|sDz+Z6|+;^-kllA2BJuxjVWjgf(#Rr~dzePR;Dvq`_ruh8nftsSFZrHayDiVn%{
z1UNhT;u%Fe#=;)8)>m_>rcG1p-mcz^pMRYn1SKZB=jW6bq-#Guf;zF!|JK*%a5Ltv
z-o^x7Gj=r!p%dX&1%yeuq>5QPM%<$!gATpx%*iR8X!GEx+LZAf^#CV)qhH8ACe(>q
zT3yc_G1Ahbt*#B2WKzAY!EN1RHD)_8H0+i5-#=&Lr9H;fjE#vS+;}N1w0ViEj1~rd
z$;B=j`sOeM`pNNz=rOld<-w)A*DzLh)H#s>-kr`elB)_%S&%`FZKyLNEfyZu
z*(ecl{euBXsUF%ZUF)~a&yR~R%iq~UkE8H2p?>=W7KKC5f~L==p3B_$Tv7K$zPBtG
zGwF!6Mt42kcL@zTAUc%`T59V5uT`rbbeU6m&no{lT#@%4$U@MKw$rq4s^@PVpjY~PbXR{pOYXCh)QABoa{2YnK
z+uIB}F9YMHpYjzJ7S)J9FMBnTk7NI271F=dwQngV#1d!o3CWeuZ2Is0Z7`OPM_D5B
zAZD>VjnI{kKj9&OF6RmZM03vov>*K|zMVcZO+l4!Js=a1O1u=e%!h2jETX!@*b-0G@9()l;O9bx*`
z`pdkEJHi;PsM|MB%;p~Px@g6jipX*#fcb|TaTI;8f$=9f)BgG&!#E7e_zNoowgW=d
z+whj@h@rg9nG8MgG`)47`=%upZ-ysnmVU%2R#3!je*;`dGWAV`4_O2XqlMtC(
zn&0jbq@o<#;6z+xo^N_NH_=e;=-@EHQ;6LJ!#UnkxCpX=mQv4x1y??%WAodSddoFP
zlA3!drPL_xP~YbRvI)2SkuaP`cqc#BkZ{_;kx4!)fsQOk95YmVV$!CkIMr>7KSQkE
z!~{h%Yyo+fE;ae$F9~VkaPRu54GQf{Q7{xK3w>XNL&J)=p=7wB1t#)6POE85;
zzBNi|#o!uh$WX#-ml;bx=bBrGQ{G2kWR|_Mg-TQtjvKl9gy)I7+rPar
z%2i_ZU%S&#UMeF?O{g6mwr+AiM@O&CbdgVB97
zkD>)M9+#!LDLjf>pL^b15xF!q=^68tpVr#66tAmT@eNBz^|W_jzgcSXv@Y+0!{Mc*
zlW(LhUGX0jUV}}JYkY_yYJ}E~HHYUHDcK$myn6lN`7|Kh8}=v9SDJzeRpJo^ibZX7
zpJQx<+TB#?=&5`A@9=K?tTwE+0)yz6QQX+bzfkxMK<=#cI%S@(EJ6=fH~8aiO6~r;
zC%SOK1j%>GO_Xc1{{f`z580Fo{u{&`nol;5o`K;*rdre{hc`{KWI~+X?-_4-TLTuN
zC(_DFu9Y27`W?9X_2N9@A@2cd8E*WiOGpVEFN-ok!mdZ!{Dh0O2H~4;&Yf(yST0d*$oJNuDB~9QR5p
zZmyt4E*U>L_Id^hP8t{=Ys9f?rDVvGoOH%X^#B_zi~_pz{&9T=b%BbSCD&kJ58Pkm
zjEl32Ja^3Spm&Ah*@f%ZoDT)8cA^-MYFwJmH#1jWf^3j+3krI>o8OHPUCbsjh|~h4
zsFj;!0x8vb8heA$?K#br7KQ2x`ud6A-lv!D(4%KWxEV6~NoxaIC@;6^nD3eE5s#Td
z^6&!1_XJP-b^Y%LWMWQP=;CF3z`}?eXNlh3uD|a@tFph5
zEm`mwY>1r<{{Hkz7lAtZT1iDkOg8cJmB&dNO-Q&eJl*h|0NU`^N2xI3kT_jWGcz;n
zU1qrrfv0M^bvPf>ENyLVV;;bSiBDA8wP7`$Zek_QF$@L+g^aEl%5W?%A=d!N>pCB{
zj7!(J5hR{6g|MjDs4*9RIFwb+_%bTlbrsY5$!0Wd92@{kO6eMjT_0led`0T*p-4J(
zT&{Mq)HFa**m$|2xmo>fiTtkwNhh%sNtUyX&7tX;42g@2FYK+%4vd*yC>Ea;DSa?V
zA~lJDw^eI;`W%<}dZE1Xy`{=Dk|xHXHxhhN8H)D6lTf^b@IAY5=^MREV(=ox)(JSJ
zA~dn$mm3c9@{&vA`#AQ3M3-%D3Hn>Aog8{i{?T`pzZ}O`7zcke76}>i7l8U#jB1o$
zq1&=RTk_2pA&~<%^e-@egknoqS66u3@>ThkJI;EkMX~{(t_$nH%SN1a{)SXOrH|CrGoK!Rh
zgbV&Z{?G2g{WIdGJhJ6AA&CzJ$B~LG}u~1`;
z1bKVpetVto85F@76k!6s{B)N`|E;8?)Ld3pR*$*5$TKT~=C2{`6HPuXRUi9_=#o}Qke_LUY50|+fQp5`0|0u*?u1$;L=JZvMU
z?AqMR%SE(EW!2?TO>7_-UW)#-y}j)t2DtI5b*bsE#+H_eu^N}7V|r1G$1xXnw;5n-
z=d1-g*`)0iEZPjv+iEj99_Apy>*8IksU|5Myv2G*m`_3%Q-LS
z*3YZGaMhM03W8~((m_pr13;z*jqjB1qS0YMqXL8H$A=F67is;kGW&n;z2fDL>;yeN
W>f%eQ2fU6ez|7d{I>zvJ%6|ZS;$eXR

literal 0
HcmV?d00001

diff --git a/docs/utilities.md b/docs/utilities.md
index 1d29de3..a4a01c6 100644
--- a/docs/utilities.md
+++ b/docs/utilities.md
@@ -124,4 +124,40 @@ def setup():
 
 Results in:
 
-![dist demo](img/dist_2.png)
\ No newline at end of file
+![dist demo](img/dist_2.png)
+
+### Accessing the canvas frame rate
+
+The frame rate of the canvas can be accessed through the built-in variable
+
+```python
+FRAME_RATE
+```
+
+The value of FRAME_RATE is set to 30 by default, and should not be changed by the user. Changing this manually will not change the actual frame rate, and will likely result in errors.
+
+**Example:**
+
+```python
+%%ignite
+
+def setup():
+    print(FRAME_RATE)
+```
+
+Results in:
+
+![FRAME_RATE demo](img/frame_rate.png)
+
+The use-cases of this of this variable are fairly limited, but can be used for example to set a speed variable in terms of the frame rate. For example:
+
+```python
+x = 10
+speed = 300/FRAME_RATE
+
+def draw():
+    global x, speed
+    circle(x, 100, 50)
+    x += speed
+```
+will result in the circle moving across the screen at 300 pixels per second.
\ No newline at end of file