<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><title>Python: module skeinforge_tools.craft_plugins.cleave</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>.cleave</strong></big></big> ($Date: 2008/02/05 $)</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/cleave.py">/home/enrique/Desktop/backup/babbleold/script/reprap/pyRepRap/skeinforge_tools/craft_plugins/cleave.py</a></font></td></tr></table> <p> <a href="skeinforge_tools.craft_plugins.chop.html">Previous</a> / <a href="skeinforge_tools.craft_plugins.clip.html">Next</a> / <a href="contents.html">Contents</a> </p> <p><tt><br> Cleave is a script to cleave a shape into svg slice layers.<br> <br> <br /> <a href="#Settings">Settings</a><br /> <a href="#Extra Decimal Places">Extra Decimal Places</a><br /> <a href="#Import Coarseness">Import Coarseness</a><br /> <a href="#Layer Thickness">Layer Thickness</a><br /> <a href="#Layers">Layers</a><br /> <a href="#Layers From">Layers From</a><br /> <a href="#Layers To">Layers To</a><br /> <a href="#Mesh Type">Mesh Type</a><br /> <a href="#Correct Mesh">Correct Mesh</a><br /> <a href="#Unproven Mesh">Unproven Mesh</a><br /> <a href="#Perimeter Width">Perimeter Width</a><br /> <a href="#Examples">Examples</a><br /> <br /> <a name="Settings" id="Settings"></a><h2>Settings</h2> <hr> <a name="Extra Decimal Places" id="Extra Decimal Places"></a><h3>Extra Decimal Places</h3> Default is one.<br> <br> Defines the number of extra decimal places export will output compared to the number of decimal places in the layer thickness. The higher the 'Extra Decimal Places', the more significant figures the output numbers will have.<br> <br> <a name="Import Coarseness" id="Import Coarseness"></a><h3>Import Coarseness</h3> Default is one.<br> <br> When a triangle mesh has holes in it, the triangle mesh slicer switches over to a slow algorithm that spans gaps in the mesh. The higher the 'Import Coarseness' setting, the wider the gaps in the mesh it will span. An import coarseness of one means it will span gaps of the perimeter width.<br> <br> <a name="Layer Thickness" id="Layer Thickness"></a><h3>Layer Thickness</h3> Default is 0.4 mm.<br> <br> Defines the thickness of the layer, this is the most important cleave setting.<br> <br> <a name="Layers" id="Layers"></a><h3>Layers</h3> Cleave slices from bottom to top. To get a single layer, set the "Layers From" to zero and the "Layers To" to one. The layer from until layer to range is a python slice.<br> <br> <a name="Layers From" id="Layers From"></a><h4>Layers From</h4> Default is zero.<br> <br> Defines the index of the bottom layer that will be cleaved. If the layer from is the default zero, the carving will start from the lowest layer. If the 'Layers From' index is negative, then the carving will start from the 'Layers From' index below the top layer.<br> <br> <a name="Layers To" id="Layers To"></a><h4>Layers To</h4> Default is a huge number, which will be limited to the highest index layer.<br> <br> Defines the index of the top layer that will be cleaved. If the 'Layers To' index is a huge number like the default, the carving will go to the top of the model. If the 'Layers To' index is negative, then the carving will go to the 'Layers To' index below the top layer.<br> <br> <a name="Mesh Type" id="Mesh Type"></a><h3>Mesh Type</h3> Default is 'Correct Mesh'.<br> <br> <a name="Correct Mesh" id="Correct Mesh"></a><h4>Correct Mesh</h4> When selected, the mesh will be accurately cleaved, and if a hole is found, cleave will switch over to the algorithm that spans gaps.<br> <br> <a name="Unproven Mesh" id="Unproven Mesh"></a><h4>Unproven Mesh</h4> When selected, cleave will use the gap spanning algorithm from the start. The problem with the gap spanning algothm is that it will span gaps, even if there is not actually a gap in the model.<br> <br> <a name="Perimeter Width" id="Perimeter Width"></a><h3>Perimeter Width</h3> Default is two millimeters.<br> <br> Defines the width of the perimeter.<br> <br> <a name="Examples" id="Examples"></a><h2>Examples</h2> <hr> The following examples cleave the file Screw Holder Bottom.stl. The examples are run in a terminal in the folder which contains Screw Holder Bottom.stl and cleave.py.<br> <br> <br> > python cleave.py<br> This brings up the cleave dialog.<br> <br> <br> > python cleave.py Screw Holder Bottom.stl<br> The cleave tool is parsing the file:<br> Screw Holder Bottom.stl<br> ..<br> The cleave tool has created the file:<br> .. Screw Holder Bottom_cleave.svg<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 cleave<br> >>> cleave.<a href="#-main">main</a>()<br> This brings up the cleave dialog.<br> <br> <br> >>> cleave.<a href="#-writeOutput">writeOutput</a>( 'Screw Holder Bottom.stl' )<br> The cleave tool is parsing the file:<br> Screw Holder Bottom.stl<br> ..<br> The cleave tool has created the file:<br> .. Screw Holder Bottom_cleave.svg</tt> <br /> <br /> <p> <a href="skeinforge_tools.craft_plugins.chop.html">Previous</a> / <a href="skeinforge_tools.craft_plugins.clip.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.euclidean.html">skeinforge_tools.skeinforge_utilities.euclidean</a><br> <a href="skeinforge_tools.skeinforge_utilities.gcodec.html">skeinforge_tools.skeinforge_utilities.gcodec</a><br> </td><td width="25%" valign=top><a href="skeinforge_tools.skeinforge_utilities.interpret.html">skeinforge_tools.skeinforge_utilities.interpret</a><br> <a href="math.html">math</a><br> <a href="os.html">os</a><br> </td><td width="25%" valign=top><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> <a href="skeinforge_tools.skeinforge_utilities.settings.html">skeinforge_tools.skeinforge_utilities.settings</a><br> </td><td width="25%" valign=top><a href="skeinforge_tools.skeinforge_utilities.svg_codec.html">skeinforge_tools.skeinforge_utilities.svg_codec</a><br> <a href="sys.html">sys</a><br> <a href="time.html">time</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.cleave.html#CleaveRepository">CleaveRepository</a> </font></dt><dt><font face="helvetica, arial"><a href="skeinforge_tools.skeinforge_utilities.svg_codec.html#SVGCodecSkein">skeinforge_tools.skeinforge_utilities.svg_codec.SVGCodecSkein</a> </font></dt><dd> <dl> <dt><font face="helvetica, arial"><a href="skeinforge_tools.craft_plugins.cleave.html#CleaveSkein">CleaveSkein</a> </font></dt></dl> </dd> </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="CleaveRepository">class <strong>CleaveRepository</strong></a></font></td></tr> <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> <td colspan=2><tt>A class to handle the cleave settings.<br> </tt></td></tr> <tr><td> </td> <td width="100%">Methods defined here:<br> <dl><dt><a name="CleaveRepository-__init__"><strong>__init__</strong></a>(self)</dt><dd><tt>Set the default settings, execute title & settings fileName.</tt></dd></dl> <dl><dt><a name="CleaveRepository-execute"><strong>execute</strong></a>(self)</dt><dd><tt>Cleave 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="CleaveSkein">class <strong>CleaveSkein</strong></a>(<a href="skeinforge_tools.skeinforge_utilities.svg_codec.html#SVGCodecSkein">skeinforge_tools.skeinforge_utilities.svg_codec.SVGCodecSkein</a>)</font></td></tr> <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> <td colspan=2><tt>A class to cleave a carving.<br> </tt></td></tr> <tr><td> </td> <td width="100%">Methods defined here:<br> <dl><dt><a name="CleaveSkein-getCarvedSVG"><strong>getCarvedSVG</strong></a>(self, carving, fileName, repository)</dt><dd><tt>Parse gnu triangulated surface text and store the cleaved gcode.</tt></dd></dl> <hr> Methods inherited from <a href="skeinforge_tools.skeinforge_utilities.svg_codec.html#SVGCodecSkein">skeinforge_tools.skeinforge_utilities.svg_codec.SVGCodecSkein</a>:<br> <dl><dt><a name="CleaveSkein-__init__"><strong>__init__</strong></a>(self)</dt></dl> <dl><dt><a name="CleaveSkein-addLayerBegin"><strong>addLayerBegin</strong></a>(self, layerIndex, z)</dt><dd><tt>Add the start lines for the layer.</tt></dd></dl> <dl><dt><a name="CleaveSkein-addLayerEnd"><strong>addLayerEnd</strong></a>(self, rotatedBoundaryLayer)</dt><dd><tt>Add the path and end lines for the layer.</tt></dd></dl> <dl><dt><a name="CleaveSkein-addLine"><strong>addLine</strong></a>(self, line)</dt><dd><tt>Add a line of text and a newline to the output.</tt></dd></dl> <dl><dt><a name="CleaveSkein-addLines"><strong>addLines</strong></a>(self, lines)</dt><dd><tt>Add lines of text to the output.</tt></dd></dl> <dl><dt><a name="CleaveSkein-addRotatedLoopLayerToOutput"><strong>addRotatedLoopLayerToOutput</strong></a>(self, layerIndex, rotatedBoundaryLayer)</dt><dd><tt>Add rotated boundary layer to the output.</tt></dd></dl> <dl><dt><a name="CleaveSkein-addRotatedLoopLayersToOutput"><strong>addRotatedLoopLayersToOutput</strong></a>(self, rotatedBoundaryLayers)</dt><dd><tt>Add rotated boundary layers to the output.</tt></dd></dl> <dl><dt><a name="CleaveSkein-getInitializationForOutputSVG"><strong>getInitializationForOutputSVG</strong></a>(self, procedureName)</dt><dd><tt>Get initialization gcode for the output.</tt></dd></dl> <dl><dt><a name="CleaveSkein-getReplacedSVGTemplate"><strong>getReplacedSVGTemplate</strong></a>(self, fileName, procedureName, rotatedBoundaryLayers)</dt><dd><tt>Get the lines of text from the svg_layer.template file.</tt></dd></dl> <dl><dt><a name="CleaveSkein-getRounded"><strong>getRounded</strong></a>(self, number)</dt><dd><tt>Get number rounded to the number of carried decimal places as a string.</tt></dd></dl> <dl><dt><a name="CleaveSkein-getRoundedComplexString"><strong>getRoundedComplexString</strong></a>(self, point)</dt><dd><tt>Get the rounded complex string.</tt></dd></dl> <dl><dt><a name="CleaveSkein-getSVGLoopString"><strong>getSVGLoopString</strong></a>(self, loop)</dt><dd><tt>Get the svg loop string.</tt></dd></dl> <dl><dt><a name="CleaveSkein-getSVGPathString"><strong>getSVGPathString</strong></a>(self, path)</dt><dd><tt>Get the svg path string.</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, text<font color="#909090">=''</font>, repository<font color="#909090">=None</font>)</dt><dd><tt>Get cleaved text.</tt></dd></dl> <dl><dt><a name="-getCraftedTextFromFileName"><strong>getCraftedTextFromFileName</strong></a>(fileName, repository<font color="#909090">=None</font>)</dt><dd><tt>Cleave a shape file.</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 cleave dialog.</tt></dd></dl> <dl><dt><a name="-writeOutput"><strong>writeOutput</strong></a>(fileName<font color="#909090">=''</font>)</dt><dd><tt>Cleave a GNU Triangulated Surface file. If no fileName is specified, cleave the first GNU Triangulated Surface file in this folder.</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/02/05 $'<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>