Главная Обзор Помощь
Вход
marcos
/
FlatCAM
1
0
Ответвить 0
Файлы Задачи 0 Запросы на слияние 0 Вики
Дерево: 7979757d60
Ветки Метки
FlatCAM
/
doc
/
build
/
index.html

index.html 99 KB
История Исходник

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186 
  1. 

  2. 

  3. <!DOCTYPE html>
    4. 

  4. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
    5. 

  5. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
    6. 

  6. <head>
    7. 

  7.   <meta charset="utf-8">
    8. 

  8.   <meta name="viewport" content="width=device-width, initial-scale=1.0">
    9. 

  9.   
    10. 

  10.   <title>Welcome to Cirkuix’s documentation! &mdash; Cirkuix 0.5 documentation</title>
    11. 

  11.   
    12. 

  12. 

  13.   
    14. 

  14.   
    15. 

  15. 

  16.   
    17. 

  17.   <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
    18. 

  18. 

  19.   
    20. 

  20.   
    21. 

  21. 

  22.     <script type="text/javascript">
    23. 

  23.       var DOCUMENTATION_OPTIONS = {
    24. 

  24.         URL_ROOT:'./',
    25. 

  25.         VERSION:'0.5',
    26. 

  26.         COLLAPSE_INDEX:false,
    27. 

  27.         FILE_SUFFIX:'.html',
    28. 

  28.         HAS_SOURCE:  true
    29. 

  29.       };
    30. 

  30.     </script>
    31. 

  31.       <script type="text/javascript" src="_static/jquery.js"></script>
    32. 

  32.       <script type="text/javascript" src="_static/underscore.js"></script>
    33. 

  33.       <script type="text/javascript" src="_static/doctools.js"></script>
    34. 

  34. 

  35.     
    36. 

  36. 

  37.   
    38. 

  38. 

  39.   
    40. 

  40.   
    41. 

  41.     <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
    42. 

  42.     <script type="text/javascript" src="_static/js/theme.js"></script>
    43. 

  43.   
    44. 

  44. 

  45.   
    46. 

  46.   
    47. 

  47.     <script type="text/javascript">
    48. 

  48.         jQuery(function () {
    49. 

  49.             SphinxRtdTheme.StickyNav.enable();
    50. 

  50.         });
    51. 

  51.     </script>
    52. 

  52.   
    53. 

  53. 

  54.   
    55. 

  55.     <link rel="top" title="Cirkuix 0.5 documentation" href="#"/> 
    56. 

  56. 

  57.   <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
    58. 

  58. 

  59. </head>
    60. 

  60. 

  61. <body class="wy-body-for-nav" role="document">
    62. 

  62. 

  63.   <div class="wy-grid-for-nav">
    64. 

  64. 

  65.     
    66. 

  66.     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
    67. 

  67.       <div class="wy-side-nav-search">
    68. 

  68.         <a href="#" class="icon icon-home"> Cirkuix</a>
    69. 

  69.         <div role="search">
    70. 

  70.   <form id ="rtd-search-form" class="wy-form" action="search.html" method="get">
    71. 

  71.     <input type="text" name="q" placeholder="Search docs" />
    72. 

  72.     <input type="hidden" name="check_keywords" value="yes" />
    73. 

  73.     <input type="hidden" name="area" value="default" />
    74. 

  74.   </form>
    75. 

  75. </div>
    76. 

  76.       </div>
    77. 

  77. 

  78.       <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
    79. 

  79.         
    80. 

  80.         
    81. 

  81.             <ul class="simple">
    82. 

  82. </ul>
    83. 

  83. 

  84.         
    85. 

  85.       </div>
    86. 

  86.       &nbsp;
    87. 

  87.     </nav>
    88. 

  88. 

  89.     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
    90. 

  90. 

  91.       
    92. 

  92.       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
    93. 

  93.         <i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
    94. 

  94.         <a href="#">Cirkuix</a>
    95. 

  95.       </nav>
    96. 

  96. 

  97. 

  98.       
    99. 

  99.       <div class="wy-nav-content">
    100. 

  100.         <div class="rst-content">
    101. 

  101.           <div role="navigation" aria-label="breadcrumbs navigation">
    102. 

  102.   <ul class="wy-breadcrumbs">
    103. 

  103.     <li><a href="#">Docs</a> &raquo;</li>
    104. 

  104.       
    105. 

  105.     <li>Welcome to Cirkuix&#8217;s documentation!</li>
    106. 

  106.       <li class="wy-breadcrumbs-aside">
    107. 

  107.         
    108. 

  108.           <a href="_sources/index.txt" rel="nofollow"> View page source</a>
    109. 

  109.         
    110. 

  110.       </li>
    111. 

  111.   </ul>
    112. 

  112.   <hr/>
    113. 

  113. </div>
    114. 

  114.           <div role="main">
    115. 

  115.             
    116. 

  116.   <div class="section" id="welcome-to-cirkuix-s-documentation">
    117. 

  117. <h1>Welcome to Cirkuix&#8217;s documentation!<a class="headerlink" href="#welcome-to-cirkuix-s-documentation" title="Permalink to this headline">¶</a></h1>
    118. 

  118. <p>Contents:</p>
    119. 

  119. <div class="toctree-wrapper compound">
    120. 

  120. <ul class="simple">
    121. 

  121. </ul>
    122. 

  122. </div>
    123. 

  123. <span class="target" id="module-FlatCAM"></span><dl class="class">
    124. 

  124. <dt id="FlatCAM.App">
    125. 

  125. <em class="property">class </em><tt class="descclassname">FlatCAM.</tt><tt class="descname">App</tt><a class="headerlink" href="#FlatCAM.App" title="Permalink to this definition">¶</a></dt>
    126. 

  126. <dd><p>The main application class. The constructor starts the GUI.</p>
    127. 

  127. <dl class="method">
    128. 

  128. <dt id="FlatCAM.App.adjust_axes">
    129. 

  129. <tt class="descname">adjust_axes</tt><big>(</big><em>xmin</em>, <em>ymin</em>, <em>xmax</em>, <em>ymax</em><big>)</big><a class="headerlink" href="#FlatCAM.App.adjust_axes" title="Permalink to this definition">¶</a></dt>
    130. 

  130. <dd><p>Adjusts axes of all plots while maintaining the use of the whole canvas
    131. 

  131. and an aspect ratio to 1:1 between x and y axes. The parameters are an original
    132. 

  132. request that will be modified to fit these restrictions.</p>
    133. 

  133. <table class="docutils field-list" frame="void" rules="none">
    134. 

  134. <col class="field-name" />
    135. 

  135. <col class="field-body" />
    136. 

  136. <tbody valign="top">
    137. 

  137. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    138. 

  138. <li><strong>xmin</strong> (<em>float</em>) &#8211; Requested minimum value for the X axis.</li>
    139. 

  139. <li><strong>ymin</strong> (<em>float</em>) &#8211; Requested minimum value for the Y axis.</li>
    140. 

  140. <li><strong>xmax</strong> (<em>float</em>) &#8211; Requested maximum value for the X axis.</li>
    141. 

  141. <li><strong>ymax</strong> (<em>float</em>) &#8211; Requested maximum value for the Y axis.</li>
    142. 

  142. </ul>
    143. 

  143. </td>
    144. 

  144. </tr>
    145. 

  145. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
    146. 

  146. </td>
    147. 

  147. </tr>
    148. 

  148. </tbody>
    149. 

  149. </table>
    150. 

  150. </dd></dl>
    151. 

  151. 

  152. <dl class="method">
    153. 

  153. <dt id="FlatCAM.App.build_list">
    154. 

  154. <tt class="descname">build_list</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.App.build_list" title="Permalink to this definition">¶</a></dt>
    155. 

  155. <dd><p>Clears and re-populates the list of objects in currently
    156. 

  156. in the project.</p>
    157. 

  157. <table class="docutils field-list" frame="void" rules="none">
    158. 

  158. <col class="field-name" />
    159. 

  159. <col class="field-body" />
    160. 

  160. <tbody valign="top">
    161. 

  161. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    162. 

  162. </tr>
    163. 

  163. </tbody>
    164. 

  164. </table>
    165. 

  165. </dd></dl>
    166. 

  166. 

  167. <dl class="method">
    168. 

  168. <dt id="FlatCAM.App.clear_plots">
    169. 

  169. <tt class="descname">clear_plots</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.App.clear_plots" title="Permalink to this definition">¶</a></dt>
    170. 

  170. <dd><p>Clears self.axes and self.figure.</p>
    171. 

  171. <table class="docutils field-list" frame="void" rules="none">
    172. 

  172. <col class="field-name" />
    173. 

  173. <col class="field-body" />
    174. 

  174. <tbody valign="top">
    175. 

  175. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    176. 

  176. </tr>
    177. 

  177. </tbody>
    178. 

  178. </table>
    179. 

  179. </dd></dl>
    180. 

  180. 

  181. <dl class="method">
    182. 

  182. <dt id="FlatCAM.App.file_chooser_action">
    183. 

  183. <tt class="descname">file_chooser_action</tt><big>(</big><em>on_success</em><big>)</big><a class="headerlink" href="#FlatCAM.App.file_chooser_action" title="Permalink to this definition">¶</a></dt>
    184. 

  184. <dd><p>Opens the file chooser and runs on_success on a separate thread
    185. 

  185. upon completion of valid file choice.</p>
    186. 

  186. <table class="docutils field-list" frame="void" rules="none">
    187. 

  187. <col class="field-name" />
    188. 

  188. <col class="field-body" />
    189. 

  189. <tbody valign="top">
    190. 

  190. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>on_success</strong> (<em>func</em>) &#8211; A function to run upon completion of a valid file
    191. 

  191. selection. Takes 2 parameters: The app instance and the filename.
    192. 

  192. Note that it is run on a separate thread, therefore it must take the
    193. 

  193. appropriate precautions  when accessing shared resources.</td>
    194. 

  194. </tr>
    195. 

  195. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    196. 

  196. </tr>
    197. 

  197. </tbody>
    198. 

  198. </table>
    199. 

  199. </dd></dl>
    200. 

  200. 

  201. <dl class="method">
    202. 

  202. <dt id="FlatCAM.App.file_chooser_save_action">
    203. 

  203. <tt class="descname">file_chooser_save_action</tt><big>(</big><em>on_success</em><big>)</big><a class="headerlink" href="#FlatCAM.App.file_chooser_save_action" title="Permalink to this definition">¶</a></dt>
    204. 

  204. <dd><p>Opens the file chooser and runs on_success upon completion of valid file choice.</p>
    205. 

  205. <table class="docutils field-list" frame="void" rules="none">
    206. 

  206. <col class="field-name" />
    207. 

  207. <col class="field-body" />
    208. 

  208. <tbody valign="top">
    209. 

  209. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>on_success</strong> &#8211; A function to run upon selection of a filename. Takes 2
    210. 

  210. parameters: The instance of the application (App) and the chosen filename. This
    211. 

  211. gets run immediately in the same thread.</td>
    212. 

  212. </tr>
    213. 

  213. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    214. 

  214. </tr>
    215. 

  215. </tbody>
    216. 

  216. </table>
    217. 

  217. </dd></dl>
    218. 

  218. 

  219. <dl class="method">
    220. 

  220. <dt id="FlatCAM.App.get_current">
    221. 

  221. <tt class="descname">get_current</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.App.get_current" title="Permalink to this definition">¶</a></dt>
    222. 

  222. <dd><p>Returns the currently selected FlatCAMObj in the application.</p>
    223. 

  223. <table class="docutils field-list" frame="void" rules="none">
    224. 

  224. <col class="field-name" />
    225. 

  225. <col class="field-body" />
    226. 

  226. <tbody valign="top">
    227. 

  227. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Currently selected FlatCAMObj in the application.</td>
    228. 

  228. </tr>
    229. 

  229. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">FlatCAMObj or None</td>
    230. 

  230. </tr>
    231. 

  231. </tbody>
    232. 

  232. </table>
    233. 

  233. </dd></dl>
    234. 

  234. 

  235. <dl class="method">
    236. 

  236. <dt id="FlatCAM.App.get_eval">
    237. 

  237. <tt class="descname">get_eval</tt><big>(</big><em>widget_name</em><big>)</big><a class="headerlink" href="#FlatCAM.App.get_eval" title="Permalink to this definition">¶</a></dt>
    238. 

  238. <dd><p>Runs eval() on the on the text entry of name &#8216;widget_name&#8217;
    239. 

  239. and returns the results.</p>
    240. 

  240. <table class="docutils field-list" frame="void" rules="none">
    241. 

  241. <col class="field-name" />
    242. 

  242. <col class="field-body" />
    243. 

  243. <tbody valign="top">
    244. 

  244. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget_name</strong> (<em>str</em>) &#8211; Name of Gtk.Entry</td>
    245. 

  245. </tr>
    246. 

  246. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Depends on contents of the entry text.</td>
    247. 

  247. </tr>
    248. 

  248. </tbody>
    249. 

  249. </table>
    250. 

  250. </dd></dl>
    251. 

  251. 

  252. <dl class="method">
    253. 

  253. <dt id="FlatCAM.App.get_radio_value">
    254. 

  254. <tt class="descname">get_radio_value</tt><big>(</big><em>radio_set</em><big>)</big><a class="headerlink" href="#FlatCAM.App.get_radio_value" title="Permalink to this definition">¶</a></dt>
    255. 

  255. <dd><p>Returns the radio_set[key] of the radiobutton
    256. 

  256. whose name is key is active.</p>
    257. 

  257. <table class="docutils field-list" frame="void" rules="none">
    258. 

  258. <col class="field-name" />
    259. 

  259. <col class="field-body" />
    260. 

  260. <tbody valign="top">
    261. 

  261. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>radio_set</strong> (<em>dict</em>) &#8211; A dictionary containing widget_name: value pairs.</td>
    262. 

  262. </tr>
    263. 

  263. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">radio_set[key]</td>
    264. 

  264. </tr>
    265. 

  265. </tbody>
    266. 

  266. </table>
    267. 

  267. </dd></dl>
    268. 

  268. 

  269. <dl class="method">
    270. 

  270. <dt id="FlatCAM.App.info">
    271. 

  271. <tt class="descname">info</tt><big>(</big><em>text</em><big>)</big><a class="headerlink" href="#FlatCAM.App.info" title="Permalink to this definition">¶</a></dt>
    272. 

  272. <dd><p>Show text on the status bar.</p>
    273. 

  273. <table class="docutils field-list" frame="void" rules="none">
    274. 

  274. <col class="field-name" />
    275. 

  275. <col class="field-body" />
    276. 

  276. <tbody valign="top">
    277. 

  277. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>text</strong> (<em>str</em>) &#8211; Text to display.</td>
    278. 

  278. </tr>
    279. 

  279. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    280. 

  280. </tr>
    281. 

  281. </tbody>
    282. 

  282. </table>
    283. 

  283. </dd></dl>
    284. 

  284. 

  285. <dl class="method">
    286. 

  286. <dt id="FlatCAM.App.load_defaults">
    287. 

  287. <tt class="descname">load_defaults</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.App.load_defaults" title="Permalink to this definition">¶</a></dt>
    288. 

  288. <dd><p>Loads the aplication&#8217;s default settings from defaults.json into
    289. 

  289. <tt class="docutils literal"><span class="pre">self.defaults</span></tt>.</p>
    290. 

  290. <table class="docutils field-list" frame="void" rules="none">
    291. 

  291. <col class="field-name" />
    292. 

  292. <col class="field-body" />
    293. 

  293. <tbody valign="top">
    294. 

  294. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    295. 

  295. </tr>
    296. 

  296. </tbody>
    297. 

  297. </table>
    298. 

  298. </dd></dl>
    299. 

  299. 

  300. <dl class="method">
    301. 

  301. <dt id="FlatCAM.App.new_object">
    302. 

  302. <tt class="descname">new_object</tt><big>(</big><em>kind</em>, <em>name</em>, <em>initialize</em><big>)</big><a class="headerlink" href="#FlatCAM.App.new_object" title="Permalink to this definition">¶</a></dt>
    303. 

  303. <dd><p>Creates a new specalized FlatCAMObj and attaches it to the application,
    304. 

  304. this is, updates the GUI accordingly, any other records and plots it.</p>
    305. 

  305. <table class="docutils field-list" frame="void" rules="none">
    306. 

  306. <col class="field-name" />
    307. 

  307. <col class="field-body" />
    308. 

  308. <tbody valign="top">
    309. 

  309. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    310. 

  310. <li><strong>kind</strong> (<em>str</em>) &#8211; The kind of object to create. One of &#8216;gerber&#8217;,
    311. 

  311. &#8216;excellon&#8217;, &#8216;cncjob&#8217; and &#8216;geometry&#8217;.</li>
    312. 

  312. <li><strong>name</strong> (<em>str</em>) &#8211; Name for the object.</li>
    313. 

  313. <li><strong>initialize</strong> (<em>function</em>) &#8211; Function to run after creation of the object
    314. 

  314. but before it is attached to the application. The function is
    315. 

  315. called with 2 parameters: the new object and the App instance.</li>
    316. 

  316. </ul>
    317. 

  317. </td>
    318. 

  318. </tr>
    319. 

  319. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">None</p>
    320. 

  320. </td>
    321. 

  321. </tr>
    322. 

  322. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
    323. 

  323. </td>
    324. 

  324. </tr>
    325. 

  325. </tbody>
    326. 

  326. </table>
    327. 

  327. </dd></dl>
    328. 

  328. 

  329. <dl class="method">
    330. 

  330. <dt id="FlatCAM.App.on_activate_name">
    331. 

  331. <tt class="descname">on_activate_name</tt><big>(</big><em>entry</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_activate_name" title="Permalink to this definition">¶</a></dt>
    332. 

  332. <dd><p>Hitting &#8216;Enter&#8217; after changing the name of an item
    333. 

  333. updates the item dictionary and re-builds the item list.</p>
    334. 

  334. <table class="docutils field-list" frame="void" rules="none">
    335. 

  335. <col class="field-name" />
    336. 

  336. <col class="field-body" />
    337. 

  337. <tbody valign="top">
    338. 

  338. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>entry</strong> &#8211; The widget from which this was called.</td>
    339. 

  339. </tr>
    340. 

  340. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    341. 

  341. </tr>
    342. 

  342. </tbody>
    343. 

  343. </table>
    344. 

  344. </dd></dl>
    345. 

  345. 

  346. <dl class="method">
    347. 

  347. <dt id="FlatCAM.App.on_canvas_configure">
    348. 

  348. <tt class="descname">on_canvas_configure</tt><big>(</big><em>widget</em>, <em>event</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_canvas_configure" title="Permalink to this definition">¶</a></dt>
    349. 

  349. <dd><p>Called whenever the canvas changes size. The axes are updated such
    350. 

  350. as to use the whole canvas.</p>
    351. 

  351. <table class="docutils field-list" frame="void" rules="none">
    352. 

  352. <col class="field-name" />
    353. 

  353. <col class="field-body" />
    354. 

  354. <tbody valign="top">
    355. 

  355. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    356. 

  356. <li><strong>widget</strong> &#8211; Ignored.</li>
    357. 

  357. <li><strong>event</strong> &#8211; Ignored.</li>
    358. 

  358. </ul>
    359. 

  359. </td>
    360. 

  360. </tr>
    361. 

  361. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
    362. 

  362. </td>
    363. 

  363. </tr>
    364. 

  364. </tbody>
    365. 

  365. </table>
    366. 

  366. </dd></dl>
    367. 

  367. 

  368. <dl class="method">
    369. 

  369. <dt id="FlatCAM.App.on_clear_plots">
    370. 

  370. <tt class="descname">on_clear_plots</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_clear_plots" title="Permalink to this definition">¶</a></dt>
    371. 

  371. <dd><p>Callback for toolbar button. Clears all plots.</p>
    372. 

  372. <table class="docutils field-list" frame="void" rules="none">
    373. 

  373. <col class="field-name" />
    374. 

  374. <col class="field-body" />
    375. 

  375. <tbody valign="top">
    376. 

  376. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; The widget from which this was called.</td>
    377. 

  377. </tr>
    378. 

  378. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    379. 

  379. </tr>
    380. 

  380. </tbody>
    381. 

  381. </table>
    382. 

  382. </dd></dl>
    383. 

  383. 

  384. <dl class="method">
    385. 

  385. <dt id="FlatCAM.App.on_click_over_plot">
    386. 

  386. <tt class="descname">on_click_over_plot</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_click_over_plot" title="Permalink to this definition">¶</a></dt>
    387. 

  387. <dd><p>Callback for the mouse click event over the plot. This event is generated
    388. 

  388. by the Matplotlib backend and has been registered in <tt class="docutils literal"><span class="pre">self.__init__()</span></tt>.
    389. 

  389. For details, see: <a class="reference external" href="http://matplotlib.org/users/event_handling.html">http://matplotlib.org/users/event_handling.html</a></p>
    390. 

  390. <p>Default actions are:</p>
    391. 

  391. <ul class="simple">
    392. 

  392. <li>Copy coordinates to clipboard. Ex.: (65.5473, -13.2679)</li>
    393. 

  393. </ul>
    394. 

  394. <table class="docutils field-list" frame="void" rules="none">
    395. 

  395. <col class="field-name" />
    396. 

  396. <col class="field-body" />
    397. 

  397. <tbody valign="top">
    398. 

  398. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> &#8211; Contains information about the event, like which button
    399. 

  399. was clicked, the pixel coordinates and the axes coordinates.</td>
    400. 

  400. </tr>
    401. 

  401. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    402. 

  402. </tr>
    403. 

  403. </tbody>
    404. 

  404. </table>
    405. 

  405. </dd></dl>
    406. 

  406. 

  407. <dl class="method">
    408. 

  408. <dt id="FlatCAM.App.on_closewindow">
    409. 

  409. <tt class="descname">on_closewindow</tt><big>(</big><em>param</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_closewindow" title="Permalink to this definition">¶</a></dt>
    410. 

  410. <dd><p>Callback for closing the main window.</p>
    411. 

  411. <table class="docutils field-list" frame="void" rules="none">
    412. 

  412. <col class="field-name" />
    413. 

  413. <col class="field-body" />
    414. 

  414. <tbody valign="top">
    415. 

  415. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> &#8211; Whatever is passed by the event. Ignore.</td>
    416. 

  416. </tr>
    417. 

  417. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    418. 

  418. </tr>
    419. 

  419. </tbody>
    420. 

  420. </table>
    421. 

  421. </dd></dl>
    422. 

  422. 

  423. <dl class="method">
    424. 

  424. <dt id="FlatCAM.App.on_cncjob_exportgcode">
    425. 

  425. <tt class="descname">on_cncjob_exportgcode</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_cncjob_exportgcode" title="Permalink to this definition">¶</a></dt>
    426. 

  426. <dd><p>Called from button on CNCjob form to save the G-Code from the object.</p>
    427. 

  427. <table class="docutils field-list" frame="void" rules="none">
    428. 

  428. <col class="field-name" />
    429. 

  429. <col class="field-body" />
    430. 

  430. <tbody valign="top">
    431. 

  431. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; The widget from which this was called.</td>
    432. 

  432. </tr>
    433. 

  433. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    434. 

  434. </tr>
    435. 

  435. </tbody>
    436. 

  436. </table>
    437. 

  437. </dd></dl>
    438. 

  438. 

  439. <dl class="method">
    440. 

  440. <dt id="FlatCAM.App.on_create_aligndrill">
    441. 

  441. <tt class="descname">on_create_aligndrill</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_create_aligndrill" title="Permalink to this definition">¶</a></dt>
    442. 

  442. <dd><p>Creates alignment holes Excellon object. Creates mirror duplicates
    443. 

  443. of the specified holes around the specified axis.</p>
    444. 

  444. <table class="docutils field-list" frame="void" rules="none">
    445. 

  445. <col class="field-name" />
    446. 

  446. <col class="field-body" />
    447. 

  447. <tbody valign="top">
    448. 

  448. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; Ignored.</td>
    449. 

  449. </tr>
    450. 

  450. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    451. 

  451. </tr>
    452. 

  452. </tbody>
    453. 

  453. </table>
    454. 

  454. </dd></dl>
    455. 

  455. 

  456. <dl class="method">
    457. 

  457. <dt id="FlatCAM.App.on_create_mirror">
    458. 

  458. <tt class="descname">on_create_mirror</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_create_mirror" title="Permalink to this definition">¶</a></dt>
    459. 

  459. <dd><p>Creates a mirror image of a Gerber object to be used as a bottom
    460. 

  460. copper layer.</p>
    461. 

  461. <table class="docutils field-list" frame="void" rules="none">
    462. 

  462. <col class="field-name" />
    463. 

  463. <col class="field-body" />
    464. 

  464. <tbody valign="top">
    465. 

  465. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; Ignored.</td>
    466. 

  466. </tr>
    467. 

  467. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    468. 

  468. </tr>
    469. 

  469. </tbody>
    470. 

  470. </table>
    471. 

  471. </dd></dl>
    472. 

  472. 

  473. <dl class="method">
    474. 

  474. <dt id="FlatCAM.App.on_delete">
    475. 

  475. <tt class="descname">on_delete</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_delete" title="Permalink to this definition">¶</a></dt>
    476. 

  476. <dd><p>Delete the currently selected FlatCAMObj.</p>
    477. 

  477. <table class="docutils field-list" frame="void" rules="none">
    478. 

  478. <col class="field-name" />
    479. 

  479. <col class="field-body" />
    480. 

  480. <tbody valign="top">
    481. 

  481. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; The widget from which this was called.</td>
    482. 

  482. </tr>
    483. 

  483. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    484. 

  484. </tr>
    485. 

  485. </tbody>
    486. 

  486. </table>
    487. 

  487. </dd></dl>
    488. 

  488. 

  489. <dl class="method">
    490. 

  490. <dt id="FlatCAM.App.on_entry_eval_activate">
    491. 

  491. <tt class="descname">on_entry_eval_activate</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_entry_eval_activate" title="Permalink to this definition">¶</a></dt>
    492. 

  492. <dd><p>Called when an entry is activated (eg. by hitting enter) if
    493. 

  493. set to do so. Its text is eval()&#8217;d and set to the returned value.
    494. 

  494. The current object is updated.</p>
    495. 

  495. <table class="docutils field-list" frame="void" rules="none">
    496. 

  496. <col class="field-name" />
    497. 

  497. <col class="field-body" />
    498. 

  498. <tbody valign="top">
    499. 

  499. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; </td>
    500. 

  500. </tr>
    501. 

  501. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"></td>
    502. 

  502. </tr>
    503. 

  503. </tbody>
    504. 

  504. </table>
    505. 

  505. </dd></dl>
    506. 

  506. 

  507. <dl class="method">
    508. 

  508. <dt id="FlatCAM.App.on_eval_update">
    509. 

  509. <tt class="descname">on_eval_update</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_eval_update" title="Permalink to this definition">¶</a></dt>
    510. 

  510. <dd><p>Modifies the content of a Gtk.Entry by running
    511. 

  511. eval() on its contents and puting it back as a
    512. 

  512. string.</p>
    513. 

  513. <table class="docutils field-list" frame="void" rules="none">
    514. 

  514. <col class="field-name" />
    515. 

  515. <col class="field-body" />
    516. 

  516. <tbody valign="top">
    517. 

  517. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; The widget from which this was called.</td>
    518. 

  518. </tr>
    519. 

  519. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    520. 

  520. </tr>
    521. 

  521. </tbody>
    522. 

  522. </table>
    523. 

  523. </dd></dl>
    524. 

  524. 

  525. <dl class="method">
    526. 

  526. <dt id="FlatCAM.App.on_excellon_tool_choose">
    527. 

  527. <tt class="descname">on_excellon_tool_choose</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_excellon_tool_choose" title="Permalink to this definition">¶</a></dt>
    528. 

  528. <dd><p>Callback for button on Excellon form to open up a window for
    529. 

  529. selecting tools.</p>
    530. 

  530. <table class="docutils field-list" frame="void" rules="none">
    531. 

  531. <col class="field-name" />
    532. 

  532. <col class="field-body" />
    533. 

  533. <tbody valign="top">
    534. 

  534. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; The widget from which this was called.</td>
    535. 

  535. </tr>
    536. 

  536. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    537. 

  537. </tr>
    538. 

  538. </tbody>
    539. 

  539. </table>
    540. 

  540. </dd></dl>
    541. 

  541. 

  542. <dl class="method">
    543. 

  543. <dt id="FlatCAM.App.on_file_new">
    544. 

  544. <tt class="descname">on_file_new</tt><big>(</big><em>param</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_file_new" title="Permalink to this definition">¶</a></dt>
    545. 

  545. <dd><p>Callback for menu item File-&gt;New. Returns the application to its
    546. 

  546. startup state.</p>
    547. 

  547. <table class="docutils field-list" frame="void" rules="none">
    548. 

  548. <col class="field-name" />
    549. 

  549. <col class="field-body" />
    550. 

  550. <tbody valign="top">
    551. 

  551. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> &#8211; Whatever is passed by the event. Ignore.</td>
    552. 

  552. </tr>
    553. 

  553. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    554. 

  554. </tr>
    555. 

  555. </tbody>
    556. 

  556. </table>
    557. 

  557. </dd></dl>
    558. 

  558. 

  559. <dl class="method">
    560. 

  560. <dt id="FlatCAM.App.on_file_openproject">
    561. 

  561. <tt class="descname">on_file_openproject</tt><big>(</big><em>param</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_file_openproject" title="Permalink to this definition">¶</a></dt>
    562. 

  562. <dd><p>Callback for menu item File-&gt;Open Project. Opens a file chooser and calls
    563. 

  563. <tt class="docutils literal"><span class="pre">self.open_project()</span></tt> after successful selection of a filename.</p>
    564. 

  564. <table class="docutils field-list" frame="void" rules="none">
    565. 

  565. <col class="field-name" />
    566. 

  566. <col class="field-body" />
    567. 

  567. <tbody valign="top">
    568. 

  568. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> &#8211; Ignored.</td>
    569. 

  569. </tr>
    570. 

  570. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    571. 

  571. </tr>
    572. 

  572. </tbody>
    573. 

  573. </table>
    574. 

  574. </dd></dl>
    575. 

  575. 

  576. <dl class="method">
    577. 

  577. <dt id="FlatCAM.App.on_file_savedefaults">
    578. 

  578. <tt class="descname">on_file_savedefaults</tt><big>(</big><em>param</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_file_savedefaults" title="Permalink to this definition">¶</a></dt>
    579. 

  579. <dd><p>Callback for menu item File-&gt;Save Defaults. Saves application default options
    580. 

  580. <tt class="docutils literal"><span class="pre">self.defaults</span></tt> to defaults.json.</p>
    581. 

  581. <table class="docutils field-list" frame="void" rules="none">
    582. 

  582. <col class="field-name" />
    583. 

  583. <col class="field-body" />
    584. 

  584. <tbody valign="top">
    585. 

  585. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> &#8211; Ignored.</td>
    586. 

  586. </tr>
    587. 

  587. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    588. 

  588. </tr>
    589. 

  589. </tbody>
    590. 

  590. </table>
    591. 

  591. </dd></dl>
    592. 

  592. 

  593. <dl class="method">
    594. 

  594. <dt id="FlatCAM.App.on_file_saveproject">
    595. 

  595. <tt class="descname">on_file_saveproject</tt><big>(</big><em>param</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_file_saveproject" title="Permalink to this definition">¶</a></dt>
    596. 

  596. <dd><p>Callback for menu item File-&gt;Save Project. Saves the project to
    597. 

  597. <tt class="docutils literal"><span class="pre">self.project_filename</span></tt> or calls <tt class="docutils literal"><span class="pre">self.on_file_saveprojectas()</span></tt>
    598. 

  598. if set to None. The project is saved by calling <tt class="docutils literal"><span class="pre">self.save_project()</span></tt>.</p>
    599. 

  599. <table class="docutils field-list" frame="void" rules="none">
    600. 

  600. <col class="field-name" />
    601. 

  601. <col class="field-body" />
    602. 

  602. <tbody valign="top">
    603. 

  603. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> &#8211; Ignored.</td>
    604. 

  604. </tr>
    605. 

  605. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    606. 

  606. </tr>
    607. 

  607. </tbody>
    608. 

  608. </table>
    609. 

  609. </dd></dl>
    610. 

  610. 

  611. <dl class="method">
    612. 

  612. <dt id="FlatCAM.App.on_file_saveprojectas">
    613. 

  613. <tt class="descname">on_file_saveprojectas</tt><big>(</big><em>param</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_file_saveprojectas" title="Permalink to this definition">¶</a></dt>
    614. 

  614. <dd><p>Callback for menu item File-&gt;Save Project As... Opens a file
    615. 

  615. chooser and saves the project to the given file via
    616. 

  616. <tt class="docutils literal"><span class="pre">self.save_project()</span></tt>.</p>
    617. 

  617. <table class="docutils field-list" frame="void" rules="none">
    618. 

  618. <col class="field-name" />
    619. 

  619. <col class="field-body" />
    620. 

  620. <tbody valign="top">
    621. 

  621. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> &#8211; Ignored.</td>
    622. 

  622. </tr>
    623. 

  623. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    624. 

  624. </tr>
    625. 

  625. </tbody>
    626. 

  626. </table>
    627. 

  627. </dd></dl>
    628. 

  628. 

  629. <dl class="method">
    630. 

  630. <dt id="FlatCAM.App.on_file_saveprojectcopy">
    631. 

  631. <tt class="descname">on_file_saveprojectcopy</tt><big>(</big><em>param</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_file_saveprojectcopy" title="Permalink to this definition">¶</a></dt>
    632. 

  632. <dd><p>Callback for menu item File-&gt;Save Project Copy... Opens a file
    633. 

  633. chooser and saves the project to the given file via
    634. 

  634. <tt class="docutils literal"><span class="pre">self.save_project</span></tt>. It does not update <tt class="docutils literal"><span class="pre">self.project_filename</span></tt> so
    635. 

  635. subsequent save requests are done on the previous known filename.</p>
    636. 

  636. <table class="docutils field-list" frame="void" rules="none">
    637. 

  637. <col class="field-name" />
    638. 

  638. <col class="field-body" />
    639. 

  639. <tbody valign="top">
    640. 

  640. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> &#8211; Ignore.</td>
    641. 

  641. </tr>
    642. 

  642. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    643. 

  643. </tr>
    644. 

  644. </tbody>
    645. 

  645. </table>
    646. 

  646. </dd></dl>
    647. 

  647. 

  648. <dl class="method">
    649. 

  649. <dt id="FlatCAM.App.on_fileopenexcellon">
    650. 

  650. <tt class="descname">on_fileopenexcellon</tt><big>(</big><em>param</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_fileopenexcellon" title="Permalink to this definition">¶</a></dt>
    651. 

  651. <dd><p>Callback for menu item File-&gt;Open Excellon. Defines a function that is then passed
    652. 

  652. to <tt class="docutils literal"><span class="pre">self.file_chooser_action()</span></tt>. It requests the creation of a FlatCAMExcellon object
    653. 

  653. and updates the progress bar throughout the process.</p>
    654. 

  654. <table class="docutils field-list" frame="void" rules="none">
    655. 

  655. <col class="field-name" />
    656. 

  656. <col class="field-body" />
    657. 

  657. <tbody valign="top">
    658. 

  658. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> &#8211; Ignore</td>
    659. 

  659. </tr>
    660. 

  660. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    661. 

  661. </tr>
    662. 

  662. </tbody>
    663. 

  663. </table>
    664. 

  664. </dd></dl>
    665. 

  665. 

  666. <dl class="method">
    667. 

  667. <dt id="FlatCAM.App.on_fileopengcode">
    668. 

  668. <tt class="descname">on_fileopengcode</tt><big>(</big><em>param</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_fileopengcode" title="Permalink to this definition">¶</a></dt>
    669. 

  669. <dd><p>Callback for menu item File-&gt;Open G-Code. Defines a function that is then passed
    670. 

  670. to <tt class="docutils literal"><span class="pre">self.file_chooser_action()</span></tt>. It requests the creation of a FlatCAMCNCjob object
    671. 

  671. and updates the progress bar throughout the process.</p>
    672. 

  672. <table class="docutils field-list" frame="void" rules="none">
    673. 

  673. <col class="field-name" />
    674. 

  674. <col class="field-body" />
    675. 

  675. <tbody valign="top">
    676. 

  676. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> &#8211; Ignore</td>
    677. 

  677. </tr>
    678. 

  678. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    679. 

  679. </tr>
    680. 

  680. </tbody>
    681. 

  681. </table>
    682. 

  682. </dd></dl>
    683. 

  683. 

  684. <dl class="method">
    685. 

  685. <dt id="FlatCAM.App.on_fileopengerber">
    686. 

  686. <tt class="descname">on_fileopengerber</tt><big>(</big><em>param</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_fileopengerber" title="Permalink to this definition">¶</a></dt>
    687. 

  687. <dd><p>Callback for menu item File-&gt;Open Gerber. Defines a function that is then passed
    688. 

  688. to <tt class="docutils literal"><span class="pre">self.file_chooser_action()</span></tt>. It requests the creation of a FlatCAMGerber object
    689. 

  689. and updates the progress bar throughout the process.</p>
    690. 

  690. <table class="docutils field-list" frame="void" rules="none">
    691. 

  691. <col class="field-name" />
    692. 

  692. <col class="field-body" />
    693. 

  693. <tbody valign="top">
    694. 

  694. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> &#8211; Ignore</td>
    695. 

  695. </tr>
    696. 

  696. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    697. 

  697. </tr>
    698. 

  698. </tbody>
    699. 

  699. </table>
    700. 

  700. </dd></dl>
    701. 

  701. 

  702. <dl class="method">
    703. 

  703. <dt id="FlatCAM.App.on_filequit">
    704. 

  704. <tt class="descname">on_filequit</tt><big>(</big><em>param</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_filequit" title="Permalink to this definition">¶</a></dt>
    705. 

  705. <dd><p>Callback for menu item File-&gt;Quit. Closes the application.</p>
    706. 

  706. <table class="docutils field-list" frame="void" rules="none">
    707. 

  707. <col class="field-name" />
    708. 

  708. <col class="field-body" />
    709. 

  709. <tbody valign="top">
    710. 

  710. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> &#8211; Whatever is passed by the event. Ignore.</td>
    711. 

  711. </tr>
    712. 

  712. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    713. 

  713. </tr>
    714. 

  714. </tbody>
    715. 

  715. </table>
    716. 

  716. </dd></dl>
    717. 

  717. 

  718. <dl class="method">
    719. 

  719. <dt id="FlatCAM.App.on_generate_cncjob">
    720. 

  720. <tt class="descname">on_generate_cncjob</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_generate_cncjob" title="Permalink to this definition">¶</a></dt>
    721. 

  721. <dd><p>Callback for button on geometry form to generate CNC job.</p>
    722. 

  722. <table class="docutils field-list" frame="void" rules="none">
    723. 

  723. <col class="field-name" />
    724. 

  724. <col class="field-body" />
    725. 

  725. <tbody valign="top">
    726. 

  726. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; The widget from which this was called.</td>
    727. 

  727. </tr>
    728. 

  728. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    729. 

  729. </tr>
    730. 

  730. </tbody>
    731. 

  731. </table>
    732. 

  732. </dd></dl>
    733. 

  733. 

  734. <dl class="method">
    735. 

  735. <dt id="FlatCAM.App.on_generate_excellon_cncjob">
    736. 

  736. <tt class="descname">on_generate_excellon_cncjob</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_generate_excellon_cncjob" title="Permalink to this definition">¶</a></dt>
    737. 

  737. <dd><p>Callback for button active/click on Excellon form to
    738. 

  738. create a CNC Job for the Excellon file.</p>
    739. 

  739. <table class="docutils field-list" frame="void" rules="none">
    740. 

  740. <col class="field-name" />
    741. 

  741. <col class="field-body" />
    742. 

  742. <tbody valign="top">
    743. 

  743. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; The widget from which this was called.</td>
    744. 

  744. </tr>
    745. 

  745. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    746. 

  746. </tr>
    747. 

  747. </tbody>
    748. 

  748. </table>
    749. 

  749. </dd></dl>
    750. 

  750. 

  751. <dl class="method">
    752. 

  752. <dt id="FlatCAM.App.on_generate_gerber_bounding_box">
    753. 

  753. <tt class="descname">on_generate_gerber_bounding_box</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_generate_gerber_bounding_box" title="Permalink to this definition">¶</a></dt>
    754. 

  754. <dd><p>Callback for request from the Gerber form to generate a bounding box for the
    755. 

  755. geometry in the object. Creates a FlatCAMGeometry with the bounding box.</p>
    756. 

  756. <table class="docutils field-list" frame="void" rules="none">
    757. 

  757. <col class="field-name" />
    758. 

  758. <col class="field-body" />
    759. 

  759. <tbody valign="top">
    760. 

  760. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; Ignored.</td>
    761. 

  761. </tr>
    762. 

  762. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    763. 

  763. </tr>
    764. 

  764. </tbody>
    765. 

  765. </table>
    766. 

  766. </dd></dl>
    767. 

  767. 

  768. <dl class="method">
    769. 

  769. <dt id="FlatCAM.App.on_generate_isolation">
    770. 

  770. <tt class="descname">on_generate_isolation</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_generate_isolation" title="Permalink to this definition">¶</a></dt>
    771. 

  771. <dd><p>Callback for button on Gerber form to create isolation routing geometry.</p>
    772. 

  772. <table class="docutils field-list" frame="void" rules="none">
    773. 

  773. <col class="field-name" />
    774. 

  774. <col class="field-body" />
    775. 

  775. <tbody valign="top">
    776. 

  776. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; The widget from which this was called.</td>
    777. 

  777. </tr>
    778. 

  778. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    779. 

  779. </tr>
    780. 

  780. </tbody>
    781. 

  781. </table>
    782. 

  782. </dd></dl>
    783. 

  783. 

  784. <dl class="method">
    785. 

  785. <dt id="FlatCAM.App.on_generate_paintarea">
    786. 

  786. <tt class="descname">on_generate_paintarea</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_generate_paintarea" title="Permalink to this definition">¶</a></dt>
    787. 

  787. <dd><p>Callback for button on geometry form.
    788. 

  788. Subscribes to the &#8220;Click on plot&#8221; event and continues
    789. 

  789. after the click. Finds the polygon containing
    790. 

  790. the clicked point and runs clear_poly() on it, resulting
    791. 

  791. in a new FlatCAMGeometry object.</p>
    792. 

  792. <table class="docutils field-list" frame="void" rules="none">
    793. 

  793. <col class="field-name" />
    794. 

  794. <col class="field-body" />
    795. 

  795. <tbody valign="top">
    796. 

  796. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; The  widget from which this was called.</td>
    797. 

  797. </tr>
    798. 

  798. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    799. 

  799. </tr>
    800. 

  800. </tbody>
    801. 

  801. </table>
    802. 

  802. </dd></dl>
    803. 

  803. 

  804. <dl class="method">
    805. 

  805. <dt id="FlatCAM.App.on_gerber_generate_cutout">
    806. 

  806. <tt class="descname">on_gerber_generate_cutout</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_gerber_generate_cutout" title="Permalink to this definition">¶</a></dt>
    807. 

  807. <dd><p>Callback for button on Gerber form to create geometry with lines
    808. 

  808. for cutting off the board.</p>
    809. 

  809. <table class="docutils field-list" frame="void" rules="none">
    810. 

  810. <col class="field-name" />
    811. 

  811. <col class="field-body" />
    812. 

  812. <tbody valign="top">
    813. 

  813. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; The widget from which this was called.</td>
    814. 

  814. </tr>
    815. 

  815. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    816. 

  816. </tr>
    817. 

  817. </tbody>
    818. 

  818. </table>
    819. 

  819. </dd></dl>
    820. 

  820. 

  821. <dl class="method">
    822. 

  822. <dt id="FlatCAM.App.on_gerber_generate_noncopper">
    823. 

  823. <tt class="descname">on_gerber_generate_noncopper</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_gerber_generate_noncopper" title="Permalink to this definition">¶</a></dt>
    824. 

  824. <dd><p>Callback for button on Gerber form to create a geometry object
    825. 

  825. with polygons covering the area without copper or negative of the
    826. 

  826. Gerber.</p>
    827. 

  827. <table class="docutils field-list" frame="void" rules="none">
    828. 

  828. <col class="field-name" />
    829. 

  829. <col class="field-body" />
    830. 

  830. <tbody valign="top">
    831. 

  831. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; The widget from which this was called.</td>
    832. 

  832. </tr>
    833. 

  833. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    834. 

  834. </tr>
    835. 

  835. </tbody>
    836. 

  836. </table>
    837. 

  837. </dd></dl>
    838. 

  838. 

  839. <dl class="method">
    840. 

  840. <dt id="FlatCAM.App.on_key_over_plot">
    841. 

  841. <tt class="descname">on_key_over_plot</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_key_over_plot" title="Permalink to this definition">¶</a></dt>
    842. 

  842. <dd><p>Callback for the key pressed event when the canvas is focused. Keyboard
    843. 

  843. shortcuts are handled here. So far, these are the shortcuts:</p>
    844. 

  844. <table border="1" class="docutils">
    845. 

  845. <colgroup>
    846. 

  846. <col width="19%" />
    847. 

  847. <col width="81%" />
    848. 

  848. </colgroup>
    849. 

  849. <thead valign="bottom">
    850. 

  850. <tr class="row-odd"><th class="head">Key</th>
    851. 

  851. <th class="head">Action</th>
    852. 

  852. </tr>
    853. 

  853. </thead>
    854. 

  854. <tbody valign="top">
    855. 

  855. <tr class="row-even"><td>&#8216;1&#8217;</td>
    856. 

  856. <td>Zoom-fit. Fits the axes limits to the data.</td>
    857. 

  857. </tr>
    858. 

  858. <tr class="row-odd"><td>&#8216;2&#8217;</td>
    859. 

  859. <td>Zoom-out.</td>
    860. 

  860. </tr>
    861. 

  861. <tr class="row-even"><td>&#8216;3&#8217;</td>
    862. 

  862. <td>Zoom-in.</td>
    863. 

  863. </tr>
    864. 

  864. </tbody>
    865. 

  865. </table>
    866. 

  866. <table class="docutils field-list" frame="void" rules="none">
    867. 

  867. <col class="field-name" />
    868. 

  868. <col class="field-body" />
    869. 

  869. <tbody valign="top">
    870. 

  870. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> &#8211; Ignored.</td>
    871. 

  871. </tr>
    872. 

  872. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    873. 

  873. </tr>
    874. 

  874. </tbody>
    875. 

  875. </table>
    876. 

  876. </dd></dl>
    877. 

  877. 

  878. <dl class="method">
    879. 

  879. <dt id="FlatCAM.App.on_mouse_move_over_plot">
    880. 

  880. <tt class="descname">on_mouse_move_over_plot</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_mouse_move_over_plot" title="Permalink to this definition">¶</a></dt>
    881. 

  881. <dd><p>Callback for the mouse motion event over the plot. This event is generated
    882. 

  882. by the Matplotlib backend and has been registered in <tt class="docutils literal"><span class="pre">self.__init__()</span></tt>.
    883. 

  883. For details, see: <a class="reference external" href="http://matplotlib.org/users/event_handling.html">http://matplotlib.org/users/event_handling.html</a></p>
    884. 

  884. <table class="docutils field-list" frame="void" rules="none">
    885. 

  885. <col class="field-name" />
    886. 

  886. <col class="field-body" />
    887. 

  887. <tbody valign="top">
    888. 

  888. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> &#8211; Contains information about the event.</td>
    889. 

  889. </tr>
    890. 

  890. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    891. 

  891. </tr>
    892. 

  892. </tbody>
    893. 

  893. </table>
    894. 

  894. </dd></dl>
    895. 

  895. 

  896. <dl class="method">
    897. 

  897. <dt id="FlatCAM.App.on_options_app2object">
    898. 

  898. <tt class="descname">on_options_app2object</tt><big>(</big><em>param</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_options_app2object" title="Permalink to this definition">¶</a></dt>
    899. 

  899. <dd><p>Callback for Options-&gt;Transfer Options-&gt;App=&gt;Object. Copies options
    900. 

  900. from application defaults to the currently selected object.</p>
    901. 

  901. <table class="docutils field-list" frame="void" rules="none">
    902. 

  902. <col class="field-name" />
    903. 

  903. <col class="field-body" />
    904. 

  904. <tbody valign="top">
    905. 

  905. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> &#8211; Ignored.</td>
    906. 

  906. </tr>
    907. 

  907. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    908. 

  908. </tr>
    909. 

  909. </tbody>
    910. 

  910. </table>
    911. 

  911. </dd></dl>
    912. 

  912. 

  913. <dl class="method">
    914. 

  914. <dt id="FlatCAM.App.on_options_app2project">
    915. 

  915. <tt class="descname">on_options_app2project</tt><big>(</big><em>param</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_options_app2project" title="Permalink to this definition">¶</a></dt>
    916. 

  916. <dd><p>Callback for Options-&gt;Transfer Options-&gt;App=&gt;Project. Copies options
    917. 

  917. from application defaults to project defaults.</p>
    918. 

  918. <table class="docutils field-list" frame="void" rules="none">
    919. 

  919. <col class="field-name" />
    920. 

  920. <col class="field-body" />
    921. 

  921. <tbody valign="top">
    922. 

  922. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> &#8211; Ignored.</td>
    923. 

  923. </tr>
    924. 

  924. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    925. 

  925. </tr>
    926. 

  926. </tbody>
    927. 

  927. </table>
    928. 

  928. </dd></dl>
    929. 

  929. 

  930. <dl class="method">
    931. 

  931. <dt id="FlatCAM.App.on_options_combo_change">
    932. 

  932. <tt class="descname">on_options_combo_change</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_options_combo_change" title="Permalink to this definition">¶</a></dt>
    933. 

  933. <dd><p>Called when the combo box to choose between application defaults and
    934. 

  934. project option changes value. The corresponding variables are
    935. 

  935. copied to the UI.</p>
    936. 

  936. <table class="docutils field-list" frame="void" rules="none">
    937. 

  937. <col class="field-name" />
    938. 

  938. <col class="field-body" />
    939. 

  939. <tbody valign="top">
    940. 

  940. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; The widget from which this was called. Ignore.</td>
    941. 

  941. </tr>
    942. 

  942. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    943. 

  943. </tr>
    944. 

  944. </tbody>
    945. 

  945. </table>
    946. 

  946. </dd></dl>
    947. 

  947. 

  948. <dl class="method">
    949. 

  949. <dt id="FlatCAM.App.on_options_object2app">
    950. 

  950. <tt class="descname">on_options_object2app</tt><big>(</big><em>param</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_options_object2app" title="Permalink to this definition">¶</a></dt>
    951. 

  951. <dd><p>Callback for Options-&gt;Transfer Options-&gt;Object=&gt;App. Copies options
    952. 

  952. from the currently selected object to application defaults.</p>
    953. 

  953. <table class="docutils field-list" frame="void" rules="none">
    954. 

  954. <col class="field-name" />
    955. 

  955. <col class="field-body" />
    956. 

  956. <tbody valign="top">
    957. 

  957. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> &#8211; Ignored.</td>
    958. 

  958. </tr>
    959. 

  959. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    960. 

  960. </tr>
    961. 

  961. </tbody>
    962. 

  962. </table>
    963. 

  963. </dd></dl>
    964. 

  964. 

  965. <dl class="method">
    966. 

  966. <dt id="FlatCAM.App.on_options_object2project">
    967. 

  967. <tt class="descname">on_options_object2project</tt><big>(</big><em>param</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_options_object2project" title="Permalink to this definition">¶</a></dt>
    968. 

  968. <dd><p>Callback for Options-&gt;Transfer Options-&gt;Object=&gt;Project. Copies options
    969. 

  969. from the currently selected object to project defaults.</p>
    970. 

  970. <table class="docutils field-list" frame="void" rules="none">
    971. 

  971. <col class="field-name" />
    972. 

  972. <col class="field-body" />
    973. 

  973. <tbody valign="top">
    974. 

  974. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> &#8211; Ignored.</td>
    975. 

  975. </tr>
    976. 

  976. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    977. 

  977. </tr>
    978. 

  978. </tbody>
    979. 

  979. </table>
    980. 

  980. </dd></dl>
    981. 

  981. 

  982. <dl class="method">
    983. 

  983. <dt id="FlatCAM.App.on_options_project2app">
    984. 

  984. <tt class="descname">on_options_project2app</tt><big>(</big><em>param</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_options_project2app" title="Permalink to this definition">¶</a></dt>
    985. 

  985. <dd><p>Callback for Options-&gt;Transfer Options-&gt;Project=&gt;App. Copies options
    986. 

  986. from project defaults to application defaults.</p>
    987. 

  987. <table class="docutils field-list" frame="void" rules="none">
    988. 

  988. <col class="field-name" />
    989. 

  989. <col class="field-body" />
    990. 

  990. <tbody valign="top">
    991. 

  991. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> &#8211; Ignored.</td>
    992. 

  992. </tr>
    993. 

  993. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    994. 

  994. </tr>
    995. 

  995. </tbody>
    996. 

  996. </table>
    997. 

  997. </dd></dl>
    998. 

  998. 

  999. <dl class="method">
    1000. 

  1000. <dt id="FlatCAM.App.on_options_project2object">
    1001. 

  1001. <tt class="descname">on_options_project2object</tt><big>(</big><em>param</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_options_project2object" title="Permalink to this definition">¶</a></dt>
    1002. 

  1002. <dd><p>Callback for Options-&gt;Transfer Options-&gt;Project=&gt;Object. Copies options
    1003. 

  1003. from project defaults to the currently selected object.</p>
    1004. 

  1004. <table class="docutils field-list" frame="void" rules="none">
    1005. 

  1005. <col class="field-name" />
    1006. 

  1006. <col class="field-body" />
    1007. 

  1007. <tbody valign="top">
    1008. 

  1008. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> &#8211; Ignored.</td>
    1009. 

  1009. </tr>
    1010. 

  1010. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1011. 

  1011. </tr>
    1012. 

  1012. </tbody>
    1013. 

  1013. </table>
    1014. 

  1014. </dd></dl>
    1015. 

  1015. 

  1016. <dl class="method">
    1017. 

  1017. <dt id="FlatCAM.App.on_options_update">
    1018. 

  1018. <tt class="descname">on_options_update</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_options_update" title="Permalink to this definition">¶</a></dt>
    1019. 

  1019. <dd><p>Called whenever a value in the options/defaults form changes.
    1020. 

  1020. All values are updated. Can be inhibited by setting <tt class="docutils literal"><span class="pre">self.options_update_ignore</span> <span class="pre">=</span> <span class="pre">True</span></tt>,
    1021. 

  1021. which may be necessary when updating the UI from code and not by the user.</p>
    1022. 

  1022. <table class="docutils field-list" frame="void" rules="none">
    1023. 

  1023. <col class="field-name" />
    1024. 

  1024. <col class="field-body" />
    1025. 

  1025. <tbody valign="top">
    1026. 

  1026. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; The widget from which this was called. Ignore.</td>
    1027. 

  1027. </tr>
    1028. 

  1028. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1029. 

  1029. </tr>
    1030. 

  1030. </tbody>
    1031. 

  1031. </table>
    1032. 

  1032. </dd></dl>
    1033. 

  1033. 

  1034. <dl class="method">
    1035. 

  1035. <dt id="FlatCAM.App.on_replot">
    1036. 

  1036. <tt class="descname">on_replot</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_replot" title="Permalink to this definition">¶</a></dt>
    1037. 

  1037. <dd><p>Callback for toolbar button. Re-plots all objects.</p>
    1038. 

  1038. <table class="docutils field-list" frame="void" rules="none">
    1039. 

  1039. <col class="field-name" />
    1040. 

  1040. <col class="field-body" />
    1041. 

  1041. <tbody valign="top">
    1042. 

  1042. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; The widget from which this was called.</td>
    1043. 

  1043. </tr>
    1044. 

  1044. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1045. 

  1045. </tr>
    1046. 

  1046. </tbody>
    1047. 

  1047. </table>
    1048. 

  1048. </dd></dl>
    1049. 

  1049. 

  1050. <dl class="method">
    1051. 

  1051. <dt id="FlatCAM.App.on_row_activated">
    1052. 

  1052. <tt class="descname">on_row_activated</tt><big>(</big><em>widget</em>, <em>path</em>, <em>col</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_row_activated" title="Permalink to this definition">¶</a></dt>
    1053. 

  1053. <dd><p>Callback for selection activation (Enter or double-click) on the Project list.
    1054. 

  1054. Switches the notebook page to the object properties form. Calls
    1055. 

  1055. <tt class="docutils literal"><span class="pre">self.notebook.set_current_page(1)</span></tt>.</p>
    1056. 

  1056. <table class="docutils field-list" frame="void" rules="none">
    1057. 

  1057. <col class="field-name" />
    1058. 

  1058. <col class="field-body" />
    1059. 

  1059. <tbody valign="top">
    1060. 

  1060. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1061. 

  1061. <li><strong>widget</strong> &#8211; Ignored.</li>
    1062. 

  1062. <li><strong>path</strong> &#8211; Ignored.</li>
    1063. 

  1063. <li><strong>col</strong> &#8211; Ignored.</li>
    1064. 

  1064. </ul>
    1065. 

  1065. </td>
    1066. 

  1066. </tr>
    1067. 

  1067. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
    1068. 

  1068. </td>
    1069. 

  1069. </tr>
    1070. 

  1070. </tbody>
    1071. 

  1071. </table>
    1072. 

  1072. </dd></dl>
    1073. 

  1073. 

  1074. <dl class="method">
    1075. 

  1075. <dt id="FlatCAM.App.on_scale_object">
    1076. 

  1076. <tt class="descname">on_scale_object</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_scale_object" title="Permalink to this definition">¶</a></dt>
    1077. 

  1077. <dd><p>Callback for request to change an objects geometry scale. The object
    1078. 

  1078. is re-scaled and replotted.</p>
    1079. 

  1079. <table class="docutils field-list" frame="void" rules="none">
    1080. 

  1080. <col class="field-name" />
    1081. 

  1081. <col class="field-body" />
    1082. 

  1082. <tbody valign="top">
    1083. 

  1083. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; Ignored.</td>
    1084. 

  1084. </tr>
    1085. 

  1085. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1086. 

  1086. </tr>
    1087. 

  1087. </tbody>
    1088. 

  1088. </table>
    1089. 

  1089. </dd></dl>
    1090. 

  1090. 

  1091. <dl class="method">
    1092. 

  1092. <dt id="FlatCAM.App.on_toggle_pointbox">
    1093. 

  1093. <tt class="descname">on_toggle_pointbox</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_toggle_pointbox" title="Permalink to this definition">¶</a></dt>
    1094. 

  1094. <dd><p>Callback for radio selection change between point and box in the
    1095. 

  1095. Double-sided PCB tool. Updates the UI accordingly.</p>
    1096. 

  1096. <table class="docutils field-list" frame="void" rules="none">
    1097. 

  1097. <col class="field-name" />
    1098. 

  1098. <col class="field-body" />
    1099. 

  1099. <tbody valign="top">
    1100. 

  1100. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; Ignored.</td>
    1101. 

  1101. </tr>
    1102. 

  1102. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1103. 

  1103. </tr>
    1104. 

  1104. </tbody>
    1105. 

  1105. </table>
    1106. 

  1106. </dd></dl>
    1107. 

  1107. 

  1108. <dl class="method">
    1109. 

  1109. <dt id="FlatCAM.App.on_toggle_units">
    1110. 

  1110. <tt class="descname">on_toggle_units</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_toggle_units" title="Permalink to this definition">¶</a></dt>
    1111. 

  1111. <dd><p>Callback for the Units radio-button change in the Options tab.
    1112. 

  1112. Changes the application&#8217;s default units or the current project&#8217;s units.
    1113. 

  1113. If changing the project&#8217;s units, the change propagates to all of
    1114. 

  1114. the objects in the project.</p>
    1115. 

  1115. <table class="docutils field-list" frame="void" rules="none">
    1116. 

  1116. <col class="field-name" />
    1117. 

  1117. <col class="field-body" />
    1118. 

  1118. <tbody valign="top">
    1119. 

  1119. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; Ignored.</td>
    1120. 

  1120. </tr>
    1121. 

  1121. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1122. 

  1122. </tr>
    1123. 

  1123. </tbody>
    1124. 

  1124. </table>
    1125. 

  1125. </dd></dl>
    1126. 

  1126. 

  1127. <dl class="method">
    1128. 

  1128. <dt id="FlatCAM.App.on_tools_doublesided">
    1129. 

  1129. <tt class="descname">on_tools_doublesided</tt><big>(</big><em>param</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_tools_doublesided" title="Permalink to this definition">¶</a></dt>
    1130. 

  1130. <dd><p>Callback for menu item Tools-&gt;Double Sided PCB Tool. Launches the
    1131. 

  1131. tool placing its UI in the &#8220;Tool&#8221; tab in the notebook.</p>
    1132. 

  1132. <table class="docutils field-list" frame="void" rules="none">
    1133. 

  1133. <col class="field-name" />
    1134. 

  1134. <col class="field-body" />
    1135. 

  1135. <tbody valign="top">
    1136. 

  1136. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> &#8211; Ignored.</td>
    1137. 

  1137. </tr>
    1138. 

  1138. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1139. 

  1139. </tr>
    1140. 

  1140. </tbody>
    1141. 

  1141. </table>
    1142. 

  1142. </dd></dl>
    1143. 

  1143. 

  1144. <dl class="method">
    1145. 

  1145. <dt id="FlatCAM.App.on_tree_selection_changed">
    1146. 

  1146. <tt class="descname">on_tree_selection_changed</tt><big>(</big><em>selection</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_tree_selection_changed" title="Permalink to this definition">¶</a></dt>
    1147. 

  1147. <dd><p>Callback for selection change in the project list. This changes
    1148. 

  1148. the currently selected FlatCAMObj.</p>
    1149. 

  1149. <table class="docutils field-list" frame="void" rules="none">
    1150. 

  1150. <col class="field-name" />
    1151. 

  1151. <col class="field-body" />
    1152. 

  1152. <tbody valign="top">
    1153. 

  1153. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>selection</strong> (<em>Gtk.TreeSelection</em>) &#8211; Selection associated to the project tree or list</td>
    1154. 

  1154. </tr>
    1155. 

  1155. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1156. 

  1156. </tr>
    1157. 

  1157. </tbody>
    1158. 

  1158. </table>
    1159. 

  1159. </dd></dl>
    1160. 

  1160. 

  1161. <dl class="method">
    1162. 

  1162. <dt id="FlatCAM.App.on_update_plot">
    1163. 

  1163. <tt class="descname">on_update_plot</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_update_plot" title="Permalink to this definition">¶</a></dt>
    1164. 

  1164. <dd><p>Callback for button on form for all kinds of objects.
    1165. 

  1165. Re-plots the current object only.</p>
    1166. 

  1166. <table class="docutils field-list" frame="void" rules="none">
    1167. 

  1167. <col class="field-name" />
    1168. 

  1168. <col class="field-body" />
    1169. 

  1169. <tbody valign="top">
    1170. 

  1170. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> &#8211; The widget from which this was called.</td>
    1171. 

  1171. </tr>
    1172. 

  1172. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1173. 

  1173. </tr>
    1174. 

  1174. </tbody>
    1175. 

  1175. </table>
    1176. 

  1176. </dd></dl>
    1177. 

  1177. 

  1178. <dl class="method">
    1179. 

  1179. <dt id="FlatCAM.App.on_zoom_fit">
    1180. 

  1180. <tt class="descname">on_zoom_fit</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_zoom_fit" title="Permalink to this definition">¶</a></dt>
    1181. 

  1181. <dd><p>Callback for zoom-out request. This can be either from the corresponding
    1182. 

  1182. toolbar button or the &#8216;1&#8217; key when the canvas is focused. Calls <tt class="docutils literal"><span class="pre">self.adjust_axes()</span></tt>
    1183. 

  1183. with axes limits from the geometry bounds of all objects.</p>
    1184. 

  1184. <table class="docutils field-list" frame="void" rules="none">
    1185. 

  1185. <col class="field-name" />
    1186. 

  1186. <col class="field-body" />
    1187. 

  1187. <tbody valign="top">
    1188. 

  1188. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> &#8211; Ignored.</td>
    1189. 

  1189. </tr>
    1190. 

  1190. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1191. 

  1191. </tr>
    1192. 

  1192. </tbody>
    1193. 

  1193. </table>
    1194. 

  1194. </dd></dl>
    1195. 

  1195. 

  1196. <dl class="method">
    1197. 

  1197. <dt id="FlatCAM.App.on_zoom_in">
    1198. 

  1198. <tt class="descname">on_zoom_in</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_zoom_in" title="Permalink to this definition">¶</a></dt>
    1199. 

  1199. <dd><p>Callback for zoom-in request. This can be either from the corresponding
    1200. 

  1200. toolbar button or the &#8216;3&#8217; key when the canvas is focused. Calls <tt class="docutils literal"><span class="pre">self.zoom()</span></tt>.</p>
    1201. 

  1201. <table class="docutils field-list" frame="void" rules="none">
    1202. 

  1202. <col class="field-name" />
    1203. 

  1203. <col class="field-body" />
    1204. 

  1204. <tbody valign="top">
    1205. 

  1205. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> &#8211; Ignored.</td>
    1206. 

  1206. </tr>
    1207. 

  1207. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1208. 

  1208. </tr>
    1209. 

  1209. </tbody>
    1210. 

  1210. </table>
    1211. 

  1211. </dd></dl>
    1212. 

  1212. 

  1213. <dl class="method">
    1214. 

  1214. <dt id="FlatCAM.App.on_zoom_out">
    1215. 

  1215. <tt class="descname">on_zoom_out</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_zoom_out" title="Permalink to this definition">¶</a></dt>
    1216. 

  1216. <dd><p>Callback for zoom-out request. This can be either from the corresponding
    1217. 

  1217. toolbar button or the &#8216;2&#8217; key when the canvas is focused. Calls <tt class="docutils literal"><span class="pre">self.zoom()</span></tt>.</p>
    1218. 

  1218. <table class="docutils field-list" frame="void" rules="none">
    1219. 

  1219. <col class="field-name" />
    1220. 

  1220. <col class="field-body" />
    1221. 

  1221. <tbody valign="top">
    1222. 

  1222. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> &#8211; Ignored.</td>
    1223. 

  1223. </tr>
    1224. 

  1224. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1225. 

  1225. </tr>
    1226. 

  1226. </tbody>
    1227. 

  1227. </table>
    1228. 

  1228. </dd></dl>
    1229. 

  1229. 

  1230. <dl class="method">
    1231. 

  1231. <dt id="FlatCAM.App.open_project">
    1232. 

  1232. <tt class="descname">open_project</tt><big>(</big><em>filename</em><big>)</big><a class="headerlink" href="#FlatCAM.App.open_project" title="Permalink to this definition">¶</a></dt>
    1233. 

  1233. <dd><p>Loads a project from the specified file.</p>
    1234. 

  1234. <table class="docutils field-list" frame="void" rules="none">
    1235. 

  1235. <col class="field-name" />
    1236. 

  1236. <col class="field-body" />
    1237. 

  1237. <tbody valign="top">
    1238. 

  1238. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> (<em>str</em>) &#8211; Name of the file from which to load.</td>
    1239. 

  1239. </tr>
    1240. 

  1240. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1241. 

  1241. </tr>
    1242. 

  1242. </tbody>
    1243. 

  1243. </table>
    1244. 

  1244. </dd></dl>
    1245. 

  1245. 

  1246. <dl class="method">
    1247. 

  1247. <dt id="FlatCAM.App.options2form">
    1248. 

  1248. <tt class="descname">options2form</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.App.options2form" title="Permalink to this definition">¶</a></dt>
    1249. 

  1249. <dd><p>Sets the &#8216;Project Options&#8217; or &#8216;Application Defaults&#8217; form with values from
    1250. 

  1250. <tt class="docutils literal"><span class="pre">self.options</span></tt> or <tt class="docutils literal"><span class="pre">self.defaults</span></tt>.</p>
    1251. 

  1251. <table class="docutils field-list" frame="void" rules="none">
    1252. 

  1252. <col class="field-name" />
    1253. 

  1253. <col class="field-body" />
    1254. 

  1254. <tbody valign="top">
    1255. 

  1255. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1256. 

  1256. </tr>
    1257. 

  1257. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">None</td>
    1258. 

  1258. </tr>
    1259. 

  1259. </tbody>
    1260. 

  1260. </table>
    1261. 

  1261. </dd></dl>
    1262. 

  1262. 

  1263. <dl class="method">
    1264. 

  1264. <dt id="FlatCAM.App.plot_all">
    1265. 

  1265. <tt class="descname">plot_all</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.App.plot_all" title="Permalink to this definition">¶</a></dt>
    1266. 

  1266. <dd><p>Re-generates all plots from all objects.</p>
    1267. 

  1267. <table class="docutils field-list" frame="void" rules="none">
    1268. 

  1268. <col class="field-name" />
    1269. 

  1269. <col class="field-body" />
    1270. 

  1270. <tbody valign="top">
    1271. 

  1271. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1272. 

  1272. </tr>
    1273. 

  1273. </tbody>
    1274. 

  1274. </table>
    1275. 

  1275. </dd></dl>
    1276. 

  1276. 

  1277. <dl class="method">
    1278. 

  1278. <dt id="FlatCAM.App.populate_objects_combo">
    1279. 

  1279. <tt class="descname">populate_objects_combo</tt><big>(</big><em>combo</em><big>)</big><a class="headerlink" href="#FlatCAM.App.populate_objects_combo" title="Permalink to this definition">¶</a></dt>
    1280. 

  1280. <dd><p>Populates a Gtk.Comboboxtext with the list of the object in the project.</p>
    1281. 

  1281. <table class="docutils field-list" frame="void" rules="none">
    1282. 

  1282. <col class="field-name" />
    1283. 

  1283. <col class="field-body" />
    1284. 

  1284. <tbody valign="top">
    1285. 

  1285. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>combo</strong> (<em>str or Gtk.ComboBoxText</em>) &#8211; Name or instance of the comboboxtext.</td>
    1286. 

  1286. </tr>
    1287. 

  1287. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1288. 

  1288. </tr>
    1289. 

  1289. </tbody>
    1290. 

  1290. </table>
    1291. 

  1291. </dd></dl>
    1292. 

  1292. 

  1293. <dl class="method">
    1294. 

  1294. <dt id="FlatCAM.App.read_form">
    1295. 

  1295. <tt class="descname">read_form</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.App.read_form" title="Permalink to this definition">¶</a></dt>
    1296. 

  1296. <dd><p>Reads the options form into self.defaults/self.options.</p>
    1297. 

  1297. <table class="docutils field-list" frame="void" rules="none">
    1298. 

  1298. <col class="field-name" />
    1299. 

  1299. <col class="field-body" />
    1300. 

  1300. <tbody valign="top">
    1301. 

  1301. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1302. 

  1302. </tr>
    1303. 

  1303. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">None</td>
    1304. 

  1304. </tr>
    1305. 

  1305. </tbody>
    1306. 

  1306. </table>
    1307. 

  1307. </dd></dl>
    1308. 

  1308. 

  1309. <dl class="method">
    1310. 

  1310. <dt id="FlatCAM.App.read_form_item">
    1311. 

  1311. <tt class="descname">read_form_item</tt><big>(</big><em>name</em>, <em>dest</em><big>)</big><a class="headerlink" href="#FlatCAM.App.read_form_item" title="Permalink to this definition">¶</a></dt>
    1312. 

  1312. <dd><p>Reads the value of a form item in the defaults/options form and
    1313. 

  1313. saves it to the corresponding dictionary.</p>
    1314. 

  1314. <table class="docutils field-list" frame="void" rules="none">
    1315. 

  1315. <col class="field-name" />
    1316. 

  1316. <col class="field-body" />
    1317. 

  1317. <tbody valign="top">
    1318. 

  1318. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1319. 

  1319. <li><strong>name</strong> (<em>str</em>) &#8211; Name of the form item. A key in <tt class="docutils literal"><span class="pre">self.defaults</span></tt> or
    1320. 

  1320. <tt class="docutils literal"><span class="pre">self.options</span></tt>.</li>
    1321. 

  1321. <li><strong>dest</strong> (<em>dict</em>) &#8211; Dictionary to which to save the value.</li>
    1322. 

  1322. </ul>
    1323. 

  1323. </td>
    1324. 

  1324. </tr>
    1325. 

  1325. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
    1326. 

  1326. </td>
    1327. 

  1327. </tr>
    1328. 

  1328. </tbody>
    1329. 

  1329. </table>
    1330. 

  1330. </dd></dl>
    1331. 

  1331. 

  1332. <dl class="method">
    1333. 

  1333. <dt id="FlatCAM.App.save_project">
    1334. 

  1334. <tt class="descname">save_project</tt><big>(</big><em>filename</em><big>)</big><a class="headerlink" href="#FlatCAM.App.save_project" title="Permalink to this definition">¶</a></dt>
    1335. 

  1335. <dd><p>Saves the current project to the specified file.</p>
    1336. 

  1336. <table class="docutils field-list" frame="void" rules="none">
    1337. 

  1337. <col class="field-name" />
    1338. 

  1338. <col class="field-body" />
    1339. 

  1339. <tbody valign="top">
    1340. 

  1340. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> (<em>str</em>) &#8211; Name of the file in which to save.</td>
    1341. 

  1341. </tr>
    1342. 

  1342. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1343. 

  1343. </tr>
    1344. 

  1344. </tbody>
    1345. 

  1345. </table>
    1346. 

  1346. </dd></dl>
    1347. 

  1347. 

  1348. <dl class="method">
    1349. 

  1349. <dt id="FlatCAM.App.set_form_item">
    1350. 

  1350. <tt class="descname">set_form_item</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#FlatCAM.App.set_form_item" title="Permalink to this definition">¶</a></dt>
    1351. 

  1351. <dd><p>Sets a form item &#8216;name&#8217; in the GUI with the given &#8216;value&#8217;. The syntax of
    1352. 

  1352. form names in the GUI is &lt;kind&gt;_app_&lt;name&gt;, where kind is one of: rb (radio button),
    1353. 

  1353. cb (check button), entry_eval or entry_text (entry), combo (combo box). name is
    1354. 

  1354. whatever name it&#8217;s been given. For self.defaults, name is a key in the dictionary.</p>
    1355. 

  1355. <table class="docutils field-list" frame="void" rules="none">
    1356. 

  1356. <col class="field-name" />
    1357. 

  1357. <col class="field-body" />
    1358. 

  1358. <tbody valign="top">
    1359. 

  1359. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1360. 

  1360. <li><strong>name</strong> (<em>str</em>) &#8211; Name of the form field.</li>
    1361. 

  1361. <li><strong>value</strong> (<em>Depends on field kind.</em>) &#8211; The value to set the form field to.</li>
    1362. 

  1362. </ul>
    1363. 

  1363. </td>
    1364. 

  1364. </tr>
    1365. 

  1365. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
    1366. 

  1366. </td>
    1367. 

  1367. </tr>
    1368. 

  1368. </tbody>
    1369. 

  1369. </table>
    1370. 

  1370. </dd></dl>
    1371. 

  1371. 

  1372. <dl class="method">
    1373. 

  1373. <dt id="FlatCAM.App.set_list_selection">
    1374. 

  1374. <tt class="descname">set_list_selection</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#FlatCAM.App.set_list_selection" title="Permalink to this definition">¶</a></dt>
    1375. 

  1375. <dd><p>Marks a given object as selected in the list ob objects
    1376. 

  1376. in the GUI. This selection will in turn trigger
    1377. 

  1377. <tt class="docutils literal"><span class="pre">self.on_tree_selection_changed()</span></tt>.</p>
    1378. 

  1378. <table class="docutils field-list" frame="void" rules="none">
    1379. 

  1379. <col class="field-name" />
    1380. 

  1380. <col class="field-body" />
    1381. 

  1381. <tbody valign="top">
    1382. 

  1382. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<em>str</em>) &#8211; Name of the object.</td>
    1383. 

  1383. </tr>
    1384. 

  1384. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1385. 

  1385. </tr>
    1386. 

  1386. </tbody>
    1387. 

  1387. </table>
    1388. 

  1388. </dd></dl>
    1389. 

  1389. 

  1390. <dl class="method">
    1391. 

  1391. <dt id="FlatCAM.App.set_progress_bar">
    1392. 

  1392. <tt class="descname">set_progress_bar</tt><big>(</big><em>percentage</em>, <em>text=''</em><big>)</big><a class="headerlink" href="#FlatCAM.App.set_progress_bar" title="Permalink to this definition">¶</a></dt>
    1393. 

  1393. <dd><p>Sets the application&#8217;s progress bar to a given fraction and text.</p>
    1394. 

  1394. <table class="docutils field-list" frame="void" rules="none">
    1395. 

  1395. <col class="field-name" />
    1396. 

  1396. <col class="field-body" />
    1397. 

  1397. <tbody valign="top">
    1398. 

  1398. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1399. 

  1399. <li><strong>percentage</strong> (<em>float</em>) &#8211; The fraction (0.0-1.0) of the progress.</li>
    1400. 

  1400. <li><strong>text</strong> (<em>str</em>) &#8211; Text to display on the progress bar.</li>
    1401. 

  1401. </ul>
    1402. 

  1402. </td>
    1403. 

  1403. </tr>
    1404. 

  1404. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"></p>
    1405. 

  1405. </td>
    1406. 

  1406. </tr>
    1407. 

  1407. </tbody>
    1408. 

  1408. </table>
    1409. 

  1409. </dd></dl>
    1410. 

  1410. 

  1411. <dl class="method">
    1412. 

  1412. <dt id="FlatCAM.App.setup_component_editor">
    1413. 

  1413. <tt class="descname">setup_component_editor</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.App.setup_component_editor" title="Permalink to this definition">¶</a></dt>
    1414. 

  1414. <dd><p>Initial configuration of the component editor. Creates
    1415. 

  1415. a page titled &#8220;Selection&#8221; on the notebook on the left
    1416. 

  1416. side of the main window.</p>
    1417. 

  1417. <table class="docutils field-list" frame="void" rules="none">
    1418. 

  1418. <col class="field-name" />
    1419. 

  1419. <col class="field-body" />
    1420. 

  1420. <tbody valign="top">
    1421. 

  1421. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1422. 

  1422. </tr>
    1423. 

  1423. </tbody>
    1424. 

  1424. </table>
    1425. 

  1425. </dd></dl>
    1426. 

  1426. 

  1427. <dl class="method">
    1428. 

  1428. <dt id="FlatCAM.App.setup_obj_classes">
    1429. 

  1429. <tt class="descname">setup_obj_classes</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.App.setup_obj_classes" title="Permalink to this definition">¶</a></dt>
    1430. 

  1430. <dd><p>Sets up application specifics on the FlatCAMObj class.</p>
    1431. 

  1431. <table class="docutils field-list" frame="void" rules="none">
    1432. 

  1432. <col class="field-name" />
    1433. 

  1433. <col class="field-body" />
    1434. 

  1434. <tbody valign="top">
    1435. 

  1435. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1436. 

  1436. </tr>
    1437. 

  1437. </tbody>
    1438. 

  1438. </table>
    1439. 

  1439. </dd></dl>
    1440. 

  1440. 

  1441. <dl class="method">
    1442. 

  1442. <dt id="FlatCAM.App.setup_plot">
    1443. 

  1443. <tt class="descname">setup_plot</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.App.setup_plot" title="Permalink to this definition">¶</a></dt>
    1444. 

  1444. <dd><p>Sets up the main plotting area by creating a Matplotlib
    1445. 

  1445. figure in self.canvas, adding axes and configuring them.
    1446. 

  1446. These axes should not be ploted on and are just there to
    1447. 

  1447. display the axes ticks and grid.</p>
    1448. 

  1448. <table class="docutils field-list" frame="void" rules="none">
    1449. 

  1449. <col class="field-name" />
    1450. 

  1450. <col class="field-body" />
    1451. 

  1451. <tbody valign="top">
    1452. 

  1452. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1453. 

  1453. </tr>
    1454. 

  1454. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">None</td>
    1455. 

  1455. </tr>
    1456. 

  1456. </tbody>
    1457. 

  1457. </table>
    1458. 

  1458. </dd></dl>
    1459. 

  1459. 

  1460. <dl class="method">
    1461. 

  1461. <dt id="FlatCAM.App.setup_project_list">
    1462. 

  1462. <tt class="descname">setup_project_list</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.App.setup_project_list" title="Permalink to this definition">¶</a></dt>
    1463. 

  1463. <dd><p>Sets up list or Tree where whatever has been loaded or created is
    1464. 

  1464. displayed.</p>
    1465. 

  1465. <table class="docutils field-list" frame="void" rules="none">
    1466. 

  1466. <col class="field-name" />
    1467. 

  1467. <col class="field-body" />
    1468. 

  1468. <tbody valign="top">
    1469. 

  1469. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1470. 

  1470. </tr>
    1471. 

  1471. </tbody>
    1472. 

  1472. </table>
    1473. 

  1473. </dd></dl>
    1474. 

  1474. 

  1475. <dl class="method">
    1476. 

  1476. <dt id="FlatCAM.App.zoom">
    1477. 

  1477. <tt class="descname">zoom</tt><big>(</big><em>factor</em>, <em>center=None</em><big>)</big><a class="headerlink" href="#FlatCAM.App.zoom" title="Permalink to this definition">¶</a></dt>
    1478. 

  1478. <dd><p>Zooms the plot by factor around a given
    1479. 

  1479. center point. Takes care of re-drawing.</p>
    1480. 

  1480. <table class="docutils field-list" frame="void" rules="none">
    1481. 

  1481. <col class="field-name" />
    1482. 

  1482. <col class="field-body" />
    1483. 

  1483. <tbody valign="top">
    1484. 

  1484. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1485. 

  1485. <li><strong>factor</strong> (<em>float</em>) &#8211; Number by which to scale the plot.</li>
    1486. 

  1486. <li><strong>center</strong> (<em>list</em>) &#8211; Coordinates [x, y] of the point around which to scale the plot.</li>
    1487. 

  1487. </ul>
    1488. 

  1488. </td>
    1489. 

  1489. </tr>
    1490. 

  1490. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
    1491. 

  1491. </td>
    1492. 

  1492. </tr>
    1493. 

  1493. </tbody>
    1494. 

  1494. </table>
    1495. 

  1495. </dd></dl>
    1496. 

  1496. 

  1497. </dd></dl>
    1498. 

  1498. 

  1499. <dl class="class">
    1500. 

  1500. <dt id="FlatCAM.Geometry">
    1501. 

  1501. <em class="property">class </em><tt class="descclassname">FlatCAM.</tt><tt class="descname">Geometry</tt><a class="headerlink" href="#FlatCAM.Geometry" title="Permalink to this definition">¶</a></dt>
    1502. 

  1502. <dd><dl class="method">
    1503. 

  1503. <dt id="FlatCAM.Geometry.bounds">
    1504. 

  1504. <tt class="descname">bounds</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.Geometry.bounds" title="Permalink to this definition">¶</a></dt>
    1505. 

  1505. <dd><p>Returns coordinates of rectangular bounds
    1506. 

  1506. of geometry: (xmin, ymin, xmax, ymax).</p>
    1507. 

  1507. </dd></dl>
    1508. 

  1508. 

  1509. <dl class="method">
    1510. 

  1510. <dt id="FlatCAM.Geometry.clear_polygon">
    1511. 

  1511. <tt class="descname">clear_polygon</tt><big>(</big><em>polygon</em>, <em>tooldia</em>, <em>overlap=0.15</em><big>)</big><a class="headerlink" href="#FlatCAM.Geometry.clear_polygon" title="Permalink to this definition">¶</a></dt>
    1512. 

  1512. <dd><p>Creates geometry inside a polygon for a tool to cover
    1513. 

  1513. the whole area.</p>
    1514. 

  1514. </dd></dl>
    1515. 

  1515. 

  1516. <dl class="method">
    1517. 

  1517. <dt id="FlatCAM.Geometry.convert_units">
    1518. 

  1518. <tt class="descname">convert_units</tt><big>(</big><em>units</em><big>)</big><a class="headerlink" href="#FlatCAM.Geometry.convert_units" title="Permalink to this definition">¶</a></dt>
    1519. 

  1519. <dd><p>Converts the units of the object to <tt class="docutils literal"><span class="pre">units</span></tt> by scaling all
    1520. 

  1520. the geometry appropriately. This call <tt class="docutils literal"><span class="pre">scale()</span></tt>. Don&#8217;t call
    1521. 

  1521. it again in descendents.</p>
    1522. 

  1522. <table class="docutils field-list" frame="void" rules="none">
    1523. 

  1523. <col class="field-name" />
    1524. 

  1524. <col class="field-body" />
    1525. 

  1525. <tbody valign="top">
    1526. 

  1526. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>units</strong> (<em>str</em>) &#8211; &#8220;IN&#8221; or &#8220;MM&#8221;</td>
    1527. 

  1527. </tr>
    1528. 

  1528. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Scaling factor resulting from unit change.</td>
    1529. 

  1529. </tr>
    1530. 

  1530. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">float</td>
    1531. 

  1531. </tr>
    1532. 

  1532. </tbody>
    1533. 

  1533. </table>
    1534. 

  1534. </dd></dl>
    1535. 

  1535. 

  1536. <dl class="method">
    1537. 

  1537. <dt id="FlatCAM.Geometry.from_dict">
    1538. 

  1538. <tt class="descname">from_dict</tt><big>(</big><em>d</em><big>)</big><a class="headerlink" href="#FlatCAM.Geometry.from_dict" title="Permalink to this definition">¶</a></dt>
    1539. 

  1539. <dd><p>Sets object&#8217;s attributes from a dictionary.
    1540. 

  1540. Attributes to include are listed in <tt class="docutils literal"><span class="pre">self.ser_attrs</span></tt>.</p>
    1541. 

  1541. </dd></dl>
    1542. 

  1542. 

  1543. <dl class="method">
    1544. 

  1544. <dt id="FlatCAM.Geometry.get_empty_area">
    1545. 

  1545. <tt class="descname">get_empty_area</tt><big>(</big><em>boundary=None</em><big>)</big><a class="headerlink" href="#FlatCAM.Geometry.get_empty_area" title="Permalink to this definition">¶</a></dt>
    1546. 

  1546. <dd><p>Returns the complement of self.solid_geometry within
    1547. 

  1547. the given boundary polygon. If not specified, it defaults to
    1548. 

  1548. the rectangular bounding box of self.solid_geometry.</p>
    1549. 

  1549. </dd></dl>
    1550. 

  1550. 

  1551. <dl class="method">
    1552. 

  1552. <dt id="FlatCAM.Geometry.isolation_geometry">
    1553. 

  1553. <tt class="descname">isolation_geometry</tt><big>(</big><em>offset</em><big>)</big><a class="headerlink" href="#FlatCAM.Geometry.isolation_geometry" title="Permalink to this definition">¶</a></dt>
    1554. 

  1554. <dd><p>Creates contours around geometry at a given
    1555. 

  1555. offset distance.</p>
    1556. 

  1556. </dd></dl>
    1557. 

  1557. 

  1558. <dl class="method">
    1559. 

  1559. <dt id="FlatCAM.Geometry.scale">
    1560. 

  1560. <tt class="descname">scale</tt><big>(</big><em>factor</em><big>)</big><a class="headerlink" href="#FlatCAM.Geometry.scale" title="Permalink to this definition">¶</a></dt>
    1561. 

  1561. <dd><p>Scales all of the object&#8217;s geometry by a given factor. Override
    1562. 

  1562. this method.
    1563. 

  1563. :param factor: Number by which to scale.
    1564. 

  1564. :type factor: float
    1565. 

  1565. :return: None
    1566. 

  1566. :rtype: None</p>
    1567. 

  1567. </dd></dl>
    1568. 

  1568. 

  1569. <dl class="method">
    1570. 

  1570. <dt id="FlatCAM.Geometry.size">
    1571. 

  1571. <tt class="descname">size</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.Geometry.size" title="Permalink to this definition">¶</a></dt>
    1572. 

  1572. <dd><p>Returns (width, height) of rectangular
    1573. 

  1573. bounds of geometry.</p>
    1574. 

  1574. </dd></dl>
    1575. 

  1575. 

  1576. <dl class="method">
    1577. 

  1577. <dt id="FlatCAM.Geometry.to_dict">
    1578. 

  1578. <tt class="descname">to_dict</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.Geometry.to_dict" title="Permalink to this definition">¶</a></dt>
    1579. 

  1579. <dd><p>Returns a respresentation of the object as a dictionary.
    1580. 

  1580. Attributes to include are listed in <tt class="docutils literal"><span class="pre">self.ser_attrs</span></tt>.</p>
    1581. 

  1581. <table class="docutils field-list" frame="void" rules="none">
    1582. 

  1582. <col class="field-name" />
    1583. 

  1583. <col class="field-body" />
    1584. 

  1584. <tbody valign="top">
    1585. 

  1585. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A dictionary-encoded copy of the object.</td>
    1586. 

  1586. </tr>
    1587. 

  1587. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">dict</td>
    1588. 

  1588. </tr>
    1589. 

  1589. </tbody>
    1590. 

  1590. </table>
    1591. 

  1591. </dd></dl>
    1592. 

  1592. 

  1593. </dd></dl>
    1594. 

  1594. 

  1595. <dl class="class">
    1596. 

  1596. <dt id="FlatCAM.Gerber">
    1597. 

  1597. <em class="property">class </em><tt class="descclassname">FlatCAM.</tt><tt class="descname">Gerber</tt><big>(</big><em>Geometry</em><big>)</big><a class="headerlink" href="#FlatCAM.Gerber" title="Permalink to this definition">¶</a></dt>
    1598. 

  1598. <dd><p><strong>ATTRIBUTES</strong></p>
    1599. 

  1599. <ul class="simple">
    1600. 

  1600. <li><tt class="docutils literal"><span class="pre">apertures</span></tt> (dict): The keys are names/identifiers of each aperture.
    1601. 

  1601. The values are dictionaries key/value pairs which describe the aperture. The
    1602. 

  1602. type key is always present and the rest depend on the key:</li>
    1603. 

  1603. </ul>
    1604. 

  1604. <table border="1" class="docutils">
    1605. 

  1605. <colgroup>
    1606. 

  1606. <col width="24%" />
    1607. 

  1607. <col width="76%" />
    1608. 

  1608. </colgroup>
    1609. 

  1609. <thead valign="bottom">
    1610. 

  1610. <tr class="row-odd"><th class="head">Key</th>
    1611. 

  1611. <th class="head">Value</th>
    1612. 

  1612. </tr>
    1613. 

  1613. </thead>
    1614. 

  1614. <tbody valign="top">
    1615. 

  1615. <tr class="row-even"><td>type</td>
    1616. 

  1616. <td>(str) &#8220;C&#8221;, &#8220;R&#8221;, or &#8220;O&#8221;</td>
    1617. 

  1617. </tr>
    1618. 

  1618. <tr class="row-odd"><td>others</td>
    1619. 

  1619. <td>Depend on <tt class="docutils literal"><span class="pre">type</span></tt></td>
    1620. 

  1620. </tr>
    1621. 

  1621. </tbody>
    1622. 

  1622. </table>
    1623. 

  1623. <ul class="simple">
    1624. 

  1624. <li><tt class="docutils literal"><span class="pre">paths</span></tt> (list): A path is described by a line an aperture that follows that
    1625. 

  1625. line. Each paths[i] is a dictionary:</li>
    1626. 

  1626. </ul>
    1627. 

  1627. <table border="1" class="docutils">
    1628. 

  1628. <colgroup>
    1629. 

  1629. <col width="20%" />
    1630. 

  1630. <col width="80%" />
    1631. 

  1631. </colgroup>
    1632. 

  1632. <thead valign="bottom">
    1633. 

  1633. <tr class="row-odd"><th class="head">Key</th>
    1634. 

  1634. <th class="head">Value</th>
    1635. 

  1635. </tr>
    1636. 

  1636. </thead>
    1637. 

  1637. <tbody valign="top">
    1638. 

  1638. <tr class="row-even"><td>linestring</td>
    1639. 

  1639. <td>(Shapely.LineString) The actual path.</td>
    1640. 

  1640. </tr>
    1641. 

  1641. <tr class="row-odd"><td>aperture</td>
    1642. 

  1642. <td>(str) The key for an aperture in apertures.</td>
    1643. 

  1643. </tr>
    1644. 

  1644. </tbody>
    1645. 

  1645. </table>
    1646. 

  1646. <ul class="simple">
    1647. 

  1647. <li><tt class="docutils literal"><span class="pre">flashes</span></tt> (list): Flashes are single-point strokes of an aperture. Each
    1648. 

  1648. is a dictionary:</li>
    1649. 

  1649. </ul>
    1650. 

  1650. <table border="1" class="docutils">
    1651. 

  1651. <colgroup>
    1652. 

  1652. <col width="20%" />
    1653. 

  1653. <col width="80%" />
    1654. 

  1654. </colgroup>
    1655. 

  1655. <thead valign="bottom">
    1656. 

  1656. <tr class="row-odd"><th class="head">Key</th>
    1657. 

  1657. <th class="head">Value</th>
    1658. 

  1658. </tr>
    1659. 

  1659. </thead>
    1660. 

  1660. <tbody valign="top">
    1661. 

  1661. <tr class="row-even"><td>loc</td>
    1662. 

  1662. <td>(list) [x (float), y (float)] coordinates.</td>
    1663. 

  1663. </tr>
    1664. 

  1664. <tr class="row-odd"><td>aperture</td>
    1665. 

  1665. <td>(str) The key for an aperture in apertures.</td>
    1666. 

  1666. </tr>
    1667. 

  1667. </tbody>
    1668. 

  1668. </table>
    1669. 

  1669. <ul class="simple">
    1670. 

  1670. <li><tt class="docutils literal"><span class="pre">regions</span></tt> (list): Are surfaces defined by a polygon (Shapely.Polygon),
    1671. 

  1671. which have an exterior and zero or more interiors. An aperture is also
    1672. 

  1672. associated with a region. Each is a dictionary:</li>
    1673. 

  1673. </ul>
    1674. 

  1674. <table border="1" class="docutils">
    1675. 

  1675. <colgroup>
    1676. 

  1676. <col width="18%" />
    1677. 

  1677. <col width="82%" />
    1678. 

  1678. </colgroup>
    1679. 

  1679. <thead valign="bottom">
    1680. 

  1680. <tr class="row-odd"><th class="head">Key</th>
    1681. 

  1681. <th class="head">Value</th>
    1682. 

  1682. </tr>
    1683. 

  1683. </thead>
    1684. 

  1684. <tbody valign="top">
    1685. 

  1685. <tr class="row-even"><td>polygon</td>
    1686. 

  1686. <td>(Shapely.Polygon) The polygon defining the region.</td>
    1687. 

  1687. </tr>
    1688. 

  1688. <tr class="row-odd"><td>aperture</td>
    1689. 

  1689. <td>(str) The key for an aperture in apertures.</td>
    1690. 

  1690. </tr>
    1691. 

  1691. </tbody>
    1692. 

  1692. </table>
    1693. 

  1693. <ul class="simple">
    1694. 

  1694. <li><tt class="docutils literal"><span class="pre">flash_geometry</span></tt> (list): List of (Shapely) geometric object resulting
    1695. 

  1695. from <tt class="docutils literal"><span class="pre">flashes</span></tt>. These are generated from <tt class="docutils literal"><span class="pre">flashes</span></tt> in <tt class="docutils literal"><span class="pre">do_flashes()</span></tt>.</li>
    1696. 

  1696. <li><tt class="docutils literal"><span class="pre">buffered_paths</span></tt> (list): List of (Shapely) polygons resulting from
    1697. 

  1697. <em>buffering</em> (or thickening) the <tt class="docutils literal"><span class="pre">paths</span></tt> with the aperture. These are
    1698. 

  1698. generated from <tt class="docutils literal"><span class="pre">paths</span></tt> in <tt class="docutils literal"><span class="pre">buffer_paths()</span></tt>.</li>
    1699. 

  1699. </ul>
    1700. 

  1700. <p><strong>USAGE</strong>:</p>
    1701. 

  1701. <div class="highlight-python"><div class="highlight"><pre><span class="n">g</span> <span class="o">=</span> <span class="n">Gerber</span><span class="p">()</span>
    1702. 

  1702. <span class="n">g</span><span class="o">.</span><span class="n">parse_file</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
    1703. 

  1703. <span class="n">g</span><span class="o">.</span><span class="n">create_geometry</span><span class="p">()</span>
    1704. 

  1704. <span class="n">do_something</span><span class="p">(</span><span class="n">s</span><span class="o">.</span><span class="n">solid_geometry</span><span class="p">)</span>
    1705. 

  1705. </pre></div>
    1706. 

  1706. </div>
    1707. 

  1707. <dl class="method">
    1708. 

  1708. <dt id="FlatCAM.Gerber.aperture_parse">
    1709. 

  1709. <tt class="descname">aperture_parse</tt><big>(</big><em>gline</em><big>)</big><a class="headerlink" href="#FlatCAM.Gerber.aperture_parse" title="Permalink to this definition">¶</a></dt>
    1710. 

  1710. <dd><p>Parse gerber aperture definition into dictionary of apertures.
    1711. 

  1711. The following kinds and their attributes are supported:</p>
    1712. 

  1712. <ul class="simple">
    1713. 

  1713. <li><em>Circular (C)</em>: size (float)</li>
    1714. 

  1714. <li><em>Rectangle (R)</em>: width (float), height (float)</li>
    1715. 

  1715. <li><em>Obround (O)</em>: width (float), height (float).</li>
    1716. 

  1716. </ul>
    1717. 

  1717. <table class="docutils field-list" frame="void" rules="none">
    1718. 

  1718. <col class="field-name" />
    1719. 

  1719. <col class="field-body" />
    1720. 

  1720. <tbody valign="top">
    1721. 

  1721. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>gline</strong> (<em>str</em>) &#8211; Line of Gerber code known to have an aperture definition.</td>
    1722. 

  1722. </tr>
    1723. 

  1723. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Identifier of the aperture.</td>
    1724. 

  1724. </tr>
    1725. 

  1725. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
    1726. 

  1726. </tr>
    1727. 

  1727. </tbody>
    1728. 

  1728. </table>
    1729. 

  1729. </dd></dl>
    1730. 

  1730. 

  1731. <dl class="method">
    1732. 

  1732. <dt id="FlatCAM.Gerber.create_geometry">
    1733. 

  1733. <tt class="descname">create_geometry</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.Gerber.create_geometry" title="Permalink to this definition">¶</a></dt>
    1734. 

  1734. <dd><p>Geometry from a Gerber file is made up entirely of polygons.
    1735. 

  1735. Every stroke (linear or circular) has an aperture which gives
    1736. 

  1736. it thickness. Additionally, aperture strokes have non-zero area,
    1737. 

  1737. and regions naturally do as well.</p>
    1738. 

  1738. <p>:rtype : None
    1739. 

  1739. :return: None</p>
    1740. 

  1740. </dd></dl>
    1741. 

  1741. 

  1742. <dl class="attribute">
    1743. 

  1743. <dt id="FlatCAM.Gerber.digits">
    1744. 

  1744. <tt class="descname">digits</tt><em class="property"> = None</em><a class="headerlink" href="#FlatCAM.Gerber.digits" title="Permalink to this definition">¶</a></dt>
    1745. 

  1745. <dd><p>Number of integer digits in Gerber numbers. Used during parsing.</p>
    1746. 

  1746. </dd></dl>
    1747. 

  1747. 

  1748. <dl class="method">
    1749. 

  1749. <dt id="FlatCAM.Gerber.do_flashes">
    1750. 

  1750. <tt class="descname">do_flashes</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.Gerber.do_flashes" title="Permalink to this definition">¶</a></dt>
    1751. 

  1751. <dd><p>Creates geometry for Gerber flashes (aperture on a single point).</p>
    1752. 

  1752. </dd></dl>
    1753. 

  1753. 

  1754. <dl class="method">
    1755. 

  1755. <dt id="FlatCAM.Gerber.fix_regions">
    1756. 

  1756. <tt class="descname">fix_regions</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.Gerber.fix_regions" title="Permalink to this definition">¶</a></dt>
    1757. 

  1757. <dd><p>Overwrites the region polygons with fixed
    1758. 

  1758. versions if found to be invalid (according to Shapely).</p>
    1759. 

  1759. </dd></dl>
    1760. 

  1760. 

  1761. <dl class="attribute">
    1762. 

  1762. <dt id="FlatCAM.Gerber.fraction">
    1763. 

  1763. <tt class="descname">fraction</tt><em class="property"> = None</em><a class="headerlink" href="#FlatCAM.Gerber.fraction" title="Permalink to this definition">¶</a></dt>
    1764. 

  1764. <dd><p>Number of fraction digits in Gerber numbers. Used during parsing.</p>
    1765. 

  1765. </dd></dl>
    1766. 

  1766. 

  1767. <dl class="method">
    1768. 

  1768. <dt id="FlatCAM.Gerber.get_bounding_box">
    1769. 

  1769. <tt class="descname">get_bounding_box</tt><big>(</big><em>margin=0.0</em>, <em>rounded=False</em><big>)</big><a class="headerlink" href="#FlatCAM.Gerber.get_bounding_box" title="Permalink to this definition">¶</a></dt>
    1770. 

  1770. <dd><p>Creates and returns a rectangular polygon bounding at a distance of
    1771. 

  1771. margin from the object&#8217;s <tt class="docutils literal"><span class="pre">solid_geometry</span></tt>. If margin &gt; 0, the polygon
    1772. 

  1772. can optionally have rounded corners of radius equal to margin.</p>
    1773. 

  1773. <table class="docutils field-list" frame="void" rules="none">
    1774. 

  1774. <col class="field-name" />
    1775. 

  1775. <col class="field-body" />
    1776. 

  1776. <tbody valign="top">
    1777. 

  1777. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1778. 

  1778. <li><strong>margin</strong> (<em>float</em>) &#8211; Distance to enlarge the rectangular bounding
    1779. 

  1779. box in both positive and negative, x and y axes.</li>
    1780. 

  1780. <li><strong>rounded</strong> (<em>bool</em>) &#8211; Wether or not to have rounded corners.</li>
    1781. 

  1781. </ul>
    1782. 

  1782. </td>
    1783. 

  1783. </tr>
    1784. 

  1784. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The bounding box.</p>
    1785. 

  1785. </td>
    1786. 

  1786. </tr>
    1787. 

  1787. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Shapely.Polygon</p>
    1788. 

  1788. </td>
    1789. 

  1789. </tr>
    1790. 

  1790. </tbody>
    1791. 

  1791. </table>
    1792. 

  1792. </dd></dl>
    1793. 

  1793. 

  1794. <dl class="method">
    1795. 

  1795. <dt id="FlatCAM.Gerber.parse_file">
    1796. 

  1796. <tt class="descname">parse_file</tt><big>(</big><em>filename</em><big>)</big><a class="headerlink" href="#FlatCAM.Gerber.parse_file" title="Permalink to this definition">¶</a></dt>
    1797. 

  1797. <dd><p>Calls Gerber.parse_lines() with array of lines
    1798. 

  1798. read from the given file.</p>
    1799. 

  1799. </dd></dl>
    1800. 

  1800. 

  1801. <dl class="method">
    1802. 

  1802. <dt id="FlatCAM.Gerber.parse_lines">
    1803. 

  1803. <tt class="descname">parse_lines</tt><big>(</big><em>glines</em><big>)</big><a class="headerlink" href="#FlatCAM.Gerber.parse_lines" title="Permalink to this definition">¶</a></dt>
    1804. 

  1804. <dd><p>Main Gerber parser.</p>
    1805. 

  1805. </dd></dl>
    1806. 

  1806. 

  1807. <dl class="method">
    1808. 

  1808. <dt id="FlatCAM.Gerber.scale">
    1809. 

  1809. <tt class="descname">scale</tt><big>(</big><em>factor</em><big>)</big><a class="headerlink" href="#FlatCAM.Gerber.scale" title="Permalink to this definition">¶</a></dt>
    1810. 

  1810. <dd><p>Scales the objects&#8217; geometry on the XY plane by a given factor.
    1811. 

  1811. These are:</p>
    1812. 

  1812. <ul class="simple">
    1813. 

  1813. <li><tt class="docutils literal"><span class="pre">apertures</span></tt></li>
    1814. 

  1814. <li><tt class="docutils literal"><span class="pre">paths</span></tt></li>
    1815. 

  1815. <li><tt class="docutils literal"><span class="pre">regions</span></tt></li>
    1816. 

  1816. <li><tt class="docutils literal"><span class="pre">flashes</span></tt></li>
    1817. 

  1817. </ul>
    1818. 

  1818. <p>Then <tt class="docutils literal"><span class="pre">buffered_paths</span></tt>, <tt class="docutils literal"><span class="pre">flash_geometry</span></tt> and <tt class="docutils literal"><span class="pre">solid_geometry</span></tt>
    1819. 

  1819. are re-created with <tt class="docutils literal"><span class="pre">self.create_geometry()</span></tt>.
    1820. 

  1820. :param factor: Number by which to scale.
    1821. 

  1821. :type factor: float
    1822. 

  1822. :rtype : None</p>
    1823. 

  1823. </dd></dl>
    1824. 

  1824. 

  1825. </dd></dl>
    1826. 

  1826. 

  1827. <dl class="class">
    1828. 

  1828. <dt id="FlatCAM.Excellon">
    1829. 

  1829. <em class="property">class </em><tt class="descclassname">FlatCAM.</tt><tt class="descname">Excellon</tt><a class="headerlink" href="#FlatCAM.Excellon" title="Permalink to this definition">¶</a></dt>
    1830. 

  1830. <dd><p><em>ATTRIBUTES</em></p>
    1831. 

  1831. <ul class="simple">
    1832. 

  1832. <li><tt class="docutils literal"><span class="pre">tools</span></tt> (dict): The key is the tool name and the value is
    1833. 

  1833. the size (diameter).</li>
    1834. 

  1834. <li><tt class="docutils literal"><span class="pre">drills</span></tt> (list): Each is a dictionary:</li>
    1835. 

  1835. </ul>
    1836. 

  1836. <table border="1" class="docutils">
    1837. 

  1837. <colgroup>
    1838. 

  1838. <col width="31%" />
    1839. 

  1839. <col width="69%" />
    1840. 

  1840. </colgroup>
    1841. 

  1841. <thead valign="bottom">
    1842. 

  1842. <tr class="row-odd"><th class="head">Key</th>
    1843. 

  1843. <th class="head">Value</th>
    1844. 

  1844. </tr>
    1845. 

  1845. </thead>
    1846. 

  1846. <tbody valign="top">
    1847. 

  1847. <tr class="row-even"><td>point</td>
    1848. 

  1848. <td>(Shapely.Point) Where to drill</td>
    1849. 

  1849. </tr>
    1850. 

  1850. <tr class="row-odd"><td>tool</td>
    1851. 

  1851. <td>(str) A key in <tt class="docutils literal"><span class="pre">tools</span></tt></td>
    1852. 

  1852. </tr>
    1853. 

  1853. </tbody>
    1854. 

  1854. </table>
    1855. 

  1855. <dl class="method">
    1856. 

  1856. <dt id="FlatCAM.Excellon.parse_lines">
    1857. 

  1857. <tt class="descname">parse_lines</tt><big>(</big><em>elines</em><big>)</big><a class="headerlink" href="#FlatCAM.Excellon.parse_lines" title="Permalink to this definition">¶</a></dt>
    1858. 

  1858. <dd><p>Main Excellon parser.</p>
    1859. 

  1859. </dd></dl>
    1860. 

  1860. 

  1861. <dl class="method">
    1862. 

  1862. <dt id="FlatCAM.Excellon.scale">
    1863. 

  1863. <tt class="descname">scale</tt><big>(</big><em>factor</em><big>)</big><a class="headerlink" href="#FlatCAM.Excellon.scale" title="Permalink to this definition">¶</a></dt>
    1864. 

  1864. <dd><p>Scales geometry on the XY plane in the object by a given factor.
    1865. 

  1865. Tool sizes, feedrates an Z-plane dimensions are untouched.</p>
    1866. 

  1866. <table class="docutils field-list" frame="void" rules="none">
    1867. 

  1867. <col class="field-name" />
    1868. 

  1868. <col class="field-body" />
    1869. 

  1869. <tbody valign="top">
    1870. 

  1870. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>factor</strong> (<em>float</em>) &#8211; Number by which to scale the object.</td>
    1871. 

  1871. </tr>
    1872. 

  1872. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1873. 

  1873. </tr>
    1874. 

  1874. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">NOne</td>
    1875. 

  1875. </tr>
    1876. 

  1876. </tbody>
    1877. 

  1877. </table>
    1878. 

  1878. </dd></dl>
    1879. 

  1879. 

  1880. </dd></dl>
    1881. 

  1881. 

  1882. <dl class="class">
    1883. 

  1883. <dt id="FlatCAM.CNCjob">
    1884. 

  1884. <em class="property">class </em><tt class="descclassname">FlatCAM.</tt><tt class="descname">CNCjob</tt><big>(</big><em>units='in'</em>, <em>kind='generic'</em>, <em>z_move=0.1</em>, <em>feedrate=3.0</em>, <em>z_cut=-0.002</em>, <em>tooldia=0.0</em><big>)</big><a class="headerlink" href="#FlatCAM.CNCjob" title="Permalink to this definition">¶</a></dt>
    1885. 

  1885. <dd><p>Represents work to be done by a CNC machine.</p>
    1886. 

  1886. <p><em>ATTRIBUTES</em></p>
    1887. 

  1887. <ul class="simple">
    1888. 

  1888. <li><tt class="docutils literal"><span class="pre">gcode_parsed</span></tt> (list): Each is a dictionary:</li>
    1889. 

  1889. </ul>
    1890. 

  1890. <table border="1" class="docutils">
    1891. 

  1891. <colgroup>
    1892. 

  1892. <col width="34%" />
    1893. 

  1893. <col width="66%" />
    1894. 

  1894. </colgroup>
    1895. 

  1895. <thead valign="bottom">
    1896. 

  1896. <tr class="row-odd"><th class="head">Key</th>
    1897. 

  1897. <th class="head">Value</th>
    1898. 

  1898. </tr>
    1899. 

  1899. </thead>
    1900. 

  1900. <tbody valign="top">
    1901. 

  1901. <tr class="row-even"><td>geom</td>
    1902. 

  1902. <td>(Shapely.LineString) Tool path (XY plane)</td>
    1903. 

  1903. </tr>
    1904. 

  1904. <tr class="row-odd"><td>kind</td>
    1905. 

  1905. <td>(string) &#8220;AB&#8221;, A is &#8220;T&#8221; (travel) or
    1906. 

  1906. &#8220;C&#8221; (cut). B is &#8220;F&#8221; (fast) or &#8220;S&#8221; (slow).</td>
    1907. 

  1907. </tr>
    1908. 

  1908. </tbody>
    1909. 

  1909. </table>
    1910. 

  1910. <dl class="method">
    1911. 

  1911. <dt id="FlatCAM.CNCjob.gcode_parse">
    1912. 

  1912. <tt class="descname">gcode_parse</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.CNCjob.gcode_parse" title="Permalink to this definition">¶</a></dt>
    1913. 

  1913. <dd><p>G-Code parser (from self.gcode). Generates dictionary with
    1914. 

  1914. single-segment LineString&#8217;s and &#8220;kind&#8221; indicating cut or travel,
    1915. 

  1915. fast or feedrate speed.</p>
    1916. 

  1916. </dd></dl>
    1917. 

  1917. 

  1918. <dl class="method">
    1919. 

  1919. <dt id="FlatCAM.CNCjob.generate_from_excellon">
    1920. 

  1920. <tt class="descname">generate_from_excellon</tt><big>(</big><em>exobj</em><big>)</big><a class="headerlink" href="#FlatCAM.CNCjob.generate_from_excellon" title="Permalink to this definition">¶</a></dt>
    1921. 

  1921. <dd><p>Generates G-code for drilling from Excellon object.
    1922. 

  1922. self.gcode becomes a list, each element is a
    1923. 

  1923. different job for each tool in the excellon code.</p>
    1924. 

  1924. </dd></dl>
    1925. 

  1925. 

  1926. <dl class="method">
    1927. 

  1927. <dt id="FlatCAM.CNCjob.generate_from_excellon_by_tool">
    1928. 

  1928. <tt class="descname">generate_from_excellon_by_tool</tt><big>(</big><em>exobj</em>, <em>tools='all'</em><big>)</big><a class="headerlink" href="#FlatCAM.CNCjob.generate_from_excellon_by_tool" title="Permalink to this definition">¶</a></dt>
    1929. 

  1929. <dd><p>Creates gcode for this object from an Excellon object
    1930. 

  1930. for the specified tools.
    1931. 

  1931. &#64;param exobj: Excellon object to process
    1932. 

  1932. &#64;type exobj: Excellon
    1933. 

  1933. &#64;param tools: Comma separated tool names
    1934. 

  1934. &#64;type: tools: str
    1935. 

  1935. &#64;return: None</p>
    1936. 

  1936. </dd></dl>
    1937. 

  1937. 

  1938. <dl class="method">
    1939. 

  1939. <dt id="FlatCAM.CNCjob.generate_from_geometry">
    1940. 

  1940. <tt class="descname">generate_from_geometry</tt><big>(</big><em>geometry</em>, <em>append=True</em>, <em>tooldia=None</em><big>)</big><a class="headerlink" href="#FlatCAM.CNCjob.generate_from_geometry" title="Permalink to this definition">¶</a></dt>
    1941. 

  1941. <dd><p>Generates G-Code from a Geometry object.</p>
    1942. 

  1942. </dd></dl>
    1943. 

  1943. 

  1944. <dl class="method">
    1945. 

  1945. <dt id="FlatCAM.CNCjob.plot2">
    1946. 

  1946. <tt class="descname">plot2</tt><big>(</big><em>axes, tooldia=None, dpi=75, margin=0.1, color={'C': ['#5E6CFF', '#4650BD'], 'T': ['#F0E24D', '#B5AB3A']}, alpha={'C': 1.0, 'T': 0.3}</em><big>)</big><a class="headerlink" href="#FlatCAM.CNCjob.plot2" title="Permalink to this definition">¶</a></dt>
    1947. 

  1947. <dd><p>Plots the G-code job onto the given axes.</p>
    1948. 

  1948. </dd></dl>
    1949. 

  1949. 

  1950. <dl class="method">
    1951. 

  1951. <dt id="FlatCAM.CNCjob.polygon2gcode">
    1952. 

  1952. <tt class="descname">polygon2gcode</tt><big>(</big><em>polygon</em><big>)</big><a class="headerlink" href="#FlatCAM.CNCjob.polygon2gcode" title="Permalink to this definition">¶</a></dt>
    1953. 

  1953. <dd><p>Creates G-Code for the exterior and all interior paths
    1954. 

  1954. of a polygon.</p>
    1955. 

  1955. <table class="docutils field-list" frame="void" rules="none">
    1956. 

  1956. <col class="field-name" />
    1957. 

  1957. <col class="field-body" />
    1958. 

  1958. <tbody valign="top">
    1959. 

  1959. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>polygon</strong> (<em>Shapely.Polygon</em>) &#8211; A Shapely.Polygon</td>
    1960. 

  1960. </tr>
    1961. 

  1961. </tbody>
    1962. 

  1962. </table>
    1963. 

  1963. </dd></dl>
    1964. 

  1964. 

  1965. <dl class="method">
    1966. 

  1966. <dt id="FlatCAM.CNCjob.pre_parse">
    1967. 

  1967. <tt class="descname">pre_parse</tt><big>(</big><em>gtext</em><big>)</big><a class="headerlink" href="#FlatCAM.CNCjob.pre_parse" title="Permalink to this definition">¶</a></dt>
    1968. 

  1968. <dd><p>gtext is a single string with g-code</p>
    1969. 

  1969. </dd></dl>
    1970. 

  1970. 

  1971. <dl class="method">
    1972. 

  1972. <dt id="FlatCAM.CNCjob.scale">
    1973. 

  1973. <tt class="descname">scale</tt><big>(</big><em>factor</em><big>)</big><a class="headerlink" href="#FlatCAM.CNCjob.scale" title="Permalink to this definition">¶</a></dt>
    1974. 

  1974. <dd><p>Scales all the geometry on the XY plane in the object by the
    1975. 

  1975. given factor. Tool sizes, feedrates, or Z-axis dimensions are
    1976. 

  1976. not altered.</p>
    1977. 

  1977. <table class="docutils field-list" frame="void" rules="none">
    1978. 

  1978. <col class="field-name" />
    1979. 

  1979. <col class="field-body" />
    1980. 

  1980. <tbody valign="top">
    1981. 

  1981. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>factor</strong> (<em>float</em>) &#8211; Number by which to scale the object.</td>
    1982. 

  1982. </tr>
    1983. 

  1983. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    1984. 

  1984. </tr>
    1985. 

  1985. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">None</td>
    1986. 

  1986. </tr>
    1987. 

  1987. </tbody>
    1988. 

  1988. </table>
    1989. 

  1989. </dd></dl>
    1990. 

  1990. 

  1991. </dd></dl>
    1992. 

  1992. 

  1993. <dl class="class">
    1994. 

  1994. <dt id="FlatCAM.FlatCAMObj">
    1995. 

  1995. <em class="property">class </em><tt class="descclassname">FlatCAM.</tt><tt class="descname">FlatCAMObj</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#FlatCAM.FlatCAMObj" title="Permalink to this definition">¶</a></dt>
    1996. 

  1996. <dd><p>Base type of objects handled in FlatCAM. These become interactive
    1997. 

  1997. in the GUI, can be plotted, and their options can be modified
    1998. 

  1998. by the user in their respective forms.</p>
    1999. 

  1999. <dl class="method">
    2000. 

  2000. <dt id="FlatCAM.FlatCAMObj.build_ui">
    2001. 

  2001. <tt class="descname">build_ui</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.FlatCAMObj.build_ui" title="Permalink to this definition">¶</a></dt>
    2002. 

  2002. <dd><p>Sets up the UI/form for this object.</p>
    2003. 

  2003. <table class="docutils field-list" frame="void" rules="none">
    2004. 

  2004. <col class="field-name" />
    2005. 

  2005. <col class="field-body" />
    2006. 

  2006. <tbody valign="top">
    2007. 

  2007. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    2008. 

  2008. </tr>
    2009. 

  2009. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">None</td>
    2010. 

  2010. </tr>
    2011. 

  2011. </tbody>
    2012. 

  2012. </table>
    2013. 

  2013. </dd></dl>
    2014. 

  2014. 

  2015. <dl class="method">
    2016. 

  2016. <dt id="FlatCAM.FlatCAMObj.deserialize">
    2017. 

  2017. <tt class="descname">deserialize</tt><big>(</big><em>obj_dict</em><big>)</big><a class="headerlink" href="#FlatCAM.FlatCAMObj.deserialize" title="Permalink to this definition">¶</a></dt>
    2018. 

  2018. <dd><p>Re-builds an object from its serialized version.
    2019. 

  2019. &#64;param obj_dict: Dictionary representing a FlatCAMObj
    2020. 

  2020. &#64;type obj_dict: dict
    2021. 

  2021. &#64;return None</p>
    2022. 

  2022. </dd></dl>
    2023. 

  2023. 

  2024. <dl class="method">
    2025. 

  2025. <dt id="FlatCAM.FlatCAMObj.plot">
    2026. 

  2026. <tt class="descname">plot</tt><big>(</big><em>figure</em><big>)</big><a class="headerlink" href="#FlatCAM.FlatCAMObj.plot" title="Permalink to this definition">¶</a></dt>
    2027. 

  2027. <dd><p>Extend this method! Sets up axes if needed and
    2028. 

  2028. clears them. Descendants must do the actual plotting.</p>
    2029. 

  2029. </dd></dl>
    2030. 

  2030. 

  2031. <dl class="method">
    2032. 

  2032. <dt id="FlatCAM.FlatCAMObj.read_form">
    2033. 

  2033. <tt class="descname">read_form</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.FlatCAMObj.read_form" title="Permalink to this definition">¶</a></dt>
    2034. 

  2034. <dd><p>Reads form into <tt class="docutils literal"><span class="pre">self.options</span></tt>.</p>
    2035. 

  2035. <table class="docutils field-list" frame="void" rules="none">
    2036. 

  2036. <col class="field-name" />
    2037. 

  2037. <col class="field-body" />
    2038. 

  2038. <tbody valign="top">
    2039. 

  2039. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    2040. 

  2040. </tr>
    2041. 

  2041. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">None</td>
    2042. 

  2042. </tr>
    2043. 

  2043. </tbody>
    2044. 

  2044. </table>
    2045. 

  2045. </dd></dl>
    2046. 

  2046. 

  2047. <dl class="method">
    2048. 

  2048. <dt id="FlatCAM.FlatCAMObj.serialize">
    2049. 

  2049. <tt class="descname">serialize</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.FlatCAMObj.serialize" title="Permalink to this definition">¶</a></dt>
    2050. 

  2050. <dd><p>Returns a representation of the object as a dictionary so
    2051. 

  2051. it can be later exported as JSON. Override this method.
    2052. 

  2052. &#64;return: Dictionary representing the object
    2053. 

  2053. &#64;rtype: dict</p>
    2054. 

  2054. </dd></dl>
    2055. 

  2055. 

  2056. <dl class="method">
    2057. 

  2057. <dt id="FlatCAM.FlatCAMObj.set_form_item">
    2058. 

  2058. <tt class="descname">set_form_item</tt><big>(</big><em>option</em><big>)</big><a class="headerlink" href="#FlatCAM.FlatCAMObj.set_form_item" title="Permalink to this definition">¶</a></dt>
    2059. 

  2059. <dd><p>Copies the specified options to the UI form.</p>
    2060. 

  2060. <table class="docutils field-list" frame="void" rules="none">
    2061. 

  2061. <col class="field-name" />
    2062. 

  2062. <col class="field-body" />
    2063. 

  2063. <tbody valign="top">
    2064. 

  2064. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>option</strong> (<em>str</em>) &#8211; Name of the option (Key in <tt class="docutils literal"><span class="pre">self.options</span></tt>).</td>
    2065. 

  2065. </tr>
    2066. 

  2066. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    2067. 

  2067. </tr>
    2068. 

  2068. </tbody>
    2069. 

  2069. </table>
    2070. 

  2070. </dd></dl>
    2071. 

  2071. 

  2072. <dl class="method">
    2073. 

  2073. <dt id="FlatCAM.FlatCAMObj.setup_axes">
    2074. 

  2074. <tt class="descname">setup_axes</tt><big>(</big><em>figure</em><big>)</big><a class="headerlink" href="#FlatCAM.FlatCAMObj.setup_axes" title="Permalink to this definition">¶</a></dt>
    2075. 

  2075. <dd><p>1) Creates axes if they don&#8217;t exist. 2) Clears axes. 3) Attaches
    2076. 

  2076. them to figure if not part of the figure. 4) Sets transparent
    2077. 

  2077. background. 5) Sets 1:1 scale aspect ratio.</p>
    2078. 

  2078. <table class="docutils field-list" frame="void" rules="none">
    2079. 

  2079. <col class="field-name" />
    2080. 

  2080. <col class="field-body" />
    2081. 

  2081. <tbody valign="top">
    2082. 

  2082. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>figure</strong> (<em>matplotlib.figure.Figure</em>) &#8211; A Matplotlib.Figure on which to add/configure axes.</td>
    2083. 

  2083. </tr>
    2084. 

  2084. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    2085. 

  2085. </tr>
    2086. 

  2086. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">None</td>
    2087. 

  2087. </tr>
    2088. 

  2088. </tbody>
    2089. 

  2089. </table>
    2090. 

  2090. </dd></dl>
    2091. 

  2091. 

  2092. <dl class="method">
    2093. 

  2093. <dt id="FlatCAM.FlatCAMObj.to_form">
    2094. 

  2094. <tt class="descname">to_form</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.FlatCAMObj.to_form" title="Permalink to this definition">¶</a></dt>
    2095. 

  2095. <dd><p>Copies options to the UI form.</p>
    2096. 

  2096. <table class="docutils field-list" frame="void" rules="none">
    2097. 

  2097. <col class="field-name" />
    2098. 

  2098. <col class="field-body" />
    2099. 

  2099. <tbody valign="top">
    2100. 

  2100. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    2101. 

  2101. </tr>
    2102. 

  2102. </tbody>
    2103. 

  2103. </table>
    2104. 

  2104. </dd></dl>
    2105. 

  2105. 

  2106. </dd></dl>
    2107. 

  2107. 

  2108. <dl class="class">
    2109. 

  2109. <dt id="FlatCAM.FlatCAMGerber">
    2110. 

  2110. <em class="property">class </em><tt class="descclassname">FlatCAM.</tt><tt class="descname">FlatCAMGerber</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#FlatCAM.FlatCAMGerber" title="Permalink to this definition">¶</a></dt>
    2111. 

  2111. <dd><p>Represents Gerber code.</p>
    2112. 

  2112. <dl class="method">
    2113. 

  2113. <dt id="FlatCAM.FlatCAMGerber.convert_units">
    2114. 

  2114. <tt class="descname">convert_units</tt><big>(</big><em>units</em><big>)</big><a class="headerlink" href="#FlatCAM.FlatCAMGerber.convert_units" title="Permalink to this definition">¶</a></dt>
    2115. 

  2115. <dd><p>Converts the units of the object by scaling dimensions in all geometry
    2116. 

  2116. and options.</p>
    2117. 

  2117. <table class="docutils field-list" frame="void" rules="none">
    2118. 

  2118. <col class="field-name" />
    2119. 

  2119. <col class="field-body" />
    2120. 

  2120. <tbody valign="top">
    2121. 

  2121. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>units</strong> (<em>str</em>) &#8211; Units to which to convert the object: &#8220;IN&#8221; or &#8220;MM&#8221;.</td>
    2122. 

  2122. </tr>
    2123. 

  2123. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
    2124. 

  2124. </tr>
    2125. 

  2125. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">None</td>
    2126. 

  2126. </tr>
    2127. 

  2127. </tbody>
    2128. 

  2128. </table>
    2129. 

  2129. </dd></dl>
    2130. 

  2130. 

  2131. </dd></dl>
    2132. 

  2132. 

  2133. <dl class="class">
    2134. 

  2134. <dt id="FlatCAM.FlatCAMExcellon">
    2135. 

  2135. <em class="property">class </em><tt class="descclassname">FlatCAM.</tt><tt class="descname">FlatCAMExcellon</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#FlatCAM.FlatCAMExcellon" title="Permalink to this definition">¶</a></dt>
    2136. 

  2136. <dd><p>Represents Excellon code.</p>
    2137. 

  2137. </dd></dl>
    2138. 

  2138. 

  2139. <dl class="class">
    2140. 

  2140. <dt id="FlatCAM.FlatCAMCNCjob">
    2141. 

  2141. <em class="property">class </em><tt class="descclassname">FlatCAM.</tt><tt class="descname">FlatCAMCNCjob</tt><big>(</big><em>name</em>, <em>units='in'</em>, <em>kind='generic'</em>, <em>z_move=0.1</em>, <em>feedrate=3.0</em>, <em>z_cut=-0.002</em>, <em>tooldia=0.0</em><big>)</big><a class="headerlink" href="#FlatCAM.FlatCAMCNCjob" title="Permalink to this definition">¶</a></dt>
    2142. 

  2142. <dd><p>Represents G-Code.</p>
    2143. 

  2143. </dd></dl>
    2144. 

  2144. 

  2145. <dl class="class">
    2146. 

  2146. <dt id="FlatCAM.FlatCAMGeometry">
    2147. 

  2147. <em class="property">class </em><tt class="descclassname">FlatCAM.</tt><tt class="descname">FlatCAMGeometry</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#FlatCAM.FlatCAMGeometry" title="Permalink to this definition">¶</a></dt>
    2148. 

  2148. <dd><p>Geometric object not associated with a specific
    2149. 

  2149. format.</p>
    2150. 

  2150. </dd></dl>
    2151. 

  2151. 

  2152. </div>
    2153. 

  2153. <div class="section" id="indices-and-tables">
    2154. 

  2154. <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
    2155. 

  2155. <ul class="simple">
    2156. 

  2156. <li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
    2157. 

  2157. <li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
    2158. 

  2158. <li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
    2159. 

  2159. </ul>
    2160. 

  2160. </div>
    2161. 

  2161. 

  2162. 

  2163.           </div>
    2164. 

  2164.           <footer>
    2165. 

  2165.   
    2166. 

  2166. 

  2167.   <hr/>
    2168. 

  2168. 

  2169.   <div role="contentinfo">
    2170. 

  2170.     <p>
    2171. 

  2171.         &copy; Copyright 2014, Juan Pablo Caram.
    2172. 

  2172.     </p>
    2173. 

  2173.   </div>
    2174. 

  2174. 

  2175.   <a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>
    2176. 

  2176. </footer>
    2177. 

  2177.         </div>
    2178. 

  2178.       </div>
    2179. 

  2179. 

  2180.     </section>
    2181. 

  2181. 

  2182.   </div>
    2183. 

  2183.   
    2184. 

  2184. 

  2185. </body>
    2186. 

  2186. </html>
    2187.