<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><title>Python: module skeinforge_tools.craft_plugins.coil</title> </head><body bgcolor="#f0f0f8"> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> <tr bgcolor="#7799ee"> <td valign=bottom> <br> <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="skeinforge_tools.html"><font color="#ffffff">skeinforge_tools</font></a>.<a href="skeinforge_tools.craft_plugins.html"><font color="#ffffff">craft_plugins</font></a>.coil</strong></big></big> ($Date: 2008/21/04 $)</font></td ><td align=right valign=bottom ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/enrique/Desktop/backup/babbleold/script/reprap/pyRepRap/skeinforge_tools/craft_plugins/coil.py">/home/enrique/Desktop/backup/babbleold/script/reprap/pyRepRap/skeinforge_tools/craft_plugins/coil.py</a></font></td></tr></table> <p> <a href="skeinforge_tools.craft_plugins.clip.html">Previous</a> / <a href="skeinforge_tools.craft_plugins.comb.html">Next</a> / <a href="contents.html">Contents</a> </p> <p><tt><br> Coil is a script to coil wire or filament around an object.<br> <br> <br /> <a href="#Operation">Operation</a><br /> <a href="#Settings">Settings</a><br /> <a href="#Minimum Tool Distance">Minimum Tool Distance</a><br /> <a href="#Examples">Examples</a><br /> <br /> <a name="Operation" id="Operation"></a><h2>Operation</h2> <hr> The default 'Activate Coil' checkbox is on. When it is on, the functions described below will work, when it is off, the functions will not be called.<br> <br> <a name="Settings" id="Settings"></a><h2>Settings</h2> <hr> <a name="Minimum Tool Distance" id="Minimum Tool Distance"></a><h3>Minimum Tool Distance</h3> Default is twenty millimeters.<br> <br> Defines the minimum distance between the wire dispenser and the object. The 'Minimum Tool Distance' should be set to the maximum radius of the wire dispenser, times at least 1.3 to get a reasonable safety margin.<br> <br> <a name="Examples" id="Examples"></a><h2>Examples</h2> <hr> The following examples coil the file Screw Holder Bottom.stl. The examples are run in a terminal in the folder which contains Screw Holder Bottom.stl and coil.py.<br> <br> <br> > python coil.py<br> This brings up the coil dialog.<br> <br> <br> > python coil.py Screw Holder Bottom.stl<br> The coil tool is parsing the file:<br> Screw Holder Bottom.stl<br> ..<br> The coil tool has created the file:<br> Screw Holder Bottom_coil.gcode<br> <br> <br> > python<br> Python 2.5.1 (r251:54863, Sep 22 2007, 01:43:31)<br> [GCC 4.2.1 (SUSE Linux)] on linux2<br> Type "help", "copyright", "credits" or "license" for more information.<br> >>> import coil<br> >>> coil.<a href="#-main">main</a>()<br> This brings up the coil dialog.<br> <br> <br> >>> coil.<a href="#-writeOutput">writeOutput</a>( 'Screw Holder Bottom.stl' )<br> Screw Holder Bottom.stl<br> The coil tool is parsing the file:<br> Screw Holder Bottom.stl<br> ..<br> The coil tool has created the file:<br> Screw Holder Bottom_coil.gcode</tt> <br /> <br /> <p> <a href="skeinforge_tools.craft_plugins.clip.html">Previous</a> / <a href="skeinforge_tools.craft_plugins.comb.html">Next</a> / <a href="contents.html">Contents</a> </p> <hr> </p> <p> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#aa55cc"> <td colspan=3 valign=bottom> <br> <font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> <tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="__init__.html">__init__</a><br> <a href="skeinforge_tools.skeinforge_utilities.consecution.html">skeinforge_tools.skeinforge_utilities.consecution</a><br> <a href="skeinforge_tools.skeinforge_utilities.euclidean.html">skeinforge_tools.skeinforge_utilities.euclidean</a><br> </td><td width="25%" valign=top><a href="skeinforge_tools.skeinforge_utilities.gcodec.html">skeinforge_tools.skeinforge_utilities.gcodec</a><br> <a href="skeinforge_tools.skeinforge_utilities.intercircle.html">skeinforge_tools.skeinforge_utilities.intercircle</a><br> <a href="skeinforge_tools.skeinforge_utilities.interpret.html">skeinforge_tools.skeinforge_utilities.interpret</a><br> </td><td width="25%" valign=top><a href="os.html">os</a><br> <a href="skeinforge_tools.meta_plugins.polyfile.html">skeinforge_tools.meta_plugins.polyfile</a><br> <a href="skeinforge_tools.profile.html">skeinforge_tools.profile</a><br> </td><td width="25%" valign=top><a href="skeinforge_tools.skeinforge_utilities.settings.html">skeinforge_tools.skeinforge_utilities.settings</a><br> <a href="sys.html">sys</a><br> <a href="skeinforge_tools.skeinforge_utilities.triangle_mesh.html">skeinforge_tools.skeinforge_utilities.triangle_mesh</a><br> </td></tr></table></td></tr></table><p> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ee77aa"> <td colspan=3 valign=bottom> <br> <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> <td width="100%"><dl> <dt><font face="helvetica, arial"><a href="skeinforge_tools.craft_plugins.coil.html#CoilRepository">CoilRepository</a> </font></dt><dt><font face="helvetica, arial"><a href="skeinforge_tools.craft_plugins.coil.html#CoilSkein">CoilSkein</a> </font></dt></dl> <p> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ffc8d8"> <td colspan=3 valign=bottom> <br> <font color="#000000" face="helvetica, arial"><a name="CoilRepository">class <strong>CoilRepository</strong></a></font></td></tr> <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> <td colspan=2><tt>A class to handle the coil settings.<br> </tt></td></tr> <tr><td> </td> <td width="100%">Methods defined here:<br> <dl><dt><a name="CoilRepository-__init__"><strong>__init__</strong></a>(self)</dt><dd><tt>Set the default settings, execute title & settings fileName.</tt></dd></dl> <dl><dt><a name="CoilRepository-execute"><strong>execute</strong></a>(self)</dt><dd><tt>Coil button has been clicked.</tt></dd></dl> </td></tr></table> <p> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ffc8d8"> <td colspan=3 valign=bottom> <br> <font color="#000000" face="helvetica, arial"><a name="CoilSkein">class <strong>CoilSkein</strong></a></font></td></tr> <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> <td colspan=2><tt>A class to coil a skein of extrusions.<br> </tt></td></tr> <tr><td> </td> <td width="100%">Methods defined here:<br> <dl><dt><a name="CoilSkein-__init__"><strong>__init__</strong></a>(self)</dt></dl> <dl><dt><a name="CoilSkein-addCoilLayer"><strong>addCoilLayer</strong></a>(self, boundaryLayers, radius, z)</dt><dd><tt>Add a coil layer.</tt></dd></dl> <dl><dt><a name="CoilSkein-addCoilLayers"><strong>addCoilLayers</strong></a>(self)</dt><dd><tt>Add the coil layers.</tt></dd></dl> <dl><dt><a name="CoilSkein-addCoilToThread"><strong>addCoilToThread</strong></a>(self, beginLocation, endZ, loop, thread)</dt><dd><tt>Add a coil to the thread.</tt></dd></dl> <dl><dt><a name="CoilSkein-addGcodeFromThread"><strong>addGcodeFromThread</strong></a>(self, thread)</dt><dd><tt>Add a thread to the output.</tt></dd></dl> <dl><dt><a name="CoilSkein-getCraftedGcode"><strong>getCraftedGcode</strong></a>(self, gcodeText, repository)</dt><dd><tt>Parse gcode text and store the coil gcode.</tt></dd></dl> <dl><dt><a name="CoilSkein-parseBoundaries"><strong>parseBoundaries</strong></a>(self)</dt><dd><tt>Parse the boundaries and add them to the boundary layers.</tt></dd></dl> <dl><dt><a name="CoilSkein-parseInitialization"><strong>parseInitialization</strong></a>(self)</dt><dd><tt>Parse gcode initialization and store the parameters.</tt></dd></dl> <dl><dt><a name="CoilSkein-parseUntilLayer"><strong>parseUntilLayer</strong></a>(self)</dt><dd><tt>Parse until the layer line and add it to the coil skein.</tt></dd></dl> </td></tr></table></td></tr></table><p> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#eeaa77"> <td colspan=3 valign=bottom> <br> <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> <tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> <td width="100%"><dl><dt><a name="-getCraftedText"><strong>getCraftedText</strong></a>(fileName, gcodeText<font color="#909090">=''</font>, repository<font color="#909090">=None</font>)</dt><dd><tt>Coil the file or gcodeText.</tt></dd></dl> <dl><dt><a name="-getCraftedTextFromText"><strong>getCraftedTextFromText</strong></a>(gcodeText, repository<font color="#909090">=None</font>)</dt><dd><tt>Coil a gcode linear move gcodeText.</tt></dd></dl> <dl><dt><a name="-getNewRepository"><strong>getNewRepository</strong></a>()</dt><dd><tt>Get the repository constructor.</tt></dd></dl> <dl><dt><a name="-main"><strong>main</strong></a>()</dt><dd><tt>Display the coil dialog.</tt></dd></dl> <dl><dt><a name="-writeOutput"><strong>writeOutput</strong></a>(fileName<font color="#909090">=''</font>)</dt><dd><tt>Coil a gcode linear move file.</tt></dd></dl> </td></tr></table><p> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#55aa55"> <td colspan=3 valign=bottom> <br> <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> <tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> <td width="100%"><strong>__author__</strong> = 'Enrique Perez (perez_enrique@yahoo.com)'<br> <strong>__date__</strong> = '$Date: 2008/21/04 $'<br> <strong>__license__</strong> = 'GPL 3.0'<br> <strong>absolute_import</strong> = _Feature((2, 5, 0, 'alpha', 1), (2, 7, 0, 'alpha', 0), 16384)</td></tr></table><p> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#7799ee"> <td colspan=3 valign=bottom> <br> <font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr> <tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td> <td width="100%">Enrique Perez (perez_enrique@yahoo.com)</td></tr></table> </body></html>