2202 lines
99 KiB
HTML
2202 lines
99 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<title>Welcome to FlatCAM’s documentation! — Cirkuix 0.5 documentation</title>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
var DOCUMENTATION_OPTIONS = {
|
||
URL_ROOT:'./',
|
||
VERSION:'0.5',
|
||
COLLAPSE_INDEX:false,
|
||
FILE_SUFFIX:'.html',
|
||
HAS_SOURCE: true
|
||
};
|
||
</script>
|
||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.StickyNav.enable();
|
||
});
|
||
</script>
|
||
|
||
|
||
|
||
<link rel="top" title="Cirkuix 0.5 documentation" href="#"/>
|
||
|
||
<script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
|
||
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav" role="document">
|
||
|
||
<div class="wy-grid-for-nav">
|
||
|
||
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-nav-search">
|
||
<a href="#" class="icon icon-home"> Cirkuix</a>
|
||
<div role="search">
|
||
<form id ="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
||
|
||
<ul class="simple">
|
||
</ul>
|
||
|
||
|
||
</div>
|
||
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
||
|
||
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
||
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
|
||
<a href="#">Cirkuix</a>
|
||
</nav>
|
||
|
||
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="#">Docs</a> »</li>
|
||
|
||
<li>Welcome to FlatCAM’s documentation!</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
<a href="_sources/index.txt" rel="nofollow"> View page source</a>
|
||
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main">
|
||
|
||
<div class="section" id="welcome-to-flatcam-s-documentation">
|
||
<h1>Welcome to FlatCAM’s documentation!<a class="headerlink" href="#welcome-to-flatcam-s-documentation" title="Permalink to this headline">¶</a></h1>
|
||
<p>Contents:</p>
|
||
<div class="toctree-wrapper compound">
|
||
<ul class="simple">
|
||
</ul>
|
||
</div>
|
||
<span class="target" id="module-FlatCAM"></span><dl class="class">
|
||
<dt id="FlatCAM.App">
|
||
<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>
|
||
<dd><p>The main application class. The constructor starts the GUI.</p>
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.adjust_axes">
|
||
<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>
|
||
<dd><p>Adjusts axes of all plots while maintaining the use of the whole canvas
|
||
and an aspect ratio to 1:1 between x and y axes. The parameters are an original
|
||
request that will be modified to fit these restrictions.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>xmin</strong> (<em>float</em>) – Requested minimum value for the X axis.</li>
|
||
<li><strong>ymin</strong> (<em>float</em>) – Requested minimum value for the Y axis.</li>
|
||
<li><strong>xmax</strong> (<em>float</em>) – Requested maximum value for the X axis.</li>
|
||
<li><strong>ymax</strong> (<em>float</em>) – Requested maximum value for the Y axis.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.build_list">
|
||
<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>
|
||
<dd><p>Clears and re-populates the list of objects in currently
|
||
in the project.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.clear_plots">
|
||
<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>
|
||
<dd><p>Clears self.axes and self.figure.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.file_chooser_action">
|
||
<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>
|
||
<dd><p>Opens the file chooser and runs on_success on a separate thread
|
||
upon completion of valid file choice.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>on_success</strong> (<em>func</em>) – A function to run upon completion of a valid file
|
||
selection. Takes 2 parameters: The app instance and the filename.
|
||
Note that it is run on a separate thread, therefore it must take the
|
||
appropriate precautions when accessing shared resources.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.file_chooser_save_action">
|
||
<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>
|
||
<dd><p>Opens the file chooser and runs on_success upon completion of valid file choice.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>on_success</strong> – A function to run upon selection of a filename. Takes 2
|
||
parameters: The instance of the application (App) and the chosen filename. This
|
||
gets run immediately in the same thread.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.get_current">
|
||
<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>
|
||
<dd><p>Returns the currently selected FlatCAMObj in the application.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Currently selected FlatCAMObj in the application.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">FlatCAMObj or None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.get_eval">
|
||
<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>
|
||
<dd><p>Runs eval() on the on the text entry of name ‘widget_name’
|
||
and returns the results.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget_name</strong> (<em>str</em>) – Name of Gtk.Entry</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Depends on contents of the entry text.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.get_radio_value">
|
||
<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>
|
||
<dd><p>Returns the radio_set[key] of the radiobutton
|
||
whose name is key is active.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>radio_set</strong> (<em>dict</em>) – A dictionary containing widget_name: value pairs.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">radio_set[key]</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.info">
|
||
<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>
|
||
<dd><p>Show text on the status bar.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>text</strong> (<em>str</em>) – Text to display.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.load_defaults">
|
||
<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>
|
||
<dd><p>Loads the aplication’s default settings from defaults.json into
|
||
<tt class="docutils literal"><span class="pre">self.defaults</span></tt>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.new_object">
|
||
<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>
|
||
<dd><p>Creates a new specalized FlatCAMObj and attaches it to the application,
|
||
this is, updates the GUI accordingly, any other records and plots it.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>kind</strong> (<em>str</em>) – The kind of object to create. One of ‘gerber’,
|
||
‘excellon’, ‘cncjob’ and ‘geometry’.</li>
|
||
<li><strong>name</strong> (<em>str</em>) – Name for the object.</li>
|
||
<li><strong>initialize</strong> (<em>function</em>) – Function to run after creation of the object
|
||
but before it is attached to the application. The function is
|
||
called with 2 parameters: the new object and the App instance.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">None</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">None</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_about">
|
||
<tt class="descname">on_about</tt><big>(</big><em>widget</em><big>)</big><a class="headerlink" href="#FlatCAM.App.on_about" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Opens the ‘About’ dialog box.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_activate_name">
|
||
<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>
|
||
<dd><p>Hitting ‘Enter’ after changing the name of an item
|
||
updates the item dictionary and re-builds the item list.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>entry</strong> – The widget from which this was called.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_canvas_configure">
|
||
<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>
|
||
<dd><p>Called whenever the canvas changes size. The axes are updated such
|
||
as to use the whole canvas.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>widget</strong> – Ignored.</li>
|
||
<li><strong>event</strong> – Ignored.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_clear_plots">
|
||
<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>
|
||
<dd><p>Callback for toolbar button. Clears all plots.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – The widget from which this was called.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_click_over_plot">
|
||
<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>
|
||
<dd><p>Callback for the mouse click event over the plot. This event is generated
|
||
by the Matplotlib backend and has been registered in <tt class="docutils literal"><span class="pre">self.__init__()</span></tt>.
|
||
For details, see: <a class="reference external" href="http://matplotlib.org/users/event_handling.html">http://matplotlib.org/users/event_handling.html</a></p>
|
||
<p>Default actions are:</p>
|
||
<ul class="simple">
|
||
<li>Copy coordinates to clipboard. Ex.: (65.5473, -13.2679)</li>
|
||
</ul>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> – Contains information about the event, like which button
|
||
was clicked, the pixel coordinates and the axes coordinates.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_closewindow">
|
||
<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>
|
||
<dd><p>Callback for closing the main window.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> – Whatever is passed by the event. Ignore.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_cncjob_exportgcode">
|
||
<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>
|
||
<dd><p>Called from button on CNCjob form to save the G-Code from the object.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – The widget from which this was called.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_create_aligndrill">
|
||
<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>
|
||
<dd><p>Creates alignment holes Excellon object. Creates mirror duplicates
|
||
of the specified holes around the specified axis.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_create_mirror">
|
||
<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>
|
||
<dd><p>Creates a mirror image of a Gerber object to be used as a bottom
|
||
copper layer.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_delete">
|
||
<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>
|
||
<dd><p>Delete the currently selected FlatCAMObj.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – The widget from which this was called.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_entry_eval_activate">
|
||
<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>
|
||
<dd><p>Called when an entry is activated (eg. by hitting enter) if
|
||
set to do so. Its text is eval()’d and set to the returned value.
|
||
The current object is updated.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – </td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_eval_update">
|
||
<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>
|
||
<dd><p>Modifies the content of a Gtk.Entry by running
|
||
eval() on its contents and puting it back as a
|
||
string.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – The widget from which this was called.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_excellon_tool_choose">
|
||
<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>
|
||
<dd><p>Callback for button on Excellon form to open up a window for
|
||
selecting tools.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – The widget from which this was called.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_file_new">
|
||
<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>
|
||
<dd><p>Callback for menu item File->New. Returns the application to its
|
||
startup state.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> – Whatever is passed by the event. Ignore.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_file_openproject">
|
||
<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>
|
||
<dd><p>Callback for menu item File->Open Project. Opens a file chooser and calls
|
||
<tt class="docutils literal"><span class="pre">self.open_project()</span></tt> after successful selection of a filename.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_file_savedefaults">
|
||
<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>
|
||
<dd><p>Callback for menu item File->Save Defaults. Saves application default options
|
||
<tt class="docutils literal"><span class="pre">self.defaults</span></tt> to defaults.json.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_file_saveproject">
|
||
<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>
|
||
<dd><p>Callback for menu item File->Save Project. Saves the project to
|
||
<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>
|
||
if set to None. The project is saved by calling <tt class="docutils literal"><span class="pre">self.save_project()</span></tt>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_file_saveprojectas">
|
||
<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>
|
||
<dd><p>Callback for menu item File->Save Project As... Opens a file
|
||
chooser and saves the project to the given file via
|
||
<tt class="docutils literal"><span class="pre">self.save_project()</span></tt>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_file_saveprojectcopy">
|
||
<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>
|
||
<dd><p>Callback for menu item File->Save Project Copy... Opens a file
|
||
chooser and saves the project to the given file via
|
||
<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
|
||
subsequent save requests are done on the previous known filename.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> – Ignore.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_fileopenexcellon">
|
||
<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>
|
||
<dd><p>Callback for menu item File->Open Excellon. Defines a function that is then passed
|
||
to <tt class="docutils literal"><span class="pre">self.file_chooser_action()</span></tt>. It requests the creation of a FlatCAMExcellon object
|
||
and updates the progress bar throughout the process.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> – Ignore</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_fileopengcode">
|
||
<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>
|
||
<dd><p>Callback for menu item File->Open G-Code. Defines a function that is then passed
|
||
to <tt class="docutils literal"><span class="pre">self.file_chooser_action()</span></tt>. It requests the creation of a FlatCAMCNCjob object
|
||
and updates the progress bar throughout the process.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> – Ignore</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_fileopengerber">
|
||
<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>
|
||
<dd><p>Callback for menu item File->Open Gerber. Defines a function that is then passed
|
||
to <tt class="docutils literal"><span class="pre">self.file_chooser_action()</span></tt>. It requests the creation of a FlatCAMGerber object
|
||
and updates the progress bar throughout the process.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> – Ignore</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_filequit">
|
||
<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>
|
||
<dd><p>Callback for menu item File->Quit. Closes the application.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> – Whatever is passed by the event. Ignore.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_generate_cncjob">
|
||
<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>
|
||
<dd><p>Callback for button on geometry form to generate CNC job.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – The widget from which this was called.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_generate_excellon_cncjob">
|
||
<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>
|
||
<dd><p>Callback for button active/click on Excellon form to
|
||
create a CNC Job for the Excellon file.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – The widget from which this was called.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_generate_gerber_bounding_box">
|
||
<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>
|
||
<dd><p>Callback for request from the Gerber form to generate a bounding box for the
|
||
geometry in the object. Creates a FlatCAMGeometry with the bounding box.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_generate_isolation">
|
||
<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>
|
||
<dd><p>Callback for button on Gerber form to create isolation routing geometry.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – The widget from which this was called.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_generate_paintarea">
|
||
<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>
|
||
<dd><p>Callback for button on geometry form.
|
||
Subscribes to the “Click on plot” event and continues
|
||
after the click. Finds the polygon containing
|
||
the clicked point and runs clear_poly() on it, resulting
|
||
in a new FlatCAMGeometry object.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – The widget from which this was called.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_gerber_generate_cutout">
|
||
<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>
|
||
<dd><p>Callback for button on Gerber form to create geometry with lines
|
||
for cutting off the board.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – The widget from which this was called.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_gerber_generate_noncopper">
|
||
<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>
|
||
<dd><p>Callback for button on Gerber form to create a geometry object
|
||
with polygons covering the area without copper or negative of the
|
||
Gerber.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – The widget from which this was called.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_key_over_plot">
|
||
<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>
|
||
<dd><p>Callback for the key pressed event when the canvas is focused. Keyboard
|
||
shortcuts are handled here. So far, these are the shortcuts:</p>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="19%" />
|
||
<col width="81%" />
|
||
</colgroup>
|
||
<thead valign="bottom">
|
||
<tr class="row-odd"><th class="head">Key</th>
|
||
<th class="head">Action</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody valign="top">
|
||
<tr class="row-even"><td>‘1’</td>
|
||
<td>Zoom-fit. Fits the axes limits to the data.</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>‘2’</td>
|
||
<td>Zoom-out.</td>
|
||
</tr>
|
||
<tr class="row-even"><td>‘3’</td>
|
||
<td>Zoom-in.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_mouse_move_over_plot">
|
||
<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>
|
||
<dd><p>Callback for the mouse motion event over the plot. This event is generated
|
||
by the Matplotlib backend and has been registered in <tt class="docutils literal"><span class="pre">self.__init__()</span></tt>.
|
||
For details, see: <a class="reference external" href="http://matplotlib.org/users/event_handling.html">http://matplotlib.org/users/event_handling.html</a></p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> – Contains information about the event.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_options_app2object">
|
||
<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>
|
||
<dd><p>Callback for Options->Transfer Options->App=>Object. Copies options
|
||
from application defaults to the currently selected object.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_options_app2project">
|
||
<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>
|
||
<dd><p>Callback for Options->Transfer Options->App=>Project. Copies options
|
||
from application defaults to project defaults.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_options_combo_change">
|
||
<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>
|
||
<dd><p>Called when the combo box to choose between application defaults and
|
||
project option changes value. The corresponding variables are
|
||
copied to the UI.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – The widget from which this was called. Ignore.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_options_object2app">
|
||
<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>
|
||
<dd><p>Callback for Options->Transfer Options->Object=>App. Copies options
|
||
from the currently selected object to application defaults.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_options_object2project">
|
||
<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>
|
||
<dd><p>Callback for Options->Transfer Options->Object=>Project. Copies options
|
||
from the currently selected object to project defaults.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_options_project2app">
|
||
<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>
|
||
<dd><p>Callback for Options->Transfer Options->Project=>App. Copies options
|
||
from project defaults to application defaults.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_options_project2object">
|
||
<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>
|
||
<dd><p>Callback for Options->Transfer Options->Project=>Object. Copies options
|
||
from project defaults to the currently selected object.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_options_update">
|
||
<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>
|
||
<dd><p>Called whenever a value in the options/defaults form changes.
|
||
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>,
|
||
which may be necessary when updating the UI from code and not by the user.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – The widget from which this was called. Ignore.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_replot">
|
||
<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>
|
||
<dd><p>Callback for toolbar button. Re-plots all objects.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – The widget from which this was called.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_row_activated">
|
||
<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>
|
||
<dd><p>Callback for selection activation (Enter or double-click) on the Project list.
|
||
Switches the notebook page to the object properties form. Calls
|
||
<tt class="docutils literal"><span class="pre">self.notebook.set_current_page(1)</span></tt>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>widget</strong> – Ignored.</li>
|
||
<li><strong>path</strong> – Ignored.</li>
|
||
<li><strong>col</strong> – Ignored.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_scale_object">
|
||
<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>
|
||
<dd><p>Callback for request to change an objects geometry scale. The object
|
||
is re-scaled and replotted.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_toggle_pointbox">
|
||
<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>
|
||
<dd><p>Callback for radio selection change between point and box in the
|
||
Double-sided PCB tool. Updates the UI accordingly.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_toggle_units">
|
||
<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>
|
||
<dd><p>Callback for the Units radio-button change in the Options tab.
|
||
Changes the application’s default units or the current project’s units.
|
||
If changing the project’s units, the change propagates to all of
|
||
the objects in the project.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_tools_doublesided">
|
||
<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>
|
||
<dd><p>Callback for menu item Tools->Double Sided PCB Tool. Launches the
|
||
tool placing its UI in the “Tool” tab in the notebook.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_tree_selection_changed">
|
||
<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>
|
||
<dd><p>Callback for selection change in the project list. This changes
|
||
the currently selected FlatCAMObj.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>selection</strong> (<em>Gtk.TreeSelection</em>) – Selection associated to the project tree or list</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_update_plot">
|
||
<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>
|
||
<dd><p>Callback for button on form for all kinds of objects.
|
||
Re-plots the current object only.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>widget</strong> – The widget from which this was called.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_zoom_fit">
|
||
<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>
|
||
<dd><p>Callback for zoom-out request. This can be either from the corresponding
|
||
toolbar button or the ‘1’ key when the canvas is focused. Calls <tt class="docutils literal"><span class="pre">self.adjust_axes()</span></tt>
|
||
with axes limits from the geometry bounds of all objects.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_zoom_in">
|
||
<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>
|
||
<dd><p>Callback for zoom-in request. This can be either from the corresponding
|
||
toolbar button or the ‘3’ key when the canvas is focused. Calls <tt class="docutils literal"><span class="pre">self.zoom()</span></tt>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.on_zoom_out">
|
||
<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>
|
||
<dd><p>Callback for zoom-out request. This can be either from the corresponding
|
||
toolbar button or the ‘2’ key when the canvas is focused. Calls <tt class="docutils literal"><span class="pre">self.zoom()</span></tt>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> – Ignored.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.open_project">
|
||
<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>
|
||
<dd><p>Loads a project from the specified file.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> (<em>str</em>) – Name of the file from which to load.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.options2form">
|
||
<tt class="descname">options2form</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.App.options2form" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sets the ‘Project Options’ or ‘Application Defaults’ form with values from
|
||
<tt class="docutils literal"><span class="pre">self.options</span></tt> or <tt class="docutils literal"><span class="pre">self.defaults</span></tt>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.plot_all">
|
||
<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>
|
||
<dd><p>Re-generates all plots from all objects.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.populate_objects_combo">
|
||
<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>
|
||
<dd><p>Populates a Gtk.Comboboxtext with the list of the object in the project.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>combo</strong> (<em>str or Gtk.ComboBoxText</em>) – Name or instance of the comboboxtext.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.read_form">
|
||
<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>
|
||
<dd><p>Reads the options form into self.defaults/self.options.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.read_form_item">
|
||
<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>
|
||
<dd><p>Reads the value of a form item in the defaults/options form and
|
||
saves it to the corresponding dictionary.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>name</strong> (<em>str</em>) – Name of the form item. A key in <tt class="docutils literal"><span class="pre">self.defaults</span></tt> or
|
||
<tt class="docutils literal"><span class="pre">self.options</span></tt>.</li>
|
||
<li><strong>dest</strong> (<em>dict</em>) – Dictionary to which to save the value.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.save_project">
|
||
<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>
|
||
<dd><p>Saves the current project to the specified file.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> (<em>str</em>) – Name of the file in which to save.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.set_form_item">
|
||
<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>
|
||
<dd><p>Sets a form item ‘name’ in the GUI with the given ‘value’. The syntax of
|
||
form names in the GUI is <kind>_app_<name>, where kind is one of: rb (radio button),
|
||
cb (check button), entry_eval or entry_text (entry), combo (combo box). name is
|
||
whatever name it’s been given. For self.defaults, name is a key in the dictionary.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>name</strong> (<em>str</em>) – Name of the form field.</li>
|
||
<li><strong>value</strong> (<em>Depends on field kind.</em>) – The value to set the form field to.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.set_list_selection">
|
||
<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>
|
||
<dd><p>Marks a given object as selected in the list ob objects
|
||
in the GUI. This selection will in turn trigger
|
||
<tt class="docutils literal"><span class="pre">self.on_tree_selection_changed()</span></tt>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<em>str</em>) – Name of the object.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.set_progress_bar">
|
||
<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>
|
||
<dd><p>Sets the application’s progress bar to a given fraction and text.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>percentage</strong> (<em>float</em>) – The fraction (0.0-1.0) of the progress.</li>
|
||
<li><strong>text</strong> (<em>str</em>) – Text to display on the progress bar.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.setup_component_editor">
|
||
<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>
|
||
<dd><p>Initial configuration of the component editor. Creates
|
||
a page titled “Selection” on the notebook on the left
|
||
side of the main window.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.setup_obj_classes">
|
||
<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>
|
||
<dd><p>Sets up application specifics on the FlatCAMObj class.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.setup_plot">
|
||
<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>
|
||
<dd><p>Sets up the main plotting area by creating a Matplotlib
|
||
figure in self.canvas, adding axes and configuring them.
|
||
These axes should not be ploted on and are just there to
|
||
display the axes ticks and grid.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.setup_project_list">
|
||
<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>
|
||
<dd><p>Sets up list or Tree where whatever has been loaded or created is
|
||
displayed.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.App.zoom">
|
||
<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>
|
||
<dd><p>Zooms the plot by factor around a given
|
||
center point. Takes care of re-drawing.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>factor</strong> (<em>float</em>) – Number by which to scale the plot.</li>
|
||
<li><strong>center</strong> (<em>list</em>) – Coordinates [x, y] of the point around which to scale the plot.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="FlatCAM.Geometry">
|
||
<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>
|
||
<dd><dl class="method">
|
||
<dt id="FlatCAM.Geometry.bounds">
|
||
<tt class="descname">bounds</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.Geometry.bounds" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns coordinates of rectangular bounds
|
||
of geometry: (xmin, ymin, xmax, ymax).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.Geometry.clear_polygon">
|
||
<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>
|
||
<dd><p>Creates geometry inside a polygon for a tool to cover
|
||
the whole area.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.Geometry.convert_units">
|
||
<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>
|
||
<dd><p>Converts the units of the object to <tt class="docutils literal"><span class="pre">units</span></tt> by scaling all
|
||
the geometry appropriately. This call <tt class="docutils literal"><span class="pre">scale()</span></tt>. Don’t call
|
||
it again in descendents.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>units</strong> (<em>str</em>) – “IN” or “MM”</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Scaling factor resulting from unit change.</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">float</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.Geometry.from_dict">
|
||
<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>
|
||
<dd><p>Sets object’s attributes from a dictionary.
|
||
Attributes to include are listed in <tt class="docutils literal"><span class="pre">self.ser_attrs</span></tt>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.Geometry.get_empty_area">
|
||
<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>
|
||
<dd><p>Returns the complement of self.solid_geometry within
|
||
the given boundary polygon. If not specified, it defaults to
|
||
the rectangular bounding box of self.solid_geometry.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.Geometry.isolation_geometry">
|
||
<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>
|
||
<dd><p>Creates contours around geometry at a given
|
||
offset distance.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.Geometry.scale">
|
||
<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>
|
||
<dd><p>Scales all of the object’s geometry by a given factor. Override
|
||
this method.
|
||
:param factor: Number by which to scale.
|
||
:type factor: float
|
||
:return: None
|
||
:rtype: None</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.Geometry.size">
|
||
<tt class="descname">size</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.Geometry.size" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns (width, height) of rectangular
|
||
bounds of geometry.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.Geometry.to_dict">
|
||
<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>
|
||
<dd><p>Returns a respresentation of the object as a dictionary.
|
||
Attributes to include are listed in <tt class="docutils literal"><span class="pre">self.ser_attrs</span></tt>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A dictionary-encoded copy of the object.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">dict</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="FlatCAM.Gerber">
|
||
<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>
|
||
<dd><p><strong>ATTRIBUTES</strong></p>
|
||
<ul class="simple">
|
||
<li><tt class="docutils literal"><span class="pre">apertures</span></tt> (dict): The keys are names/identifiers of each aperture.
|
||
The values are dictionaries key/value pairs which describe the aperture. The
|
||
type key is always present and the rest depend on the key:</li>
|
||
</ul>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="24%" />
|
||
<col width="76%" />
|
||
</colgroup>
|
||
<thead valign="bottom">
|
||
<tr class="row-odd"><th class="head">Key</th>
|
||
<th class="head">Value</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody valign="top">
|
||
<tr class="row-even"><td>type</td>
|
||
<td>(str) “C”, “R”, or “O”</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>others</td>
|
||
<td>Depend on <tt class="docutils literal"><span class="pre">type</span></tt></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<ul class="simple">
|
||
<li><tt class="docutils literal"><span class="pre">paths</span></tt> (list): A path is described by a line an aperture that follows that
|
||
line. Each paths[i] is a dictionary:</li>
|
||
</ul>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="20%" />
|
||
<col width="80%" />
|
||
</colgroup>
|
||
<thead valign="bottom">
|
||
<tr class="row-odd"><th class="head">Key</th>
|
||
<th class="head">Value</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody valign="top">
|
||
<tr class="row-even"><td>linestring</td>
|
||
<td>(Shapely.LineString) The actual path.</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>aperture</td>
|
||
<td>(str) The key for an aperture in apertures.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<ul class="simple">
|
||
<li><tt class="docutils literal"><span class="pre">flashes</span></tt> (list): Flashes are single-point strokes of an aperture. Each
|
||
is a dictionary:</li>
|
||
</ul>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="20%" />
|
||
<col width="80%" />
|
||
</colgroup>
|
||
<thead valign="bottom">
|
||
<tr class="row-odd"><th class="head">Key</th>
|
||
<th class="head">Value</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody valign="top">
|
||
<tr class="row-even"><td>loc</td>
|
||
<td>(list) [x (float), y (float)] coordinates.</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>aperture</td>
|
||
<td>(str) The key for an aperture in apertures.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<ul class="simple">
|
||
<li><tt class="docutils literal"><span class="pre">regions</span></tt> (list): Are surfaces defined by a polygon (Shapely.Polygon),
|
||
which have an exterior and zero or more interiors. An aperture is also
|
||
associated with a region. Each is a dictionary:</li>
|
||
</ul>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="18%" />
|
||
<col width="82%" />
|
||
</colgroup>
|
||
<thead valign="bottom">
|
||
<tr class="row-odd"><th class="head">Key</th>
|
||
<th class="head">Value</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody valign="top">
|
||
<tr class="row-even"><td>polygon</td>
|
||
<td>(Shapely.Polygon) The polygon defining the region.</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>aperture</td>
|
||
<td>(str) The key for an aperture in apertures.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<ul class="simple">
|
||
<li><tt class="docutils literal"><span class="pre">flash_geometry</span></tt> (list): List of (Shapely) geometric object resulting
|
||
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>
|
||
<li><tt class="docutils literal"><span class="pre">buffered_paths</span></tt> (list): List of (Shapely) polygons resulting from
|
||
<em>buffering</em> (or thickening) the <tt class="docutils literal"><span class="pre">paths</span></tt> with the aperture. These are
|
||
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>
|
||
</ul>
|
||
<p><strong>USAGE</strong>:</p>
|
||
<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>
|
||
<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>
|
||
<span class="n">g</span><span class="o">.</span><span class="n">create_geometry</span><span class="p">()</span>
|
||
<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>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="method">
|
||
<dt id="FlatCAM.Gerber.aperture_parse">
|
||
<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>
|
||
<dd><p>Parse gerber aperture definition into dictionary of apertures.
|
||
The following kinds and their attributes are supported:</p>
|
||
<ul class="simple">
|
||
<li><em>Circular (C)</em>: size (float)</li>
|
||
<li><em>Rectangle (R)</em>: width (float), height (float)</li>
|
||
<li><em>Obround (O)</em>: width (float), height (float).</li>
|
||
</ul>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>gline</strong> (<em>str</em>) – Line of Gerber code known to have an aperture definition.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Identifier of the aperture.</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.Gerber.create_geometry">
|
||
<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>
|
||
<dd><p>Geometry from a Gerber file is made up entirely of polygons.
|
||
Every stroke (linear or circular) has an aperture which gives
|
||
it thickness. Additionally, aperture strokes have non-zero area,
|
||
and regions naturally do as well.</p>
|
||
<p>:rtype : None
|
||
:return: None</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="FlatCAM.Gerber.digits">
|
||
<tt class="descname">digits</tt><em class="property"> = None</em><a class="headerlink" href="#FlatCAM.Gerber.digits" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of integer digits in Gerber numbers. Used during parsing.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.Gerber.do_flashes">
|
||
<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>
|
||
<dd><p>Creates geometry for Gerber flashes (aperture on a single point).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.Gerber.fix_regions">
|
||
<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>
|
||
<dd><p>Overwrites the region polygons with fixed
|
||
versions if found to be invalid (according to Shapely).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="FlatCAM.Gerber.fraction">
|
||
<tt class="descname">fraction</tt><em class="property"> = None</em><a class="headerlink" href="#FlatCAM.Gerber.fraction" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of fraction digits in Gerber numbers. Used during parsing.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.Gerber.get_bounding_box">
|
||
<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>
|
||
<dd><p>Creates and returns a rectangular polygon bounding at a distance of
|
||
margin from the object’s <tt class="docutils literal"><span class="pre">solid_geometry</span></tt>. If margin > 0, the polygon
|
||
can optionally have rounded corners of radius equal to margin.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>margin</strong> (<em>float</em>) – Distance to enlarge the rectangular bounding
|
||
box in both positive and negative, x and y axes.</li>
|
||
<li><strong>rounded</strong> (<em>bool</em>) – Wether or not to have rounded corners.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The bounding box.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Shapely.Polygon</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.Gerber.parse_file">
|
||
<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>
|
||
<dd><p>Calls Gerber.parse_lines() with array of lines
|
||
read from the given file.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.Gerber.parse_lines">
|
||
<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>
|
||
<dd><p>Main Gerber parser.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.Gerber.scale">
|
||
<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>
|
||
<dd><p>Scales the objects’ geometry on the XY plane by a given factor.
|
||
These are:</p>
|
||
<ul class="simple">
|
||
<li><tt class="docutils literal"><span class="pre">apertures</span></tt></li>
|
||
<li><tt class="docutils literal"><span class="pre">paths</span></tt></li>
|
||
<li><tt class="docutils literal"><span class="pre">regions</span></tt></li>
|
||
<li><tt class="docutils literal"><span class="pre">flashes</span></tt></li>
|
||
</ul>
|
||
<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>
|
||
are re-created with <tt class="docutils literal"><span class="pre">self.create_geometry()</span></tt>.
|
||
:param factor: Number by which to scale.
|
||
:type factor: float
|
||
:rtype : None</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="FlatCAM.Excellon">
|
||
<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>
|
||
<dd><p><em>ATTRIBUTES</em></p>
|
||
<ul class="simple">
|
||
<li><tt class="docutils literal"><span class="pre">tools</span></tt> (dict): The key is the tool name and the value is
|
||
the size (diameter).</li>
|
||
<li><tt class="docutils literal"><span class="pre">drills</span></tt> (list): Each is a dictionary:</li>
|
||
</ul>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="31%" />
|
||
<col width="69%" />
|
||
</colgroup>
|
||
<thead valign="bottom">
|
||
<tr class="row-odd"><th class="head">Key</th>
|
||
<th class="head">Value</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody valign="top">
|
||
<tr class="row-even"><td>point</td>
|
||
<td>(Shapely.Point) Where to drill</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>tool</td>
|
||
<td>(str) A key in <tt class="docutils literal"><span class="pre">tools</span></tt></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="method">
|
||
<dt id="FlatCAM.Excellon.parse_lines">
|
||
<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>
|
||
<dd><p>Main Excellon parser.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.Excellon.scale">
|
||
<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>
|
||
<dd><p>Scales geometry on the XY plane in the object by a given factor.
|
||
Tool sizes, feedrates an Z-plane dimensions are untouched.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>factor</strong> (<em>float</em>) – Number by which to scale the object.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">NOne</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="FlatCAM.CNCjob">
|
||
<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>
|
||
<dd><p>Represents work to be done by a CNC machine.</p>
|
||
<p><em>ATTRIBUTES</em></p>
|
||
<ul class="simple">
|
||
<li><tt class="docutils literal"><span class="pre">gcode_parsed</span></tt> (list): Each is a dictionary:</li>
|
||
</ul>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="34%" />
|
||
<col width="66%" />
|
||
</colgroup>
|
||
<thead valign="bottom">
|
||
<tr class="row-odd"><th class="head">Key</th>
|
||
<th class="head">Value</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody valign="top">
|
||
<tr class="row-even"><td>geom</td>
|
||
<td>(Shapely.LineString) Tool path (XY plane)</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>kind</td>
|
||
<td>(string) “AB”, A is “T” (travel) or
|
||
“C” (cut). B is “F” (fast) or “S” (slow).</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="method">
|
||
<dt id="FlatCAM.CNCjob.gcode_parse">
|
||
<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>
|
||
<dd><p>G-Code parser (from self.gcode). Generates dictionary with
|
||
single-segment LineString’s and “kind” indicating cut or travel,
|
||
fast or feedrate speed.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.CNCjob.generate_from_excellon">
|
||
<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>
|
||
<dd><p>Generates G-code for drilling from Excellon object.
|
||
self.gcode becomes a list, each element is a
|
||
different job for each tool in the excellon code.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.CNCjob.generate_from_excellon_by_tool">
|
||
<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>
|
||
<dd><p>Creates gcode for this object from an Excellon object
|
||
for the specified tools.
|
||
@param exobj: Excellon object to process
|
||
@type exobj: Excellon
|
||
@param tools: Comma separated tool names
|
||
@type: tools: str
|
||
@return: None</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.CNCjob.generate_from_geometry">
|
||
<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>
|
||
<dd><p>Generates G-Code from a Geometry object.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.CNCjob.plot2">
|
||
<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>
|
||
<dd><p>Plots the G-code job onto the given axes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.CNCjob.polygon2gcode">
|
||
<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>
|
||
<dd><p>Creates G-Code for the exterior and all interior paths
|
||
of a polygon.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>polygon</strong> (<em>Shapely.Polygon</em>) – A Shapely.Polygon</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.CNCjob.pre_parse">
|
||
<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>
|
||
<dd><p>gtext is a single string with g-code</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.CNCjob.scale">
|
||
<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>
|
||
<dd><p>Scales all the geometry on the XY plane in the object by the
|
||
given factor. Tool sizes, feedrates, or Z-axis dimensions are
|
||
not altered.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>factor</strong> (<em>float</em>) – Number by which to scale the object.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="FlatCAM.FlatCAMObj">
|
||
<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>
|
||
<dd><p>Base type of objects handled in FlatCAM. These become interactive
|
||
in the GUI, can be plotted, and their options can be modified
|
||
by the user in their respective forms.</p>
|
||
<dl class="method">
|
||
<dt id="FlatCAM.FlatCAMObj.build_ui">
|
||
<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>
|
||
<dd><p>Sets up the UI/form for this object.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.FlatCAMObj.deserialize">
|
||
<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>
|
||
<dd><p>Re-builds an object from its serialized version.
|
||
@param obj_dict: Dictionary representing a FlatCAMObj
|
||
@type obj_dict: dict
|
||
@return None</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.FlatCAMObj.plot">
|
||
<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>
|
||
<dd><p>Extend this method! Sets up axes if needed and
|
||
clears them. Descendants must do the actual plotting.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.FlatCAMObj.read_form">
|
||
<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>
|
||
<dd><p>Reads form into <tt class="docutils literal"><span class="pre">self.options</span></tt>.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.FlatCAMObj.serialize">
|
||
<tt class="descname">serialize</tt><big>(</big><big>)</big><a class="headerlink" href="#FlatCAM.FlatCAMObj.serialize" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns a representation of the object as a dictionary so
|
||
it can be later exported as JSON. Override this method.
|
||
@return: Dictionary representing the object
|
||
@rtype: dict</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.FlatCAMObj.set_form_item">
|
||
<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>
|
||
<dd><p>Copies the specified options to the UI form.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>option</strong> (<em>str</em>) – Name of the option (Key in <tt class="docutils literal"><span class="pre">self.options</span></tt>).</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.FlatCAMObj.setup_axes">
|
||
<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>
|
||
<dd><p>1) Creates axes if they don’t exist. 2) Clears axes. 3) Attaches
|
||
them to figure if not part of the figure. 4) Sets transparent
|
||
background. 5) Sets 1:1 scale aspect ratio.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>figure</strong> (<em>matplotlib.figure.Figure</em>) – A Matplotlib.Figure on which to add/configure axes.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="FlatCAM.FlatCAMObj.to_form">
|
||
<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>
|
||
<dd><p>Copies options to the UI form.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="FlatCAM.FlatCAMGerber">
|
||
<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>
|
||
<dd><p>Represents Gerber code.</p>
|
||
<dl class="method">
|
||
<dt id="FlatCAM.FlatCAMGerber.convert_units">
|
||
<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>
|
||
<dd><p>Converts the units of the object by scaling dimensions in all geometry
|
||
and options.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>units</strong> (<em>str</em>) – Units to which to convert the object: “IN” or “MM”.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="FlatCAM.FlatCAMExcellon">
|
||
<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>
|
||
<dd><p>Represents Excellon code.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="FlatCAM.FlatCAMCNCjob">
|
||
<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>
|
||
<dd><p>Represents G-Code.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="FlatCAM.FlatCAMGeometry">
|
||
<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>
|
||
<dd><p>Geometric object not associated with a specific
|
||
format.</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="indices-and-tables">
|
||
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
|
||
<ul class="simple">
|
||
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
|
||
<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
|
||
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
<footer>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2014, Juan Pablo Caram.
|
||
</p>
|
||
</div>
|
||
|
||
<a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
</body>
|
||
</html> |